Chain template: Initiate Document Export

The Initiate Document Export template allows you to export Workiva documents in HTTP format, which can then be converted to a PDF or DOCX file. This feature is commonly used to back up documents, enable offline editing, or to share Workiva documents with users outside the workspace.

Requirements

You must have access to the Client ID and Client Secret through your OAuth2 grant.
The following connectors must be configured in your workspace:
- HTTP
- Handlebars

Build your template

The Initiate Document Export template is located in the Workiva Chains section of the Templates screen.

Here's how to find it:

In Chain Builder, go to the Templates dynamic_feed tab.
Select Workiva Chains from the menu at the top.
Search for Initiate Document Export at the top right and open the template.

After locating your template, configure it to for your workspace using the variables and runtime inputs listed below.

Note: For detailed instructions on creating a chain from a template, see the Create and manage chains article.

Variables

Variable type	Variable name	Description	Required?
Dynamic Chain	dcv-exportStatus	Used to capture the export status of the document.	Yes
Dynamic Chain	dcv-resourceURL	The document name or ID Value.	Yes
Workspace	wsv-ClientID	ID generated from the OAuth2 Grant for your Workiva connector.	Yes
Workspace	wsv-Secret	Secret token generated from the OAuth2 Grant for your Workiva connector.	Yes
Workspace	wsv-IAMURL	The IAM Host Override URL.	Yes
Workspace	wsv-PlatformURL	The Platform API Host Override URL.	Yes

Considerations

Runtime input	Description	Options	Required?
ExportFormat	Indicates the format of the export.	.pdf or .docx	Yes
ExportID	The ID of the document.		Yes
ExportFileName	Can be used when uploading or emailing to replace the default name of the file.		No
Sections	The IDs of the sections within the document to export. Can be left blank if exporting the entire doc.		No
Docx - Export Options	When exporting to .docx, this provides specifications on the exported object.	includeLeaderDots showTableCellShading	No
PDF Export Options	When exporting to .pdf, this provides specifications on the exported object.	includeAlternateRowFill includeAttachmentLabels includeComments includeHyperlinks tagForWebAccessibility useCmykColorspace includeTrackChanges includeLeaderDots includeDraftWatermark	No

Note: If the optional fields are left blank, the entire object will be exported with no specifications applied.

Email delivery notification setup

To receive the exported file, you must additionally configure the Get (Final Resource) command with an email notification:

While editing the Initiate Document Export chain, select the Get (Final Resource) command and click the Edit create pencil.
Click the envelope icon to open the Notifications screen.
Click the + New notification button.
Open the "Condition" dropdown menu and select Success.
Open the "Recipients" dropdown menu and select the email of all users who should receive the exported object.
Open the "Attachments" menu and select the file output from the Get (Final Resource) command.

This process will send the recipient of the email an HTTP file. The recipient must then manually rename the file's extension to the desired format:

File_name.txt. => file_name.pdf
File_name.txt => file_name.docx

Troubleshooting

If your chain triggered an error or failed to update the correct data, check that the following is true:

All workspace variables are correct. If you're using a sandbox workspace, use the sandbox version of the IAM/Platform URLs.
You have included all the necessary runtime inputs, such as the presentation and export ID.
You configured an email notification setting for the Get (Final Result) command.

Support

Community

Workiva Support Center