> 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/configuration-avancee.md).

# Configuration Avancée

## Éléments de Modélisation

Plusieurs éléments de modélisation sont disponibles pour mettre en oeuvre les intéractions avec Efalia Doc:

* le composant de formulaire Efalia Docs,
* une source Efalia Doc pour les domaines de valeurs,
* un ensemble de connecteurs d'opération.

### Composant de formulaire Efalia Docs

En cas d'instanciation de processus depuis Efalia Doc (i.e. "Appel par URL"), et s'il a été spécifié que le contenu (le "binaire") du document Efalia Doc doit être référencé dans un champ de type composant Efalia Docs (cf. étape optionnelle de définition d'un mappage de gabarit de document), alors il est impératif de s'assurer que ce composant soit effectivement bien présent dans le formulaire utilisé au moment de l'initialisation du flux.

Les fonctionnalités de ce composant sont multiples:

* la récupération des métadonnées/données système du document sélectionné (et de son éventuel dossier parent),
* la ventilation de ces données dans les champs du formulaire au regard des mappages définis.
* il peut référencer le contenu (le "binaire") du document Efalia Doc sélectionné, permettant alors:
  * de visualiser le document,
  * d'éditer le document,
  * de télécharger le document.

Son utilisation est requise dès lors qu'il est nécessaire de pouvoir instancier, depuis l'application Efalia Process, un processus s'appuyant sur un document d'Efalia Doc.

En cas d'instanciation de processus depuis Efalia Doc (i.e. "Appel par URL"), et s'il a été spécifié que le contenu (le "binaire") du document Efalia Doc doit être référencé dans un champ de type composant Efalia Docs (cf. étape optionnelle de définition d'un mappage de gabarit de document), alors il est impératif de s'assurer que ce composant soit effectivement bien présent dans le formulaire utilisé au moment de l'initialisation du flux.

**Le document d'Efalia Doc reste dans Efalia Doc. Il n'y a pas dédoublement ou recopie du binaire dans Efalia Process.**

#### Utilisation du composant dans la modélisation d'un formulaire

Ce composant dédié est disponible dans la palette de composant lors de la modélisation d'un formulaire.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-dd9a5951d1c4015119d48a63949fc455ec2b7e02%2Fprocess-quickstart-doc-process-designer_icone_composant_EfaliaDocs.png?alt=media" alt=""><figcaption></figcaption></figure>

Il est possible de restreindre le type des documents sélectionnables en précisant, dans les paramètres du composant, le ou les gabarits de documents souhaités.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-b5045d4d1b9aae16c393ab31c52e89fd6c179424%2Fprocess-quickstart-doc-process-designer_parametres_composant_EfaliaDoc.webp?alt=media" alt=""><figcaption></figcaption></figure>

Pour ajouter une restriction de gabarit de document, cliquer sur l'icône d'ajout pour faire apparaître une fenêtre de sélection affichant initialement les armoires du Plan de Classement.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-a07b9c7d7062f282c55330e0fa97bf7c5c87d82d%2Fprocess-quickstart-doc-process-designer_selecteur_de_gabarit_de_document.webp?alt=media" alt=""><figcaption></figcaption></figure>

* sélectionner l'armoire souhaitée; s'affiche alors le détail du Plan de Classement de cette armoire, avec ses gabarits de dossier, catégories et gabarits de document;
* sélectionner le gabarit de document souhaité;
* valider en cliquant sur `Ok`.

Pour retirer une restriction de gabarit de document, cliquer sur son icône de suppression.

**Cette restriction ne s'applique qu'à la fonctionnalité de&#x20;*****browsing*****&#x20;depuis le composant dans le formulaire.** Le champ pourrait potentiellement référencer un document Efalia Doc appartenant à un gabarit de document différent: par exemple dans le cas d'une instanciation du processus depuis Efalia Doc (i.e. "Appel par URL").

#### Usage dans l'application

En cas d'instanciation du processus depuis Efalia Doc (i.e. "Appel par URL"), si le composant à été désigné comme réceptacle du contenu (le "binaire") du document, alors le composant sera pré-rempli avec le document efalia Doc à l'ouverture initiale du formulaire dans Efalia Process.

Pour sélectionner un document Efalia Doc avec le composant:

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-f7b4f077a60d5490c215724c27985f5d6eeb83e2%2Fprocess-quickstart-doc-process-formulaire_vierge_composant_EfaliaDoc.webp?alt=media" alt=""><figcaption></figcaption></figure>

* cliquer sur le bouton `Sélectionner...` pour faire apparaître la fenêtre listant les documents Efalia Doc éligibles;

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-810b1d475d304a204235e6dd8edd02cf6090f308%2Fprocess-quickstart-doc-process-selection_document_EfaliaDoc_via_composant.webp?alt=media" alt=""><figcaption></figcaption></figure>

* sélectionner un gabarit de document pour lister les documents correspondants;
* sélectionner le document voulu;
* valider en cliquant sur `Ok`.

Une fois la sélection validée, le document Efalia Doc apparaît dans le composant. Il est alors possible de le visualiser, l'éditer, le télécharger ou bien d'enlever la référence vers son contenu.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-bc525a0d7be245644b7af62a70e5649929347e42%2Fprocess-quickstart-doc-process-actions_possible_sur_contenu_doc_EfaliaDoc_via_composant.webp?alt=media" alt=""><figcaption></figcaption></figure>

**Rappel**:

* à la validation de la sélection, il y a récupération des métadonnées/données système du document (et de son éventuel dossier parent) et ventilation de celles-ci dans les champs du formulaire, au regard des mappages définis;

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-edb70211714674dc2fe13c82c6470dfd14424924%2Fprocess-quickstart-doc-process-formulaire_peuple_apres_selection_depuis_composant_EfaliaDoc.webp?alt=media" alt=""><figcaption></figcaption></figure>

* tous les champs cibles des mappages doivent être présents dans le formulaire au moment de la validation de la sélection, afin que leur valorisation puisse se faire.

### Domaine de valeur spécifique (source Efalia Doc)

Afin de pouvoir exploiter les valorisations des métadonnées de type "Liste de Valeur" d'Efalia Doc, il est nécessaire d'utiliser l'un des composants de formulaire qui peut être adossé à un domaine de valeur. Au moment de choisir le domaine de valeur auquel est adossé le composant, il suffit de choisir (ou de définir) un domaine de valeur d'un nouveau type: source Efalia Doc.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-9e6ef91c0e7b11972de0507fc0ac7d48f9e6cdf3%2Fprocess-quickstart-doc-process-designer_specification_domaine_de_valeur.webp?alt=media" alt=""><figcaption></figcaption></figure>

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-79d91191bb134d894d161bce282291946bce8f87%2Fprocess-quickstart-doc-process-designer_definiton_domaine_valeur_source_EfaliaDoc.webp?alt=media" alt=""><figcaption></figcaption></figure>

Utilisation du sélecteur de liste:

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-a650011ee2606912168ba57173b36573ebb5df8d%2Fprocess-quickstart-doc-process-designer_selecteur_metadonnee_de_type_liste.webp?alt=media" alt=""><figcaption></figcaption></figure>

Après validation, le gabarit de document et la métadonnée de type Liste de valeur sont renseignés (via leur ID externe respectifs) dans les paramètres du domaine:

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-8658f50448f620c8cdf984ba9751660d94630dd8%2Fprocess-quickstart-doc-process-designer_definiton_domaine_valeur_source_EfaliaDoc_renseigne.webp?alt=media" alt=""><figcaption></figcaption></figure>

Le bouton `Réinitialiser` permet de remettre à vide cette sélection de métadonnée source.

La particularité de ce domaine de valeur réside dans le fait qu'il mappe les items de la métadonnée sous forme de couple valeur/libellé; où la valeur est l'ID externe de l'item, et son libellé est le nom de l'item.

La valorisation du champ du formulaire se fera donc avec l'ID externe de l'item. Ceci doit donc être pris en compte dans les expressions STalk ou dans les cas d'export de la valorisation du champ adossé à un tel domaine de valeur.

**Il est impératif que chaque item de la liste de valeur sélectionnée dispose d'un ID externe renseigné.**

### Connecteurs d'opération

Les interactions entre Efalia Doc et Efalia Process doivent être explicitées dans la modélisation du processus. Celles-ci se traduisent par la mise en place de connecteurs (PRE et/ou POST) sur les opérations.

Les spécifications des échanges de données, et de manière plus générale le paramétrage dynamique, passent par les champs en entrée et/ou en sortie de ces connecteurs.

Il appartient au modélisateur de s'assurer de l'adéquation des types de données entre les métadonnées Efalia Doc et les champs sources/cibles dans les formulaires de Efalia Process.

#### Principe d'utilisation des connecteurs Efalia Doc

Un ensemble de connecteurs de type Java est mis a disposition. Ceux-ci peuvent être rapidement listés en tapant `mgx` dans la zone de saisie du nom de la classe Java (puisqu'ils sont situés dans le package `com.clog.workey.mgx`).

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-ac4b20e09df8d1620e1b8fb4190089f4b6264d61%2Fprocess-quickstart-doc-process-designer_ajout_connecteur_operation_mgx.webp?alt=media" alt=""><figcaption></figcaption></figure>

Une fois le connecteur souhaité sélectionné, il est possible d'accéder à sa documentation en ligne en cliquant sur le lien.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-f51dec7d199ae52a81e3c587444903ca2defa644%2Fprocess-quickstart-doc-process-designer_detail_connecteur_mgx.webp?alt=media" alt=""><figcaption></figcaption></figure>

Cette documentation est également disponible [ici](https://documentation.efalia.com/produit/efalia-process/integrations/mise-en-oeuvre/connecteurs-efalia-doc.md#connecteurs-sortant-disponibles).

**Attention**:

Selon la configuration de l'intéraction entre Efalia Doc et Efalia Process (cf. compte de service ou API Key), le comportement fonctionnel de certains de ces connecteurs peut varier. Il est donc important d'en tenir compte:

* lors de la modélisation des processus,
* lors des mises-à-jour d'Efalia Doc et d'Efalia Process,
* lors des changement de configuration (compte de service / API Key) dès lors que des processus sont déjà en cours.

**Rappel**:

* Les champs sources et/ou cibles des connecteurs doivent être présents dans le formulaire au moment de la soumission (ou éventuellement du rafraîchissement) du document; c'est-è-dire au moment de l'exécution du connecteur.
* Le périmètre fonctionnel de chacun de ces connecteurs est dicté par le ou les endpoints de l'API d'Efalia Doc qu'ils interfacent.
* Se reporter à la documentation spécifique de chaque connecteur pour connaîtres ses conditions d'échec d'exécution.
* L'utilisation de connecteurs ayant une fonctionnalité d'impersonnification doit impérativement être faite en toute cohérence avec le contexte des opérations réalisées; notamment lorsque celles-ci sont réalisées par des Agents (agent de type rôle ou de dépassement de délais), ou s'il est nécessaire d'utiliser des contraites d'acteur.

#### Exemple de configuration d'un connecteur

Ci-après, nous prenons l'exemple de l'utilisation du connecteur `DocumentMetadataUpdaterConnector`, dont l'objet est de mettre à jour des métadonnées d'un document Efalia Doc. Celui-ci doit être spécifiquement placé au niveau l'opération qui devra être réalisée en vue de son exécution (sur l'opération `Modifier`); c'est-à-dire que le concepteur du flux indique à quel étape la mise-à-jour de ces métadonnées doit avoir lieu.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-3120c21284332ee2c0241281a7dcf8ffce8489ac%2Fprocess-quickstart-doc-process-designer_modelisation_POST_connecteur.webp?alt=media" alt=""><figcaption></figcaption></figure>

A noter qu'ici un formulaire spécique (`FormulaireModification`) a été précisé pour la réalisation de l'opération; ceci afin d'attirer l'attention sur les champs qui doivent être présents au moment de l'exécution du connecteur.

***

En s'appuyant sur la documentation du connecteur, on peut y voir que celui-ci requiert deux champs de formulaire en entrée:

* un premier champ qui contient l'UID du document Efalia Doc à mettre à jour,
* un second qui explicite quelles données du formulaire doivent être exportées et vers quelles métadonnées du document Efalia Doc; et si la mise-à-jour des métadonnées requiert ou non l'impersonnification.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-b83d3341ca48636184e6ffb7d557edb0d468d2dc%2Fprocess-quickstart-doc-process-documentation_connecteur_MetadataUpdaterConnector.webp?alt=media" alt=""><figcaption></figcaption></figure>

***

Il faut s'assurer que le formulaire `FormulaireModification` contienne bien les champs en entrée du connecteur, ainsi que les champs portant les données à exporter.

{% hint style="warning" %}
🚧 Capture manquante — Champs du formulaire `FormulaireModification` (opération Modifier) dans le Designer
{% endhint %}

***

Dans la déclaration du connecteur, il faut désigner les deux champs de formulaire qui seront passé en entrée.

<figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-d9543a3e5df7b09a4df45aea1896a1d029b8f2b0%2Fprocess-quickstart-doc-process-designer_configuration_champs_connecteur_MetadataUpdater.webp?alt=media" alt=""><figcaption></figcaption></figure>

***

Vu que le deuxième champ en paramètre doit contenir les directives de mise-à-jour, il est nécessaire d'éditer le contenu JSon du champ `Parametres_JSon_Connecteurs_Initialisation`.

{% hint style="warning" %}
🚧 Capture manquante — Paramétrage JSON du connecteur MetadataUpdater dans le Designer
{% endhint %}


---

# 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/configuration-avancee.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.
