介绍
数据字典链 模板使用户能够捕获和导出工作区中特定表的高级详细信息到电子表格。用户可以指定关键字来查找表，定义导出电子表格的名称，并在工作区中创建一个表来存储每个表的架构。
有关更多详细信息，请参阅 将数据加载到 Wdata 过程 的文档，以获取全面的概述。 建议在使用数据字典模板之前先查看此文档。
先决条件
此模板假定您的 Workiva 应用程序中已设置以下对象：
- API 授权
- 为了利用 Workiva API，用户必须在其工作区内建立 OAuth API 授权 。请参考这篇文章，了解管理 OAuth 授权的 最佳 实践。
- 必须在工作区中启用并配置 以下连接 器：
注意： 某些变量值可能包含敏感信息，例如用户名和密码。我们建议对信息敏感变量使用 “加密”选项 ，并为您的电子表格设置 适当的 权限
。- 配置变量
- 为了使模板中的 Load Data to Wdata 子链 按预期工作，必须创建一个名为 wsv-WdataLoadWarningThreshold 的工作区 变量。
注： 最佳实践是将此变量的默认值设置为 50（代表 50MB），但如有必要，可以进行调整。
-
- 此外，在使用数据字典链之前，还必须创建其他四个工作区变量。
以下是需要设置和填充的每个变量的详细说明：
| 多变的 | 值 | 描述 |
|---|---|---|
| wsv-WdataLoadWarningThreshold | 建议：50MB | 设置链式处理程序标记超过此文件大小的数据集的阈值。 |
| wsv客户端ID | 源自用户的 API 授权 | 创建 API 授权后填充。 |
| wsv-客户端密钥 | 源自用户的 API 授权 | 创建 API 授权后填充。 |
| wsv-IAMBaseURL | https://api.app.wdesk.com/iam/v1 |
Workiva IAM API 的基本 URL。 注：基本URL 取决于集成用户的位置。 |
| wsv-PlatformBaseURL | https://api.app.wdesk.com/platform/v1 |
Workiva平台API的基本URL。 注：基本URL 取决于集成用户的位置。 |
建立你的链条
数据字典 | 全部 | 主 链模板位于模板屏幕的 Workiva 链部分。
以下是查找方法：
- 在 Chain Builder中，转到 Templates 选项卡。
- 从顶部菜单中选择 Workiva Chains
- 在右上角搜索 “数据字典 | 全部 | 主链模板”，然后打开该模板。
当 数据字典 | 全部 | 主链 部署到工作区时，它将自动部署六个额外的子链。
用户必须确保所有七条链都已部署并发布到同一工作区：
- 数据字典 | 全部 | 主数据
- 数据字典 | 创建文档和子章节 | 创建电子表格
- 数据字典 | 创建文档和子章节 | 创建工作表
- 数据字典 | 创建表
- 将数据加载到 Wdata | 主链
- 将数据加载到 Wdata | 替换数据集
- 将数据加载到 Wdata | 添加新数据集
找到模板后，使用上面 部分中创建的变量为您的工作区配置它。
注： 有关如何从模板创建链的详细说明，请参阅 创建和管理链 文章。
运行时输入
运行此主链（数据字典 | 全部 | 主链）时，需要填充以下运行时输入或将其传递给调用链：
| 运行时输入 | 描述 | 栏位类型 | 必需的？ |
|---|---|---|---|
| 电子表格名称 | 指定要写入表架构的电子表格名称。 | 文本 | 是的 |
| 搜索值 | 此输入用于查找包含指定关键字的表。 | 文本 | 是的 |
| Wdata 表名称 | 指定在初始模板执行时创建的数据字典表的名称。 | 文本 | 是的 |
Wdata 表格
要使用此链，工作区中必须存在数据字典 Wdata 表。除非用户指定不同的表名，否则该链将使用“数据字典表”的命名约定自动创建此表。
我们将使用以下表结构来构建数据字典表：
| 列名称 | 列描述 | 列 ID | 列类型 |
|---|---|---|---|
| 表名 | N/A | 表名 | 文本 |
| 别名 | N/A | 别名 | 文本 |
| 模式 | N/A | 模式 | 文本 |
| 姓名 | N/A | 名称 | 文本 |
| 类型 | N/A | 类型 | 文本 |
自定义调整免责声明： 如果用户在将数据导入 Wdata 表时遇到列标题不匹配的问题，他们可以利用数据准备或其他命令来纠正此问题。但是，如果用户确实要对该模板进行任何自定义调整，建议先复制一份。对模板的任何更改都会影响其可重复使用性。如果将 标签配置 应用于模板，则此方法同样适用
。疑难解答
以下步骤可用于排查链式模板问题：
链式执行错误
- 确认所有区块链都已发布。
- 确保 OAuth2 凭据（
wsv-Client ID和wsv-Client Secret）有效且最新。 - 检查执行该链的用户的工作区权限。
数据导入错误
- 请确认源文件中的列标题与 Wdata 表的架构相符。
- 对于替换数据集操作，请确保文件名与表中现有数据集匹配。
- 对于“添加新数据集”操作，请确保表中的文件名是唯一的。
重复创建表格或电子表格
- 在多次运行中，对
Wdata 表名和电子表格名使用一致的名称。
显示器屏幕
- 用户可以通过访问显示器屏幕来诊断错误原因。
- DCV_Chain Result 变量根据最终结果捕获链的状态。如果发生错误，它会将失败原因应用到监视器屏幕上链的输出文本中。
用户还可以通过监控屏幕来判断文件是否已成功导入。
最佳实践
-
避免修改原始模板:
如果需要调整，请创建副本。对模板的更改可能会影响其重复使用。 -
增强上下文的标记:
如果需要，向标记数据集添加运行时输入（标签键和标签值）。更新链节点以传递这些输入。 -
文件大小管理:
使用wsv-WdataLoadWarningThreshold变量监控数据集大小。如果触发警告，请考虑拆分大型数据集。