--- title: "Best Practices for Naming Elements in Tulip" slug: "best-practices-for-naming-elements-in-tulip-1" updated: 2023-10-31T15:34:25Z published: 2023-10-31T15:34:25Z canonical: "support.tulip.co/best-practices-for-naming-elements-in-tulip-1" --- > ## Documentation Index > Fetch the complete documentation index at: https://support.tulip.co/llms.txt > Use this file to discover all available pages before exploring further. # Práticas recomendadas para nomear elementos no Tulip ## Finalidade *Revisar nossas melhores práticas para nomear elementos personalizados na Tulip como ponto de partida para seus próprios aplicativos e convenções de nomeação.* Todos os elementos personalizados nomeados, por exemplo, Variáveis, Etapas, Registros, etc., na Tulip devem ser nomeados de forma que sejam legíveis, não ambíguos e compreensíveis para facilitar a usabilidade dos aplicativos durante seu ciclo de vida. Recomenda-se adotar as 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 caixa alta, letras subsequentes em caixa baixa - Palavras individuais separadas por um espaço | | | | | --- | --- | --- | | **Exemplo** | **Problema** | **Melhor exemplo** | | | Feito | Não descritivo | Operação concluída | | operatorName | Minúsculas e sem espaço | Nome do operador As seções abaixo descrevem algumas diretrizes mais detalhadas para elementos específicos. --- ## Variáveis Os nomes das variáveis devem ser exclusivos em um aplicativo, porém os mesmos nomes podem ser reutilizados na plataforma Tulip. - Tipo de variável não incluído no nome - Abreviações de unidades escritas entre parênteses ao lado do nome de variáveis numéricas | | | | | --- | --- | --- | | **Exemplo** | **Problema** | **Melhor Exemplo** | | | Peso total | Abreviação e unidades. Para setores regulamentados, veja o comentário abaixo. | Peso total (g) | fltTemperatureF | Digite o nome, sem espaço e com a unidade incorretaPara setores regulamentados, consulte a próxima subseção | Temperatura (°F) | Temperatura (°F) ### Setores regulamentados Recomenda-se armazenar um valor e sua unidade de medida em dois campos separados de registro de variáveis/tabela, por exemplo, "Total Weight" (Peso total) e "Total Weight_UOM" (Peso total_UOM). Consulte Práticas recomendadas de criação de aplicativos GxP para obter mais informações. | | | | | --- | --- | --- | | **Exemplo** | **Problema** | **Melhor Exemplo** | | | Temperatura (°F) | Apenas uma variável usada para valor e unidade de medida | Temperatura Temperature_UOM | ### Variáveis usadas para filtrar tabelas As variáveis usadas para filtrar uma tabela com relação a uma coluna específica devem ser nomeadas com o prefixo "Filter" (Filtro). Isso melhora a usabilidade dessas variáveis durante a criação de aplicativos. Isso é recomendado para variáveis usadas exclusivamente para filtragem. As variáveis de uso geral nos aplicativos não precisam de um prefixo. | | | | | --- | --- | --- | | **Exemplo** | **Problema** | **Melhor exemplo** | | | Filtro de status | Sufixo sem | Filter_Status | | Filtro de IPCtimestamp | Sufixo vs. prefixo Letras minúsculas e sem espaço | Filter_IPC Timestamp | ### Variáveis para indicadores-chave Para Apps 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** | **Problema** | **Melhor Exemplo** | | | CPP Temperatura | Prefixo não claramente separado do nome da variável | CPP_Temperatura (°C) | | | EnsaioB_CQA | Usar como sufixo em vez de prefixo | CQA_A Ensaio B | | | Disponibilidade | Falta de prefixo para o indicador-chave | KPI_Disponibilidade| --- ## Tabelas Os nomes das tabelas devem seguir a mesma convenção de nomes usada para as variáveis e ser agrupados com um prefixo. As tabelas devem ser agrupadas de acordo com a finalidade geral, por exemplo, vários/todos os casos de uso, ou casos de uso específicos. Recomenda-se usar ' ## ' para agrupamento de propósito geral e não usar '*'. O '*' é usado pela Tulip para marcar tabelas originadas de aplicativos da biblioteca da Tulip. | | | | | --- | --- | --- | | **Exemplo** | **Problema** | **Melhor Exemplo** | | | Tabela_de_tabelas_impressas | Uso do sufixo | #Etiquetas_impressas | *Etiquetas_impressas | Uso do prefixo '*' | #Etiquetas_impressas | --- ## Acionadores Não é recomendável usar o nome padrão "unnamed trigger" (acionador sem nome). Em vez disso, o nome de um acionador deve descrever sua funcionalidade em poucas palavras. | | | | | --- | --- | --- | | **Exemplo** | **Problema** | **Melhor nome** | | | Gatilho sem nome | Nome padrão | Incrementar contador de defeitos | | Verificar status | Muito pouco contexto | Verificar status de entrega do pedido |