本指南提供了实施 使用控制表运行查询并下载结果模板的分步说明。此模板可替代 Run Query 命令,该命令以前需要用户在部署和执行之前手动在链中输入参数。
通过使用 控制表,用户可以动态地添加多个查询 ID 并定义参数,例如 选择列表 或 多选。此模板通常集成到现有链中,但也可用于任何需要以 CSV 格式查询结果的工作流程。
先决条件
必须在工作区中启用并配置以下连接器。
- 配置 Workiva连接器
- 配置 JSON 连接器
- 配置 车把连接器
- 配置 HTTP 请求连接器
- 配置 表格转换连接器
必须在您的工作区中创建以下工作区变量:
- wsv_API 基本 URL - IAM
- wsv_客户端 ID
- wsv_Client Secret
- wsv_API 基本 URL - Wdata
找到模板
“使用控制表运行查询并下载结果 ”模板位于 “模板 ”屏幕的 Workiva Chains 部分。
以下是查找方法:
- 在 Chain Builder 中,转到 卡。
- 从顶部菜单中选择 Workiva Chains 。
- 在右上角搜索 0.0 执行查询 | 顶级编排 并打开模板。
-
找到模板后,点击 新建链 将其部署到您的工作区。
注意:配置完成后,此模板中的 每个链都必须发布到工作区。
变量
| 变量类型 | 变量名 | 描述 |
|---|---|---|
| 工作区变量 | wsv_API 基本 URL - IAM |
请根据您所在的地区输入 API 的基本 URL:
|
| 工作区变量 | wsv_客户端 ID |
输入您在设置 API 授权时收到的客户端 ID。 有关 Workiva API 的更多说明,请参阅此处 。 |
| 工作区变量 | wsv_Client Secret |
您可以通过转到用户个人资料中的“安全”选项卡,然后单击授权旁边的“操作”下拉菜单中的“重新生成”选项来查看您的 API 授权密钥。 有关 Workiva API 的更多说明,请参阅此处 |
| 工作区变量 | wsv_API 基本 URL - Wdata |
请根据您所在的地区输入 API 的基本 URL:
|
运行时输入
配置模板
此模板由两条链组成,分别是 0.0 执行查询 | 顶级编排和 0.1 执行查询 | 下载结果。当主链部署到工作区时,子链也会自动随之部署。
- 顶级编排: 根据控制表中的信息,此链确定查询是使用单一参数类型( 选择列表 或 多选)还是多种参数类型( 选择列表 和 多选)。
- 执行查询 | 下载结果: 此链使用指定的参数运行查询并检索相应的数据。查询执行完毕后,结果将以 CSV 格式下载,以便进行进一步分析或使用。
一旦 控制表 配置完成,并且 链模板 部署到您的工作区,您只需要控制表的 电子表格 ID 和 工作表 ID 即可。
这些值必须作为 运行时输入 添加到 顶级编排链中。
按参数类型配置控制表
控制表的配置方式取决于 Wdata 查询中定义的参数类型。如果查询包含 多个参数类型 (例如,同时包含 单选 列表和 多选) ,则每个参数必须在 单独的 行中使用 相同的查询 ID 进行定义。如果查询仅使用 一个参数类型,则控制表需要 [] 为该查询提供 一行 。
以下示例说明了这两种情况。
示例:包含多种参数类型的查询
对于需要同时包含 选择列表 和 多选 参数的查询,控制表应包含 个单独的行,每个参数行都使用 相同的查询 ID。
注: 键 列指的是 Wdata 查询中定义的 参数名称 。
配置示例:
| 查询 ID | 类型 | 索引键 | 值 |
|---|---|---|---|
| Wdata 查询 ID | 选择列表参数 | 年 | 指定一个默认值(例如, 2023)。 |
| Wdata 查询 ID | 多选参数 | 账户类型 | 请输入多个可接受的值,以逗号分隔(例如, 资产、费用、权益、收入)。 |
示例:单参数查询
对于仅使用 一个参数类型的查询,控制表应包含 针对该查询 ID 的单行 。
例如,如果查询仅使用 选择列表 参数:
| 查询 ID | 类型 | 索引键 | 值 |
|---|---|---|---|
| Wdata 查询 ID | 选择列表参数 | 年 | 指定一个默认值(例如, 一月)。 |
请确保控制表配置准确,因为不正确的设置可能会导致后续问题。
将数据加载到表中
您可以自动将输出结果直接加载到表格中。要将输出数据加载到表中,请考虑使用 "Load Data to Wdata" 模板。这可以通过在 HTTP 连接器上添加 Run Chain 事件 来触发,该事件会下载结果。
故障排除
查看您的链式运行历史记录,包括错误信息:
- 转到 Chain Builder 中的 Monitor 选项卡。
-
将鼠标悬停在问号上,即可查看链式运行状态。
如果您的查询链触发了错误或下载查询结果失败,请执行以下检查:
- 请确认两条链都已发布到您的工作区。每条链条都必须单独发布。
- 请确保 Wdata 中的查询已更新至最新版本。
- 在控制表 中输入 查询 ID、 类型、键和值时,请确保输入完整的 ID,并且没有前导或尾随空格。另外,请确认键和值与 Wdata 中使用的参数正确匹配。
- 确保与 Workiva 连接关联的 OAuth2 授权 具有适当的访问权限。
- 请确保查询中使用的所有参数都包含在控制表中。
更多资源