Buenas prácticas para nombrar elementos en Tulip

Propósito

Revise nuestras mejores prácticas para nombrar elementos personalizados en Tulip como punto de partida para sus propias aplicaciones y convenciones de nomenclatura.

Todos los elementos con nombres personalizados, por ejemplo, Variables, Pasos, Registros, etc., en Tulip deben ser nombrados de una manera que los haga legibles, inequívocos y comprensibles para facilitar la usabilidad de las aplicaciones durante su ciclo de vida.

Se recomienda adoptar las siguientes convenciones generales de nomenclatura para todos los elementos:

• Nombre descriptivo
• Palabras completas, sin abreviaturas.
• Primera letra de cada palabra en mayúscula, las siguientes en minúscula.
• Palabras individuales separadas por un espacio

| | | | | --- | --- | | Ejemplo | Problema | Mejor ejemplo | | Hecho | No descriptivo | Operación terminada | | Nombre del operador | En minúsculas y sin espacio | Nombre del operador |

En las secciones siguientes se describen algunas directrices más detalladas para elementos específicos.

Variables

Los nombres de las variables deben ser únicos con una App, sin embargo los mismos nombres pueden ser reutilizados dentro de la plataforma Tulip.

• Tipo de variable no incluido en el nombre
• Abreviaturas de unidades escritas entre paréntesis junto al nombre de las variables numéricas

| | | | | | --- | --- | | Ejemplo | Edición | Mejor Ejemplo | | Total wgt | Abreviatura y unidades.Para industrias reguladas, ver comentario abajo. | Peso total (g) | | fltTemperatureF | Escriba el nombre, sin espacios y unidad incorrectaPara industrias reguladas, vea la siguiente subsección | Temperature (°F) | Temperatura (°F)

Industrias reguladas

Se recomienda almacenar un valor y su unidad de medida en dos Variables/Campos de registro de tabla separados, por ejemplo, "Peso total" y "Peso total_UOM". Consulte GxP App Building Best Practices para obtener más información.

| Temperatura (°F) | Sólo se utiliza una variable para el valor y la unidad de medida | Temperatura Temperatura_UOM | Variables utilizadas para filtrar Tablas

Variables utilizadas para filtrar tablas

Las variables utilizadas para filtrar una tabla con respecto a una columna específica deben nombrarse con el prefijo 'Filtro'. Esto mejora la usabilidad de esas variables durante la construcción de la aplicación. Esto se recomienda para las variables utilizadas únicamente para filtrar. Las variables de propósito general en las aplicaciones no necesitan un prefijo.

| | | | | --- | --- | | Ejemplo | Problema | Ejemplo mejor | | Filtro de estado | Sufijo sin | Filtro_Status | | Filtro IPCtimestamp | Sufijo vs. prefijo Minúsculas y sin espacio | Filtro_IPC Timestamp |

Variables para indicadores clave

Para aplicaciones con indicadores clave, por ejemplo CPPs/CQAs (Parámetros Críticos de Proceso / Atributos Críticos de Proceso) o KPIs, añada un prefijo a los nombres de las variables para mejorar la legibilidad de las mismas.

| | | | | --- | --- | | Ejemplo | Problema | Ejemplo mejor | | CPP Temperatura | Prefijo no claramente separado del nombre de la variable | CPP_Temperatura (°C) | | AssayB_CQA | Usar como sufijo vs. prefijo | CQA_Assay B | | Disponibilidad | Falta prefijo para indicador clave | KPI_Availability|

Tablas

Los nombres de las tablas deben adaptarse a la misma convención de nomenclatura utilizada para las variables y agruparse con un prefijo. Las tablas deben agruparse en función de su propósito general, por ejemplo, casos de uso múltiples/todos, o casos de uso específicos. Se recomienda utilizar '

para agrupaciones de propósito general y no utilizar '*'. El '*' es utilizado por Tulip para marcar las tablas que se originan en Tulip library Apps.

| | | | | | --- | --- | | Ejemplo | Edición | Ejemplo mejor | | Printed lables_table | Uso del sufijo | #Printed Labels | | *Printed_labels | Uso del prefijo '*' | #Printed Labels |

Disparadores

No se recomienda utilizar el nombre predeterminado "disparador sin nombre". En su lugar, el nombre de un disparador debe describir su funcionalidad en pocas palabras.

| | | | | | --- | --- | | Ejemplo | Problema | Mejor Nombre | | Disparador sin nombre | Nombre por defecto | Incrementar contador de defectos | Comprobar estado | Muy poco contexto | Comprobar estado de entrega de pedido |