> 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.md).

# Efalia Doc

Mise en œuvre de l'intégration Efalia Doc – Efalia Process : configuration, synchronisation du Plan de Classement, mappages et lancement de workflow depuis Doc.

## Pré-requis

Ce document s'adresse à un public maîtrisant déjà les principes de modélisation de processus avec Efalia Process.

En outre, le paramétrage de la communication entre Efalia Doc et Efalia Process est supposé avoir été réalisé et être fonctionnel.

Les fonctionnalités, telle que décrites dans ce document, ne sont disponibles qu'à partir:

* de la version **6.33** d'Efalia **Process**,
* de la **canari 34** d'Efalia **Doc**.

***

**Dans Efalia Process**

Accéder au panneau d'administration.

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

S'assurer que les fonctionnalités Efalia Doc sont activées (dans l'`Administration > Paramètres Process`).

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

Puis naviguer dans l'`Administration > Efalia Docs > Paramètres`.

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

En cas de problème de la connexion avec Efalia Doc, le statut mentionnera l'éventuelle erreur rencontrée.

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

***

**Dans Efalia Doc**

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

## Préambule

Les instances de processus (i.e. les "documents" dans Efalia Process) ne "savent" pas ce que représentent les données qu'elles véhiculent.

C'est la raison pour laquelle il appartient à celui qui modélise d'expliciter les intéractions unitaires nécessaires avec Efalia Doc lors des actions réalisées depuis les documents d'Efalia Process.

## Principe du mappage Efalia Doc - Efalia Process

Cette étape **obligatoire** de définition des mappages permet de:

1. Définir les associations entre les gabarits de document (ou de dossier) d'Efalia Doc et les types de document des processus qui peuvent être instanciés. Ceci est un prérequis pour permettre le lancement (instanciation) d'un workflow depuis Efalia Doc (i.e. "Appel par URL").
2. (Optionnel) Spécifier le champ du formulaire réceptacle du contenu ("binaire") du document Doc lors d'un lancement de processus depuis Efalia Doc (i.e. "Appel par URL").
3. Définir les correspondances (mappage) entre les métadonnées / données système des gabarits de document (ou de dossier) et les champs des types de document des processus.

Ces mappages sont définis via le panneau d'administration d'Efalia Process.

### ID externe dans Efalia Doc

Dans un mappage, tout élément du Plan de Classement est référencé par son ID externe. Les IDs externes, de type chaîne de caractère, sont définis au niveau du Plan de Classement, directement dans Efalia Doc.

Toutefois ces "IDs" n'ont pas la qualité d'identifiant: ils ne revendiquent aucune garantie d'unicité.

Ils n'ont pour finalité que de permettre le découplage entre les UIDs des éléments du Plan de Classement (propres à chaque instance de serveur Efalia Doc) et les modélisations de processus d'Efalia Process qui les référenceront.

### Récupération du Plan de Classement d'Efalia Doc

Avant de commencer à définir un mappage, il est nécessaire de s'assurer que le Plan de Classement d'Efalia Doc soit connu d'Efalia Process et qu'il soit bien à jour (mise en cache implicite !). Pour cela, il faut naviguer dans l'`Administration > Efalia Docs > 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-d887a6b9c37c34c219414ade20b5a8ca52467a02%2Fprocess-quickstart-doc-process-synchro_pdc.webp?alt=media" alt=""><figcaption></figcaption></figure>

Cliquer sur le bouton `Synchroniser` pour le (re)synchroniser, puis vérifier que la date de la dernière synchronisation ait bien été actualisée.

***

{% hint style="warning" %}

* Seuls les éléments du Plan de Classement disposant d'ID externe pourront faire l'objet d'un mappage.

* Si l'ID externe d'un élément est modifié dans Efalia Doc alors qu'il est utilisé dans un mappage, il est nécessaire de refaire le mappage de cet élément !

* Les éléments des processus listés correspondent toujours à leur version active (celle déployée et instanciable).
  {% endhint %}

* Si le nom interne d'un élément est modifié dans Efalia Process alors qu'il est utilisé dans un mappage, il est nécessaire de refaire le mappage de cet élément.

* Les habilitations de l'identité utilisée sont ignorées lors des opérations d'administration et de modélisation (i.e. synchronisation du le Plan de Classement, définition des mappages ...) pour les besoins de visbilité exhautive des éléments. **Toutefois les habilitations sont bien prises en compte dans le Panorama** (i.e. pour le déroulement des workflows) et influent donc sur le périmètre des éléments visibles (i.e. lors des navigations dans le Plan de Classement).

* Le Plan de Classement est automatiquement resynchronisé quotidiennement (par défaut à 01:00 AM).

* La resynchronisation du Plan de Classement est **obligatoire** dès lors que les UIDs de ses éléments changent (exemple: nouvelle instance de serveur Efalia Doc). La synchronisation constitue une table de correspondance (mise en cache) entre les UIDs et les IDs externes. Cette indirection est requise par le fait que le dialogue entre Efalia Doc et Efalia Process s'appuie exclusivement sur les UIDs.

***

### Définition du mappage

Le mappage se défini au niveau de l'`Administration > Efalia Docs > Mappage`.

{% hint style="warning" %}
🚧 Capture manquante — Liste des mappages existants entre gabarits et processus
{% endhint %}

#### Ajout d'un mappage de gabarit

Cliquer sur l'icône d'ajout pour faire apparaître le panneau de définition de mappage de gabarit.

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

{% stepper %}
{% step %}
**Sélectionner un gabarit de dossier ou de document**

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

Il est possible de naviguer dans l'arborescence en cliquant sur les armoires, dossiers et catégories. Un clic sur ces éléments permet alternativement de développer ou de réduire le niveau d'arborescence.

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

Les armoires et les catégories ne peuvent pas faire l'objet d'une définition de mappage.

**Rappel: seuls les éléments du Plan de Classement ayant des IDs externes renseignés peuvent faire l'objet d'un mappage**. Dans le cas contraire, un message d'erreur indiquera que l'élément ne peut pas être sélectionné.

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

{% step %}
**Sélectioner un processus**

L'interface liste les processus actuellement déployés dans Efalia Process.

La sélection d'un de ces processus affiche la liste des types de documents pouvant faire l'objet d'une instanciation.
{% endstep %}

{% step %}
**Sélectionner un type de document**

La sélection d'un des types de document affiche la liste des rôles pouvant réaliser l'instanciation.
{% endstep %}

{% step %}
**Sélectionner un rôle**
{% endstep %}

{% step %}
**Valider la sélection**

Une fois les sélections réalisées, confirmer en cliquant sur `Ok`.

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

Si les contraintes de sélection sont respectées, le panneau d'ajout de mappage de gabarit se referme et le nouveau mappage défini apparaît alors dans la liste des mappages existants.

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

En dessous du nom du gabarit est rappelé son ID externe. En dessous du nom du processus est rappelé le triplet: type de processus / type de document / rôle (désignés par leur nom interne respectif).
{% endstep %}

{% step %}
**(Optionnel) Sélectionner le champ de contenu**

Sélectionner le champ qui référencera le contenu (le "binaire") du document en cas de lancement du workflow depuis Efalia Doc (i.e. "Appel par URL")

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

Ce paramétrage complémentaire n'est possible que pour un mappage de gabarit de document.

La liste déroulante propose les champs aptes à recevoir le contenu (composant **Efalia Docs**).
{% endstep %}
{% endstepper %}

#### Suppression d'un mappage d'un gabarit

* Sélectionner le mappage de gabarit à supprimer dans la liste.
* Cliquer sur l'icône de suppression.
* Confirmer la suppression.

#### Détail du mappage des métadonnées d'un gabarit

**Ajout et suppression d'un mappage de champ**

* Pour définir un nouveau mappage de champ:
  * sélectionner le mappage de gabarit concerné,
  * cliquer sur l'icône d'ajout pour faire apparaître le panneau de mappage de champ.
* Pour supprimer un ou plusieurs mappages de champ existant:
  * sélectionner le ou les mappages de champ en cochant les cases-à-cocher correspondantes,
  * cliquer sur l'icône de suppression,
  * confirmer la suppression.

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

**Définition d'un mappage de champ**

A l'ouverture, le panneau liste les metadonnées et données système du gabarit concerné. En regard sont listés les champs du type de document du processus concerné.

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

Les données système du gabarit sont signalées par une icône de roue crantée devant leur description (le nom de la propriété est précisée juste en dessous et entre parenthèses).

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

* Sélectionner le champ du gabarit à mapper. A cet instant, la liste des champs du processus est filtrée au regard du type de la donnée sous jacente (afin de prévenir d'éventuels problèmes de compatibilité).

  <figure><img src="https://3557286639-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FcnnXLnfB61CBUw4H9Fho%2Fuploads%2Fgit-blob-f5b0db329c1f95cf474f013dacf8499ffac1fd32%2Fprocess-quickstart-doc-process-ajout_mappage_champ_filtrage_par_type.webp?alt=media" alt=""><figcaption></figcaption></figure>
* Sélectionner le champ de processus qui recevra la valeur de la métadonnée ou de la donnée système d'Efalia Doc.
* Valider la définition en cliquant sur le bouton `Ok`.

***

**Utilisation de ces mappages lors de l'instanciation d'un processus**

Les mappages de gabarit définis permettent la ventilation des métadonnées/données système du document Efalia Doc (et de son éventuel dossier parent) dans les champs du formulaire d'Efalia Process.

La récupération et la ventilation de ces données ont lieu:

* à l'ouverture du formulaire lorsque l'instanciation du processus est réalisée depuis Efalia Doc (i.e. "Appel par URL). Note: le document Efalia Doc est implicitement connu puisque désigné dans l'appel.
* à la validation de la sélection d'un document (via le bouton Sélectionner du composant Efalia Docs) lorsque l'instanciation est réalisée depuis Efalia Process. En effet, dans ce cas le document Efalia Doc n'est pas encore connu et sa désignation doit nécessairement se faire à l'aide de ce composant (cf. éléments de modélisation).

***

#### Définition d'un mappage non lié à un gabarit de document

Il est possible de spécifier un mappage permettant l'instanciation d'un processus à partir de n'importe quel gabarit de document. Pour cela, lors de l'ajout d'un mappage de gabarit, il suffit d'activer le commutateur `N'importe quel document` (l'éventuelle sélection de gabarit sera ignorée à la validation).

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

Une fois la définition du mappage validée, celui-ci apparaîtra dans la liste des mappages avec une indication spécifique.

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

**Note**: pour ce type de mappage, il n'est pas possible de définir de mappage de métadonnée/donnée système.

***


---

# 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.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.
