Bonnes pratiques pour nommer les éléments dans Tulip

Objectif

Examiner 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, par exemple les variables, les étapes, les enregistrements, etc., dans Tulip doivent être nommés d'une manière qui les rende lisibles par l'homme, sans ambiguïté et compréhensibles pour 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 majuscules, les suivantes en minuscules
• Mots séparés par un espace

| | | | --- | --- | | Exemple | Problème | Meilleur exemple | | Fait | Non-descriptif | Opération terminée | | Nom de l'opérateur | En minuscules et sans espace | Nom de l'opérateur | Nom de l'opérateur | Nom de l'opérateur

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

Variables

Les noms de variables doivent être uniques pour une application, cependant 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 des unités écrites entre parenthèses à côté du nom des variables numériques

| | | | --- | --- | | Exemple | Problème | Meilleur exemple | | Poids total (g) | Abréviation et unités Pour les industries réglementées, voir le commentaire ci-dessous. | Poids total (g) | fltTemperatureF | Tapez le nom, sans espace et avec la mauvaise unitéPour les industries réglementées, voir la sous-section suivante | Température (°F) |

Industries réglementées

Il est recommandé de stocker une valeur et son unité de mesure dans deux champs de variables/enregistrements de table distincts, par exemple "Poids total" et "Poids total_UOM". Voir les meilleures pratiques de construction d'applications GxP pour plus d'informations.

| Les variables utilisées pour filtrer les tables sont les suivantes : température (°F) | Une seule variable est utilisée pour la valeur et l'unité de mesure | Température Température_UOM | Température_UOM | Température_UOM | Température_UOM | Température_UOM | Température_UOM | Température_UOM | Température_UOM | Température_UOM | Température_UOM | Température_UOM

Variables utilisées pour filtrer les tableaux

Les variables utilisées pour filtrer un tableau par rapport à une colonne spécifique doivent être nommées avec le préfixe "Filter". Cela permet d'améliorer 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 d'usage général dans les applications n'ont pas besoin de préfixe.

| | | | --- | --- | | Exemple | Problème | Meilleur exemple | | Filtre d'état | Suffixe sans | Filter_Status | | Filtre d'horodatage IPC | Suffixe contre préfixe Minuscules et sans espace | Filtre d'horodatage IPC |

Variables pour les indicateurs clés

Pour les applications comportant des indicateurs clés, par exemple des CPP/CQA (Critical Process Parameters / Critical Process Attributes) ou des KPI, ajoutez un préfixe aux noms des variables afin d'en améliorer la lisibilité.

| | | | --- | --- | | Exemple | Problème | Meilleur exemple | | CPP Temperature | Le préfixe n'est pas clairement séparé du nom de la variable | CPP_Temperature (°C) | | AssayB_CQA | Utiliser comme suffixe plutôt que comme préfixe | CQA_Assay B | | Availability | Préfixe manquant pour l'indicateur clé | KPI_Availability|

Tableaux

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

pour le regroupement général et de ne pas utiliser "*". Le '*' est utilisé par Tulip pour marquer les tables provenant de la bibliothèque Tulip Apps.

| | | | --- | --- | | Exemple | Problème | Meilleur exemple | | Table_listes_imprimées | Utilisation du suffixe | #Etiquettes_imprimées | | *Etiquettes_imprimées | Utilisation du préfixe '*' | #Etiquettes_imprimées |

Déclencheurs

Il n'est pas recommandé d'utiliser le nom par défaut du "déclencheur sans nom". Le nom d'un déclencheur doit plutôt décrire sa fonctionnalité en quelques mots.

| | | | --- | --- | | Exemple | Problème | Meilleur nom | | Déclencheur sans nom | Nom par défaut | Incrémenter le compteur de défauts | | Vérifier l'état | Trop peu de contexte | Vérifier l'état de la livraison de la commande |