Set dynamic chain variables

With dynamic variables, you can define custom values when a chain runs or during the execution of a chain, such as based on a previous command's output. To pause a chain's run to prompt for dynamic variables' values before proceeding to the next command, include a Set Dynamic Chain Variables event. 

                                                                     Additional training available

Unlock the power of chains with our self-paced course in the Workiva Learning Hub! This comprehensive course guides you through the process of creating a chain from start to finish, providing hands-on experience and a deep understanding of the Chain Builder platform.

                                                                  Visit the Workiva Learning Hub

Step 1: Add the event to the chain

When adding an event to a chain, you set the default values for its first run; after that, the event automatically uses the values from its previous run. To set the values at the start of a chain's run, add a Runtime Inputs trigger event instead.

To add an event:

1. In Chain Builder, from the Chains  device_hub tab, click Edit create for the chain.
2. Click Chain Events  event, and move Set Dynamic Chain Variable  code to where the event should occur in the chain.
   
3. Drag a link to the event from the previous node in the chain.

   Note: To change a node's position in the chain, unlink it from other nodes, and then move it to where it should occur. To move multiple nodes at once, hold SHIFT as you select them.

Step 2: Set the dynamic variables' default values

1. Select the event's node, and click Edit  create.
   
2. Under Basic Info, enter a unique name and description to help identify the event.
3. Under Action, select the dynamic chain variable to set.
4. In Value, enter the variable's default value, or select the previous command's output or runtime variable to provide the value.

   Tip: To concatenate multiple values for a dynamic variable, such as to include a prefix or separator, select the values to use, and enter the text to appear before or after each.

5. To define additional dynamic variables, click Add add, and set their values.
6. Click Save.

Step 3. Add a skip condition (if necessary)

To set the variables based on branching logic, you can set up a skip condition and automatically return a specific result.

1. Under Skip skip_next, choose whether to automatically return a result of success  check_circle, warning  warning, or error  error for the event when skipped.
   
2. To specify when to skip the event, build the conditional logic as a group you add rules and other groups of rules to, each joined with an AND or OR.
   • If all conditions must be true to skip, select AND.
   • If only one condition must be true, select OR.
     
     
   You can add rules based on various data types:

   Data Type	Description
   String	Two or more characters
   Integer	Any whole, non-decimal numeric value
   Date	Any date string or Date variable
   Float	Any numeric value
   JSON	JavaScript Object Notation; use Variable Transformation to parse objects

   To verify whether data meets the criteria to skip the command, pair it with an operator and value:
   • Is blank or Is not blank
   • Contains
   • Matches RegExp, for regular expression
   • Starts with or Ends with
   • = or !=
   • < or >
   • <= or >=
3. Click Save.