启动文档导出 模板允许您以 HTTP 格式导出 Workiva 文档,然后可以将其转换为 PDF 或 DOCX 文件。此功能通常用于备份文档、启用离线编辑或与工作区外的用户共享 Workiva 文档。
要求
- 您必须通过 OAuth2授权获得客户端 ID 和客户端密钥。
- 必须在工作区中配置以下连接器:
构建您的模板
“启动文档导出 ”模板位于“模板”屏幕的 Workiva Chains 部分。
以下是查找方法:
- 在 Chain Builder中,转到 Templates 选项卡。
- 从顶部菜单中选择 Workiva Chains 。
- 在右上角搜索 启动文档导出 并打开模板。
找到模板后,使用下面列出的变量和运行时输入,将其配置到您的工作区中。
注: 有关如何从模板创建链的详细说明,请参阅 创建和管理链 文章。
变量
| 变量类型 | 变量名 | 描述 | 必需的? |
| 动态链 | dcv-exportStatus | 用于获取文档的导出状态。 | 是的 |
| 动态链 | dcv资源URL | 文档名称或ID值。 | 是的 |
| 工作区 | wsv-客户端ID | 从您的 Workiva 连接器的 OAuth2 授权中生成的 ID。 | 是的 |
| 工作区 | wsv-Secret | 从 Workiva 连接器的 OAuth2 授权中生成的密钥令牌。 | 是的 |
| 工作区 | wsv-IAMURL | IAM主机覆盖URL。 | 是的 |
| 工作区 | wsv-平台URL | 平台 API 主机覆盖 URL。 | 是的 |
考虑因素
| 运行时输入 | 描述 | 选项 | 必需的? |
| 导出格式 | 指示导出格式。 | .pdf 或 .docx | 是的 |
| 导出ID | 文档的 ID。 | 是的 | |
| 导出文件名 | 上传文件或通过电子邮件发送文件时,可用于替换文件的默认名称。 | 不 | |
| 区段 | 要导出的文档中各部分的 ID。如果导出整个文档,可以留空。 | 不 | |
| Docx - 导出选项 | 导出为 .docx 格式时,此设置提供有关导出对象的规范。 |
|
不 |
| PDF导出选项 | 导出为 .pdf 格式时,此设置提供有关导出对象的规格说明。 |
|
不 |
注:如果可选字段留空,则整个对象将按原样导出,不应用任何规范。
电子邮件发送通知设置
要接收导出的文件,您还必须配置 Get (Final Resource) 命令,使其通过电子邮件通知:
- 在编辑“启动文档导出”链时,选择 “获取(最终资源) ”命令,然后单击 “编辑 。
- 点击信封图标打开 通知 屏幕。
- 点击 + 新通知 按钮。
- 打开“条件”下拉菜单,然后选择 成功。
- 打开“收件人”下拉菜单,选择所有应接收导出对象的用户的电子邮件地址。
- 打开“附件”菜单,选择“获取(最终资源)”命令输出的文件。
此过程会将一个 HTTP 文件发送给电子邮件的收件人。收件人随后必须手动将文件扩展名更改为所需的格式:
- File_name.txt. => file_name.pdf
- File_name.txt => file_name.docx
疑难解答
如果您的链式操作触发了错误或未能更新正确的数据,请检查以下情况是否属实:
-
所有工作区变量均正确。如果您使用的是沙盒工作区,请使用沙盒版本的 IAM/平台 URL。
-
您已包含所有必要的运行时输入,例如演示 ID 和导出 ID。
-
您已为 “获取(最终结果) ”命令配置了电子邮件通知设置。