> 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/documentations/efalia-process/vue-ensemble/mise-en-oeuvre.md).
# Efalia Doc
Ce guide s'adresse aux administrateurs fonctionnels maîtrisant déjà la modélisation de processus dans Efalia Process et souhaitant mettre en place l'intégration avec Efalia Doc (GED).
{% hint style="info" %}
💡 **Compatibilité des versions**
Les fonctionnalités décrites dans cette section nécessitent :
* **Efalia Process** version **6.33** ou supérieure
* **Efalia Doc** version **canari 34** ou supérieure
Pour les versions antérieures, consultez [Connecteurs Multigest 9 (hérités)](/documentations/efalia-process/vue-ensemble/mise-en-oeuvre/connecteur-multigest.md).
{% endhint %}
***
## Vue d'Ensemble
L'intégration Efalia Doc — Efalia Process permet de :
* **Lancer un workflow** depuis un document archivé dans Efalia Doc (appel par URL)
* **Classer des documents** dans la GED depuis un formulaire Process
* **Synchroniser des métadonnées** entre un document Process et un dossier GED
* **Télécharger des documents** de la GED dans les formulaires Process
* **Lier des documents GED** à des instances de workflow
***
## Prérequis
Avant de configurer l'intégration, assurez-vous que :
{% hint style="warning" %}
**Checklist :**
☐ Efalia Process v6.33+ et Efalia Doc canari 34+ sont déployés et accessibles\
☐ Un compte de service Efalia Doc avec les droits nécessaires (lecture/écriture sur les armoires concernées) est créé\
☐ Les éléments du Plan de Classement à utiliser ont des **IDs externes** définis dans Efalia Doc\
☐ La connectivité réseau entre les deux serveurs est établie
{% endhint %}
***
## Phase 1 : Configuration de la Connexion
{% stepper %}
{% step %}
#### Activer les fonctionnalités Efalia Doc dans Process
Dans la **console d'administration** d'Efalia Process (`/workey/admin`), naviguez vers **Paramètres Process** et activez les fonctionnalités Efalia Doc.
📸 **CAPTURE : integration-doc-01-activation-admin.png**
> Console d'administration avec le bouton d'activation des fonctionnalités Efalia Doc
> {% endstep %}
{% step %}
#### Configurer les paramètres de l'API Efalia Doc
Dans l'administration, naviguez vers **Efalia Docs > Paramètres**.
Renseignez :
1. **Adresse du serveur** avec le port de l'API (ex : `https://docs.efalia.demo:1202`)
2. **Type d'authentification** : `Compte de service` ou `Clé d'API`
3. Selon le type :
* **Compte de service** : login et mot de passe du compte de service
* **Clé d'API** : valeur de la clé API
📸 **CAPTURE : integration-doc-02-parametres-api.png**
> Panneau de paramétrage de l'API Efalia Doc avec les champs de connexion
{% hint style="info" %}
💡 **Compte de service vs Clé d'API**
* **Compte de service** : toutes les actions effectuées sur Doc sont attribuées à ce compte. Il doit avoir les habilitations nécessaires dans Doc.
* **Clé d'API** : les actions peuvent être exécutées par l'utilisateur connecté (mode `impersonate: true`) ou par l'application Process (mode `impersonate: false`).
{% endhint %}
En cas d'erreur de connexion, le statut affiche le détail de l'erreur rencontrée.
{% endstep %}
{% step %}
#### Configurer la connexion dans Process (côté serveur)
Pour l'**agent d'import** Efalia Doc, ajoutez les paramètres suivants dans `catalina.properties` :
```properties
# URL API Process (utilisée par l'agent pour rappeler Process)
workey.api.url=http://workey/api
# Identifiants de l'utilisateur utilisé par l'agent
workey.api.login=workey_service
workey.api.password=votre_mot_de_passe
# Bannette source des documents à traiter
mgx.bannette.in=Bannette In
# Bannette de destination après traitement
mgx.bannette.out=Bannette Out
# Paramètres du processus à lancer
document.process=Nom_Interne_Processus
document.doctype=Nom_Interne_Document
document.state=Etat_Initial
document.role=Role_Acteur
# Champs Process pour stocker les données Doc
field.uuid=Champ_UUID_GED
field.attachment=Champ_PJ
```
{% endstep %}
{% endstepper %}
***
## Phase 2 : Synchronisation du Plan de Classement
Le **Plan de Classement** (PDC) d'Efalia Doc doit être synchronisé dans Efalia Process avant tout mappage.
{% stepper %}
{% step %}
#### Accéder à la synchronisation
Dans l'administration, naviguez vers **Efalia Docs > Plan de classement**.
📸 **CAPTURE : integration-doc-03-pdc.png**
> Panneau de synchronisation du Plan de Classement avec le bouton Synchroniser
> {% endstep %}
{% step %}
#### Synchroniser le PDC
Cliquez sur **Synchroniser** et vérifiez que la date de dernière synchronisation est actualisée.
{% hint style="warning" %}
**Points d'attention :**
* Seuls les éléments du PDC ayant des **IDs externes** définis dans Efalia Doc peuvent être mappés
* Si l'ID externe d'un élément est modifié dans Doc, le mappage correspondant doit être refait
* Le PDC est **resynchronisé automatiquement chaque nuit** (par défaut à 01:00)
* Une resynchronisation **manuelle est obligatoire** si les UIDs des éléments changent (ex : nouvelle instance de serveur Doc)
{% endhint %}
{% endstep %}
{% endstepper %}
***
## Phase 3 : Définition des Mappages
Les mappages définissent les correspondances entre les éléments Efalia Doc (gabarits, métadonnées) et les types de documents Process (formulaires, champs).
{% stepper %}
{% step %}
#### Accéder aux mappages
Dans l'administration, naviguez vers **Efalia Docs > Mappage**.
📸 **CAPTURE : integration-doc-04-liste-mappages.png**
> Liste des mappages existants entre gabarits Doc et processus Process
> {% endstep %}
{% step %}
#### Ajouter un mappage de gabarit
Cliquez sur l'icône d'ajout. Le panneau de définition de mappage s'ouvre.
**Sélectionner le gabarit Efalia Doc :**
* Naviguez dans l'arborescence du PDC
* Sélectionnez le gabarit de dossier ou de document à mapper
{% hint style="danger" %}
⚠️ Seuls les éléments avec un **ID externe** renseigné peuvent être sélectionnés. Si un gabarit n'est pas sélectionnable, vérifiez que son ID externe est défini dans Efalia Doc.
{% endhint %}
📸 **CAPTURE : integration-doc-05-ajout-mappage.png**
> Panneau d'ajout de mappage avec la navigation dans l'arborescence du PDC
> {% endstep %}
{% step %}
#### Configurer le mappage
**Sélectionner le type de document Process :**
* Choisissez le processus et le type de document associé
**Définir le champ réceptacle du binaire (optionnel) :**
* Si le lancement de workflow depuis Doc doit transmettre le fichier, sélectionnez le champ pièce jointe cible
**Mapper les métadonnées :**
* Pour chaque métadonnée Efalia Doc, sélectionnez le champ Process correspondant
📸 **CAPTURE : integration-doc-06-mapping-metadonnees.png**
> Interface de mappage avec la correspondance métadonnées Doc ↔ champs Process
> {% endstep %}
{% step %}
#### Valider et tester
Sauvegardez le mappage et testez le lancement d'un workflow depuis Efalia Doc pour vérifier que les données sont bien transmises.
{% endstep %}
{% endstepper %}
***
## Lancement de Workflow depuis Efalia Doc
Une fois le mappage configuré, les utilisateurs peuvent lancer un workflow Efalia Process directement depuis un document Efalia Doc (fonctionnalité "Appel par URL").
**Principe :**
1. L'utilisateur ouvre un document dans Efalia Doc
2. Il clique sur l'action "Lancer un workflow" (si disponible selon les habilitations)
3. Efalia Doc appelle Efalia Process via l'API avec les données du document
4. Un nouveau document est créé dans Process avec les métadonnées mappées
5. Le fichier du document Doc est inséré dans le champ pièce jointe configuré
***
## Bonnes Pratiques
{% hint style="success" %}
**✅ À faire :**
* Définir des IDs externes **stables et explicites** dans Efalia Doc avant de configurer les mappages
* Synchroniser le PDC manuellement après toute modification structurelle dans Efalia Doc
* Utiliser la **Clé d'API** avec `impersonate: true` pour tracer les actions dans Doc avec l'identité de l'utilisateur
* Documenter les mappages dans un registre interne (gabarit Doc ↔ processus Process)
* Tester les intégrations sur un environnement de recette avant la production
{% endhint %}
{% hint style="danger" %}
**❌ À éviter :**
* Modifier l'ID externe d'un élément PDC en production sans refaire le mappage correspondant
* Utiliser un compte nominatif comme compte de service
* Créer des mappages sur des éléments sans ID externe
{% endhint %}
***
## Questions Fréquentes
Que se passe-t-il si le Plan de Classement n'est pas synchronisé ?
Les connecteurs et le lancement de workflow depuis Doc ne pourront pas fonctionner. Les UUIDs des éléments PDC ne seront pas connus de Process, et les opérations de classement ou de création de dossier échoueront avec une erreur de référence inconnue.
Peut-on avoir plusieurs mappages pour un même gabarit Efalia Doc ?
Oui, un même gabarit peut être mappé à plusieurs types de documents de différents processus. Cela permet de lancer des workflows différents selon le contexte.
Les habilitations Efalia Doc sont-elles respectées dans les connecteurs ?
Oui. En mode **Clé d'API avec `impersonate: true`**, les actions sont exécutées avec les droits de l'utilisateur connecté dans Process. En mode **Compte de service** ou **`impersonate: false`**, les habilitations du compte de service s'appliquent. Les habilitations Doc sont donc bien prises en compte dans le déroulement des workflows.
Comment déboguer un problème de connexion avec Efalia Doc ?
1. Vérifiez le statut dans **Administration > Efalia Docs > Paramètres** — le panneau affiche l'erreur précise
2. Activez les **journaux de débogage** dans ce même panneau
3. Vérifiez que l'URL de l'API Doc est accessible depuis le serveur Process (`curl https://docs.efalia.demo:1202/api`)
4. Vérifiez que le compte de service ou la clé d'API est valide
***
Pour aller plus loin :
* [Connecteurs Efalia Doc](/documentations/efalia-process/vue-ensemble/mise-en-oeuvre/connecteurs-efalia-doc.md)
* [Configuration Avancée](/documentations/efalia-process/vue-ensemble/mise-en-oeuvre/configuration-avancee.md)
* [Dépannage](/documentations/efalia-process/vue-ensemble/mise-en-oeuvre/troubleshooting.md)
---
# 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 dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://documentation.efalia.com/documentations/efalia-process/vue-ensemble/mise-en-oeuvre.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
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.