> For the complete documentation index, see [llms.txt](https://documentation.efalia.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.efalia.com/produit/efalia-process/integrations/mise-en-oeuvre/connecteurs-efalia-doc.md).

# Connecteurs Efalia Doc

## Préambule

Connecteurs permettant de communiquer entre Efalia Doc et Efalia Process.

{% hint style="warning" %}
À partir de la **6.33** d'Efalia **Process**, les connecteurs suivants requièrent impérativement que le Plan de Classement soit synchronisé et que ses éléments soient renseignés avec des IDs externes (possible qu'à partir de la **canari 34** d'Efalia **Doc**).
{% endhint %}

## Configuration

### Configuration dans l'administration du Panorama

Aussi bien pour les connecteurs que pour l'agent il faudra se rendre dans le panneau d'administration du Panorama. Une fois dans celui-ci:

* Cliquez dans la rubrique `Efalia Doc`
* En second, cliquez sur l'onglet `Paramètres`

Dans le panneau `Paramètres de l'API`, il faudra renseigner :

1. L'adresse du serveur avec le port de l'api (ex : '<https://docs.efalia.demo:1202>')
2. Le type d'authentification
3. Le login et mot de passe du compte de service si le type d'authentification correspond à `Compte de service` (toutes les actions effectuées sur Doc depuis Process seront exécutées par le compte de service renseigné. Dans Doc, c'est cet utilisateur qui sera responsable des actions effectuées et qui devra avoir les bonnes habilitations dans les armoires, gabarits...)
4. La clé d'API par si le type d'authentification correspond à `Clé d'API`. (l'identité des actions effectuées sur Doc pourra selon le paramétrage des points d'appels (connecteurs ou interface) être l'application détentrice de la clé api (ici Process) ou l'utilisateur connecté)
5. Activation des journaux de débogage

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-1341c3eb410b24103f643da168d79c5ecbaaf93b%2Fprocess-connecteurs-efalia-doc-efa-doc-config.webp?alt=media" alt=""><figcaption></figcaption></figure>

### Configuration dans le fichier de configuration

Dans le fichier de propriété de lancement il est nécessaire d'ajouter :

* Pour l'agent :

```properties
# URL API Process
workey.api.url=http://workey/api

# Identifiants et mot de passe de l'utilisateur utilisé pour l'agent sur le serveur Process
workey.api.login=workey
workey.api.password=pa$$wo0rd

# UUID de la bannette où se trouvent les documents à traiter
mgx.bannette.in=Bannette In
# UUID de la bannette où seront placé les documents une fois traités
mgx.bannette.out=Bannette Out

# Noms interne du processus, type de document, état et rôle Process à utiliser lors du traitement
document.process=Processus
document.doctype=Type de document
document.state=Etat suivant
document.role=Rôle

# 
field.uuid=Nom interne du champ du formulaire Process qui va contenir l'UUID Document GED
field.attachment=Nom interne du champ pièce-jointe du formulaire Process qui va contenir le document téléchargé depuis la GED
```

## Agent d'import de fichier Efalia Doc en bannette et lancement de workflow

### Classe de l'agent

```java
com.clog.workey.mgx.agents.ImportMGXAgent
```

### Fonctionnement

Process propose un agent de récupération de document présents dans une bannette d'Efalia Doc. L'agent est paramétré dans le `catalina.properties` (paramétrage ci-dessus) et ne permet de scruter qu'une seule bannette.

Son action vise à intervalle régulier à :

1. Regarder quels documents sont présents dans une bannette paramétrée dans `mgx.bannette.in`
   1. Les paramètres pour pointer vers la GED sont définis dans `mgx.api.url`, `mgx.api.login` et `mgx.api.password`
2. Pour chaque document trouvé, un workflow est initié
   1. Pour son paramétrage, on renseigne :
      1. dans `document.process` : le nom du processus à lancer
      2. dans `document.doctype` : le type du document à créer dans le processus
      3. dans `document.state` : l'état validé auquel positionner le document Process une fois créé dans le processus
      4. dans `document.role` : le rôle que doit jouer l'agent dans le processus
      5. les paramètres nécessaires à l'agent qui usurpe un utilisateur `workey.api.login` et `workey.api.password` pour lancer le workflow sur l'installation de Process donnée dont on paramètre l'url des api dans `workey.api.url`
3. Dans chaque instance de workflow ainsi créé, le binaire du document téléchargé depuis la GED puis poussé dans un champ pièce-jointe standard de Process (dont le nom interne est paramétré dans `field.attachment`).
   1. Pour le traitement du document côté GED, on retient son UUID côté GED dans le champ du formulaire Process dont le nom interne est paramétré dans `field.uuid`
4. L'agent utilise ensuite l'API de la GED pour transférer le document dans une nouvelle bannette paramétrée dans `mgx.bannette.out`

## Connecteurs sortant disponibles

### DirectoryCreateConnector

#### Description

Ce connecteur permet de créer un dossier dans une armoire de la GED en utilisant son gabarit. Il permet au passage de renseigner les métadonnées du dossier créé en utilisant des champs du formulaire Process (`attribut_workey` désignant leurs noms internes). Il utilise un champ en entrée et un champ en sortie.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DirectoryCreateConnector
```

#### Paramètre d'entrée

* Un champ texte contenant la configuration JSON
  1. La propriété `gabarit` correspond à l'id externe du gabarit GED à utiliser.
  2. La propriété `mapping` établit la correspondance entre les champs présents dans le formulaire Process (appelés ici "attribut") et les métadonnées du dossier GED en fonction du "gabarit".
  3. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Valeur de sortie

* uuid du dossier créé

#### Contenu du champ de configuration json

```json
{
    "gabarit": "external_id_gabarit_dossier",
    "mapping": {
        "attribut_workey_1": "external_id_metadata_dossier",
        "attribut_workey_2": "external_id_metadata_dossier"
    },
    "impersonate" : false
}
```

NB :

* "external\_id\_..." désigne un id externe du plan de classement côté GED (le plan de classement devra être synchroniser par un administrateur avant de pouvoir l'utiliser)
* "attribut\_workey..." est à remplacer par le nom interne d'un champ de formulaire workey.\
  Si vous voulez concaténer plusieurs champs workey dans une métadonnée **texte** de la GED, ajoutez les en les séparant par un point virgule.\
  Ex : "attribut\_workey\_1;attribut\_workey\_2;...": "external\_id\_metadata\_dossier"

### DirectoryMetadataUpdaterConnector

#### Description

Ce connecteur permet de modifier les métadonnées d'un dossier GED. Il utilise deux champs en entrée et aucun en sortie.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DirectoryMetadataUpdaterConnector
```

#### Paramètres d'entrée

* Champ Process contenant l'UUID GED du dossier à modifier
* Champ texte contenant la configuration JSON
  1. La propriété `mapping` établit la correspondance entre les champs présents dans le formulaire Process (appelés ici "attribut") et les métadonnées du dossier en GED identifiées par leur "id externe".
  2. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Contenu du champ de configuration json

Mise à jour de(s) dossier(s) GED en armoire, le gabarit de dossier utilisé est celui associé au dossier dans la GED (les références vers les métadonnées devront donc se faire par rapport au gabarit de dossier à traiter).

```json
{
    "mapping": {
        "attribut_workey_1": "external_id_metadata_dossier",
        "attribut_workey_2": "external_id_metadata_dossier"
    },
    "impersonate": false
}
```

Dans le mapping, seules les métadonnées à mettre à jour sont nécessaires (inutile de mettre l'intégralité de celles disponibles en GED).

#### Valeur de sortie

* Aucune

### DirectorySearchOrCreateConnector

#### Description

Ce connecteur permet de créer, s'il n'existe pas déjà, un dossier dans une armoire de la GED en utilisant son gabarit.\
Pour savoir s'il existe déjà, ce connecteur s'appuie sur les métadonnées renseignées en entrée et effectue une recherche côté GED.

* Si la recherche sur le gabarit retourne un dossier ayant les mêmes métadonnées que le dossier à créer, le connecteur retourne son UUID.
* Sinon il crée le dossier en renseignant les métadonnées fournies et retourne son UUID. Il utilise un champ en entrée et un champ en sortie.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DirectorySearchOrCreateConnector
```

#### Paramètre d'entrée

* Un champ texte contenant la configuration JSON
  1. La propriété `gabarit` correspond à l'id externe du gabarit GED à utiliser.
  2. La propriété `mapping` établit la correspondance entre les champs présents dans le formulaire Process (appelés ici "attribut") et les métadonnées du dossier GED en fonction du "gabarit" .
  3. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Valeur de sortie

* uuid du dossier existant ou créé

#### Contenu du champ de configuration json

```json
{
    "gabarit": "external_id_gabarit_dossier",
    "mapping": {
        "attribut_workey_1": "external_id_metadata_dossier",
        "attribut_workey_2": "external_id_metadata_dossier"
    },
    "impersonate": false
}
```

NB :

* "external\_id\_..." désigne un id externe du plan de classement côté GED (le plan de classement devra être synchroniser par un administrateur avant de pouvoir l'utiliser)
* "attribut\_workey..." est à remplacer par le nom interne d'un champ de formulaire workey.\
  Si vous voulez concaténer plusieurs champs workey dans une métadonnée **texte** de la GED, ajoutez les en les séparant par un point virgule.\
  Ex : "attribut\_workey\_1;attribut\_workey\_2;...": "external\_id\_metadata\_dossier"

### DocumentChildsCreateAndClassifyConnector

#### Description

Dans le cadre d'une généalogie de documents Process (un doc père entraînant la création de docs fils dans le workflow), ce connecteur vise à déposer en GED les documents contenus dans les docs fils. Il ne peut y avoir qu'un seul document par fils (donc un seul champ pièce-jointe monovalué concerné). Si le dossier GED n'existe pas, il sera créé au passage (voir DirectorySearchOrCreateConnector). Il est à modéliser sur une opération faite sur le doc père après resynchronisation avec les fils. Il est possible de filtrer le type de fils à prendre en compte ainsi que ses états souhaités. Il utilise trois champs du document père en configuration entrante et retourne la liste des UUIDs des documents créés en GED.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentChildsCreateAndClassifyConnector
```

#### Paramètres d'entrée

Trois champs dans le document père

* Nom interne du type de document enfant à traiter parmis ceux disponibles
* Liste des états du document enfant concernés par le traitement (champ multivalué)
* Configuration JSON qui permet de désigner le champ pièce-jointe du fils à prendre en compte, le mapping champ workey - métadonnée, et le dossier où déposer le fichier.
  1. `document` : champ pièce-jointe du document fils contenant le fichier à déposer en GED (un champ pour un fichier)
  2. `gabarit` : id externe du gabarit du document GED à utiliser
  3. `mapping` : les métadonnées du fichier à déposer en GED et qui sont alimentées par des champs du document fils
  4. `dossier` (optionnel) qui correspond au dossier GED dans lequel déposer le document avec au choix
     1. uuid : uuid du répertoire cible déjà présent en GED (peut être le designer name d'un champ workey contenant cette information)
     2. gabarit + mapping : pour rechercher le répertoire existant ou le créer (voir DirectorySearchOrCreateConnector)
  5. `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Valeur de sortie

* Liste des UUIDs des documents créés en GED
* Un champ contenant l'uuid de dossier GED utilisé (celui du dossier créé ou celui fourni en paramêtre).

#### Contenu du champ de configuration json

```json
{
    "document": "attribut_workey_1_doc_fils",
    "gabarit": "external_id_gabarit_document",
    "mapping": {
        "attribut_workey_2_doc_fils": "external_id_attribut_document",
        "attribut_workey_3_doc_fils": "external_id_attribut_document"
    },
    "dossier": {
        "uuid": "uuid_dossier",
        "gabarit": "external_id_gabarit_dossier",
        "mapping": {
            "attribut_workey_1_doc_pere": "external_id_attribut_dossier",
            "attribut_workey_2_doc_pere": "external_id_attribut_dossier"
        }
    },
    "impersonate": false
}
```

NB :

* "uuid\_..." désigne un uuid du plan de classement côté GED
* "external\_id\_..." désigne un id externe du plan de classement côté GED (le plan de classement devra être synchroniser par un administrateur avant de pouvoir l'utiliser)
* "attribut\_workey..." est à remplacer par le nom interne d'un champ de formulaire workey.\
  Si vous voulez concaténer plusieurs champs workey dans une métadonnée **texte** de la GED, ajoutez les en les séparant par un point virgule.\
  Ex : "attribut\_workey\_1;attribut\_workey\_2;...": "external\_id\_metadata\_document"

### DocumentClassifyConnector

#### Description

Ce connecteur permet de classer dans une armoire de la GED un document présent initialement dans une de ses bannettes en renseignant les métadonnées du document. Il utilise deux champs en entrée et aucun en sortie.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentClassifyConnector
```

#### Paramètres d'entrée

* Champ Process (potentiellement multivalué) contenant la liste des documents en GED (uuid) à migrer d'une bannette vers une armoire.
* Champ texte contenant la configuration JSON
  1. La propriété `gabarit` correspond à l'uuid du gabarit du document GED à utiliser.
  2. La propriété `document` (optionnelle) qui permet des mappings de métadonnées différentes en fonction des documents (voir ci-dessous)
  3. La propriété `mapping` établit la correspondance entre les champs présents dans le formulaire Process (appelés ici "attribut") et les métadonnées du fichier en GED.
  4. La propriété `dossier` (optionnelle) où déposer le(s) fichier(s) qui contient au choix (Si non renseigné, les fichiers seront déposés à la racine de l'armoire.)
     1. La propriété `uuid` contient l'uuid en GED du dossier à utiliser ou le designer name d'un champ workey contenant cette information.
     2. La propriété `gabarit` correspond à l'id externe du gabarit du dossier en GED
     3. La propriété `mapping` qui établit la correspondance entre les champs présents dans le formulaire Process (appelés ici "attribut") et les métadonnées du dossier GED en fonction du "gabarit" pour sa recherche ou sa création (voir DirectorySearchOrCreateConnector).
  5. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Contenu du champ de configuration json

Classement de document(s) GED en armoire (métadonnées communes à tous les docs)

```json
{
	"gabarit": "external_id_gabarit_document",
    "mapping": {
        "attribut_workey_1": "external_id_metadata_document",
        "attribut_workey_2": "external_id_metadata_document"
    },
    "impersonate": false
}
```

Classement de document(s) GED en armoire (métadonnées communes à tous les docs) dans un dossier existant et dont on a l'uuid

```json
{
	"gabarit": "external_id_gabarit_document",
    "mapping": {
        "attribut_workey_1": "external_id_metadata_document",
        "attribut_workey_2": "external_id_metadata_document"
    },
    "dossier": {
        "uuid": "uuid_dossier"
    },
    "impersonate": false
}
```

ou classement d'un document avec ses métadonnées dans un dossier existant ou à créer (on y accède par recherche sur gabarit de dossier + métadonnées)

```json
{
	"gabarit": "external_id_gabarit_document",
    "mapping": {
        "attribut_workey_1": "external_id_metadata_document",
        "attribut_workey_2": "external_id_metadata_document"
    },
    "dossier": {
        "gabarit": "external_id_gabarit_dossier",
        "mapping": {
            "attribut_workey_3": "external_id_metadata_dossier",
            "attribut_workey_4": "external_id_metadata_dossier"
        }
    },
    "impersonate": false
}
```

**Lorsque les métadonnées ne sont pas communes à tous les documents** : classement de plusieurs documents en armoire (on peut les mettre dans un dossier en suivant l'un des deux cas précédents).\
On utilise un tableau dynamique pour distinguer les métadonnées à lier individuellement à chaque document en GED.\
Chaque ligne contient une colonne (technique) d'uuid GED de document et une colonne pour chaque métadonnée.

* "document" permet de paramétrer le nom interne de la colonne (technique) du tableau dynamique contenant les uuids des documents en GED
* "mapping" : à minima toutes les métadonnées obligatoires de chaque document en GED
  * `attribut_workey_colonne_tabDyn` : à remplacer par le nom interne d'une colonne du tableau dynamique, la métadonnée sera alors la valeur de la cellule du tableau correspondant à un uuid de document (de la colonne "document")
  * `attribut_workey_quelconque` : à remplacer par le nom interne d'un composant quelconque du formulaire, la métadonnée sera alors commune à tous les documents classé en GED

```json
{
	"gabarit": "external_id_gabarit_document",
    "document": "attribut_workey_colonne_tabDyn",
    "mapping": {
        "attribut_workey_colonne_tabDyn": "external_id_metadata_document",
        "attribut_workey_quelconque": "external_id_metadata_document"
    },
    "impersonate": false
}
```

NB :

* "uuid\_..." désigne un uuid du plan de classement côté GED
* "external\_id\_..." désigne un id externe du plan de classement côté GED (le plan de classement devra être synchroniser par un administrateur avant de pouvoir l'utiliser)
* "attribut\_workey..." est à remplacer par le nom interne d'un champ de formulaire workey.\
  Si vous voulez concaténer plusieurs champs workey dans une métadonnée **texte** de la GED, ajoutez les en les séparant par un point virgule.\
  Ex : "attribut\_workey\_1;attribut\_workey\_2;...": "external\_id\_metadata\_document"

#### Valeur de sortie

* Un champ contenant l'uuid de dossier GED utilisé (celui du dossier créé ou celui fourni en paramêtre).

### DocumentCreateAndClassifyConnector

#### Description

Ce connecteur permet de déposer des documents dans la GED à partir de fichiers répertoriés par leurs UUIDs workey.\
Usuellement, ces UUIDs sont ceux contenus dans les composants pièce-jointe des formulaires.

Il utilise deux champs en entrée et un champ en sortie.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentCreateAndClassifyConnector
```

#### Paramètres d'entrée

* Champ Process (potentiellement multivalué et usuellement un champ pièce-jointe) contenant la liste des fichiers (uuid workey) à déposer en GED
* Champ texte contenant la configuration JSON
  1. La propriété `gabarit` correspond à l'id externe du gabarit du document GED à utiliser.
  2. La propriété `document` (optionnelle) qui permet des mappings de métadonnées différentes en fonction des documents (voir ci-dessous)
  3. La propriété `mapping` établit la correspondance entre les champs présents dans le formulaire Process (appelés ici "attribut") et les métadonnées du fichier en GED.
  4. La propriété `dossier` (optionnelle) où déposer le(s) fichier(s) qui contient au choix (Si non renseigné, les fichiers seront déposés à la racine de l'armoire.)
     1. La propriété `uuid` contient l'uuid en GED du dossier à utiliser ou le designer name d'un champ workey contenant cette information.
     2. La propriété `gabarit` correspond à l'id externe du gabarit du dossier en GED
     3. La propriété `mapping` qui établit la correspondance entre les champs présents dans le formulaire Process (appelés ici "attribut") et les métadonnées du dossier GED en fonction du "gabarit" pour sa recherche ou sa création (voir DirectorySearchOrCreateConnector).
  5. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Contenu du champ de configuration json

Dépôt de document(s) en armoire avec métadonnées (communes à tous les docs)

```json
{
	"gabarit": "external_id_gabarit_document",
    "mapping": {
        "attribut_workey_1": "external_id_metadata_document",
        "attribut_workey_2": "external_id_metadata_document"
    },
    "impersonate": false
}
```

Dépôt de document(s) avec métadonnées (communes à tous les docs) dans un dossier existant et dont on a l'uuid

```json
{
	"gabarit": "external_id_gabarit_document",
    "mapping": {
        "attribut_workey_1": "external_id_metadata_document",
        "attribut_workey_2": "external_id_metadata_document"
    },
    "dossier": {
        "uuid": "uuid_dossier"
    },
    "impersonate": false
}
```

ou dépôt d'un document avec ses métadonnées dans un dossier existant ou à créer (on y accède par recherche sur gabarit de dossier + métadonnées)

```json
{
	"gabarit": "external_id_gabarit_document",
    "mapping": {
        "attribut_workey_1": "external_id_metadata_document",
        "attribut_workey_2": "external_id_metadata_document"
    },
    "dossier": {
        "gabarit": "external_id_gabarit_dossier",
        "mapping": {
            "attribut_workey_3": "external_id_metadata_dossier",
            "attribut_workey_4": "external_id_metadata_dossier"
        }
    },
    "impersonate": false
}
```

**Lorsque les métadonnées ne sont pas communes à tous les documents** : dépôt de plusieurs documents en armoire (on peut les mettre dans un dossier en suivant l'un des deux cas précédents).\
On utilise un tableau dynamique pour distinguer les métadonnées à lier individuellement à chaque document en GED. Chaque ligne contient une colonne d'uuid Process de fichier (technique) et une colonne pour chaque métadonnée GED.

* "document" permet de paramétrer le nom interne de la colonne (technique) du tableau dynamique contenant les uuids des fichiers côté Process (la plupart du temps, ceux contenus dans le composant PJ du premier paramètre d'entrée)
* "mapping" : à minima toutes les métadonnées obligatoires de chaque document en GED
  * `attribut_workey_colonne_tabDyn` : à remplacer par le nom interne d'une colonne du tableau dynamique, la métadonnée sera alors la valeur de la cellule du tableau correspondant à un uuid de document (de la colonne "document")
  * `attribut_workey_quelconque` : à remplacer par le nom interne d'un composant quelconque du formulaire, la métadonnée sera alors commune à tous les documents déposés en GED

```json
{
	"gabarit": "external_id_gabarit_document",
    "document": "attribut_workey_colonne_tabDyn",
    "mapping": {
        "attribut_workey_colonne_tabDyn": "external_id_metadata_document",
        "attribut_workey_quelconque": "external_id_metadata_document"
    },
    "impersonate": false
}
```

NB :

* "uuid\_..." désigne un uuid du plan de classement côté GED
* "external\_id\_..." désigne un id externe du plan de classement côté GED (le plan de classement devra être synchroniser par un administrateur avant de pouvoir l'utiliser)
* "attribut\_workey..." est à remplacer par le nom interne d'un champ de formulaire workey.\
  Si vous voulez concaténer plusieurs champs workey dans une métadonnée **texte** de la GED, ajoutez les en les séparant par un point virgule.\
  Ex : "attribut\_workey\_1;attribut\_workey\_2;...": "external\_id\_metadata\_document"

#### Valeur de sortie

* Un champ contenant la liste des uuids de documents GED créés (même ordre que les pièces jointes spécifiées en entrée).
* Un champ contenant l'uuid de dossier GED utilisé (celui du dossier créé ou celui fourni en paramêtre).

### DocumentCreateAndInboxConnector

#### Description

Ce connecteur permet de déposer des fichiers Process dans une bannette de la GED. Il utilise trois champs en entrée et un champ en sortie.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentCreateAndInboxConnector
```

#### Paramètres d'entrée

* Champ Process contenant les UUID GED de la bannette dans laquelle déposer les fichiers.
* Champ workey contenant la liste des uuids des fichiers workey à envoyer en GED (habituellement un composant pièce-jointe qui les répertoires)
* Champ texte contenant la configuration JSON (optionnel)
  1. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Valeur de sortie

* Un champ contenant la liste des uuids de documents GED créés.

#### Contenu du champ de configuration json

```json
{
	"impersonate": false
}
```

### DocumentImportContentToAttachmentConnector

#### Description

Ce connecteur permet de télécharger un document déposé en GED à partir de son UUID pour en stocker une copie sur le file system Process sous forme de pièce-jointe dans le but de le modifier dans un workflow.

Il utilise trois champs en entrée et un champ en sortie.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentImportContentToAttachmentConnector
```

#### Paramètres d'entrée

* Champ Process (monovalué et usuellement un champ texte) contenant l'uuid du fichier GED à récupérer
* Champ texte monovalué contenant le nom de fichier souhaité avec son extension (optionnel)
* Champ texte contenant la configuration JSON (optionnel)
  1. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Valeur de sortie

* Un champ contenant l'uuid de la pièce jointe nouvellement créée (usuellement un champ pièce jointe).

#### Contenu du champ de configuration json

```json
{
	"impersonate": false
}
```

### DocumentLinkConnector

#### Description

Ce connecteur permet d'attacher à un processus une liste de documents en GED. Il utilise deux champs en entrée et aucun en sortie.

Il aura également besoin du paramétrage d'une apiKey et de son impersonification pour fonctionner.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentLinkConnector
```

#### Paramètres d'entrée

* Champ Process contenant les UUID GED des documents à attacher
* Champ texte contenant la configuration JSON (optionnel)
  1. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Valeur de sortie

* Aucune

#### Contenu du champ de configuration json

```json
{
	"impersonate": false
}
```

### DocumentLockConnector

#### Description

Ce connecteur permet de verrouiller une liste de documents en GED. Il utilise deux champs en entrée et aucun en sortie.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentLockConnector
```

#### Paramètres d'entrée

* Champ Process contenant les UUID GED des documents à verrouiller
* Champ texte contenant la configuration JSON
  1. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Valeur de sortie

* Aucune

### DocumentMetadataUpdaterConnector

#### Description

Ce connecteur permet de modifier les métadonnées d'un document GED. Il utilise deux champs en entrée et aucun en sortie.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentMetadataUpdaterConnector
```

#### Paramètres d'entrée

* Champ Process contenant l'UUID GED du fichier à modifier
* Champ texte contenant la configuration JSON
  1. La propriété `mapping` établit la correspondance entre les champs présents dans le formulaire Process (appelés ici "attribut") et les métadonnées du fichier en GED référencée par leur id externe.
  2. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Contenu du champ de configuration json

Mise à jour de(s) document(s) GED en armoire, le gabarit de document utilisé est celui associé au document dans la GED (les références vers les métadonnées devront donc se faire par rapport au gabarit de document à traiter).

```json
{
    "mapping": {
        "attribut_workey_1": "external_id_metadata_document",
        "attribut_workey_2": "external_id_metadata_document"
    },
    "impersonate": false
}
```

Dans le mapping, seules les métadonnées à mettre à jour sont nécessaires (inutile de mettre l'intégralité de celles disponibles en GED).

#### Valeur de sortie

* Aucune

### DocumentMoveConnector

#### Description

Ce connecteur permet de déplacer les documents trouvés de une bannette source de la GED vers une bannette de destination. Il utilise trois champs en entrée et aucun en sortie.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentMoveConnector
```

#### Paramètres d'entrée

* Champ Process contenant l'UUID GED de la bannette source à utiliser
* Champ Process contenant l'UUID GED de la bannette de destination à utiliser
* Champ texte contenant la configuration JSON (optionnel)
  1. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Valeur de sortie

* Aucune

#### Contenu du champ de configuration json

```json
{
    "impersonate": false
}
```

### DocumentReclassifyConnector

#### Description

Ce connecteur permet de reclasser un document vers un autre dossier de destination.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentReclassifyConnector
```

#### Paramètres d'entrée

* Champ Process contenant l'UUID GED du document à reclasser
* Champ Process contenant l'UUID GED du dossier de destination à utiliser
* Champ texte contenant la configuration JSON (optionnel)
  1. La propriété `gabarit` correspond à l'id externe du gabarit de document GED à utiliser.
  2. La propriété `mapping` établit la correspondance entre les champs présents dans le formulaire Process (appelés ici "attribut") et les métadonnées du dossier GED en fonction du "gabarit".
  3. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Valeur de sortie

* Champ UUI

#### Contenu du champ de configuration json

```json
{
    "impersonate": false
}
```

### DocumentUnlinkConnector

#### Description

Ce connecteur permet de détacher d'un processus une liste de documents en GED à partir d'un champ workey contenant la liste de leurs UUIDs en GED. Il utilise deux champs en entrée et aucun en sortie.

Il aura également besoin du paramétrage d'une apiKey et de son impersonification pour fonctionner.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentUnlinkConnector
```

#### Paramètres d'entrée

* Un champ contenant la liste des UUIDs MGX des documents à détacher
* Champ texte contenant la configuration JSON (optionnel)
  1. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Valeur de sortie

* Aucune

#### Contenu du champ de configuration json

```json
{
    "impersonate": false
}
```

### DocumentUnlockConnector

#### Description

Ce connecteur permet de déverrouiller une liste de documents en GED à partir d'un champ workey contenant la liste de leurs UUIDs en GED. Il utilise deux champs en entrée et aucun en sortie.

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentUnlockConnector
```

#### Paramètres d'entrée

* Un champ contenant la liste des UUIDs MGX des documents à déverrouiller
* Champ texte contenant la configuration JSON (optionnel)
  1. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

#### Valeur de sortie

* Aucune

#### Contenu du champ de configuration json

```json
{
    "impersonate": false
}
```

### DocumentUpdateBinaryConnector

#### Description

Ce connecteur permet de mettre à jour un ou plusieurs documents en GED. Il utilise trois champs (dont un optionnel) en entrée et aucun en sortie.

à partir d'un champ contenant la liste des uuids GED des documents à actualiser ainsi qu'un autre contenant la liste des UUIDs des fichiers workey à envoyer (habituellement, un champ pièce-jointe workey)

#### Classe du connecteur

```java
com.clog.workey.mgx.connectors.DocumentUpdateBinaryConnector
```

#### Paramètres d'entrée

* Champ contenant la liste des UUIDs GED des fichiers à remplacer
* Champ pièces-jointes Process (ou champ texte listant les uuid Processs) contenant les nouvelles versions des fichiers à déposer en GED
* Champ texte contenant la configuration JSON (optionnel)
  1. La propriété `mapping` (optionnelle) établit la correspondance entre les champs présents dans le formulaire Process (appelés ici "attribut") et les métadonnées du fichier en GED référencée par leur id externe.
  2. La propriété `impersonate`, \[[plus d'infos ici](#la-propriété-impersonate)]

Si le nombre d'éléments présents dans chacun des deux premiers champs n'est pas identique, le connecteur ne s'exécute pas. Dans le mapping, seules les métadonnées à mettre à jour sont nécessaires (inutile de mettre l'intégralité de celles disponibles en GED).

#### Contenu du champ de configuration json

Mise à jour fichier(s) GED en armoire, le gabarit de document utilisé est celui associé au fichier dans la GED (les références vers les métadonnées devront donc se faire par rapport au gabarit de document GED à traiter).

```json
{
    "mapping": {
        "attribut_workey_1": "external_id_metadata_document",
        "attribut_workey_2": "external_id_metadata_document"
    },
    "impersonate": false
}
```

#### Valeur de sortie

* Aucune

## Notes

### La propriété `impersonate`

Cette propriété est optionnelle, elle de type booléen (`true` ou `false`). Trois cas sont possibles, en fonction du paramétrage du type d'authentification :

1. si elle est absente: quelque soit le paramétrage général, le compte de service sera utilisé (par défaut la propriété "impersonate" est absente pour garder une rétro compatibilité des anciennes configurations).
2. si le type d'authentification est à `Compte de service` : cette propriété est à proscrire car au changement de type d'authentification les workflows existants changeront d'utilisateur réalisant les actions du côté de Doc ce qui risque d'engendrer des problèmes de droit.
3. si le type d'authentification est à `Clé d'API` : avec la valeur true, c'est l'utilisateur connecté qui réalisera l'action dans Doc, avec la valeur false c'est l'application Process qui fera l'action dans Doc.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://documentation.efalia.com/produit/efalia-process/integrations/mise-en-oeuvre/connecteurs-efalia-doc.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
