Najlepsze praktyki nazywania elementów w Tulip

Cel

Zapoznaj się z naszymi najlepszymi praktykami dotyczącymi nazywania niestandardowych elementów w Tulip jako punkt wyjścia dla własnych aplikacji i konwencji nazewnictwa.

Wszystkie niestandardowe nazwane elementy, np. zmienne, kroki, rekordy itp. w Tulip powinny być nazwane w sposób czytelny dla człowieka, jednoznaczny i zrozumiały, aby ułatwić korzystanie z aplikacji podczas ich cyklu życia.

Zaleca się przyjęcie następujących ogólnych konwencji nazewnictwa dla wszystkich elementów:

• Nazwa opisowa
• Słowa pisane w całości, bez skrótów
• Pierwsza litera każdego słowa pisana wielkimi literami, kolejne litery pisane małymi literami
• Poszczególne słowa oddzielone spacją

| Przykład | Zagadnienie | Lepszy przykład | Gotowe | Nieopisowe | Operacja zakończona | | operatorName | Małe litery i brak spacji | Nazwa operatora |

Poniższe sekcje zawierają bardziej szczegółowe wytyczne dotyczące określonych elementów.

Zmienne

Nazwy zmiennych muszą być unikalne dla aplikacji, jednak te same nazwy mogą być ponownie użyte na platformie Tulip.

• Typ zmiennej nie jest zawarty w nazwie
• Skróty jednostek zapisane w nawiasach obok nazwy zmiennych numerycznych

| | | | | | | --- | | | | | | Przykład | | Zagadnienie | | Lepszy przykład | | | Waga całkowita | | Skrót i jednostki.Dla branż regulowanych, patrz komentarz poniżej. | Całkowita waga (g) | | fltTemperatureF | Wpisz nazwę, bez spacji i niewłaściwą jednostkę Dla branż regulowanych, patrz następny podrozdział | Temperatura (°F) |

Branże regulowane

Zaleca się przechowywanie wartości i jej jednostki miary w dwóch oddzielnych polach zmiennych/tabel rekordów, np. "Waga całkowita" i "Waga całkowita_UOM". Aby uzyskać więcej informacji, zobacz Najlepsze praktyki tworzenia aplikacji GxP.

| | | | | | --- | | --- | | | Przykład | | Problem | | Lepszy przykład | | Temperatura (°F) | Tylko jedna zmienna używana dla wartości i jednostki miary | Temperatura Temperatura_UOM |

Zmienne używane do filtrowania tabel

Zmienne używane do filtrowania tabeli w odniesieniu do określonej kolumny powinny być nazwane z prefiksem "Filter". Poprawia to użyteczność tych zmiennych podczas tworzenia aplikacji. Jest to zalecane w przypadku zmiennych używanych wyłącznie do filtrowania. Zmienne ogólnego przeznaczenia w aplikacjach nie wymagają prefiksu.

| | | | | | --- | | | | | Przykład | | Problem | | Lepszy przykład | | Status Filter | Sufiks bez | Filter_Status | | IPCtimestamp Filter | Sufiks vs. prefiks Małe litery i bez spacji | Filter_IPC Timestamp |

Zmienne dla kluczowych wskaźników

W przypadku aplikacji z kluczowymi wskaźnikami, np. CPPs/CQAs (Critical Process Parameters / Critical Process Attributes) lub KPI, dodaj przedrostek do nazw zmiennych, aby poprawić czytelność zmiennych.

| | | | | | --- | | --- | | | | Przykład | Problem | | Lepszy przykład | | CPP Temperature | Prefiks nie jest wyraźnie oddzielony od nazwy zmiennej | CPP_Temperature (°C) | | AssayB_CQA | Użyj jako sufiksu vs. prefiksu | CQA_Assay B | | Availability | Brakujący prefiks dla kluczowego wskaźnika | KPI_Availability|

Tabele

Nazwy tabel powinny być zgodne z tą samą konwencją nazewnictwa stosowaną dla zmiennych i powinny być zgrupowane z prefiksem. Tabele powinny być pogrupowane według ogólnego przeznaczenia, np. wiele/wszystkie przypadki użycia lub konkretne przypadki użycia. Zaleca się używanie

" do grupowania ogólnego przeznaczenia i nie używać "*". Znak "*" jest używany przez Tulip do oznaczania tabel pochodzących z biblioteki Tulip Apps.

| | | | | | --- | | | | | Przykład | | Issue | Better Example | | | Printed lables_table | Use of suffix | #Printed Labels | | *Printed_labels | Use of '*' prefix | #Printed Labels |

Wyzwalacze

Nie zaleca się używania domyślnej nazwy "nienazwanego trigera". Zamiast tego, nazwa wyzwalacza powinna opisywać jego funkcjonalność w kilku słowach.

| Przykład | Problem | Lepsza nazwa | | Nienazwany wyzwalacz | Domyślna nazwa | Zwiększanie licznika defektów | | Sprawdź status | Zbyt mały kontekst | Sprawdź status dostawy zamówienia |