Melhores Práticas para Elementos de Nomes na Tulip

Objetivo

Revise nossas melhores práticas de nomeação de elementos personalizados na Tulip como um ponto de partida para suas próprias aplicações e convenções de nomeação.

Todos os elementos personalizados nomeados, por exemplo, Variáveis, Passos, Registros, etc., na Tulip devem ser nomeados de uma forma que os torne legíveis, inequívocos e compreensíveis para facilitar a usabilidade dos aplicativos durante seu ciclo de vida.

Recomenda-se a adoção das seguintes convenções gerais de nomenclatura para todos os elementos:

• Nome descritivo
• Palavras escritas por extenso, sem abreviações
• Primeira letra de cada palavra em maiúsculas, letras subseqüentes em minúsculas
• Palavras individuais separadas por um espaço

| | | | | | --- | --- | | Exemplo | Edição | | Melhor Exemplo | | Feito | Não-descritivo | Operação Concluída ||| OperadorNome | Em letras minúsculas e sem espaço | Nome do operador |

As seções abaixo esboçam algumas diretrizes mais detalhadas para elementos específicos.

Variáveis

Os nomes variáveis devem ser únicos com um aplicativo, porém os mesmos nomes podem ser reutilizados dentro da plataforma Tulip.

• Tipo de variável não incluída no nome
• Abreviaturas de unidades escritas entre parênteses ao lado do nome das variáveis numéricas

| | | | | | --- | --- | | Exemplo | Edição | | Melhor Exemplo ||| Total wgt | Abreviação e unidades. Para indústrias regulamentadas, veja o comentário abaixo. | Peso Total (g) || fltTemperaturaF | Digite o nome, sem espaço e unidade erradaPara indústrias reguladas, veja próxima subseção | Temperatura (°F) |

Indústrias regulamentadas

Recomenda-se armazenar um valor e sua unidade de medida em dois campos separados de Variáveis/Registros de Tabela, por exemplo, "Peso Total" e "Peso Total_UOM". Veja GxP App Building Best Practices (Melhores Práticas de Construção de Aplicações GxP) para mais informações.

| | | | | | --- | --- | | Exemplo | Edição | | Melhor Exemplo ||| Temperatura (°F) | Apenas uma variável usada para valor e unidade de medida | Temperatura_UOM | Temperature Temperature_UOM

Variáveis utilizadas para filtrar as tabelas

As variáveis usadas para filtrar uma tabela com respeito a uma coluna específica devem ser nomeadas com o prefixo "Filtrar". Isto melhora a usabilidade dessas variáveis durante a construção do aplicativo. Isto é recomendado para variáveis utilizadas exclusivamente para filtragem. Variáveis de propósito geral em Apps não precisam de um prefixo.

| | | | | | --- | --- | | Exemplo | Edição | | Melhor Exemplo ||| Status Filter | Sufixo sem | Filter_Status || IPCtimestamp Filter | Sufixo vs. prefixoBaixa minúscula e sem espaço | Filter_IPC Timestamp |

Variáveis para indicadores-chave

Para aplicações com indicadores chave, por exemplo, CPPs/CQAs (Critical Process Parameters / Critical Process Attributes) ou KPIs, adicione um prefixo aos nomes das variáveis para melhorar a legibilidade das variáveis.

| | | | | | --- | --- | | Exemplo | Edição | | Melhor Exemplo ||| Temperatura CPP | Prefixo não claramente separado do nome da variável | CPP_Temperatura (°C) || AssayB_CQA | Use como sufixo vs. prefixo | CQA_Assay B || Disponibilidade | Prefixo em falta para indicador chave | KPI_Availability|

Tabelas

Os nomes das tabelas devem adaptar a mesma convenção de nomenclatura utilizada para Variáveis e ser agrupados com um prefixo. As tabelas devem ser agrupadas contra casos de propósito geral, por exemplo, casos de uso múltiplo/tudo, ou casos de uso específico. Recomenda-se o uso de '

para agrupamento de propósito geral e não para usar '*'. O '*' é usado pela Tulip para marcar tabelas originárias das aplicações da biblioteca da Tulip.

| | | | | | --- | --- | | Exemplo | Edição | | Melhor Exemplo || | Lables_table impressos | Uso do sufixo | #Rótulos_impressos || *Rótulos_impressos | Uso do prefixo '*' | #Rótulos_impressos |

Gatilhos

Não é recomendado o uso do nome padrão "gatilho sem nome". Ao invés disso, o nome de um gatilho deve descrever sua funcionalidade em poucas palavras.

| | | | | | --- | --- | | Exemplo | Edição | | Melhor Nome | | Acionador Sem Nome | Nome padrão | Contador de defeitos incrementais || Verificar status | Contexto muito pequeno | Verificar status de entrega do pedido |