Centro de suporte da Workiva

Visão geral

Esta série de "práticas de liderança" descreve as práticas gerais recomendadas para vários artefatos do Data Management Suite na Workiva Platform. Lembre-se de que essas são diretrizes gerais e podem precisar ser adaptadas com base em casos de uso específicos e exclusivos. Essas recomendações visam a ajudá-lo a melhorar a organização em seus espaços de trabalho. Vamos começar explorando essas convenções de nomenclatura.

Convenções de nomenclatura para Conexões, Cadeias e Ambientes

Conexões em cadeias

Ao criar conexões em cadeias, é essencial estabelecer convenções de nomenclatura ideais para garantir a clareza e a distinção entre Ambientes:

• Nome do conector: Forneça um nome descritivo para o Conector que indique claramente sua finalidade e função.
• Tipo de espaço de trabalho: Especifique o espaço de trabalho ou o projeto em que o Conector está sendo utilizado.
• Ambiente do Conector: Identifique claramente o ambiente (por exemplo, desenvolvimento, produção) ao qual o conector corresponde.

Exemplo:

• Conexão SFTP | SEC Reporting | NON-PROD
  • Descrição: Estabelece uma conexão com o servidor SFTP para uma solução de espaço de trabalho do SEC Reporting em um ambiente que não seja de produção, como Desenvolvimento, QA, Sandbox etc.
• Conexão SFTP | SEC Reporting | PROD
  • Descrição: Estabelece uma conexão com o servidor SFTP para a solução de espaço de trabalho de relatórios do SEC no ambiente de produção.

Essa convenção de nomes facilita a identificação e o gerenciamento de conexões em diferentes ambientes. Garante que as cadeias em ambientes específicos interajam somente com as fontes apropriadas, aumentando a segurança e a confiabilidade. Uma conexão Non-Prod pode ser aproveitada em ambientes Non-Prod, Dev e Test.

Essa prática de convenção de nomes deve ser aplicada de forma consistente a todas as conexões, sejam elas Core ou Premium Connectors. Ao manter a uniformidade na nomenclatura das conexões em diferentes ambientes, você pode simplificar o processo de promoção de cadeias e permitir a execução contínua de cadeias em todos os espaços de trabalho.

Construtor de cadeias

Ao criar cadeias na plataforma Workiva, é fundamental manter uma convenção de nomenclatura bem organizada. Uma estratégia de nomenclatura clara e consistente ajuda você a navegar pelas cadeias com mais eficiência, especialmente à medida que o número de fluxos de trabalho aumenta. Esta seção descreve as principais práticas para nomear as cadeias com base em sua finalidade, sistema de origem, frequência e hierarquia do fluxo de trabalho.

Finalidade e sistema de origem

Determinando o propósito da cadeia

Considere as seguintes perguntas para definir a finalidade de uma cadeia:

• Que tipo de dados está sendo usado na cadeia?
• A cadeia pode ser utilizada em vários processos (ou seja, é uma cadeia de utilidade)?
• De qual sistema de origem você está usando para extrair os dados?

Frequência

Especificando a frequência da cadeia

Ao nomear a cadeia, é importante indicar sua frequência, principalmente se ela estiver programada para ser executada automaticamente. Sugerimos as seguintes diretrizes:

• Indique se a cadeia deve ser executada em uma base ad-hoc.
• Especifique se a cadeia é executada diariamente, semanalmente, trimestralmente ou anualmente.

Hierarquia

Organização de compilações em cadeia complexas

Na construção de cadeias que consiste em vários fluxos de trabalho, normalmente há uma cadeia de nível superior com várias subcadeias executadas em uma sequência. Organize essas cadeias prefixando-as com uma convenção de nomenclatura numerada.

Exemplo de uma convenção de nomenclatura numerada:

• 1.0 Cadeia de nível superior
• 1.1 Executar conjunto de dados
• 1.2 Carregar dados na tabela Wdata
• 1.3 Atualizar conexões de entrada

Essa abordagem ajuda os usuários a identificar rapidamente a ordem das operações dentro de um fluxo de trabalho e organiza automaticamente as cadeias dentro do espaço de trabalho com base na ordem numérica.

Exemplos práticos de convenções de nomes de cadeias

Cadeias de utilitários

Cadeias de utilitários são fluxos de trabalho comuns executados por vários outros fluxos de trabalho, como Carregamento de dados em uma tabela Wdata. Para garantir que as cadeias de utilidades sejam exibidas com destaque na parte superior do espaço de trabalho, considere as seguintes convenções de nomenclatura::

• 0.0 - [Nome da cadeia de utilitários] | [Processo] | Cadeia de utilitários
• 0.1 - [Nome da cadeia de utilitários] | [Processo] | Cadeia de utilitários
• 0.2 - [Nome da cadeia de utilitários] | [Processo] | Cadeia de utilitários

Sistemas de origem

O termo "Sistemas de origem" refere-se à origem dos dados, que pode incluir vários sistemas, como ERP (Enterprise Resource Planning), EPM (Enterprise Performance Management), RH (Recursos Humanos) e sistemas de contabilidade, ou pode ser baseado em arquivos, como dados provenientes de um SFTP/FTP.

O exemplo a seguir demonstra a organização de três sistemas de origem como um exemplo:

1. Workday
   • 1.0 - [Chain Name/Process] | Workday | [Frequency]
   • 1.1 - [Nome da Cadeia/Processo] | Dia do Trabalho | [Frequência]
   • 1.2 - [Nome da Cadeia/Processo] | Workday | [Frequência]
2. SAP
   • 2.0 - [Nome da Cadeia/Processo] | SAP | [Frequência]
   • 2.1 - [Nome da Cadeia/Processo] | SAP | [Frequência]
   • 2.2 - [Nome da cadeia/Processo] | SAP | [Frequência]
3. NetSuite®
   • 3.0 - [Nome da Cadeia/Processo] | Netsuite | [Frequência]
   • 3.1 - [Nome da Cadeia/Processo] | Netsuite | [Frequência]
   • 3.2 - [Nome da Cadeia/Processo] | Netsuite | [Frequência]

Para um espaço de trabalho com um grande número de cadeias, use os seguintes exemplos de convenção de nomenclatura para maior clareza e organização:

Essa estrutura garante convenções de nomenclatura e organização claras e consistentes, facilitando a identificação e o gerenciamento de cadeias de utilitários e cadeias de sistemas de origem com base em seu processo e frequência de execução.

Convenção de nomenclatura de ambientes

Os ambientes permitem que você planeje, teste e implemente fluxos de trabalho sem esforço. Isso simplifica a aplicação das práticas recomendadas do ciclo de vida de desenvolvimento de software (SDLC) aos seus processos de automação. Ao criar ambientes, sugerimos usar as seguintes convenções de nomenclatura simplificadas para identificar claramente a finalidade de cada ambiente . Isso ajuda os usuários a entender rapidamente o uso pretendido de cada ambiente.

Tipos de ambiente e convenções de nomenclatura

1. DEV (Desenvolvimento)
   • Propósito: Usado para desenvolver novas cadeias e processos. Os desenvolvedores podem criar e experimentar com segurança no ambiente de desenvolvimento (DEV).
   • Exemplo: DEV
2. Teste (ou Sandbox)
   • Finalidade: Dedicado a processos de teste e controle de qualidade. As equipes de controle de qualidade podem revisar e testar no ambiente de teste (Test).
   • Exemplo: TESTE
3. PROD (Produção)
   • Objetivo: Para processos que foram testados, refinados e estão prontos para serem implantados no ambiente de produção. 

   • Exemplo: PROD

     

Notas

• Várias cadeias podem ter nomes idênticos, mas cada uma é diferenciada por um identificador exclusivo conhecido como GUID.

• Cada espaço de trabalho tem um ID exclusivo (veja no URL), portanto, vários espaços de trabalho podem ter o mesmo nome. No entanto, recomendamos não fazer isso devido ao potencial de confusão do usuário.
• Os nomes das cadeias, do espaço de trabalho e do ambiente de trabalho são compatíveis com espaços e com o conjunto de caracteres padrão da Workiva.
• Comprimentos do nome:
  • Os nomes da cadeia têm um comprimento máximo de 100 caracteres.
    Cuidado: ao copiar cadeias, os caracteres "-- Copy" são adicionados automaticamente. Se isso resultar em um nome com mais de 100 caracteres, a cadeia não será copiada.
  • Comando de cadeia (nó) os nomes têm um máximo de 255 caracteres. 
  • Os nomes do espaço de trabalho têm um comprimento máximo de 50 caracteres.
  • Os nomes do ambiente de espaço de trabalho têm um comprimento máximo de 25 caracteres.

Resumo

O uso dessas convenções de nomenclatura simplificadas ajuda a manter uma configuração de ambiente estruturada e de fácil navegação. Isso garante que a finalidade de cada ambiente seja clara, reduzindo a confusão e aumentando a eficiência durante as fases de desenvolvimento, teste e implantação.