Meilleures pratiques pour nommer les éléments dans Tulip

Objectif

Examinez nos meilleures pratiques pour nommer les éléments personnalisés dans Tulip comme point de départ pour vos propres applications et conventions de nommage.

Tous les éléments personnalisés nommés dans Tulip, par exemple les variables, les étapes, les enregistrements, etc., doivent être nommés de manière à être lisibles par l'homme, sans ambiguïté et compréhensibles afin de faciliter l'utilisation des applications pendant leur cycle de vie.

Il est recommandé d'adopter les conventions de nommage générales suivantes pour tous les éléments :

• Nom descriptif
• Mots écrits en entier, pas d'abréviations.
• Première lettre de chaque mot en majuscule, lettres suivantes en minuscule
• Mots individuels séparés par un espace

Les sections ci-dessous présentent des directives plus détaillées pour des éléments spécifiques.

Variables

Les noms de variables doivent être uniques pour une application, mais les mêmes noms peuvent être réutilisés au sein de la plateforme Tulip.

• Le type de variable n'est pas inclus dans le nom
• Abréviations d'unités écrites entre parenthèses à côté du nom des variables numériques

Industries réglementées

Il est recommandé de stocker une valeur et son unité de mesure dans deux variables/champs d'enregistrement de tableau distincts, par exemple "Poids total" et "Poids total_UOM". Voir GxP App Building Best Practices pour plus d'informations.

Variables utilisées pour filtrer les tableaux

Les variables utilisées pour filtrer un tableau en fonction d'une colonne spécifique doivent être nommées avec le préfixe "Filter". Cela améliore l'utilisation de ces variables lors de la création de l'application. Ceci est recommandé pour les variables utilisées uniquement pour le filtrage. Les variables à usage général dans les applications n'ont pas besoin de préfixe.

Variables pour les indicateurs clés

Pour les applications avec des indicateurs clés, par exemple les CPP/CQAs (Critical Process Parameters / Critical Process Attributes) ou les KPIs, ajoutez un préfixe au nom des variables pour améliorer la lisibilité des variables.

Tables

Les noms des tables doivent respecter la même convention d'appellation que celle utilisée pour les variables et être regroupés avec un préfixe. Les tables doivent être regroupées en fonction de leur objectif général, par exemple plusieurs cas d'utilisation ou des cas d'utilisation spécifiques. Il est recommandé d'utiliser '

pour les regroupements à usage général et de ne pas utiliser '*'. L'astérisque '*' est utilisé par Tulip pour marquer les tableaux provenant des applications de la bibliothèque Tulip.

Déclencheurs

Il n'est pas recommandé d'utiliser le nom par défaut du "trigger sans nom". Au lieu de cela, le nom d'un déclencheur doit décrire sa fonctionnalité en quelques mots.