🖋️Syntaxe des champs

Le nommage d’un champ constitue une étape essentielle pour naviguer efficacement dans une application et identifier rapidement les champs manipulés. L’objectif est de pouvoir reconnaître la nature du champ, sa fonction ainsi que la table à laquelle il se réfère.

La structure de nommage adoptée sera toujours la suivante : prefixe_racine_suffixe

Remarque : Les méthodes de nommage présentées constituent une convention proposée, mais elles peuvent être adaptées selon vos préférences ou les standards de votre projet. Par exemple, vous pouvez tout à fait utiliser str au lieu de txt pour désigner un champ texte.

◀️ Préfixes

Préfixer l’identifiant du champ par son type permet une identification rapide de sa nature et de son type de données.

Champ

Pour un champ classique Inputs, le préfixe sera uniquement celui de son type. Un texte sera alors préfixé txt.

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

Champs	Abréviation
Single Select (Question Choix Unique)	qcu
Multi Select (Question Chois Multiple)	qcm
Nombre	nbr
Texte	txt
Paragraphe	txtL
Paragraphe (Éditeur avancé)	txtEA
Note	note
Booléen	bool
E-mail	mail
Téléphone	tel
Adresse	adr
Url	url
Liaison simple	lnk
Liaison multiple	lnkM
Fichier	fle
Fichiers multiples	fleM
Date	date
Date et heure	dateH
Plage de date	dateRg
Plage de date avec heure	dateHRg
Durée	duree
Compteur	cpt
Couleur	color
IBAN	iban
chrono	chrono
Paiement One Shot	paie
Paiement Récurrent	paieR
Signature Manuscrite	sign
JSON	json
Zone Geographique	geo
Disponibilité	dispo
PDF Dynamique	pdfDyn
Liaison utilisateur	user
Liaison multi-utilisateurs	userM
Liaison Groupe	grp

Formules

Pour une formule, le préfixe conseillé est fml + Type. Pour les calculs de liaison, le préfixe est clcLnk

Exemple :

• fml_txt_nomPrenomIntervenant_ticket : Formule pour obtenir en texte le nom et le prénom de l'intervenant tech sur un ticket

• clcLnk_nbrTicket_demande : Calcul de liaison pour compter les tickets associés à une demande

Champs système

Toujours préfixer les champs systèmes, par sys

Un champ système est un champ qui stocke des données nécessaires au bon fonctionnement de l'app mais qui ne sont pas des données remplies par des utilisateurs par exemple.

Exemple :

• On souhaite récupérer l'utilisateur connecté pour savoir de qui vient la dernière modification : sys_user_connected_ticket

• On met en place une formule booléen pour afficher uniquement les tickets créés la semaine dernière : sys_fml_bool_semaineDerniere_ticket

• On souhaite trier les départements d'une entreprise selon un choix arbitraire : sys_nbr_ordreTri_departement

🫀Racine

Au centre du nom d’un champ, entre le préfixe et le suffixe, se trouve la racine. La racine sert à indiquer la fonction ou la nature de la variable.

On y inclut généralement des mots-clés significatifs, décrivant précisément le rôle du champ. On évite les espaces et les accents, et on privilégie l’utilisation d’une syntaxe en camelCase (premier mot en minuscule, les suivants avec majuscule, le tout sans espaces).

Exemple :

• Préférer : date_debutIntervention_ticket à : Debut de l'intervention sur le ticket

• Préférer : txt_num_ticket à Numéro du ticket

Liaisons

Dans le cas des liaisons, intégrer la table vers laquelle pointe la liaison, avant les informations de la racine

• Pour une liaison vers une table "Contact" : Préférer : lnk_contactResponsableTech_ticket à : lnk_responsableTech_ticket

• Pour une liaison vers une table "Client" : Préférer : lnkM_clientDemandeur_demande à : lnkM_demandeur_demande

Pour les liaisons synchronisées, ajouter synchro

Exemple :

• lnkM_synchro_etudiant_classe

• sys_lnk_synchro_demande_ticket

Pour les liaisons simples associées à une matrice, préfixer avec mat

Cela permet alors d'avoir deux liaisons vers une même table tout en gardant en tête laquelle sera affichée dans la matrice

Exemple :

Un berger souhaite suivre de manière régulière les caractéristiques de ses moutons (poids, taille, etc.). Pour cela, il veut disposer d’une matrice dans laquelle apparaissent uniquement les moutons qu’il possède actuellement, tout en conservant un historique des moutons qu’il a eus par le passé.

Il faut alors mettre en place, sur la table "Mouton", deux liaisons distinctes vers la table "Berger"

• mat_lnk_bergerActuel_mouton : liaison simple entre le mouton et son berger (affichée dans une matrice).

• lnk_bergerAncien_mouton : liaison simple permettant de conserver la trace du berger qui a élevé le mouton

Ainsi, les moutons actuellement dans le troupeau seront affichés dynamiquement dans la matrice via la liaison mat_lnk_bergerActuel_mouton, tandis que la liaison lnk_bergerAncien_mouton permettra de garder un historique, sans les afficher dans la matrice active.

▶️ Suffixes

Suffixer l’identifiant d'un champ par la table sur laquelle il est stocké facilite la navigation à travers plusieurs liaisons pour toujours savoir où vous vous situez.

Exemple : voici comment les variables d'une table "tickets" seraient nommées

• date_deadline_ticket

• txt_num_ticket

• fml_nbr_priorite_ticket

🧠 Informations supplémentaires

Si besoin, rajouter des informations supplémentaires permettant de rendre plus compréhensible l’analyse des champs

En général, ces informations sont renseignées entre le préfixe et la racine

Pour les champs utilisés comme filtres (notamment les filtres persistant), ajouter filtre

Exemple :

• lnkM_filtre_entreprise_user

• txt_filtre_nomPrenomEleve_user

Pour les champs utilisés uniquement pour de l'affichage, ajouter affichage

Exemple :

• fml_txt_affichage_nomPrenomClasse_eleve

• fml_txt_affichage_numero_ticket