Mejores prácticas para nombrar elementos en Tulipán

Propósito

Revisar 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, sin ambigüedades 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 escritas en su totalidad, sin abreviaturas
• Primera letra de cada palabra en mayúscula, las siguientes en minúscula
• Palabras individuales separadas por un espacio

Las secciones siguientes 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.

• El tipo de variable no se incluye en el nombre
• Las abreviaturas de las unidades se escriben entre paréntesis junto al nombre de las variables numéricas

| --- | --- | --- |
| Ejemplo | Edición | Ejemplo mejor |
| Peso total | Abreviatura y unidades.Para las industrias reguladas, véase el comentario a continuación. | Peso total (g) |
| fltTemperatureF | Escriba el nombre, sin espacio y unidad incorrectaPara las industrias reguladas, vea la siguiente subsección | Temperatura (°F) |

Industrias reguladas

Se recomienda almacenar un valor y su unidad de medida en dos campos de registro de variables/tabla separados, por ejemplo, "Peso total" y "Peso total_UOM". Consulte las mejores prácticas de construcción de aplicaciones GxP para obtener más información.

| --- | --- | --- |
| Ejemplo: Problema: Mejor ejemplo: Temperatura (°F)
| Temperatura (°F) | Sólo se utiliza una variable para el valor y la unidad de medida | Temperatura_UOM |

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 de Estado
| Filtro IPCtimestamp: Sufijo o prefijo
Minúsculas y sin espacio | Filtro_IPC Timestamp |

Variables para los indicadores clave

En el caso de las aplicaciones con indicadores clave, por ejemplo CPP/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 su legibilidad.

| --- | --- | --- |
| Ejemplo | Asunto | Mejor ejemplo |
| CPP Temperatura | Prefijo no claramente separado del nombre de la variable | CPP_Temperatura (°C) |
| EnsayoB_CQA: Uso como sufijo en lugar de prefijo CQA_Assay B
| Disponibilidad: Falta el prefijo para el 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 del propósito general, por ejemplo, de los casos de uso múltiples/todos, o de los casos de uso específicos. Se recomienda utilizar '

' para la agrupación 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 |
| Tabla_de_etiquetas_impresas | Uso del sufijo | #Etiquetas_impresas
| *Etiquetas_impresas | Uso del prefijo '*' | #Etiquetas_impresas |

Disparadores

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

| --- | --- | --- |
| Ejemplo: Problema: Mejor nombre.
| Activador sin nombre | Nombre por defecto | Incrementar el contador de defectos |
| Comprobar el estado | Demasiado poco contexto | Comprobar el estado de la entrega del pedido |