Workiva Support Center

As an alternative to the built-in chain scheduler, the Control Sheet Scheduler chain template provides additional options for running a process on a custom schedule.

It works by comparing the current system date to the set of dates found in column A of your control sheet. If the current date is found, it runs the selected chain in the "run chain" node; if the current date is not found, the process ends.

Requirements

Control sheet

Using a spreadsheet, create a control sheet containing the dates when your chain will be run:

1. In cell A1 of your control sheet, enter the word Dates.

   Note: To prevent yourself from making accidental edits to cell A1, consider locking the cell.

2. Enter valid run dates in the Dates column you just created.
3. Starting on row 2, open the cell properties and verify all cells are in the "Date" format and match your system date's display format (e.g., 12/31/2022).
   

Chain to schedule

This template is used with a "Run chain" node as part of an existing chain. The control sheet you've created will manage the parent chain's execution.

Build your template

The Control Sheet Scheduler template is located in the Workiva Chains section of the Templates screen.

Here's how to find it:

1. In Chain Builder, go to the Templates dynamic_feed tab.
2. Select Workiva Chains from the menu at the top.
3. Search for Control Sheet Scheduler at the top right and open the template.
   

After locating your template, configure it to for your workspace using the variables listed below. 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.

Variables

Things to know

• Control Sheet Scheduler Placeholder chain: This sub-chain is a placeholder found in the "run chain" node. When implementing the template, you must update this node to your own chain.
• Conditional - Check for Today’s Date:This node must be connected to a new "run chain" event with a green success link. The new "run chain" event must then point to the chain that will be executed after this one is successful.

Troubleshooting

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

• The OAuth2 Grant associated with the Workiva connection has access to read the control sheet (both spreadsheet and sheet).
• You properly defined the date type and format in the properties of your control sheet.
• You entered the correct control sheet spreadsheet ID and sheet ID/Name into the chain variables. Make sure that the whole ID/Name is copied, and there are no leading or trailing blank spaces.
• You set the schedule on the Control Sheet Scheduler chain -- not the sub chain.
• You published the chain after the setup.
• You configured and established the schedule for the Control Sheet Scheduler chain and published the chain after changes were made to the schedule.