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 dedicado à integração da Workiva com e uma concessão OAuth2.
Observação: Esse 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 os quais ele 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, os URLs devem substituir os hosts e os caminhos de 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. O uso de um usuário de integração dedicado - em vez da conta de usuário de um colaborador - permite que você acompanhe a atividade do conector e limite seu acesso apenas ao que é necessário para executar seus comandos.
Configure o conector Workiva
- Em Construtor de Cadeias, clique em Conexões e, em seguida, Criar no canto superior direito.
- Em Criar conexão, selecione Workiva e o CloudRunner padrão.
- Em Basic Info, digite um nome e uma descrição exclusivos para ajudar a identificar o conector.
-
Em Resources, selecione os recursos a serem associados a essa conexão.
Esta seção fornece um local seguro para todos os 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 obter mais informações, consulte a arquitetura de segurança do Workiva Chain Builder Página de suporte.Vantagens:
- Armazenamento seguro: Como esses arquivos são criptografados ao serem salvos e armazenados no nível da conexão, eles são ideais para dados de configuração confidenciais ou estáticos que não devem ser codificados na própria cadeia.
- Portabilidade: Se você mover sua cadeia de um espaço de trabalho de "Teste" para um espaço de trabalho de "Produção", os recursos permanecerão vinculados às configurações de conexão, o que significa que você não precisará reescrever os caminhos dos arquivos nos nós da cadeia.
- Acessibilidade: O armazenamento dos arquivos aqui torna os arquivos disponíveis para o Runner (o agente que executa a tarefa) sem exigir que o arquivo seja colocado manualmente no computador host físico do executor.
Desvantagens:
- Como eles são criptografados, não podem ser editados diretamente; é necessário 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 do 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 do host do Spreadsheets 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 do 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 do 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 do 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 do host da API da plataforma Para substituir o host do URL e o caminho base para os pontos de extremidade da plataforma Workiva, como em um ambiente de teste, digite o URL a ser usado. Observação: Todas as credenciais confidenciais são automaticamente criptografadas e armazenadas usando a criptografia AES-256.
- Selecione os ambientes para usar a conexão e clique em Save.
- Para testar a conexão, crie e execute uma cadeia com o comando Listar arquivos do conector e verifique se ele 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 o URL usado para fazer login no Wdesk. Se o URL contiver EU ou APAC, você precisará substituí-lo.
Observação: As informações da região dos EUA estão listadas para referência.
| Campo | Valor |
|---|---|
| Substituição de host cerebral | https://h.app.wdesk.com/s/cerebral |
| Substituição do 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 do host do administrador | https://api.app.wdesk.com/admin/v1 |
| Substituição do host do Graph DB | https://api.app.wdesk.com/graphdb/v1/ |
| Substituição do host da API da plataforma | https://api.app.wdesk.com/platform/v1 |
| Campo | Valor |
|---|---|
| Substituição do host cerebral | https://h.eu.wdesk.com/s/cerebral |
| Substituição do 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 do host do administrador | https://api.eu.wdesk.com/admin/v1 |
| Substituição do host do Graph DB | https://api.eu.wdesk.com/graphdb/v1/ |
| Substituição do host da API da plataforma | https://api.eu.wdesk.com/platform/v1 |
| Campo | Valor |
|---|---|
| Substituição de host cerebral | https://h.apac.wdesk.com/s/cerebral |
| Substituição do 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 do host do administrador | https://api.apac.wdesk.com/admin/v1 |
| Substituição do host do Graph DB | https://api.apac.wdesk.com/graphdb/v1/ |
| Substituição do host da API da plataforma | https://api.apac.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 Workiva - como a tabela, consulta ou planilha - com o qual está interagindo está correto.
Observação: O ID de um arquivo aparece em seu URL quando você o abre na Workiva. Por exemplo, o ID de uma planilha aparece depois de
spreadsheet/em seu URL; o ID de uma tabela aparece depois detables/.