Centro de suporte da Workiva

Este manual fornece instruções passo a passo para implementar o modelo Executar consulta e baixar resultados com planilha de controle. Este modelo serve como uma alternativa ao comando Executar consulta, que anteriormente exigia que os usuários inserissem parâmetros manualmente nas cadeias antes da implantação e execução.

Com o uso de uma planilha de controle, os usuários podem adicionar vários IDs de consulta e definir parâmetros, como Lista suspensa ou Seleção múltipla, de forma dinâmica. Este modelo é comumente integrado a cadeias existentes, mas também pode ser usado em qualquer fluxo de trabalho que exija resultados de consulta em formato CSV.

Pré-requisitos

Os seguintes conectores devem estar habilitados e configurados no seu espaço de trabalho.

• Configurar o conector Workiva
• Configurar o conector JSON
• Configurar o conector Handlebars
• Configure o Conector de solicitação HTTP
• Configure o Conector de transformação tabular

As seguintes variáveis de espaço de trabalho devem ser criadas dentro do seu espaço de trabalho:

• uRL base da wsv_API - IAM
• iD do cliente wsv_Client
• wsv_Client Segredo
• uRL base da wsv_API - Wdata

Encontre o modelo

O modelo Executar consulta e baixar resultados com planilha de controle está localizado na seção Cadeias da Workiva da tela Modelos.

Veja como encontrá-lo:

1. No Construtor de cadeias, vá até a aba Modelos dynamic_feed.
2. Selecione Cadeias Workiva no menu na parte superior.
3. Procure por 0.0 Execute a Query | Top-Level Orchestration no canto superior direito e abra o modelo.

4. Depois de localizar o modelo, clique em Nova cadeia para implantá-lo em seu espaço de trabalho 

   Observação: Depois de configurada, cada cadeia desse modelo deve ser publicada no espaço de trabalho.

    

Variáveis

Entradas de tempo de execução

Configurar o modelo

Este modelo consiste em duas cadeias, a 0.0 Executar uma Consulta | Orquestração de Nível Superior e a 0.1 Executar uma Consulta | Baixar Resultados. Quando a cadeia principal é implantada no seu espaço de trabalho, a cadeia secundária é implantada automaticamente com ela. 

• Orquestração de Alto Nível: Com base nas informações da planilha de controle, essa cadeia determina se uma consulta usa um único tipo de parâmetro (Lista de Seleção ou Seleção Múltipla) ou vários tipos de parâmetro (Lista de Seleção e Seleção Múltipla).
• Executar uma Consulta | Baixar Resultados: Esta cadeia executa uma consulta usando os parâmetros especificados e recupera os dados correspondentes. Depois que a consulta for executada, os resultados serão baixados em formato CSV para análise ou uso posterior.

Depois que a planilha de controle for configurada e o modelo de cadeia for implantado no seu espaço de trabalho, tudo o que você precisa é do ID da planilha e do ID da folha da planilha de controle.

Esses valores devem ser adicionados como entradas de runtime para a cadeia Orquestração de Nível Superior.

Configuração da planilha de controle por tipo de parâmetro

A forma como você configura a planilha de controle depende dos tipos de parâmetro definidos na sua consulta Wdata. Se uma consulta incluir vários tipos de parâmetro (por exemplo, tanto Lista suspensa quanto Seleção múltipla), cada parâmetro deve ser definido em uma linha separada usando o mesmo ID de consulta. Se uma consulta usar apenas um tipo de parâmetro, a planilha de controle requer uma única linha para essa consulta.

Os exemplos abaixo ilustram os dois cenários.

Exemplo: consulta com vários tipos de parâmetro

Para uma consulta que exige tanto o parâmetro Lista de Seleção quanto Seleção múltipla, a planilha de controle deve incluir linhas separadas para cada parâmetro, todas usando o mesmo ID de consulta.

Observação: a coluna Chave se refere ao Nome do parâmetro definido na consulta Wdata.

Exemplo de configuração:

Exemplo: consulta com um único tipo de parâmetro

Para uma consulta que usa apenas um tipo de parâmetro, a planilha de controle deve conter uma única linha para esse ID de consulta.

Por exemplo, se a consulta usar apenas um parâmetro Lista de Seleção:

Certifique-se de que a planilha de controle esteja configurada corretamente, pois uma configuração incorreta pode levar a problemas posteriores.

Carregando dados em uma tabela

Você pode automatizar o processo de carregar sua saída diretamente em uma tabela. Para carregar os dados de saída em uma tabela, considere usar o modelo "Carregar Dados para Wdata". Isso pode ser acionado como parte do seu processo adicionando um evento Executar cadeia no conector HTTP que baixa os resultados.

Solução de problemas

Para visualizar o histórico de execução da cadeia, inclusive os erros:

1. Acesse a guia Monitor no Chain Builder.
   

2. Passe o mouse sobre o ponto de interrogação para ver o status da execução da cadeia.

      

Se sua cadeia gerou um erro ou falhou ao baixar um resultado de consulta, realize as seguintes verificações:

• Verifique se ambas as cadeias foram publicadas no seu espaço de trabalho. Cada cadeia deve ser publicada separadamente.
• Certifique-se de que a consulta no Wdata esteja atualizada para a versão mais recente.
• Ao inserir o ID da consulta, Tipo, Chaves e Valor na planilha de controle, certifique-se de que o ID completo tenha sido inserido e não haja espaços em branco antes ou depois. Além disso, confirme que as Chaves e os Valores correspondem corretamente aos parâmetros usados no Wdata.
• Certifique-se de que a concessão OAuth2 associada à conexão Workiva tenha o acesso apropriado.
• Certifique-se de que todos os parâmetros usados em uma consulta estejam incluídos na planilha de controle.

Recursos adicionais

• Conector Workiva
• Conector de utilitários de arquivo
• Conector JSON
• Transformação tabular conector
• Execute uma cadeia dentro de outra cadeia ("Run Chain events")
• Concessões OAuth2
• Recurso Wdata e limites de API