Com o conector Workiva, você pode usar os comandos em cadeias para interagir com a plataforma Workiva, incluindo outros recursos do Wdata, Spreadsheets e GraphDB. Por exemplo, com esse conector, você pode:
- Criar e gerenciar tabelas, consultas e exibições
- Listar os conjuntos de dados de uma tabela ou erros de importação
- Criar e gerenciar planilhas ou suas folhas
- Gerenciar registros e relatórios
Requisitos
Para interagir com a plataforma Workiva, o conector usa as APIs REST da Workiva. Para configurar o conector, você precisará de:
-
Um usuário de integração dedicado do Workiva com uma concessão OAuth2.
Observação: Este usuário de integração requer permissões apropriadas para os comandos que o conector executa, como proprietário das planilhas ou do espaço de trabalho com o qual interage.
- O ID e o segredo de concessão OAuth2 do usuário de integração.
- Para executar a cadeia em um ambiente de teste, as URLs para substituir os hosts e os caminhos base da API.
Observação: Embora os proprietários do espaço de trabalho possam acessar cadeias que usam o conector, o próprio conector requer um usuário de integração dedicado para executar seus comandos. Usar um usuário de integração dedicado — em vez da conta de um colaborador — permite rastrear a atividade do conector e limitar seu acesso apenas ao que é necessário para executar seus comandos.
Configurar o conector do Workiva
- No Construtor de cadeias, clique em Conexões na barra lateral esquerda e, em seguida, em Criar no canto superior direito.
- Em Criar conexão, selecione Workiva e o CloudRunner padrão.
- Em Informações básicas, insira um nome e uma descrição únicos para ajudar a identificar o conector.
-
Em Recursos, selecione os recursos a serem associados a esta conexão.
Esta seção fornece um local seguro para quaisquer arquivos (scripts, tokens de segurança, certificados, etc.) que o conector precisa para funcionar, como para autenticação ou requisitos de ambiente. Quando você salva a conexão, esses arquivos são automaticamente criptografados com AES-256. Para mais informações, consulte a página de suporte sobre a arquitetura de segurança do Workiva Chain Builder.Vantagens:
- Armazenamento seguro: Como esses arquivos são criptografados ao salvar e armazenados no nível da conexão, são ideais para dados de configuração confidenciais ou estáticos que não devem ser codificados diretamente na cadeia.
- Portabilidade: Se você mover sua cadeia de um espaço de trabalho de "Teste" para um de "Produção", os recursos permanecem vinculados às configurações de conexão, o que significa que você não precisa reescrever os caminhos de arquivo nos nós da cadeia.
- Acessibilidade: Armazenar os arquivos aqui os torna disponíveis para o Runner (o agente que executa a tarefa) sem exigir que o arquivo seja colocado manualmente na máquina host física do runner.
Desvantagens:
- Como são criptografados, não podem ser editados diretamente; você precisa excluir o arquivo e carregar a versão alterada.
-
Em Propriedades, digite os detalhes da conexão:
Propriedade Detalhes ID Insira o ID para a concessão do OAuth dos usuários de integração. Segredo Digite o segredo para a propriedade ID. Substituição de host do Cerebral Para substituir o host do URL e o caminho base para os pontos de extremidade Wdata, como em um ambiente de teste, digite o URL a ser usado. Substituição de host de planilhas Para substituir o host do URL e o caminho base para os pontos de extremidade do Spreadsheets, como em um ambiente de teste, digite o URL a ser usado. Substituição de host do IAM Para substituir o host do URL e o caminho base para os pontos de extremidade do Identify and Access Management (IAM), como em um ambiente de teste, digite o URL a ser usado. Substituição de host do administrador Para substituir o host do URL e o caminho base para os pontos de extremidade do Admin, como em um ambiente de teste, digite o URL a ser usado. Substituição de host do GraphDB Para substituir o host da URL e o caminho base dos pontos de extremidade do GraphDB, como em um ambiente de teste, digite a URL a ser usada. Substituição de host da API da plataforma Para substituir o host da URL e o caminho base dos endpoints da plataforma Workiva, como para um ambiente de teste, insira a URL a ser usada. Observação: Todas as credenciais confidenciais são automaticamente criptografadas e armazenadas com criptografia AES-256.
- Selecione os ambientes a serem usados com a conexão e clique em Salvar.
- Para testar a conexão, crie e execute uma cadeia com o comando List Files do conector e verifique se ela retorna uma saída válida.
Substituições de URL
Dependendo da região do seu ambiente de produção, pode ser aplicado um URL de substituição. Você pode verificar isso comparando com a URL usada para fazer login no Wdesk. Se a URL contiver .apac, .ca ou .eu, uma substituição é necessária.
Observação: As informações da região dos EUA são listadas apenas para referência.
| Campo | Valor |
|---|---|
| Substituição de host do Cerebral | https://h.app.wdesk.com/s/cerebral |
| Substituição de host de planilhas | https://api.app.wdesk.com/spreadsheets/v1/ |
| Substituição de host do IAM | https://api.app.wdesk.com/iam/v1/oauth2/token |
| Substituição de host do administrador | https://api.app.wdesk.com/admin/v1 |
| Substituição de host do Graph DB | https://api.app.wdesk.com/graphdb/v1/ |
| Substituição de host da API da plataforma | https://api.app.wdesk.com/platform/v1 |
| Campo | Valor |
|---|---|
| Substituição de host do Cerebral | https://h.apac.wdesk.com/s/cerebral |
| Substituição de host de planilhas | https://api.apac.wdesk.com/spreadsheets/v1/ |
| Substituição de host do IAM | https://api.apac.wdesk.com/iam/v1/oauth2/token |
| Substituição de host do administrador | https://api.apac.wdesk.com/admin/v1 |
| Substituição de host do Graph DB | https://api.apac.wdesk.com/graphdb/v1/ |
| Substituição de host da API da plataforma | https://api.apac.wdesk.com/platform/v1 |
| Campo | Valor |
|---|---|
| Substituição de host do Cerebral | https://h.ca.wdesk.com/s/cerebral |
| Substituição de host de planilhas | https://api.ca.wdesk.com/spreadsheets/v1/ |
| Substituição de host do IAM | https://api.ca.wdesk.com/iam/v1/oauth2/token |
| Substituição de host do administrador | https://api.ca.wdesk.com/admin/v1 |
| Substituição de host do Graph DB | https://api.ca.wdesk.com/graphdb/v1/ |
| Substituição de host da API da plataforma | https://api.ca.wdesk.com/platform/v1 |
| Campo | Valor |
|---|---|
| Substituição de host do Cerebral | https://h.eu.wdesk.com/s/cerebral |
| Substituição de host de planilhas | https://api.eu.wdesk.com/spreadsheets/v1/ |
| Substituição de host do IAM | https://api.eu.wdesk.com/iam/v1/oauth2/token |
| Substituição de host do administrador | https://api.eu.wdesk.com/admin/v1 |
| Substituição de host do Graph DB | https://api.eu.wdesk.com/graphdb/v1/ |
| Substituição de host da API da plataforma | https://api.eu.wdesk.com/platform/v1 |
Solução de problemas
Se a conexão com a plataforma Workiva falhar:
- Verifique se as credenciais OAuth do aplicativo do conector estão presentes, corretas e válidas. As credenciais do OAuth têm datas de validade definidas, e o certificado pode ter expirado. Se esse for o caso, você precisará criar um novo certificado e inserir o novo segredo do cliente no Conector.
- Certifique-se de que o usuário de integração tenha as permissões adequadas para o comando que está sendo executado.
- Se estiver usando uma substituição de host, verifique se a URL inserida para o conector está correta.
-
Verifique se o ID do arquivo do Workiva — como a tabela, a consulta ou a planilha — com o qual está interagindo está correto.
Observação: O ID de um arquivo aparece na sua URL quando aberto no Workiva. Por exemplo, o ID de uma planilha aparece após
spreadsheet/na sua URL; o ID de uma tabela aparece apóstables/.