The Workiva Scripting connector provides a simple way to run Python scripts within the Workiva platform. It functions independently of the full scripting experience, allowing non-technical users to execute scripts without digging into the underlying source code.
For a full list of compatible commands, see the Workiva Scripting commands article.
The scripting feature is currently only available as part of an Early Adopter Program. If you're interested in adding scripting to your workspace, contact your Customer Success Manager to discuss program participation.
Learn more about scripting requirements
Requirements
Before using the Workiva connector:
- An org security administrator must enable the Workiva Scripting connector through the Configurations screen.
- To run the chain in a test environment, you'll need the URLs to override the API's hosts and base paths.
Why should I use the Workiva Scripting connector over HTTP Request?
The HTTP Request connector requires additional logic to refresh bearer tokens and poll the status of the script. These requirements are eliminated by using the Workiva Scripting connector.
Moreover, the Workiva Scripting connector offers additional functionality such as the ability to use command outputs (like stdout and logs) elsewhere in a chain.
Connection setup
To set up the Workiva Scripting connector:
- From Chain Builder, click Connections , and then Create at the top right.
- Under Connector Connection, select Workiva Scripting and the default CloudRunner.
- Under Basic Info, enter a unique name and description to help identify the connector.
- Under Properties, enter the connection's details:
Property Details Client ID Enter the ID for the integration user's OAuth grant. This is randomly generated. Client secret Enter the secret for the ID property. This is randomly generated. Scripting server API (Optional) Enter the URL that will replace the default URL host and base path for the Scripting server API. This is typically done in testing environments. IAM host override (Optional) Enter the URL that will replace the default URL host and base path for the Identify and Access Management (IAM) endpoints. This is typically done in testing environments. Scripting API versions Select the version of the API to use. V1 is the default and is recommended for most users.
V0 will be removed in the near future.
- Select the environments to use the connection, and click Save.
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.
| Field | Value |
|---|---|
| Cerebral Host Override | https://h.app.wdesk.com/s/cerebral |
| Spreadsheets Host Override | https://api.app.wdesk.com/spreadsheets/v1/ |
| IAM Host Override | https://api.app.wdesk.com/iam/v1/oauth2/token |
| Admin Host Override | https://api.app.wdesk.com/admin/v1 |
| Graph DB Host Override | https://api.app.wdesk.com/graphdb/v1/ |
| Platform API Host Override | https://api.app.wdesk.com/platform/v1 |
| Field | Value |
|---|---|
| Cerebral Host Override | https://h.eu.wdesk.com/s/cerebral |
| Spreadsheets Host Override | https://api.eu.wdesk.com/spreadsheets/v1/ |
| IAM Host Override | https://api.eu.wdesk.com/iam/v1/oauth2/token |
| Admin Host Override | https://api.eu.wdesk.com/admin/v1 |
| Graph DB Host Override | https://api.eu.wdesk.com/graphdb/v1/ |
| Platform API Host Override | https://api.eu.wdesk.com/platform/v1 |
| Field | Value |
|---|---|
| Cerebral Host Override | https://h.apac.wdesk.com/s/cerebral |
| Spreadsheets Host Override | https://api.apac.wdesk.com/spreadsheets/v1/ |
| IAM Host Override | https://api.apac.wdesk.com/iam/v1/oauth2/token |
| Admin Host Override | https://api.apac.wdesk.com/admin/v1 |
| Graph DB Host Override | https://api.apac.wdesk.com/graphdb/v1/ |
| Platform API Host Override | https://api.apac.wdesk.com/platform/v1 |