🔒Syntaxe des autres éléments

Nous recommandons de renommer systématiquement tous les éléments sur Ksaar afin de garantir une conception d’application claire, cohérente et compréhensible. Pour cela, chaque élément doit suivre une convention de nommage structurée. Vous trouverez ci-dessous la convention que nous préconisons :

📈 Éléments de données

Donner un nom qui explicite les conditions et les usages de cet affichage

Préfixer l’élément de données avec le persona ou le rôle qui sera principalement amené à l’utiliser.

Exemples : ADMIN - Gestion des utilisateurs ; CLIENT - Mes demandes ; AGENT - Mes tickets à traiter ; MANAGER - Les tickets de mon services

• Si un tableau est utilisé par tous les utilisateurs : ALL - Tickets traités cette année

• Si un tableau est utilisé principalement par 2 rôles : ADMIN_AGENT - Tickets traités du service

• Si un tableau est utilisé pour une dataviz : DV - Ticket par services

🗂️ Workflow

Préfixer le nom du WF avec des informations permettant de comprendre son utilité en majuscule

Pour tous les Workflow

Préfixer le nom du workflow avec le périmètre concerné si ce n'est pas une table principale dans l'application

Exemple :

• Une table qui stocke les tickets liés à une demande : DEMANDE - Ticket

• Une table qui stocke les demandes peut être considéré comme principale : DEMANDE - Demande OU Demande

Pour un Workflow qui sert de référence à une liste

Préfixer le nom du workflow avec LIST

Exemple :

• Une table qui stocke les pays pour un choix de nationalité : LIST - Nationalité

• Une table qui stocke les produits chimiques utilisables lors d'un chantier : LIST - CHANTIER - Produit Chimique

Pour un Workflow dit système

Un Workflow système représente un workflow qui n'a pas d'utilité métier mais qui a plutôt une utilité pour le fonctionnement de l'application. En général, un Workflow système n'est pas modifié par les utilisateurs à l'exception des administrateurs. On les préfixe alors SYS .

Exemple :

• Une table qui stocke des compteurs globaux, SYS - Compteur

• Une table qui stocke les statuts possibles des tickets, SYS - LIST - TICKET - Statut

Pour un Workflow créé pour une action liée à une sélection multiple dans un tableau

Pour les actions liées à une sélection multiple dans un tableau, préfixer la table créé par MSA (Multi select action)

Exemple :

• MSA - TICKET - Envoyer un mail de relance

Pour un Workflow créé pour un Mailhook

Pour les tables créées lors de la mise en place d'un trigger Mailhook dans une automation, préfixer le nom de la table par MH

Exemple :

• MH - Réponse mail entretien candidat

👀 Suivi & Fiches

Renommer les suivis et les fiches pour identifier l'utilisateur cible et l'utilité du suivi

Si un suivi ou une fiche est utilisé par un rôle en particulier, préfixer l’élément avec le persona ou le rôle qui sera principalement amené à l’utiliser

Exemples :

• CLIENT - Consultation du ticket

• AGENT - Traiter le ticket

• MANAGER - Réattribuer le ticket

Si un suivi sert de redirection, préfixer par REDIR

Exemple :

• REDIR - Ouvrir la fiche du ticket

Si un suivi est système, c'est-à-dire qu'il réalise des actions mais ne nécessite pas une manipulation de l'utilisateur, préfixer par SYS

Exemples :

• SYS - Générer le compte rendu de traitement du ticket

• SYS - Maj date et utilisateur modification

RACINE

Dans tous les cas, ajouter un nom explicite sur l'utilité du suivi ou de la fiche

🚀 Automations

Préfixer les automations avec le périmètre/la table qu’elle concerne

Bien mettre l’action réalisée par l’automation dans le nom

Exemples :

• TICKET - MaJ la date du jour

• TICKET - Envoi mail changement statut

💥 Actions dans un scénario

Préfixer les action en fonction de leur type et ajouter le but de l'action

Préfixer une action de mise à jour des champs par Maj

Détail de chaque action et de son abréviation

Action	Abréviation
Ksaar AI	IA
Mettre à jour les champs	MaJ
Créer un enregistrement	RECORD
Boucle	Pas d'abréviation car l'icône des boucles est différente
Supprimer un enregistrement	DELETE
Redirection	REDIR
Envoi de mail	MAIL
Envoi de SMS	SMS
Créer un utilisateur	USER
Activer un utilisateur	ACTIVE USER
Désactiver un utilisateur	DESACTIVE USER
Scénarios conditionnels	Pas d'abréviation car l'icône des scénarios conditionnels est différente
Call API	API
Créer un document	Mettre le type de document créé : DOCX/PDF/XLSX
Convertir des fichiers	CONVERT
Signature électronique	YOUSIGN
Créer un QR code	QR CODE
Créer un ICS	ICS
Ajouter au(x) groupe(s)	ADD GROUP

Exemples :

• MaJ - Statut À traiter

• RECORD - Nouveau ticket

🗝️ Clé API

Préfixer les clé API en fonction de l'outil auquel on se connecte

Il est recommandé de préfixer toutes vos clés API avec le nom de l’outil auquel elles sont associées et en ajoutant si besoin l’usage spécifique.

Cela facilite grandement la gestion, la traçabilité et l’administration des clés, tout en permettant de distinguer rapidement les différents cas d’usage.

Exemple :

• MAKE - Synchro Google Sheet Client

• MAKE - Synchro Notion Projet

• SWAGGER - Get files