Centro de suporte da Workiva

Este guia fornece instruções passo a passo para a implementação do 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 manualmente os parâmetros em sequência antes da implantação e execução.

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

Pré-requisitos

Os conectores a seguir devem ser ativados e configurados em seu espaço de trabalho.

• Configurar o conector Workiva
• Configurar o conector JSON
• Configurar o conector Handlebars
• Configurar o conector de solicitação HTTP “ ”
• Configurar o conector de transformação tabular do

As seguintes variáveis de espaço de trabalho devem ser criadas no 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 “Workiva Chains” da tela “ Templates” ( ).

Veja como encontrá-lo:

1. No Chain Builder, acesse a guia “ ” → “Templates” → “ dynamic_feed” .
2. Selecione Cadeias Workiva no menu na parte superior.
3. Pesquise por “ ” 0.0 Executar uma consulta | Orquestração de nível superior 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 é composto por 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 primária é implantada em seu espaço de trabalho, a cadeia secundária é implantada automaticamente junto com ela. 

• Orquestração de nível superior : Com base nas informações da planilha de controle, essa cadeia determina se uma consulta utiliza um único tipo de parâmetro (seja Lista de Seleção ou Seleção Múltipla ) ou vários tipos de parâmetros (tanto Lista de Seleção quanto Seleção Múltipla ).
• Executar uma consulta | Baixar resultados: Essa sequência executa uma consulta usando os parâmetros especificados e recupera os dados correspondentes. Assim que a consulta for executada, os resultados serão baixados no formato CSV para análise ou uso posterior.

Depois que a planilha de controle estiver configurada e o modelo de cadeia estiver implantado em 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 tempo de execução do ` ` para a cadeia de orquestração de nível superior do ` ` .

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âmetros definidos na sua consulta Wdata. Se uma consulta incluir vários tipos de parâmetros (por exemplo, tanto Lista de Seleção quanto Seleção Múltipla ), cada parâmetro deve ser definido em uma linha separada usando o mesmo ID de consulta . Se uma consulta utilizar apenas um tipo de parâmetro , a planilha de controle exigirá uma única linha para essa consulta.

Os exemplos a seguir ilustram os dois cenários.

Exemplo: Consulta com vários tipos de parâmetros

Para uma consulta que exija os parâmetros “ ” (Lista de seleção) e “ ” (Seleção múltipla) , a planilha de controle deve incluir linhas separadas para cada parâmetro , todas utilizando o mesmo ID de consulta .

Nota: A coluna “ Key” refere-se 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 utilize 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 utilizar apenas um parâmetro do tipo “Lista de Seleção” ( ) :

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

Carregando dados em uma tabela

Você pode automatizar o processo de carregamento dos resultados diretamente em uma tabela. Para carregar os dados de saída em uma tabela, considere usar o modelo “ ” Carregar dados no Wdata ” . Isso pode ser acionado como parte do seu processo adicionando um evento “ ” da Run Chain no conector HTTP que faz o download dos 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 não conseguiu baixar o resultado de uma consulta, faça 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 “ ” , o tipo “ ”, as chaves e o valor na planilha de controle , certifique-se de que o ID tenha sido digitado por completo e que não haja espaços em branco no início ou no final. Além disso, verifique se as chaves e os valores correspondem corretamente aos parâmetros utilizados no Wdata.
• Certifique-se de que a concessão OAuth2 associada à conexão com o Workiva tenha os acessos adequados.
• Certifique-se de que todos os parâmetros utilizados 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