> 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/administration/administration-fonctionnelle/parametrage-front-office.md). # Paramétrage du Front Office Le **Front Office** est l'interface principale qu'utilisent vos collaborateurs au quotidien dans Efalia Process. Son paramétrage permet de définir la structure, l'agencement et la représentation de l'application : organisation en applications verticales, pages, onglets, tableaux de bord et vues. La configuration s'effectue via un fichier JSON (`settings.json`) et des paramètres serveur (`catalina.properties` ou l'administration simplifiée). *** ## Architecture du Front Office Le Front Office d'Efalia Process se décompose en deux espaces complémentaires : {% tabs %} {% tab title="Panorama (espace générique)" %} Le **Panorama** est l'espace transverse par défaut d'Efalia Process. Il offre une vue d'ensemble de tous les processus accessibles à l'utilisateur, indépendamment de leur domaine métier. **Contenu typique :** * Bannettes "À faire" consolidées * Vue d'ensemble des dossiers en cours * Indicateurs de suivi globaux C'est l'espace recommandé pour les utilisateurs qui travaillent sur plusieurs processus différents. {% endtab %} {% tab title="Applications Verticales" %} Les **applications verticales** sont des espaces dédiés à un domaine métier spécifique (ex : Gestion des Contrats, Gestion des Tickets, RH…). Chaque application verticale dispose de : * Son propre menu de navigation * Ses pages et onglets dédiés * Ses tableaux de bord métier personnalisés * Son icône et sa route URL unique Un utilisateur peut avoir accès à plusieurs applications verticales selon ses habilitations. {% endtab %} {% endtabs %} {% hint style="info" %} 💡 Le **Panorama** n'est rien d'autre qu'une application verticale prédéfinie. Les deux espaces peuvent être utilisés simultanément. {% endhint %} **Décomposition d'un écran Efalia Process :** ``` Application └─ Pages (colonne gauche) └─ Onglets (barre horizontale) └─ Vues (listes de documents) └─ Graphiques (pie chart, line chart) ``` 📸 **CAPTURE : admin-fonct-front-office-01-decomposition-ecran.png** > Interface du Front Office avec les zones annotées : applications dans la barre de navigation, pages dans la colonne gauche, onglets en haut et vues dans la zone principale *** ## Le Fichier settings.json ### Emplacement Le fichier de configuration se nomme **`settings.json`** et est situé sur le serveur dans le répertoire des données d'Efalia Process : ``` $WORKEY_DATA/settings/settings.json ``` *`$WORKEY_DATA` correspond généralement au répertoire `Workey_Data`.* ### Édition du fichier {% tabs %} {% tab title="Éditeur en ligne (recommandé)" %} L'éditeur en ligne est accessible depuis l'interface d'administration d'Efalia Process : {% stepper %} {% step %} #### Accéder à l'administration Connectez-vous en tant qu'administrateur (Workflow Manager). {% endstep %} {% step %} #### Ouvrir l'éditeur Rendez-vous dans **Administration > Panorama et Verticaux**. 📸 **CAPTURE : admin-fonct-front-office-02-editeur-ligne.png** > Interface d'administration avec la section "Panorama et Verticaux" et l'éditeur JSON intégré > {% endstep %} {% step %} #### Modifier et sauvegarder L'éditeur intégré propose : * **Correcteur syntaxique** : détecte les erreurs JSON en temps réel * **Correcteur grammatical** : vérifie la structure du fichier * **Sauvegarde automatique** : backup à chaque modification * **Historique** : retour à une configuration antérieure Cliquez sur **Enregistrer** pour appliquer les modifications. **Résultat :** Les changements sont pris en compte immédiatement, sans redémarrage. {% endstep %} {% endstepper %} {% hint style="success" %} ✅ **Méthode recommandée.** L'éditeur en ligne gère automatiquement les sauvegardes et la validation. {% endhint %} {% endtab %} {% tab title="Édition locale" %} Pour une édition locale du fichier : 1. Utilisez un **éditeur de texte** (VS Code, Notepad++, etc.) — pas de traitement de texte (Word, LibreOffice) 2. Encodez le fichier en **UTF-8** 3. Remplacez l'ancien fichier `settings.json` par le nouveau 4. Conservez une sauvegarde de l'ancien fichier avant remplacement {% hint style="warning" %} ⚠️ Une erreur de syntaxe JSON dans le fichier peut rendre l'interface inaccessible. Validez toujours votre JSON avant de remplacer le fichier (ex : avec [jsonlint.com](https://jsonlint.com)). {% endhint %} {% endtab %} {% endtabs %} *** ## Structure du fichier settings.json Le fichier `settings.json` est un objet JSON contenant **4 propriétés principales** : ```json { "verticalApps": [ ... ], "panoramaApp": { ... }, "extraPermissions": { ... }, "uiOptions": { ... } } ``` | Propriété | Type | Description | | ------------------ | ------- | ------------------------------------------------------ | | `verticalApps` | Tableau | Définition des applications verticales métier | | `panoramaApp` | Objet | Configuration de l'espace Panorama | | `extraPermissions` | Objet | Permissions exceptionnelles pour certains utilisateurs | | `uiOptions` | Objet | Options de l'interface utilisateur | *** ## Définir une Application Verticale Chaque application dans `verticalApps` est un objet JSON avec les propriétés suivantes : ### Propriétés de base ```json { "id": "CONTRACT", "route": "contract", "label": "Gestion des Contrats", "spriteCssClass": "wky-g-contract", "enable": true, "availableDocuments": [], "descendingDocuments": [], "pages": [] } ``` | Propriété | Obligatoire | Description | | --------------------- | ----------- | --------------------------------------------------------------------- | | `id` | ✅ | Identifiant unique de l'application (majuscules recommandées) | | `route` | ✅ | Fragment d'URL d'accès (ex : `contract` → `/workey/store/#/contract`) | | `label` | ✅ | Nom affiché dans l'interface (chaîne ou objet multilingue) | | `spriteCssClass` | ✅ | Icône de l'application dans le menu de navigation | | `enable` | ❌ | Activer/désactiver l'application (`true` par défaut) | | `availableDocuments` | ❌ | Documents créables dans cette application | | `descendingDocuments` | ❌ | Documents fils (dérivés) créables | | `pages` | ❌ | Pages composant l'application | | `todoToUse` | ❌ | Vue "À faire" personnalisée (remplace la vue par défaut) | ### Label multilingue Pour une application multilingue, utilisez un objet JSON à la place d'une chaîne : ```json "label": { "fr": "Gestion des contrats", "en": "Contracts management", "de": "Vertragsverwaltung" } ``` {% hint style="info" %} 💡 Efalia Process supporte le français (`fr`), l'anglais (`en`) et l'allemand (`de`). {% endhint %} ### Icônes disponibles Les icônes utilisent la **font d'icônes Workey**. La liste complète est consultable à l'adresse : ``` http://[serveur]:8080/workey/css/fonts/workey-glyphicons.html ``` Format des classes CSS : `wky-g-[nom]` Exemples : `wky-g-contract`, `wky-g-ticket`, `wky-g-mail`, `wky-g-pencil` ### Documents créables (`availableDocuments`) Définit quels types de documents peuvent être créés dans cette application. Chaque entrée référence un processus/document/rôle du modélisateur : ```json "availableDocuments": [ { "names": "Gestion_des_contrats/Contrat/Gestionnaire_de_contrat" }, { "names": "Gestion_des_contrats/Avenant/Controleur" } ] ``` Format : `Process_Type_Name/Document_Type_Name/Role_Name` * **`Process_Type_Name`** : nom interne du processus dans le Designer * **`Document_Type_Name`** : nom interne du document * **`Role_Name`** : nom interne du rôle créateur {% hint style="info" %} 💡 Si l'utilisateur peut créer au moins un document, l'icône de création apparaît dans la barre de navigation de l'application. {% endhint %} ### Documents fils (`descendingDocuments`) Documents issus de dérivations, créables dans l'application. Format identique à `availableDocuments` mais sans le `Role_Name` : ```json "descendingDocuments": [ { "names": "Gestion_des_contrats/Facture" } ] ``` *** ## Définir les Pages et Onglets ### Structure d'une Page ```json { "id": "PAGE_CONTRACTS", "label": "Mes contrats", "spriteCssClass": "wky-g-contract", "tabs": [ ... ] } ``` Les pages apparaissent dans la **colonne gauche** de l'application. Leur ordre dans le fichier définit leur ordre d'affichage. ### Structure d'un Onglet Les onglets s'affichent en **haut de chaque page**. Chaque onglet contient une ou plusieurs vues. **3 types d'onglets sont disponibles :** {% tabs %} {% tab title="Vue de données" %} Liste de documents dans l'onglet. C'est le type le plus courant. ```json { "id": "TAB_IN_PROGRESS", "label": "En cours", "type": "DATA_VIEW", "viewName": "contrats_en_cours" } ``` `viewName` : nom interne de la vue définie dans le Designer. {% endtab %} {% tab title="Graphique camembert (PIE\_CHART)" %} Affiche une répartition en secteurs. ```json { "id": "TAB_STATS", "label": "Statistiques", "type": "PIE_CHART", "dataSource": "stats_contrats_type" } ``` {% endtab %} {% tab title="Graphique linéaire (LINE\_CHART)" %} Affiche une courbe d'évolution dans le temps. ```json { "id": "TAB_EVOLUTION", "label": "Évolution", "type": "LINE_CHART", "dataSource": "evolution_mensuelle" } ``` {% endtab %} {% endtabs %} *** ## Options de l'Interface (`uiOptions`) La propriété `uiOptions` contrôle le comportement général de l'interface : ```json "uiOptions": { "toDoCounterIcon": false, "readingPaneOfDocuments": true, "delegationAndSubstitution": false } ``` | Option | Type | Défaut | Description | | --------------------------- | ------- | ------- | --------------------------------------------- | | `toDoCounterIcon` | Boolean | `false` | Afficher un compteur sur l'icône "À faire" | | `readingPaneOfDocuments` | Boolean | `false` | Activer le volet de lecture des documents | | `delegationAndSubstitution` | Boolean | `false` | Afficher les options de délégation/suppléance | *** ## Permissions Exceptionnelles (`extraPermissions`) Permet d'accorder des droits spécifiques à certains utilisateurs (identifiés par leur login) : ```json "extraPermissions": { "listsManagement": [ "jrobert", "dmorgane" ] } ``` | Permission | Description | | ----------------- | --------------------------------------------------------------- | | `listsManagement` | Droit de gérer les listes (domaines de valeur) dans l'interface | *** ## Paramètres Back Office (catalina.properties) Les paramètres back office se configurent dans **deux emplacements** : 1. **`catalina.properties`** (fichier de configuration Tomcat) — nécessite un redémarrage serveur 2. **Administration simplifiée** (interface `/workey/admin` rubrique Paramètres) — prise en compte à chaud {% hint style="info" %} 💡 Les paramètres modifiables à chaud depuis l'administration simplifiée sont marqués d'un indicateur spécial dans la documentation source. {% endhint %} ### Paramètres essentiels | Paramètre | Valeurs | Défaut | Description | | ------------------------------------------ | --------------------- | ------- | ----------------------------------------------------------- | | `com.clog.workey.app.running.mode` | `SAAS` / `ON_PREMISE` | `SAAS` | Mode de fonctionnement du Front Office | | `com.clog.workey.app.enable` | `true` / `false` | `true` | Activer le Front Office | | `com.clog.workey.app.panorama.enable` | `true` / `false` | `false` | Activer l'espace Panorama | | `com.clog.workey.app.vertical.apps.enable` | `true` / `false` | `false` | Activer les applications verticales | | `com.clog.workey.app.custom.app.name` | Texte | — | Nom personnalisé de l'application (masque "Efalia Process") | ### Langue et internationalisation | Paramètre | Défaut | Description | | ------------------------------------- | ---------- | ----------------------------------------- | | `com.clog.workey.default.language` | `fr` | Langue par défaut | | `com.clog.workey.supported.languages` | `fr,en,de` | Langues supportées (séparées par virgule) | ### Gestion des utilisateurs | Paramètre | Défaut | Description | | ---------------------------------------------- | ------- | -------------------------------------------------------------- | | `com.clog.workey.app.manage.users.enable` | `true` | Activer la gestion des utilisateurs en administration | | `com.clog.workey.app.manage.users.crud.enable` | `false` | Permettre la création/modification/suppression de comptes LDAP | {% hint style="warning" %} ⚠️ La gestion des utilisateurs CRUD (`manage.users.crud.enable`) n'est utilisable qu'avec un LDAP de type **OpenLDAP**. Elle n'est pas compatible avec Active Directory ni Keycloak. {% endhint %} ### Thèmes et personnalisation | Paramètre | Défaut | Description | | ------------------------------------- | --------- | -------------------------------- | | `com.clog.workey.skin.custom.enabled` | `false` | Activer les thèmes personnalisés | | `com.clog.workey.skin.folder.name` | `default` | Nom du thème actif | Consultez l'article [Gestion des Thèmes](/documentations/efalia-process/administration/administration-fonctionnelle/gestion-themes.md) pour la configuration complète. ### Menu de navigation inter-espaces Ce menu permet de naviguer entre le Panorama, le Designer, l'Administration et les Archives. | Paramètre | Défaut | Description | | ------------------------------------------------- | ------ | --------------------------------------- | | `com.clog.workey.spaces.nav.menu.enable` | `true` | Activer le menu de navigation | | `com.clog.workey.spaces.nav.designer.enable` | `true` | Afficher l'icône Designer | | `com.clog.workey.spaces.nav.admin.enable` | `true` | Afficher l'icône Administration avancée | | `com.clog.workey.spaces.nav.documentation.enable` | `true` | Afficher l'icône Documentation | | `com.clog.workey.spaces.nav.archives.enable` | `true` | Afficher l'icône Serveur d'archives | 📸 **CAPTURE : admin-fonct-front-office-03-menu-navigation.png** > Menu de navigation inter-espaces avec les icônes Panorama, Designer, Administration, Documentation et Archives ### Édition de documents (PDFTron et OnlyOffice) #### PDFTron — Édition de PDF | Paramètre | Défaut | Description | | -------------------------------------------- | ------- | ------------------------------------------------------ | | `com.clog.workey.pdftron.enable` | `false` | Activer l'édition de PDF avec PDFTron | | `com.clog.workey.pdftron.candidate.docs` | `.pdf` | Extensions de fichiers éditables | | `com.clog.workey.pdftron.available.creation` | `false` | Permettre la création de PDF depuis les pièces jointes | #### OnlyOffice — Édition de documents Office | Paramètre | Défaut | Description | | --------------------------------------------------- | --------------------------------- | ------------------------------------------------------- | | `com.clog.workey.onlyoffice.enable` | `false` | Activer l'édition Office avec OnlyOffice | | `com.clog.workey.onlyoffice.docservice.url.base` | — | URL du serveur OnlyOffice (**obligatoire**) | | `com.clog.workey.onlyoffice.filesize.max` | `5242880` | Taille max des fichiers éditables (5 Mo par défaut) | | `com.clog.workey.onlyoffice.docservice.edited.docs` | `.docx\|.xlsx\|.csv\|.pptx\|.txt` | Extensions éditables | | `com.clog.workey.onlyoffice.available.creations` | `word` | Types de documents créables (`word\|excel\|powerpoint`) | {% hint style="warning" %} ⚠️ **OnlyOffice nécessite un serveur OnlyOffice accessible depuis le serveur Efalia Process (Tomcat).** Rapprochez-vous de votre administrateur technique pour la mise en place. {% endhint %} ### Intégration Efalia Doc (Multigest) | Paramètre | Description | | ------------------------------------ | ----------------------------------------------------------------------------- | | `com.clog.workey.doc.process.enable` | Activer les interactions avec Efalia Doc | | `com.clog.workey.mgx.api.server` | URL du serveur Efalia Doc | | `com.clog.workey.mgx.api.login` | Login du compte de service Doc | | `com.clog.workey.mgx.api.password` | Mot de passe du compte de service Doc | | `com.clog.workey.mgx.pdc.cache.cron` | Planning de mise en cache du plan de classement (`0 0 1 * * *` = 1h du matin) | Consultez la section [Intégrations > Efalia Doc](/documentations/efalia-process/vue-ensemble/mise-en-oeuvre.md) pour la configuration complète. *** ## Exemple de Configuration Complète Voici un exemple de fichier `settings.json` avec deux applications verticales : ```json { "verticalApps": [ { "id": "CONTRACT", "route": "contract", "label": { "fr": "Gestion des contrats", "en": "Contracts management" }, "spriteCssClass": "wky-g-contract", "enable": true, "availableDocuments": [ { "names": "Gestion_des_contrats/Contrat/Gestionnaire_de_contrat" } ], "descendingDocuments": [], "pages": [ { "id": "PAGE_MY_CONTRACTS", "label": "Mes contrats", "tabs": [] } ] } ], "panoramaApp": {}, "uiOptions": { "toDoCounterIcon": true, "readingPaneOfDocuments": true, "delegationAndSubstitution": true }, "extraPermissions": { "listsManagement": ["admin_user"] } } ``` *** ## ⚠️ Limitations {% hint style="warning" %} **Limite Technique — Gestion des utilisateurs LDAP** La gestion des utilisateurs (CRUD) n'est utilisable qu'avec un LDAP de type **OpenLDAP**. **Non compatible avec :** Active Directory, Keycloak **Solution :** Pour les annuaires Active Directory ou Keycloak, gérez les utilisateurs directement dans votre annuaire ou via Keycloak, puis synchronisez-les avec Efalia Process. {% endhint %} {% hint style="warning" %} **Limite Technique — Mode SAAS** En mode `SAAS`, le menu de navigation inter-espaces n'est pas affiché, quelle que soit la valeur de `com.clog.workey.spaces.nav.menu.enable`. De plus, la gestion des utilisateurs (`manage.users.crud.enable`) est forcée à `true` en mode SAAS. {% endhint %} *** ## Bonnes Pratiques {% hint style="success" %} **✅ À faire :** * Utiliser l'**éditeur en ligne** pour toutes les modifications (validation et historique automatiques) * Tester les modifications dans un environnement de recette avant la production * Conserver des sauvegardes nommées du fichier `settings.json` avant chaque modification importante * Utiliser des **IDs explicites** en majuscules pour les applications et pages * Définir les **labels multilingues** dès le départ si votre organisation est internationale {% endhint %} {% hint style="danger" %} **❌ À éviter :** * Modifier le fichier `settings.json` avec un traitement de texte (Word, LibreOffice) → corruption du fichier * Laisser un JSON invalide en production (interface inaccessible) * Utiliser les mêmes `id` pour plusieurs applications ou pages * Oublier de tester l'affichage après modification du menu de navigation {% endhint %} *** ## Questions Fréquentes
Comment activer les applications verticales ? Deux conditions sont nécessaires : 1. **Paramètre back office :** `com.clog.workey.app.vertical.apps.enable=true` (dans `catalina.properties` ou l'administration simplifiée) 2. **Fichier settings.json :** Au moins une application définie dans le tableau `verticalApps` Si les deux conditions sont remplies et que l'utilisateur dispose des droits sur au moins un processus de l'application, elle apparaît dans son menu de navigation.
Quelle est la différence entre le mode SAAS et ON_PREMISE ? * **SAAS** : Mode hébergé. La gestion des utilisateurs est forcée active, le menu inter-espaces est masqué. Conçu pour un hébergement mutualisé avec isolation des tenants. * **ON\_PREMISE** : Mode installation sur site. Toutes les fonctionnalités de navigation et de gestion sont configurables librement. La valeur par défaut est **SAAS**. Pour la plupart des installations on-premise (sur site), il faut passer ce paramètre à `ON_PREMISE`.
Peut-on personnaliser le nom "Efalia Process" dans l'interface ? Oui. Le paramètre `com.clog.workey.app.custom.app.name` permet de remplacer le nom du produit par un nom personnalisé (ex : "Mon Espace Workflow"). Ce paramètre est configurable à chaud depuis l'administration simplifiée.
Comment restreindre la gestion des listes (domaines de valeur) à certains utilisateurs ? Utilisez la propriété `extraPermissions.listsManagement` dans le fichier `settings.json`. Listez les logins des utilisateurs autorisés à gérer les listes : ```json "extraPermissions": { "listsManagement": ["jdupont", "mmartinez"] } ``` Ces utilisateurs auront accès à l'interface de gestion des listes même sans être Workflow Manager.
Les modifications du settings.json nécessitent-elles un redémarrage serveur ? **Non.** Les modifications apportées via l'éditeur en ligne sont prises en compte immédiatement. Pour les modifications du fichier directement sur le serveur (hors éditeur en ligne), le remplacement du fichier est également pris en compte sans redémarrage. En revanche, les paramètres back office définis dans `catalina.properties` nécessitent un redémarrage du serveur Tomcat.
Peut-on avoir une application verticale accessible uniquement à certains utilisateurs ? Oui. La visibilité d'une application verticale est conditionnée par les droits des utilisateurs sur les processus qu'elle contient. Si un utilisateur n'a aucun droit sur aucun processus de l'application, elle ne lui est pas présentée. Il n'y a pas de filtre direct sur l'application verticale elle-même dans le `settings.json` — le filtrage se fait via les habilitations définies dans les organigrammes et rôles du processus.
Comment afficher un tableau de bord graphique dans une application verticale ? Dans la définition d'un onglet, utilisez le type `PIE_CHART` ou `LINE_CHART` : ```json { "id": "TAB_STATS", "label": "Statistiques", "type": "PIE_CHART", "dataSource": "nom_de_la_vue_stats" } ``` La vue de données correspondante doit être définie dans le Designer HTML (graphe de type "Vues utilisateur") et exposer les données nécessaires.
OnlyOffice s'ouvre en lecture seule pour certains formats, comment le modifier ? Ajustez les paramètres suivants : * `com.clog.workey.onlyoffice.docservice.viewed.docs` : extensions ouvertes en **lecture seule** * `com.clog.workey.onlyoffice.docservice.edited.docs` : extensions ouvertes en **écriture** * `com.clog.workey.onlyoffice.docservice.convert.docs` : extensions **converties avant édition** Par exemple, pour ouvrir les fichiers `.odt` en écriture, ajoutez `.odt` à `edited.docs`.
*** **Votre Front Office est configuré.** Pour personnaliser l'apparence visuelle (couleurs, logo, favicon), consultez l'article sur la gestion des thèmes. Pour aller plus loin : * [Gestion des Thèmes](/documentations/efalia-process/administration/administration-fonctionnelle/gestion-themes.md) * [Tableaux de Bord et Vues](/documentations/efalia-process/administration/administration-fonctionnelle/tableaux-bord-vues.md) * [Intégration Efalia Doc](/documentations/efalia-process/vue-ensemble/mise-en-oeuvre.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/administration/administration-fonctionnelle/parametrage-front-office.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.