These commands allow you to run scripts using the Workiva Scripting connector.
Learn more about scripting requirements
Requirements
- An org security administrator must enable the Workiva Scripting connector through the Configurations screen.
Run Script
Use the Run Script command to run scripts based on script ID.
Equivalent API call: https://developers.workiva.com/prototype-platform/prototype-scriptexecution/
Properties
| Property | Detail |
|---|---|
| Script ID | Enter the ID of the script that will be run. |
| Script environment variables | (Optional) Use the switch to enable environment variables, and enter any custom values provided to the running process. |
| Polling frequency (seconds) | Enter, in seconds, how often to check for script completion. Defaults to a minimum of 10 seconds. |
| Output schema | To enable later commands in the chain to access this command's output properties, enter a sample payload for each JSON output. |
Outputs
| Output | Output Type |
|---|---|
| Logs | text file |
| Data output | JSON |
| Script Run ID | |
| Errors | JSON |
Note: To return a script output as JSON, include the '::set-output ' string in the script. Learn more.
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Failure |