借助 Workiva 连接器,您可以 使用链式命令 与 Workiva 平台进行交互,包括其他 Wdata 功能、电子表格和 GraphDB。例如,使用此连接器,您可以:
- 创建和管理表、查询和视图
- 列出表的数据集或导入错误
- 创建和管理电子表格或其工作表
- 管理记录和报告
要求
为了与 Workiva 平台进行交互,连接器使用 Workiva REST API。要设置连接器,您需要:
-
一个专用的 Workiva 集成用户 具有 OAuth2 授权。
注: 此集成用户需要拥有连接器执行命令所需的相应权限,例如其所交互的电子表格或工作区的所有者权限。
- 集成用户的 OAuth2 授权 ID 和密钥。
- 要在测试环境中运行该链,需要使用 URL 覆盖 API 的主机和基本路径。
注: 虽然工作区的所有者可以访问使用连接器的链,但连接器本身需要专门的集成用户来执行其命令。使用专用集成用户(而不是协作者的用户帐户)可以跟踪连接器的活动,并限制其访问权限,使其只能访问执行命令所需的内容。
设置 Workiva 连接器
- 从 链构建器中,单击 连接,然后单击右上角的 创建 。
- 在 创建连接下,选择 Workiva 和默认的 CloudRunner。
- 在 基本信息下,输入唯一的名称和描述,以帮助识别连接器。
-
在 资源下,选择要与此连接关联的资源。
本节为连接器运行所需的任何文件(脚本、安全令牌、证书等)提供安全位置,例如用于身份验证或环境要求的文件。保存连接时,这些文件会自动进行 AES-256 加密。有关更多信息,请参阅 Workiva Chain Builder 安全架构 支持页面。优势:
- 安全存储: 由于这些文件在保存时会被加密并存储在连接级别,因此它们非常适合存储敏感或静态配置数据,这些数据不应该被硬编码到链本身中。
- 可移植性: 如果您将链从“测试”工作区移动到“生产”工作区,资源将与连接设置绑定,这意味着您不必重写链节点中的文件路径。
- 可访问性: 将文件存储在此处,即可使 Runner (执行任务的代理)访问这些文件,而无需手动将文件放置在 Runner 的物理主机上。
缺点:
- 由于文件已加密,无法直接编辑;您必须删除文件并上传修改后的版本。
-
在 属性下,输入连接的详细信息:
摘要信息 详细信息 ID 输入集成用户 OAuth 授权的 ID。 秘密 输入 ID 属性的密钥。 脑宿主覆盖 要覆盖 Wdata 端点的URL 主机和基本路径(例如,对于测试环境),请输入要使用的 URL。 电子表格主机覆盖 要覆盖 Spreadsheets 端点的 URL 主机和基本路径(例如,对于测试环境),请输入要使用的 URL。 IAM 主机覆盖 要覆盖身份和访问管理 (IAM) 端点的URL 主机和基本路径,例如在测试环境中,请输入要使用的 URL。 管理员主机覆盖 要覆盖 管理端点的 URL 主机和基本路径(例如,对于测试环境),请输入要使用的 URL。 GraphDB 主机覆盖 要覆盖 GraphDB 端点的 URL 主机和基本路径(例如,对于测试环境),请输入要使用的 URL。 平台 API 主机覆盖 要覆盖 Workiva 平台端点的URL 主机和基本路径(例如,对于测试环境),请输入要使用的 URL。 注意:所有敏感凭证均使用 AES -256 加密自动加密并存储
。 - 选择要使用连接的环境,然后单击 保存。
- 要测试连接, 创建并运行一个链 使用 连接器的 列出文件 命令,并验证它是否返回有效输出。
URL覆盖
根据生产环境所在区域的不同,可能需要使用覆盖 URL。您可以通过与用于登录 Wdesk 的 URL 进行比较来验证这一点。如果 URL 中包含 EU 或 APAC ,则需要进行覆盖。
注: 此处列出的是美国地区信息,仅供参考。
| 字段 | 值 |
|---|---|
| 脑宿主覆盖 | https://h.app.wdesk.com/s/cerebral |
| 电子表格主机覆盖 | https://api.app.wdesk.com/spreadsheets/v1/ |
| IAM 主机覆盖 | https://api.app.wdesk.com/iam/v1/oauth2/token |
| 管理员主机覆盖 | https://api.app.wdesk.com/admin/v1 |
| 图数据库主机覆盖 | https://api.app.wdesk.com/graphdb/v1/ |
| 平台 API 主机覆盖 | https://api.app.wdesk.com/platform/v1 |
| 字段 | 值 |
|---|---|
| 脑宿主覆盖 | https://h.eu.wdesk.com/s/cerebral |
| 电子表格主机覆盖 | https://api.eu.wdesk.com/spreadsheets/v1/ |
| IAM 主机覆盖 | https://api.eu.wdesk.com/iam/v1/oauth2/token |
| 管理员主机覆盖 | https://api.eu.wdesk.com/admin/v1 |
| 图数据库主机覆盖 | https://api.eu.wdesk.com/graphdb/v1/ |
| 平台 API 主机覆盖 | https://api.eu.wdesk.com/platform/v1 |
| 字段 | 值 |
|---|---|
| 脑宿主覆盖 | https://h.apac.wdesk.com/s/cerebral |
| 电子表格主机覆盖 | https://api.apac.wdesk.com/spreadsheets/v1/ |
| IAM 主机覆盖 | https://api.apac.wdesk.com/iam/v1/oauth2/token |
| 管理员主机覆盖 | https://api.apac.wdesk.com/admin/v1 |
| 图数据库主机覆盖 | https://api.apac.wdesk.com/graphdb/v1/ |
| 平台 API 主机覆盖 | https://api.apac.wdesk.com/platform/v1 |
疑难解答
如果与 Workiva 平台的连接失败:
- 验证连接器的应用程序 OAuth 凭据是否存在、是否正确、是否有效。OAuth 凭证有定义的过期日期,证书可能已经过期。如果是这种情况,您需要创建一个新证书,并在连接器中输入新的客户端密钥。
- 请确保集成用户拥有执行该命令所需的适当权限。
- 如果使用主机覆盖,请检查为连接器输入的 URL 是否正确。
-
确认正在交互的 Workiva 文件(例如表格、查询或电子表格)的 ID 是否正确。
注: 文件 ID 会显示在 Workiva 中打开的 URL 中。例如,电子表格的 ID 出现在其 URL 的
之后。spreadsheet/之后;表格的 ID 出现在tables/