Workiva connector

With the Workiva connector, you can use commands in chains to interact with the Workiva platform, including other Wdata features, Spreadsheets, and GraphDB. For example, with this connector, you can:

• Create and manage tables, queries, and views
• List a table's datasets or import errors
• Create and manage spreadsheets or their sheets
• Manage records and reports

Requirements

To interact with the Workiva platform, the connector uses the Workiva REST APIs. To set up the connector, you'll need:

• A dedicated Workiva integration user with an OAuth2 grant

  Note: This integration user requires appropriate permissions for the commands the connector performs, such as Owner of the spreadsheets or workspace it interacts with.

• The integration user's OAuth2 grant ID and secret
• To run the chain in a test environment, the URLs to override the API's hosts and base paths

Note: While the workspace's owners can access chains that use the connector, the connector itself requires a dedicated integration user to perform its commands. Using a dedicated integration user—instead of a collaborator's user account—enables to you track the connector's activity and limit its access to only what it needs to perform its commands.

Set up the Workiva connector

Note: To make the connector available for use in your organization's chains, an org security administrator first enables it from Configuration.

1. From Chain Builder, click Connections  compare_arrows, and then Create at the top right.
2. Under BizApp Connection, select Workiva and the default CloudRunner.
   
3. Under Basic Info, enter a unique name and description to help identify the connector.
4. Under Properties, enter the connection's details:
   
   

   Property	Details
   ID	Enter the ID for the integration users' OAuth grant.
   Secret	Enter the secret for the ID property.
   Cerebral host override	To override the URL host and base path for the Wdata endpoints, such as for a test environment, enter the URL to use instead.
   Spreadsheets host override	To override the URL host and base path for the Spreadsheets endpoints, such as for a test environment, enter the URL to use instead.
   IAM host override	To override the URL host and base path for the Identify and Access Management (IAM) endpoints, such as for a test environment, enter the URL to use instead.
   Admin host override	To override the URL host and base path for the Admin endpoints, such as for a test environment, enter the URL to use instead.
   GraphDB host override	To override the URL host and base path for the GraphDB endpoints, such as for a test environment, enter the URL to use instead.
   Platform API host override	To override the URL host and base path for the Workiva platform endpoints, such as for a test environment, enter the URL to use instead.

   Note: All sensitive credentials are automatically encrypted and stored at Advanced Encryption Standard (AES)-256 encryption.

5. Select the environments to use the connection, and click Save.
6. To test the connection, create and run a chain with the connector's List Files command, and verify it returns a valid output.

URL Overrides

Depending on the region of your production environment an override URL may apply.  You can verify this by comparing against the URL used to log into Wdesk.  If the URL contains EU or APAC an override is required.

Note: US region information is listed for reference.

Recipes

To automated connected reporting, use this connector with other connectors in a chain. For example, with this connector, you can:

• Build chains with the Update Datasets in a Table chain template
• Download a file from an SFTP server to upload to a Wdata table
• Extract data from Oracle Hyperion Financial Management to Workiva as a file
• Extract data from Oracle Hyperion Financial Management to Workiva via a relational database
• Create a Wdata table based on data exported another source and stored in an online directory
• Create new spreadsheets for connected reporting

Troubleshooting

If the connection to the Workiva platform fails:

• Verify the integration user's OAuth grant ID and secret, and ensure its scopes are correct.
• Ensure the integration user has appropriate permissions for the command being performed.
• If using a host override, check the URL entered for the connector.
• Check the ID of the Workiva file—such as the table, query, or spreadsheet—being interacted with.

Note: A file's ID appears in its URL when open in Workiva. For example, a spreadsheet's ID appears after spreadsheet/ in its URL; a table's ID appears after tables/.