Documentation e-ASY

Documentation e-ASY

  • API
  • XML Projet
  • État BI
  • Administration

›Doc Administrateur

Doc Technique

  • API Publique
  • XML Projet
  • Etat BI

Doc Administrateur

  • Admin projet
  • Publipostage
  • Notifications
  • WBS
  • Filtres de page
  • Règles e-Asy
  • RGPD

Admin projet

Fonctionnalités et restructions pour administrateurs projet avancés

Personnalisation du logo

Il est possible de personnaliser l'icône et le logo de chaque projet.

  1. Déposer un fichier logo.png et/ou favicon.png dans les médias du projet (menu Gestion documentaire du backoffice du projet).
  2. Activer la personnalisation du logo et/ou de l'icône du projet via le menu Projets du backoffice général (en bas à droite de la fiche projet).

Mode intégré

Le mode intégré permet d'utiliser e-ASY dans une popup sans que l'utilisateur ait accès aux menus et aux autres pages de l'application.

Utilisation:

Le mode intégré s'utilise en ajoutant le paramètre get &integrated=true à une URL easy.

  • Exemple d'URL complète :

https://dps.test.e-asyapp.com/dps/form/update?id=a7e7885f-4179-4318-8e60-4b745c17175c&integrated=true

Exemple d'affichage :

Capture d'écran mode intégré

Mode multi-requête

Le mode multi-requêtes permet beaucoup de flexibilité et beaucoup de puissance, cependant il ne va pas sans quelques limitations et restrictions à avoir en tête lors de la conception d'un projet.

ID resources & champs link éditables

Les liens des pages générés par la navigation depuis la liste contiennent l'ID de l'enregistrement de la table principale, ainsi que tous les ids des enregistrements des tables liées à cette donnée dans la requête de la page.

Exemple d'URL :

https://dps.test.e-asyapp.com/dps/form/update?id=8f53b595-b474-48ce-91b5-b1ce1c1bd9d1&unites_id=1&zones_id=1&entreprises_id=1&services_id=1&types_appareils_id=1

On a donc une URL découpée en plusieurs parties :

  • Le tronc commun https://dps.test.e-asyapp.com/dps/form/update
  • L'ID de l'enregistrement dans la table principale ?id=8f53b595-b474-48ce-91b5-b1ce1c1bd9d1
  • Les ids des tables liées dans la jointure &unites_id=1&zones_id=1&entreprises_id=1&services_id=1&types_appareils_id=1

Importance des ids de ressources :

Les ids des tables liées sont facultatives dans la plupart des cas même si elles sont renseignées à chaque fois qu'on navigue de la page liste vers la page formulaire.

Le seul cas où ces ids sont obligatoires est si la page contient des champs links éditables sur les tables liées.

Appels API avec les Hooks

Les Hooks permettent d'appeller des APIs externes REST. Ils nécessitent la définition d'un client d'API dans le XML. voir doc XML pour leur déclaration.

Interface Backend

Le backend dispose maintenant d'une interface pour gérer les webhooks, dans le menu Configuration.

Les webhooks qui sont créés via l'import XML sont visibles et éditables ici, par contre, si un nouvel import est effectué, ils sont écrasés. Le but est à terme de remplacer complètement les webhooks XML par l'interface et de simplifier l'import.\

L'interface backend permet maintenant de définir une correspondance des données entre la base e-Asy et l'API.
Les clés correspondent aux champs côté e-Asy et les valeurs correspondent aux champs côté API.
Dans l'exemple ci-dessus, le champ e-Asy name correspond au champ de l'API title, pareil pour ville et telephone. interface-webhooks

  • Un champ doit avoir un mappage pour être envoyé au webhook.
  • Chaque champ ne peut avoir qu'un seul mappage.

Cycle de vie d'un Hook

Les Hooks s'intègrent dans le cycle de vie des formulaires e-Asy. Ils sont déclenchés avant ou après l'enregistrement en base de données.

Si order = before

L'API est appellée, puis une fois le retour obtenu la donnée est enregistrée en BDD.

  • Si l'appel API échoue ou renvoie une erreur, la donnée n'est pas enregistrée par e-Asy, et le message d'erreur retourné par l'API est remonté à l'utilisateur.
  • Si l'appel API se déroule avec succès, la donnée est enregistrée en base dans e-Asy. S'ils sont présents, les triggers BEFORE et AFTER sont exécutés.

Important : Les données retournées par l'API sont fusionnées avec les données du formulaire avant l'enregistrement en base. Si des données sont modifiées par l'API appelée (exemple e-Asy <-> Ecare) la modification retournée par le hook est insérée en base.

Si order = after

Le formulaire est d'abord enregistré en BDD puis l'API est appelée.

  • Si l'appel API échoue ou renvoie une erreur, le message d'erreur retourné par l'API est remonté à l'utilisateur. Mais la donnée est quand même enregistrée.
  • Si l'appel API se déroule avec succès, un message de succès éventuel est remonté à l'utilisateur.

Création et update

graph LR; 1[1. Form Save]-->2[2. Appel API OK]; 1-->22[2. Appel API KO]; 2-->3[3. Trigger BEFORE] 3-->4[4. Sauvegarde BDD]; 4-->5[5. Trigger AFTER]

Suppression

graph LR; 1[1. Click sur supprimer]-->2[2. Appel API OK]; 1-->22[2. Appel API KO]; 2-->3[3. Trigger BEFORE] 3-->4[4. Suppression BDD]; 4-->5[5. Trigger AFTER]

Création, suppression et update

graph LR; 1[1. Form Save]-->2[2. Trigger BEFORE] 2-->3[3. Action BDD] 3-->4[4. Trigger AFTER] 4-->5[5. Appel API OK] 4-->55[5. Appel API KO]

Gestion documentaire

Ce menu permet de gérer les documents du projet.

Documents

Utilisez ce menu pour télécharger des fichiers de projet sur le serveur "backend".

  • Les images placées dans le répertoire "media" peuvent être configurées dans le XML du projet comme sources d'images à afficher.

Example: interface-assets

Arborescences

Ce module permet de télécharger les fichiers du projet (champs : upload, upload multi et imageeditor).
Pour télécharger les fichiers, un administrateur défini une (ou plusieurs) arborescence représentant des dossiers pour classer les fichiers.
L'arborescence est téléchargeable au format zip.

Création d'une arborescence

interface-file_trees
Une arborescence est définie par un nom et un ensemble de nœuds.

Le nom de l'arborescence correspond au nom de l'archive générée.

Il existe trois types de nœud :

  • Repertoire : ce type de nœud sera remplacé par un repertoire dans l'archive générée interface-file_trees
  • WBS : ce type de nœud est défini par un nom et une colonne WBS. Ce nœud est remplacé dans l'archive par des répertoires ayant comme nom les valeurs des colonnes wbs. interface-file_trees
  • Upload : ce type de nœud est défini par un nom et un champ upload. Il est remplacé dans l'archive par l'ensemble des fichiers télécharger dans l'application. interface-file_trees

Le noeud racine est de type répertoire. Il ne peut pas être supprimé. On peut cependant modifier son nom.

Attention lors de la définition de l'arborescence, si on place un champ upload avec pour parent un (ou plusieurs) nœud wbs, la page du champ doit avoir accès à la colonne wbs correspondante.
Les fichiers ne respectant pas cette condition ne seront pas présents dans l'archive générée.

Liste des arborescences

interface-file_trees
La liste présente les informations suivantes :

  • Nom : Nom de l'arborescence
  • Nombre de nœuds : Nombre de nœuds dans l'arborescence définie
  • Demande génération : Date de demande de génération de l'archive
  • Génération statut : Statut de la génération de l'archive "En attente", "En cours de traitement", "Erreur" ou "Générée"
  • Date de génération : Date de génération de l'archive
  • Taille de l'arborescence : Taille totale des fichiers composants présents dans l'archive
  • Taille totale des fichiers : Taille totale des fichiers du projet

Pour demander la génération d'une archive, il faut sélectionner la (ou les) ligne correspondante puis cliquer sur le bouton "Générer la sélection".

La génération des arborescences se fait de manière asynchrone.

On peut suivre l'avancement de la génération à partir du champ "Génération statut". Une fois l'arborescence générée un bouton "Tout télécharger" est affiché. interface-file_trees

La taille maximum d'une arborescence est fixée à 40 Go

Purge des anciennes archives

Afin de ne pas saturer l'espace disque du serveur, les archives générées depuis plus de 3 jours sont purgées. Pour la télécharger à nouveau, il faut la générer.

Règles de nommage

Utilisez ce menu pour définir les règles de nommage des fichiers téléchargés sur le serveur par les utilisateurs.

  • Des règles peuvent s'appliquer à tous les champs de téléchargement de fichiers ("upload", "upload_multi", "imageeditor").

  • Vous pouvez utiliser les données de la page ou les données d'une page associée pour construire votre nom de fichier.

  • Les règles seront appliquées une fois l'enregistrement sauvegardé, en utilisant les données existantes au moment de la sauvegarde.

  • La règle ne sera appliquée qu'une seule fois et le nom du fichier ne changera plus après qu'il aura été renommé.

  • Dans votre règle de nommage, vous pouvez utiliser les "placeholders" suivants:

    • ${file_name} - Le nom d'origine du fichier
    • ${datetime#format} - Date/heure par fuseau horaire du client.
      La partie "#format" est optionnelle et correspond à un format DateTime PHP
      Date formats : https://www.php.net/manual/fr/datetime.format.php
      Si aucun format n'est écrit, le format par défaut sera "d-m-Y_H\hi" (Exemple : "01-01-2000_15h30")
    • ${table_name.field_name} - La valeur d'un champ. Il peut provenir des données de la page actuelle ou des données d'une page associée.
      • Les champs disponibles à utiliser peuvent être trouvés dans un tableau ci-dessous.
      • Pour activer l'utilisation de la valeur d'un champ dans la règle de nommage, définissez Actif=oui pour le champ.

    Ces "placeholders" seront remplacés par la valeur correspondante au moment de renommer le fichier (lors de la sauvegarde de l'enregistrement).

  • Une fois calculé, le nouveau nom de fichier sera transformé et tous les caractères invalides de nom de fichier seront supprimés (# % & { } \ < > * ? / $ ! ' " : @ + ` | = [espace])

Example: interface-naming_rules

← Etat BIPublipostage →
  • Personnalisation du logo
  • Mode intégré
  • Mode multi-requête
    • ID resources & champs link éditables
  • Appels API avec les Hooks
    • Interface Backend
    • Cycle de vie d'un Hook
    • Si order = before
    • Si order = after
  • Gestion documentaire
    • Documents
    • Arborescences
    • Règles de nommage
Documentation e-ASY
Docs Techniques
API PubliqueXML ProjetÉtats BI
Docs Admin
Admin projetNotificationsPublipostageMise en forme condionnelleWBSFiltres de pageRGPD
e-ASY
Présentation e-ASYQui sommes nous ?
Copyright © 2026 ELIPCE Informatique