Histórico
Ao orquestrar os processos de geração de relatórios usando o Data Management Suite, frequentemente nos deparamos com cenários complexos de fluxo de trabalho. Por exemplo, um aplicativo pode precisar ser executado:
- Um único fluxo de trabalho várias vezes com entradas variadas
- Vários fluxos de trabalho distintos
- Vários fluxos de trabalho simultâneos, cada um com entradas específicas
- Fluxos de trabalho de integração do sistema de origem que exigem parâmetros específicos, como datas, nomes de arquivos ou nomes de regras
Para automatizar e gerenciar com eficiência esses intrincados requisitos de fluxo de trabalho, o conceito de Control Sheet é inestimável. Uma Folha de Controle funciona como uma ferramenta de gerenciamento centralizada que permite a pré-definição de entradas para cada execução de fluxo de trabalho. Ao aproveitar as Folhas de Controle, os usuários podem especificar os parâmetros e as condições sob os quais cada fluxo de trabalho deve operar, facilitando assim um processo automatizado e contínuo que executa todos os fluxos de trabalho necessários com as entradas apropriadas, sem a necessidade de intervenção manual em cada etapa.
Ao criar e utilizar uma planilha de controle, os usuários podem:
- Definir valores de entrada que serão passados para uma cadeia em cada execução
- Definir sinalizadores que determinarão se uma cadeia deve executar determinadas operações
- Passe valores, como parâmetros de consulta, nomes de regras ou filtros de data, para o fluxo de trabalho do sistema ao executar uma cadeia ou uma regra.
- Executar partes das operações de Roll-forward
- Gerenciar os IDs para artefatos dentro da Workiva
- Registrar o status de execução de um fluxo de trabalho
Este artigo orientará os usuários no processo de criação de uma planilha de controle simples. Essa planilha permitirá que os usuários executem o mesmo fluxo de trabalho com vários conjuntos de entradas.
Pré-requisitos
- Configurar o conector Workiva
- Configurar o conector JSON
- Configurar o conector Handlebars
Etapa 1: Configuração de uma planilha de controle
- Crie uma planilha na plataforma Workiva
- Atribua permissões de propriedade ao usuário associado à concessão OAuth2.
- Renomeie a planilha e a planilha como
- Planilha de controle
- Planilha de controle
Etapa 2: Definição de cabeçalhos (chaves) para a planilha de controle
Estabeleça cabeçalhos para cada valor que será processado pelo fluxo de trabalho em cadeia. Neste exemplo, os seguintes cabeçalhos são configurados:
- Active_Flag: Para determinar se essa linha deve ser processada ou não
- File_Name (Nome do arquivo): Nome do arquivo a ser processado
- Table_ID: ID da tabela Wdata para a qual o arquivo seria importado
Etapa 3: Atribuir valores aos cabeçalhos na planilha de controle
- Neste exemplo, foram definidos três valores para cada par Chave/Valor. Portanto, à medida que cada linha é lida, os dados a seguir serão alimentados:
true, file_x.csv, df2a1988929e4358858306956685e162
true, file_y.csv, df2a1988929e4358858306956685e162
true, file_z.csv, df2a1988929e4358858306956685e162
Etapa 4: Criar uma cadeia para recuperar dados da planilha de controle
Para recuperar os dados da planilha de controle a partir da planilha, é necessário criar uma cadeia para ler a planilha.
- Navegue até o módulo Cadeias e crie uma nova cadeia
- Navegue até as configurações de cadeia e dê um título à sua nova cadeia Get Control Sheet Data
- Adicione duas variáveis da cadeia :
- cv-SpreadsheetID
- cv-SheetName
- Preencha cada variável com os valores correspondentes SpreadsheetID e SheetName da planilha de controle.
Etapa 5: Obter dados da planilha
Para usar os dados na sua planilha de controle, você deve usar o comando Get Sheet Data. O comando lê o conteúdo de uma planilha em uma planilha e produz uma saída .csv.
- Arraste e solte o comando Workiva Get Sheet Data na seção START da tela
- Configure o comando
- Renomeie-o para Get Control Sheet Data (Obter dados da planilha de controle)
- Use a variável de cadeia cv-SpreadsheetID para o campo Spreadsheet ID (ID da planilha)
- Use a variável de cadeia cv-SheetName para o campo Sheet ID/Name (ID/nome da planilha)
- Digite A1: para a região
- Deixe Value Style e Revision como Calculated e -1
- Clicar em Salvar
Etapa 6: Converter os dados da planilha em JSON
Depois de recuperar com êxito os dados da planilha de controle no formato .csv, a próxima etapa é convertê-los em JSON. Essa conversão garante que os cabeçalhos e os valores da coluna sejam reformatados corretamente na estrutura JSON Key-Value. Esse formato é crucial para as etapas a seguir.
- Arraste o comando CSV to JSON para a tela
- Vincule o comando Get Control Sheet Data ao comando CSV to JSON
- Edite o comando CSV to JSON
- No campo Input File, use a saída Data do menu suspenso Get Control Sheet Data
- Deixe o campo Delimitador como Vírgula (,)
- Clicar em Salvar
Etapa 7: iterar pelos dados JSON
Agora que os dados da planilha de controle estão no formato JSON, um grupo de comandos pode ser usado para iterar em cada linha de dados da planilha de controle
- Adicione Grupo de comandos à tela
- Conecte o comando CSV to JSON à parte In do grupo Command
- Edite o grupo de comandos e dê a ele o nome de JSON Iterator
- Clique no símbolo de iteração à direita da guia Informações básicas
- Ativar o iterador
- Deixe a seção Select Modifier Type como List
- Para a seção Iterations, selecione a saída <> JSON File na lista suspensa do comando CSV to JSON
- Clicar em Salvar
Etapa 8: Visualização de cada iteração de dados
Com a cadeia agora capaz de iterar por cada linha da planilha de controle, um comando Handlebars pode ser utilizado para visualizar a saída das informações.
Observação: O comando Handlebars serve como espaço reservado para a revisão de valores neste artigo, mas outros comandos também podem ser usados para processar os valores.
- Arraste e solte um comando Render Text Template na tela
- Vincule o comando Group Start do grupo de comandos ao comando Render Text Template
- Edite o comando e nomeie-o como Preview Control Sheet Data (Visualizar dados da planilha de controle)
- No campo Modelo, digite o seguinte:
Nome do arquivo ID da tabela de sinalização ativa
- Para derivar os valores da planilha de controle, uma transformação de variável deve ser aplicada a cada iteração JSON
- Ao lado de File Name, escolha JSON File Iteration na barra lateral, localizada no menu suspenso Group Iterator.
-
- Clique em JSON File Iteration, selecione Get Value from JSON
- No campo Value, digite o cabeçalho File_Name da sua planilha de controle
- Observação: Uma boa prática é copiar o cabeçalho da planilha de controle diretamente para o campo de valor
- Pressione Enter e Aceite
-
- Repita as etapas acima para os cabeçalhos Active_Flag & Table_ID da planilha de controle
- Depois de concluído, o campo de modelo deverá ter a seguinte aparência:
- Salvar o comando
Etapa 9: Executar a cadeia e visualizar
Agora que a Cadeia e a Planilha de Controle estão configuradas, é importante garantir que cada iteração da saída da Barra de Mão contenha dados para cada linha da planilha de controle.
- Clique em Publique e, em seguida, Execute a cadeia
- Execute a cadeia
- Depois que a cadeia for executada com êxito, clique no comando Preview Control Sheet Data (Visualizar dados da planilha de controle) e navegue até a guia Log
- Em "Start Rendered Text" (Iniciar texto renderizado), um resultado para a primeira iteração deve estar visível.
- Alterne para o Valor 2 na opção acima da guia Log para ver os resultados da segunda iteração
- Por fim, mude para o valor 3 para ver os resultados da terceira iteração
- Cada iteração deve aparecer da seguinte forma:
Valor 1:
Valor 2:
Valor 3:
Aproveitar o sinalizador ativo
Incorporar uma lógica condicional que utiliza o valor do sinalizador ativo é a próxima etapa, usando a mesma cadeia que foi criada.
- Edite a cadeia e exclua o link entre o JSON Iterator e o Preview Control Sheet Data
- Adicione um comando Conditional e conecte o comando Group Start do Command Group ao novo comando
- Vincule o comando Conditional ao comando Preview Control Sheet Data
- Editar o comando condicional
- Dê um nome ao comando Active Flag?
- Clique no botão + Rule
- No campo de valor, clique em <> JSON File Iteration na lista suspensa do Group Iterator
- Adicione uma transformação de variável e use o cabeçalho Active_Flag da planilha de controle como o valor
- Clique em Aceitar.
- Altere a condição de "Is Blank" para "="
- Digite a palavra "true" no campo de expressão
- Clique em Salvar
Agora, sempre que a cadeia for executada, o comando Preview Control Sheet Data será executado somente se o valor de Active_Flag nessa iteração for igual a true.
- Como o Active_Flag para duas das iterações foi definido como "FALSE", o comando Preview Control Sheet Data foi executado somente para a terceira iteração.
- Os comandos que seguem o comando condicional "Active Flag?" serão ignorados se a iteração na planilha de controle tiver o valor "FALSE"
Casos de uso adicionais
A Folha de Controle oferece uma maneira altamente eficaz de centralizar, gerenciar e automatizar os valores usados na execução do fluxo de trabalho. Pode ser aplicado em vários cenários, incluindo:
- Um hub central para gerenciar IDs de um sistema de origem, elementos Workiva e Wdata
- Utilizando um sinalizador para filtrar e tomar medidas para saber se um processo específico deve ser executado
- Especificação de pontos de extremidade de URL para execução de relatórios de um sistema de origem
- Definição de datas e convenções de nomes para arquivos específicos
- Identificação de diretórios de arquivos para que um SFTP recupere os arquivos designados