Best Practices für die Benennung von Elementen in Tulip

Zweck

Überprüfen Sie unsere Best Practices für die Benennung von benutzerdefinierten Elementen in Tulip als Ausgangspunkt für Ihre eigenen Anwendungen und Benennungskonventionen.

Alle benutzerdefinierten Elemente, z.B. Variablen, Schritte, Datensätze usw., sollten in Tulip so benannt werden, dass sie für den Menschen lesbar, eindeutig und verständlich sind, um die Benutzerfreundlichkeit von Anwendungen während ihres Lebenszyklus zu erleichtern.

Es wird empfohlen, die folgenden allgemeinen Benennungskonventionen für alle Elemente zu übernehmen:

• Beschreibender Name
• Vollständig ausgeschriebene Wörter, keine Abkürzungen
• Erster Buchstabe jedes Wortes in Großbuchstaben, nachfolgende Buchstaben in Kleinbuchstaben
• Einzelne Wörter durch ein Leerzeichen getrennt

| | | | | --- | --- | | | Beispiel | Problem | Besseres Beispiel | | Erledigt | Nicht beschreibend | Vorgang beendet | | OperatorName | Kleinbuchstaben und kein Leerzeichen | Operator Name |

In den folgenden Abschnitten werden einige detailliertere Richtlinien für bestimmte Elemente beschrieben.

Variablen

Variablennamen müssen bei einer App eindeutig sein, jedoch können dieselben Namen innerhalb der Tulip-Plattform wiederverwendet werden.

• Variablentyp nicht im Namen enthalten
• Abkürzungen für Einheiten werden in Klammern neben den Namen numerischer Variablen geschrieben

| | | | | --- | --- | | | | Beispiel | Ausgabe | Besseres Beispiel | | Gesamtgewicht | Abkürzung und Einheiten: Für regulierte Industrien siehe Kommentar unten. | Gesamtgewicht (g) | | fltTemperatureF | Name eintippen, kein Leerzeichen und falsche EinheitFür regulierte Industrien, siehe nächsten Unterabschnitt | Temperatur (°F) |

Geregelte Industrien

Es wird empfohlen, einen Wert und seine Maßeinheit in zwei separaten Variablen/Tabellendatensatzfeldern zu speichern, z. B. "Gesamtgewicht" und "Gesamtgewicht_UOM". Weitere Informationen finden Sie unter GxP App Building Best Practices.

| | | | | --- | --- | | | | Beispiel | Ausgabe | Besseres Beispiel | | Temperatur (°F) | Nur eine Variable für Wert und Maßeinheit verwendet | Temperatur Temperatur_UOM |

Variablen, die zum Filtern von Tabellen verwendet werden

Variablen, die zum Filtern einer Tabelle in Bezug auf eine bestimmte Spalte verwendet werden, sollten mit dem Präfix "Filter" benannt werden. Dies verbessert die Verwendbarkeit dieser Variablen bei der App-Erstellung. Dies wird für Variablen empfohlen, die ausschließlich zum Filtern verwendet werden. Variablen für allgemeine Zwecke in Apps benötigen kein Präfix.

| | | | | --- | | | | | Beispiel | Problem | Besseres Beispiel | | Status Filter | Suffix ohne | Filter_Status | | IPCtimestamp Filter | Suffix vs. Präfix Kleinbuchstaben und kein Leerzeichen | Filter_IPC Timestamp |

Variablen für Schlüsselindikatoren

Für Apps mit Schlüsselindikatoren, z. B. CPPs/CQAs (Critical Process Parameters / Critical Process Attributes) oder KPIs, fügen Sie den Namen der Variablen ein Präfix hinzu, um die Lesbarkeit der Variablen zu verbessern.

| | | | | --- | --- | | | Beispiel | Problem | Besseres Beispiel | | CPP Temperatur | Präfix nicht eindeutig vom Variablennamen getrennt | CPP_Temperatur (°C) | | AssayB_CQA | Verwendung als Suffix vs. Präfix | CQA_Assay B | | Verfügbarkeit | Fehlendes Präfix für Schlüsselindikator | KPI_Verfügbarkeit|

Tabellen

Tabellennamen sollten die gleiche Namenskonvention wie Variablen haben und mit einem Präfix gruppiert werden. Tabellen sollten nach allgemeinem Zweck, z. B. mehrere/alle Anwendungsfälle, oder nach spezifischen Anwendungsfällen gruppiert werden. Es wird empfohlen, '

' für allgemeine Zwecke und nicht '*' zu verwenden. Das '*' wird von Tulip verwendet, um Tabellen zu markieren, die von Tulip Library Apps stammen.

| | | | | --- | --- | | | Beispiel | Ausgabe | Besseres Beispiel | | Gedruckte_Tabellen | Verwendung des Suffixes | #Gedruckte_Etiketten | | *Gedruckte_Etiketten | Verwendung des Präfixes '*' | #Gedruckte Etiketten |

Auslöser

Es wird nicht empfohlen, den Standardnamen "unbenannter Trigger" zu verwenden. Stattdessen sollte der Name eines Triggers seine Funktionalität in wenigen Worten beschreiben.

| | | | | --- | --- | | | Beispiel | Problem | Besserer Name | | Unbenannter Trigger | Standardname | Fehlerzähler erhöhen | | Status prüfen | Zu wenig Kontext | Status der Auftragslieferung prüfen |