The Update Status chain template allows you to track an integration or automation process by outputting status updates to a spreadsheet. Using a Run Chain event, you can execute this chain from other chains which execute long-running or multiple-step processes.
Requirements
- Before using this template, you must create a spreadsheet to which the status updates can be written.
Build your template
The Update Status 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 screen.
- Select Workiva Chains from the menu at the top.
- Search for Update Status at the top right and open the template.
After locating your template, configure it for your workspace. The changes will take effect once the chain is published.
Note: For detailed instructions on creating a chain from a template, see the Create and manage chains article.
Runtime Inputs
| Runtime Input | Purpose | Option Value | Required |
| Spreadsheet ID | The ID of the spreadsheet where the status updates will be written. | <text entry> | Yes |
| Sheet Name | The name of the sheet where the status updates will be written. | <text entry> | Yes |
| Status Update |
The information to write to the status tracker. For updates across rows, each value should be a new row. For updates across columns, enter a comma delimited list of values. |
<text entry> | Yes |
| Anchor Cell Address | Address of the first cell where the update will be written (e.g., B2). | <text entry> | Yes |
| Include Start Time | Include the start time as an additional status. This should only be selected at the start of an end-to-end process. | Yes/No | Yes; No value is selected by default |
Rows vs. columns
The Status Update runtime input can be used to output updates in either rows or columns.
This will produce the following result:
This will produce the following result:
Considerations
- Last Update Field: This process automatically adds the system date and time to the output. When an update is row-based, an additional row will be added to the status update with the current date and time. When the update is column-based, an additional column will be added to the status update.
- Process Start Time: If you choose "Yes" for the Include Start Time input, an additional column or row will be added after the last update field with the current system date and time. You should only use this feature at the very start of a process. By comparing the start time with the last update value, you can easily find the overall duration of the process.
- Multi-row, Multi-Column Status: This chain supports status updates that span multiple rows and columns in a single update. Please note that if you select the Last Update and Process Start Time, these values will be output as additional columns on every row.