Connecteur Multigest
Préambule
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
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
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
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
Le contenu du fichier contient du JSON, un language descriptif (cf. Syntaxe du JSON). 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 :
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 :
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 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 documentCe 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 armoireCette propriété désigne l'armoire de travail du document, c'est une armoire SAS. Les dossiers MG y seront créés.L'attribut folderKeyNameCette propriété spécifie le nom de la métadonnée à utiliser comme clé pour accéder aux dossiers MG.L'attribut banetteIdsCette 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 defaultDossierCe 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 classementsousDossier : cette propriété contient le sous dossier à utiliser dans le dossiernomFichier : 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 apiLoginCet attribut contient le login du compte utilisé par l'agent com.clog.workey.mg.agents.CreateFolderFromInboxes pour créer le document Workey.L'attribut apiPasswordCette propriété contient le mot de passe en rapport avec le login ci-dessus.L'attribut 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).
L'attribut 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).
L'attribut 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 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 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).
Attention : ce champ doit être immuable. Il n'est jamais saisi par l'utilisateur mais généré par Workey.
L'attribut 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.MGFolderToMGDocumentsElle 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é fieldsMappingC'est un tableau JSON contenant des mappings de champs. Chaque mapping est un objet JSON composé de propriétés.L'attribut wkyFieldIl contient le nom interne du champ Workey à mettre en couple avec le champ MG qui va être synchronisé (voir aussi mgField).L'attribut mgFieldIl contient le nom du champ MG à synchroniser mis en couple avec le champ Workey (voir aussi wkyField).L'attribut typeIl 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 lengthIl 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é attachmentsMappingC'est un tableau JSON contenant des mappings de champs. Chaque mapping est un objet JSON composé de propriétés.L'attribut wkyFieldSourceIl 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 wkyFieldTargetIl contient le nom interne du champ Workey de type composant MG qui va être le récepteur du transfert de documents.La propriété MGFolderToMGDocumentsC'est un tableau JSON contenant des mappings de champs. Chaque mapping est un objet JSON composé de propriétés.L'attribut wkyFieldSourceIl 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 wkyFieldTargetIl contient le nom interne du champ Workey de type MG_Documents qui va être le récepteur des documents sources.
Paramétrage du connecteur
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.modedescription : ce paramètre active les logs sur le serveur MGvaleur(s) possible(s) : true ou falsevaleur par défaut : falsecom.clog.multigest.api.uid.modedescription : 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 falsevaleur par défaut : true
Mis à jour