Najlepsze praktyki nazywania elementów w Tulipie

Przeznaczenie

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

Wszystkie niestandardowo nazwane elementy, np. Zmienne, Kroki, Rekordy itp. w Tulipie powinny być nazwane w taki sposób, aby były czytelne dla człowieka, jednoznaczne i zrozumiałe, aby ułatwić użyteczność aplikacji podczas ich cyklu życia.

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

• Nazwa opisowa.
• Słowa napisane w całości, bez skrótów
• Pierwsza litera każdego słowa wielka, kolejne małe.
• Poszczególne słowa oddzielone spacją

| | | |

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

Poniższe sekcje przedstawiają bardziej szczegółowe wytyczne dla poszczególnych elementów.

Zmienne

Nazwy zmiennych muszą być unikalne dla aplikacji, jednakże te same nazwy mogą być ponownie użyte w ramach platformy Tulip.

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

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

Przemysł regulowany

Zaleca się przechowywanie wartości i jej jednostki miary w dwóch oddzielnych polach zmiennych/ rekordów tabeli, np. Więcej informacji można znaleźć w części Najlepsze praktyki tworzenia aplikacji GxP.

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

Zmienne używane do filtrowania tabel

Zmienne używane do filtrowania tabeli w odniesieniu do konkretnej kolumny powinny być nazwane z przedrostkiem "Filtr". Poprawia to użyteczność tych zmiennych podczas tworzenia aplikacji. Jest to zalecane dla zmiennych służących wyłącznie do filtrowania. Zmienne ogólnego przeznaczenia w aplikacjach nie potrzebują przedrostka.

| Przykład | Problem | Lepszy przykład
| Status Filter | Sufiks bez | Filter_Status |
| Filtr IPCtimestamp | Sufiks a prefiks
Małe litery i brak spacji | Filter_IPC Timestamp | 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 KPIs, należy dodać przedrostek do nazw zmiennych, aby poprawić ich czytelność.

| Przykład | Problem | Lepszy Przykład |
| CPP Temperature | Prefiks nie jest wyraźnie oddzielony od nazwy zmiennej | CPP_Temperature (°C) |.
| AssayB_CQA | Użycie przyrostka zamiast przedrostka | CQA_Assay B | | Dostępność | Brak prefiksu dla zmiennej.
| Dostępność | Brak prefiksu dla kluczowego wskaźnika | KPI_Dostępność|.

Tabele

Nazwy tabel powinny być zgodne z konwencją nazewnictwa stosowaną dla zmiennych i być pogrupowane za pomocą prefiksu. Tabele powinny być pogrupowane pod względem ogólnego przeznaczenia, np. wiele/wszystkie przypadki użycia lub konkretne przypadki użycia. Zalecane jest używanie znaku '

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

| Przykład | Problem | Lepszy Przykład |
| Printed lables_table | Użycie przyrostka | #Printed Labels | #Printed Labels
| *Printed_labels | Użycie prefiksu '*' | #Printed Labels |

Wyzwalacze

Nie zaleca się używania domyślnej nazwy "nienazwanego wyzwalacza". Zamiast tego, nazwa trigera 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