Legjobb gyakorlatok az elemek elnevezéséhez a Tulipban

Cél

Tekintse át az egyéni elemek elnevezésére vonatkozó legjobb gyakorlatainkat a Tulipban, mint kiindulópontot a saját alkalmazásai és elnevezési konvenciói számára.

A Tulipban minden egyéni elnevezésű elemet, pl. változókat, lépéseket, rekordokat stb. úgy kell elnevezni, hogy az ember számára olvasható, egyértelmű és érthető legyen, hogy megkönnyítse az alkalmazások használhatóságát azok életciklusa során.

Ajánlott az alábbi általános elnevezési konvenciókat elfogadni minden elem esetében:

• Leíró név
• A szavak teljes terjedelmükben, rövidítések nélkül.
• Minden szó első betűje nagybetűvel, a további betűk kisbetűvel.
• Az egyes szavakat szóköz választja el egymástól

| | | | | | | --- | --- | --- | | | Példa | Probléma | Jobb példa | | Kész | Nem leíró | Művelet befejezve | operatorName | Kisbetű és szóköz nélkül | Operator Name | Operator Name |

Az alábbi szakaszok néhány részletesebb iránymutatást vázolnak fel az egyes elemekre vonatkozóan.

Változók

A változók nevének egyedinek kell lennie egy alkalmazáson belül, azonban ugyanazok a nevek újra felhasználhatók a Tulip platformon belül.

• A változó típusa nem szerepel a névben
• A numerikus változók neve melletti zárójelben írt egység rövidítések.

| | | | | | | | --- | --- | --- | | | Példa | Kiadvány | Jobb példa | | | Teljes súly | Rövidítés és mértékegységek.Szabályozott iparágak esetében lásd az alábbi megjegyzést. | Teljes tömeg (g) | | fltTemperatureF | Írja be a nevet, szóköz nélkül és rossz egységgelA szabályozott iparágak esetében lásd a következő alfejezetet | Hőmérséklet (°F) |

Szabályozott iparágak

Ajánlott egy értéket és annak mértékegységét két külön változó/tábla rekordmezőben tárolni, pl. "Teljes tömeg" és "Teljes tömeg_UOM". További információért lásd a GxP alkalmazásépítés legjobb gyakorlatai című részt.

| | | | | | | | --- | --- | --- | | | Példa | Probléma | Jobb példa | | | Hőmérséklet (°F) | Csak egy változót használnak az érték és a mértékegység számára | Hőmérséklet Hőmérséklet_UOM |

A táblázatok szűrésére használt változók

A táblázat szűrésére használt változókat egy adott oszlop tekintetében a "Filter" előtaggal kell elnevezni. Ez javítja a változók használhatóságát az alkalmazáskészítés során. Ez a kizárólag szűrésre használt változók esetében ajánlott. Az alkalmazásokban lévő általános célú változóknak nincs szükségük előtagra.

| | | | | | | | | --- | --- | --- | | | Példa | Probléma | Jobb példa | | Állapotszűrő | Utótag nélkül | Filter_Status | | IPCtimestamp Filter | Utótag vs. előtag Kisbetű és szóköz nélkül | Filter_IPC Timestamp |

Változók a kulcsindikátorokhoz

A kulcsmutatókkal, pl. CPP-kkel/CQA-kkal (kritikus folyamatparaméterek / kritikus folyamatattribútumok) vagy KPI-kkal rendelkező alkalmazások esetében a változók nevéhez adjon előtagot a változók olvashatóságának javítása érdekében.

| | | | | | | | | --- | --- | --- | | | Példa | Probléma | Jobb példa | | | CPP Hőmérséklet | Az előtag nem különül el egyértelműen a változó nevétől | CPP_Hőmérséklet (°C) | | AssayB_CQA | Utótagként vagy előtagként használja | CQA_Assay B | | | Rendelkezésre állás | Hiányzó előtag a kulcsmutatóhoz | KPI_Rendelhetőség|

Táblák

A táblázatok nevének a változóknál használt elnevezési konvenciót kell követnie, és egy előtaggal kell csoportosítani. A táblázatokat általános cél szerint kell csoportosítani, pl. több/az összes felhasználási eset vagy konkrét felhasználási eset szerint. Ajánlott a '

' általános célú csoportosításhoz, és nem a '*'-ot használni. A '*'-ot a Tulip a Tulip könyvtári alkalmazásokból származó táblázatok jelölésére használja.

| | | | | | | | --- | --- | --- | | | Példa | Probléma | Jobb példa | | | Nyomtatott lables_table | Utótag használata | #Printed Labels | | | *Printed_labels | '*' előtag használata | #Printed Labels | #Printed Labels |

Triggers

Nem ajánlott az alapértelmezett "névtelen trigger" név használata. Ehelyett a kiváltó nevének néhány szóban le kell írnia a funkcióját.

| | | | | | | | --- | --- | --- | | | Példa | Probléma | Jobb név | | | Névtelen kiváltó | Alapértelmezett név | Hibaszámláló növelése | | Állapot ellenőrzése | Túl kevés kontextus | A megrendelés szállítási állapotának ellenőrzése |