Scopo
Esaminare le nostre migliori pratiche per la denominazione degli elementi personalizzati in Tulip come punto di partenza per le vostre applicazioni e convenzioni di denominazione.
Tutti gli elementi personalizzati, ad esempio variabili, fasi, record, ecc., in Tulip devono essere denominati in modo da renderli leggibili, non ambigui e comprensibili per facilitare l'usabilità delle applicazioni durante il loro ciclo di vita.
Si raccomanda di adottare le seguenti convenzioni generali di denominazione per tutti gli elementi:
- Nome descrittivo
- Parole scritte per intero, senza abbreviazioni
- Prima lettera di ogni parola in maiuscolo, lettere successive in minuscolo
- Singole parole separate da uno spazio
| | | | | --- | --- | | | Esempio | Problema | Esempio migliore | Fatto | Non descrittivo | Operazione terminata | | operatorName | Minuscolo e senza spazio | Nome dell'operatore |
Le sezioni seguenti illustrano alcune linee guida più dettagliate per elementi specifici.
Variabili
I nomi delle variabili devono essere unici per un'App, tuttavia gli stessi nomi possono essere riutilizzati all'interno della piattaforma Tulip.
- Il tipo di variabile non è incluso nel nome
- Abbreviazioni dell'unità di misura scritte tra parentesi accanto al nome delle variabili numeriche
| | | | | --- | --- | | | Esempio | Problema | Esempio migliore | | Peso totale | Abbreviazione e unità. Per le industrie regolamentate, vedere il commento sotto. | Peso totale (g) | | fltTemperatureF | Digitare il nome, senza spazi e con unità errataPer le industrie regolamentate, vedere la prossima sottosezione | Temperature (°F) |
Industrie regolamentate
Si consiglia di memorizzare un valore e la sua unità di misura in due campi variabili/registro tabella separati, ad esempio "Peso totale" e "Peso totale_UOM". Per ulteriori informazioni, consultare le Best Practice per la creazione di applicazioni GxP.
| Esempio | | Problema | Esempio migliore | Temperatura (°F) | Si usa una sola variabile per il valore e l'unità di misura | Temperatura Temperatura_UOM |
Variabili utilizzate per filtrare le tabelle
Le variabili utilizzate per filtrare una tabella rispetto a una colonna specifica devono essere denominate con il prefisso "Filter". Questo migliora l'usabilità di tali variabili durante la creazione dell'applicazione. Questo è consigliato per le variabili utilizzate esclusivamente per il filtraggio. Le variabili di uso generale nelle applicazioni non hanno bisogno di un prefisso.
| | | | | --- | --- | | | Esempio | Problema | Esempio migliore | Filtro di stato | Suffisso senza | Filter_Status | | Filtro IPCtimestamp | Suffisso vs. prefisso Minuscolo e senza spazio | Filter_IPC Timestamp |
Variabili per gli indicatori chiave
Per le applicazioni con indicatori chiave, ad esempio CPP/CQA (Critical Process Parameters / Critical Process Attributes) o KPI, aggiungere un prefisso ai nomi delle variabili per migliorarne la leggibilità.
| | | | --- | --- | --- | Esempio | Problema | Esempio migliore | Temperatura CPP | Il prefisso non è chiaramente separato dal nome della variabile | CPP_Temperature (°C) | AssayB_CQA | Usare come suffisso o come prefisso | CQA_Assay B | Availability | Manca il prefisso per l'indicatore chiave | KPI_Availability|
Tabelle
I nomi delle tabelle devono essere adattati alla stessa convenzione di denominazione utilizzata per le variabili e devono essere raggruppati con un prefisso. Le tabelle devono essere raggruppate in base allo scopo generale, ad esempio casi d'uso multipli/tutti i casi d'uso, o a casi d'uso specifici. Si raccomanda di usare '
' per il raggruppamento generale e non usare '*'. Il simbolo '*' viene utilizzato da Tulip per contrassegnare le tabelle provenienti dalle applicazioni della libreria Tulip.
| | | | --- | --- | --- | | Esempio | Problema | Esempio migliore | Tabella_etichette stampate | Uso del suffisso | #Etichette stampate | *Etichette_stampate | Uso del prefisso '*' | #Etichette stampate |
Trigger
Si sconsiglia di usare il nome predefinito "trigger senza nome". Il nome di un trigger dovrebbe invece descrivere la sua funzionalità in poche parole.
| | | | | --- | --- | | | Esempio | Problema | Nome migliore | | Trigger senza nome | Nome predefinito | Incrementa il contatore dei difetti | Controlla lo stato | Troppo poco contesto | Controlla lo stato di consegna degli ordini |