> 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/connecteur-multigest.md).

# Connecteur Multigest

## Préambule <a href="#preambule" id="preambule"></a>

Le but de ce document est de détailler la configuration du connecteur Multigest contenu dans Workey. La configuration s'axe sur l'utilisation d'un fichier de configuration et permet de définir les données qui permettront le dialogue entre Workey et Multigest.

## Emplacement du fichier de configuration <a href="#location_file" id="location_file"></a>

Le fichier se nomme settings.json et se situe sur le serveur là où est installé Workey, c'est-à-dire dans le répertoire des données de Workey. Il est préférable que le répertoire soit le suivant *$WORKEY\_DATA/mg/settings*, *$WORKEY\_DATA* étant la plupart du temps Workey\_Data.

## Edition du fichier <a href="#edition_of_file" id="edition_of_file"></a>

Un fichier JSON est tout simplement un fichier texte. Il est accessible en ligne au sein de l'application. Pour y accéder vous devez être connecté en tant qu'administrateur (Workflow Manager) et vous rendre dans l'espace d'administration, rubrique *Paramétrage*, onglet *Paramètres du connecteur MG*.Pour l'éditer localement, vous pouvez aussi utiliser votre éditeur de texte préféré hormis les traitements de texte (Word, Libre Office etc). Il est doit être encodé au format UTF-8.Il est recommandé d'utiliser l'édition en ligne qui offre un correcteur syntaxique, un correcteur grammatical, un backup à chaque modification et le retour à une configuration antérieure.

## Prise en compte des modifications <a href="#save_modifications" id="save_modifications"></a>

Il vous suffit de remplacer l'ancien fichier settings.json par le nouveau. Il est fortement recommandé de garder l'ancien au cas où... L'édition en ligne exécute et gère ces recommandations.

## Structure du fichier <a href="#structure_of_file" id="structure_of_file"></a>

Le contenu du fichier contient du JSON, un language descriptif (cf. [Syntaxe du JSON](https://documentation.efalia.com/produit/efalia-process/developpeurs/syntaxes-json-jsonpath.md)). Il se décompose en 3 parties :

* Une partie sur les informations globales concernant Multigest (propriété *mg*)
* La seconde sur les informations globales concernant Workey (propriété *wky*)
* La troisième sur les différents documents Workey qui contiennent les informations de synchronisation des métadonnées / champs entre Workey et Multigest (propriété *documents*)

Exemple de fichier :

```json
{
    "mg": {
      "indexationPopup": {
        "popupUrl": "http://20.188.33.73/popupindexation/idxController.php",
        "serverUrl": "pocgec.francecentral.cloudapp.azure.com",
        "serverPort": 21,
        "username": "fooze",
        "password": "!shelby!",
        "remoteDir": "/"
      }
    },
    "wky": {
        "apiUrl": "http://localhost:8080/workey/api"
    },
    "documents": {
        "Gestion_du_courrier/Document_GEC": {
            "mg": {
                "armoire": "ARMOIRE_GEC",
                "bannetteIds": [
                    "4",
                    "2",
                    "3"
                ],
                "folderKeyName": "UUID",
                "defaultDossier": {
                    "dossier": "Courriers entrants",
                    "sousDossier": "",
                    "nomFichier": "Document"
                }
            },
            "wky": {
                "processType": "Gestion_du_courrier",
                "documentType": "Document_GEC",
                "role": "Importateur",
                "apiLogin": "droart",
                "apiPassword": "21",
                "creationState": "Cree",
                "fieldKey": "UUID"
            },
            "sync": {
                "fieldsMapping": [
                    {
                        "wkyField": "N__Chrono",
                        "mgField": "CHRONO",
                        "type": "string",
                        "length": 32
                    },
                    {
                        "wkyField": "Date_de_reception",
                        "mgField": "DATE_RECEPTION",
                        "type": "date",
                        "length": 0
                    },
                    {
                        "wkyField": "Expediteur",
                        "mgField": "EXPEDITEUR",
                        "type": "string",
                        "length": 128
                    },
                    {
                        "wkyField": "Objet",
                        "mgField": "OBJET",
                        "type": "string",
                        "length": 255
                    },
                    {
                        "wkyField": "Service",
                        "mgField": "SERVICE",
                        "type": "string",
                        "length": 64
                    },
                    {
                        "wkyField": "Priorite",
                        "mgField": "PRIORITY",
                        "type": "number",
                        "length": 0
                    },
                    {
                        "wkyField": "Annule",
                        "mgField": "CANCELED",
                        "type": "boolean",
                        "length": 0
                    },
                    {
                        "wkyField": "Horodatage",
                        "mgField": "HORODATAGE",
                        "type": "string",
                        "length": 19
                    }
                ],
                "attachmentsMapping": [
                    {
                        "wkyFieldSource": "creationDesAnnexes",
                        "wkyFieldTarget": "Documents_annexes"
                    }
                ],
                "MGFolderToMGDocuments": [
                    {
                        "wkyFieldSource": " Documents_entrants ",
                        "wkyFieldTarget": "Documents_MG_1"
                    }
                ]
            }
        }
    }
}
```

Nous pouvons nous apercevoir qu'il est formé d'un objet JSON contenant des membres.

### L'attribut *mg* - informations MG

Cette première partie se composant d'un objet JSON qui spécifie un attribut `indexationPopup` regroupant les informations nécessaires à la classification des documents. Ces informations, sous forme d'objet JSON, contiennent différentes propriétés.

#### L'attribut *popupUrl*

Cette propriété spécifie l'adresse à appeler pour afficher la popup de classification.

#### L'attribut *serverUrl*

Cette propriété spécifie l'adresse du serveur FTP.

#### L'attribut *serverPort*

Cette propriété spécifie le port du serveur FTP.

#### L'attribut *timeout*

Cette propriété spécifie le timeout du serveur FTP (optionnel et à 5000 pas défaut).

#### L'attribut *passiveMode*

Cette propriété spécifie le mode passif du serveur FTP (optionnel et `true` par défaut).

#### L'attribut *username*

Cette propriété spécifie l'utilisateur du serveur FTP.

#### L'attribut *password*

Cette propriété spécifie le mot de passe du serveur FTP.

#### L'attribut *remoteDir*

Cette propriété spécifie le répertoire distant à utiliser (par défaut `/`).

### L'attribut *wky* - informations Workey

#### L'attribut *apiUrl*

Cet attribut spécifie l'url de l'api REST Workey

### L'attribut *documents*

Il permet de spécifier différentes configurations par document Workey. C'est un objet composé d'attributs ayant pour nomenclature '*ProcessType/DocumentType*', il est donc composé du type de processus et du type de document. Ce couple identifie chaque document et ne doit pas être spécifié plus d'une fois.

Exemple de documents :

```json
{
    "mg": {

    },
    "wky": {


    },
    "documents": {
        "Gestion_du_courrier/Document_GEC": {


        },
        "Gestion_des_contrats/Contrat": {


        },
        "Gestion_des_tickets/Ticket": {


        }
    }
}
```

En regard de chaque document, un objet JSON va définir chaque configuration décomposée en trois parties : *mg*, *wky* et *sync* (cf. [Configuration d'un document](#configuration-dun-document)).

### Configuration d'un document

L'objet JSON qui compose la configuration d'un document se décompose en trois parties.L'attribut *mg - informations MG propres au document*Ce premier groupe de propriétés va définit les endroits où sont stockés les documents dans MG, ils sont en rapport avec le plan de classement utilisé.**L'attribut&#x20;*****armoire***&#x43;ette propriété désigne l'armoire de travail du document, c'est une armoire SAS. Les dossiers MG y seront créés.**L'attribut&#x20;*****folderKeyName***&#x43;ette propriété spécifie le nom de la métadonnée à utiliser comme clé pour accéder aux dossiers MG.**L'attribut&#x20;*****banetteIds***&#x43;ette propriété spécifie les identifiants des bannettes contenant les courriers numérisés. Elles sont scrutées par l'agent Workey ***com.clog.workey.mg.agents.CreateFolderFromInboxes*** qui créée un dossier Courrier en regard de chaque courrier numérisé.**L'attribut&#x20;*****defaultDossier***&#x43;e membre contient le dossier par défaut utilisé par l'agent ***com.clog.workey.mg.agents.CreateFolderFromInboxes***. Il définit un endroit dans le plan de classement. Il est composé d'un objet JSON constitué des propriétés suivantes :***dossier*** : cette propriété contient le nom du dossier dans le plan de classemen&#x74;***sousDossier*** : cette propriété contient le sous dossier à utiliser dans le dossie&#x72;***nomFichier*** : cette propriété contient le nom du fichier à utiliser dans le dossierL'attribut *wky* - informations Workey propres au documentCe deuxième groupe composé d'un objet JSON spécifie les informations de connexion à l'API Rest Workey et les informations sur les champs techniques contenus dans les documents. Ils permettent la création de documents via l'agent *com.clog.workey.mg.agents.CreateFolderFromInboxes*. Ils permettent aussi de retrouver les informations MG depuis les champs techniques, pour assurer le bon fonctionnement des connecteurs, des agents et des Javascript embarqués.**L'attribut&#x20;*****apiLogin***&#x43;et attribut contient le login du compte utilisé par l'agent *com.clog.workey.mg.agents.CreateFolderFromInboxes* pour créer le document Workey.**L'attribut&#x20;*****apiPassword***&#x43;ette propriété contient le mot de passe en rapport avec le login ci-dessus.**L'attribut&#x20;*****processType***

Il contient le nom interne du processus spécifié dans la configuration. C'est le même que celui qui compose l'identifiant de la configuration du document (cf. [L'attribut documents](#lattribut-documents)).

**L'attribut&#x20;*****documentType***

Il contient le nom interne du document spécifié dans la configuration. C'est le même que celui qui compose l'identifiant de la configuration du document (cf. [L'attribut documents](#lattribut-documents)).

**L'attribut&#x20;*****role***

Il contient le nom interne du rôle utilisé pour créer le document Workey concerné.

**Attention : l'utilisateur apiLogin décrit ci-dessus doit jouer ce rôle.**

**L'attribut&#x20;*****creationState***

Il contient le nom interne de l'état du document spécifié dans le modélisateur. Il sert à mettre les documents à l'état souhaité lors de la création.

**L'attribut&#x20;*****fieldKey***

Il spécifie le nom interne du champ technique qui contient la valeur de la clé à utiliser pour accéder aux dossiers MG (vois aussi la propriété [folderKeyName](#lattribut-folderkeyname)).

**Attention : ce champ doit être immuable. Il n'est jamais saisi par l'utilisateur mais généré par Workey.**

**L'attribut&#x20;*****fieldBannette***

Il spécifie le nom interne qui est donné au champ technique qui contient la bannette originelle.

\#### \*\*L'attribut \*sync\* - informations de synchronisation des données entre\*\* Workey et Multigest propres au document.Cette troisième partie d'information permet la synchronisation des champs Workey vers les données MG. La synchronisation est assurée par les trois connecteurs Workey :***com.clog.workey.mg.connectors.SyncFieldscom.clog.workey.mg.connectors.SyncAttachmentscom.clog.workey.mg.connectors.MGFolderToMGDocuments***&#x45;lle est composée d'un objet JSON contenant les propriétés *fieldsMapping, attachmentsMapping et MGFolderToMGDocuments correspondantes respectivement à l'utilisation des connecteurs cités ci-dessus*. La première concerne la synchronisation des champs des formulaires Workey vers les métadonnées du dossier MG, la seconde le transfert de pièces jointes Workey vers des dossiers MG du plan de classement et la troisième le passage d'un composant MG\_Folder vers un composant MG\_Documents.La propriété *fieldsMapping*C'est un tableau JSON contenant des mappings de champs. Chaque mapping est un objet JSON composé de propriétés.**L'attribut&#x20;*****wkyField***&#x49;l contient le nom interne du champ Workey à mettre en couple avec le champ MG qui va être synchronisé (voir aussi *mgField*).**L'attribut&#x20;*****mgField***&#x49;l contient le nom du champ MG à synchroniser mis en couple avec le champ Workey (voir aussi *wkyField*).**L'attribut&#x20;*****type***&#x49;l contient le type de données qui est synchronisée. Il peut prendre la valeur *string*, *number*, *boolean* ou *date*. Les deux devant être de même type.**L'attribut&#x20;*****length***&#x49;l spécifie la longueur du champ MG qui a été donnée à la métadonnée. Il évite des erreurs d'exécution (erreur de troncature lors des synchronisations).La propriété *attachmentsMapping*C'est un tableau JSON contenant des mappings de champs. Chaque mapping est un objet JSON composé de propriétés.**L'attribut&#x20;*****wkyFieldSource***&#x49;l contient le nom interne du champ Workey de type Pièce Jointe qui va être la source des *documents* à transférer vers le composant MG (endroit dans le PDC MG).**L'attribut&#x20;*****wkyFieldTarget***&#x49;l contient le nom interne du champ Workey de type composant MG qui va être le récepteur du transfert de documents.La propriété *MGFolderToMGDocuments*C'est un tableau JSON contenant des mappings de champs. Chaque mapping est un objet JSON composé de propriétés.**L'attribut&#x20;*****wkyFieldSource***&#x49;l contient le nom interne du champ Workey de type MG\_Folder qui va être la source des *documents* à transférer vers le composant MG\_Documents. Le composant source et cible doivent spécifier le même endroit dans le PDC.**L'attribut&#x20;*****wkyFieldTarget***&#x49;l contient le nom interne du champ Workey de type MG\_Documents qui va être le récepteur des documents sources.

## Paramétrage du connecteur <a href="#settings_of_conn" id="settings_of_conn"></a>

Les paramètres suivants se définissent dans le fichier de configuration *catalina.properties* situé dans le répertoire *conf* du serveur Tomcat. Pour qu'ils soient pris en compte, il faut que le serveur soit redémarré.com.clog.multigest.api.debug.mode**description** : ce paramètre active les logs sur le serveur MG**valeur(s) possible(s)** : true ou false**valeur par défaut** : falsecom.clog.multigest.api.uid.mode**description** : ce paramètre active le mode UID (les documents MG sont référencés par leur ID unique au sein de la base de donnée MG)**valeur(s) possible(s)** : true ou false**valeur par défaut** : true


---

# 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/connecteur-multigest.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.
