Workiva Chains 连接器为工作区、环境和链提供通用命令。这包括用于检索属性、链式运行详情、登录活动事件等的 list 和 get 命令。
有关兼容命令的完整列表,请参阅 Workiva Chains 命令 文章。
要求
使用连接器之前:
- 组织安全管理员 必须通过“配置 ”屏幕启用 Workiva Chains 连接器。
- 要在测试环境中运行该链,您需要 URL 来覆盖 API 的主机和基本路径。
- 您必须在软件中创建一个专用的 集成用户 ,并授予 OAuth2 授权 。
- 要查找您的链 ID,请参阅 这篇关于在Workiva中查找 ID 的文章。
集成用户的其他要求
虽然所有工作区所有者都可以访问使用该连接器的链,但连接器本身需要专门的集成用户来执行其命令。使用专用集成用户(而不是协作者的用户帐户)可以跟踪连接器的活动,并限制其访问权限,使其只能访问执行命令所需的内容。
设置集成用户时需要以下步骤:
- 您必须知道集成用户的 OAuth2 授权 ID 和密钥。
- 您必须为集成用户提供连接器将执行的每个命令的适当权限;例如,他们可能是连接器与之交互的电子表格或工作区的所有者。
- 集成用户必须先登录 Chain Builder 才能执行任何命令。这是建立用户帐户所必需的步骤。
连接设置
设置 Workiva Chains 连接器:
- 从 链构建器中,单击 连接,然后单击右上角的 创建 。
- 在 连接器连接下,选择 Workiva 链 和默认的 CloudRunner。
- 在 基本信息下,输入唯一的名称和描述,以帮助识别连接器。
- 在 属性下,输入连接的详细信息:
摘要信息 详细信息 基本 URL 基本 URL;默认为 https://h.app.wdesk.com/s/wdata/oc/api/ ID 输入集成用户 OAuth 授权的 ID。 秘密 输入 ID 属性的密钥。 IAM 主机覆盖 要覆盖身份和访问管理 (IAM) 端点的URL 主机和基本路径,例如在测试环境中,请输入要使用的 URL。 - 选择要使用连接的环境,然后单击 保存。
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 |