Workiva Support Center

Important: Clicking Cancel on any of these tabs closes the command configuration dialog. Any changes you have made since the last time you clicked Save will be discarded and cannot be recovered.

Modify command tab

The Modify command tab lets you set up what fields are to be considered or excluded when this command is run.

To modify this command:

1. Select the Modify command tab.
2. (Optional) In Name, modify the default name provided.
3. (Optional) In Description, enter a useful description of what the command is configured to do.

4. Under Command Properties, select the Workday Connection appropriate for this command and the connection type (CloudRunner or GroundRunner).

   Note: CloudRunner is the default selection, but this connection will also work using a GroundRunner. For information on installing and using a GroundRunner, refer to the Workiva Support page Install and manage GroundRunners.

5. Select the Input file to be used.
   This is a .csv file containing the source data. A template of this file may be obtained in the Workiva documentation.

   Note: If you are using an EIB template (see below), the CSV's headers must match the fields defined in the template file.

6. Under Budget configuration, enter the Budget Structure ID associated with the plan structure, and the Custom_Budget_ID associated with the financial plan name.

7. Select the Import mode to be used.

   Import mode	Behavior
   Incremental Add only	Adds new lines and updates existing ones. Does not delete anything.
   Replace All	Deletes the entire existing budget plan and replaces it strictly with the data in your file.
   Incremental Add with Delete	Syncs the system to match the uploaded file. Adds new, updates existing, and deletes any lines in the system that are missing from the uploaded file.
   Replace All by Period	Wipes and replaces data only for the time periods found in the uploaded file. Preserves data for other months/periods.

8. (Optional) Enter a Memo providing a description of the command's purpose.

9. Select the actions to trigger when this node completes.

   Command	Description
   Auto Complete	When marked (checked), the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically bypassed, and all notifications will be automatically suppressed.
   Submit	When marked (checked), the chain automatically submits the action.

The last field and checkbox is only for using EIB Templates. If you are not using an EIB template file, you can ignore both of these.

Note:The EIB template must be an XML file that defines the fields necessary for completing an Import Budget action. If specified, this will take precedence over the "Budget Configuration" data.

1. If you are using an EIB template file to import the budget data, enter the filename in the EIB template file field.
2. (Optional) Select the Ignore warnings checkbox to ignore all warnings for any missing optional fields.
   The template file will contain optional fields, so the command will throw an error if the fields are not present unless this option has been selected.
   This option is only applicable for import budget processes using an EIB template.

Notifications tab

The Notifications tab lets you set up a notification email to be sent when a condition is met.

To establish a notification:

1. Select the Notifications tab.
2. Click New notification.
3. Click Email.
   

4. Complete the fields on the notification panel. 

   

   Notification panel fields

   Field Name	Supported values and actions
   Condition	Supported conditions are: Success: the command has completed correctly. Error: the command has failed in some manner. Warning: this indicates that an intended result was affected, but there may be outstanding circumstances about how it came to be. Check the output logs of the command for more specific reasons about why this was triggered.  Pause is a status for the command. If the command is "paused" the notification will  be sent. It has nothing to do with pausing notifications. Always send: Always sends the message.
   Recipients	Email addresses (must be complete email address) that the message is to be sent to. Clicking in this field opens a dropdown listing all the email addresses valid for the workspace. No other emails can be provided.
   Subject	The subject line for the email. The default uses the Chain.Environment, Chain.Name, and Command Name variables, followed by the selected condition, but you can enter your own text if desired.
   Attachment	This allows you to attach a file to the email. Select the file from those listed in the Select a variable pane to the left of the configuration dialog.
   Attachment name	This is the name (including the extension, such as .txt or .csv) to be assigned to the file.
   Message Body	The text to appear in the email message. Basic HTML formatting is supported.

5. Click Save.

To send additional email notifications, click New notification below the current notification, and repeat these steps.

For more information on notifications, refer to the Workiva Support page Manage chain and command notifications.

Skip conditions tab

The Skip conditions tab allows you to specify a condition that will cause the command to be skipped, and what is to happen if the command is skipped.

To establish a skip condition for this command:

1. Select the Skip conditions tab.
2. Click in the Skip conditions field, and select the trigger condition.
   The options are: 
   • Success (the command has completed correctly).
   • Error (the command has failed in some manner).

   • Warning (this indicates that an intended result was affected, but there may be outstanding circumstances about how it came to be. Check the output logs of the command for more specific reasons about why this was triggered)

     

3. Create the rule that determines what happens when the command is skipped.
   1. Select AND or OR. By default the first instruction starts with AND.

   2. Click +RULE, and select the data type to test.
      Options are String (default), Integer, Date, Float, and JSON.

      

   3. Enter the criteria that is to be used for the test.

   4. Select the test value. Options are as follows:

      Option	Result
      Is Blank	Result is blank (an empty set).
      Is Not Blank	Result is not an empty set.
      Contains	Result contains a specific value. Selecting this opens a secondary field for you to enter the string to match.
      Matches RegExp	Result matches the specific regular expression. Selecting this opens a secondary field for you to enter the regular expression.
      Starts with	Result starts with a specific string. Selecting this opens a secondary field for you to enter the string.
      Ends with	Result ends with a specific string. Selecting this opens a secondary field for you to enter the string.
      = (equals)	Result matches a specific value. Selecting this opens a secondary field for you to enter the value.
      != (does not equal)	Result does not match a specific value. Selecting this opens a secondary field for you to enter the value.
      < (less than)	Result is less than a specific value. Selecting this opens a secondary field for you to enter the value.
      > (greater than)	Result is more than a specific value. Selecting this opens a secondary field for you to enter the value.
      <= (less than or equal to)	Result is less or equal to a specific value. Selecting this opens a secondary field for you to enter the value.
      >= (greater than or equal to)	Result is greater than or equal to a specific value. Selecting this opens a secondary field for you to enter the value to be considered.

4. If you only have one condition, click Save.
5. If you have more than one condition, click +RULE again to add a single condition, or +GROUP to make the conditions be evaluated as a group.

Notes

• Conditions are evaluated in the order that they are listed (Top to bottom). Grouped conditions are evaluated as a unit, and then the result of that is evaluated in the order that the group appears in the list.
• There is not a way to reorder the conditions; if you want to change the order of the conditions, you will have to recreate the list in the order that you want them to be evaluated.
• For more information on Skip conditions, refer to the Workiva Community page Skip Conditions: Not to Be Skipped, But Definitely Worth Considering! and the Workiva Support page Manage commands in chains.

Dynamic outputs tab

The Dynamic outputs tab allows you to specify rules to extract a value or list of values from a command's output, which can then be used later in the chain. You can add multiple dynamic outputs to a command using either:

• An exact match— to specific text at the start or end of values to extract.
• A regular expression— to match values based on a specific pattern or sequence.

To set the dynamic output rules, complete the following steps.

1. Select the Dynamic outputs tab.
2. Click +ADD DYNAMIC OUTPUT. This displays the dynamic output configuration panel.
   
3. Enter a Name for this output.
4. In Original output, select the output that is to be transformed.
5. Configure how the output is to be derived and stored. The following fields are all optional.
   • The Match text field can either contain the text that is to be matched or a regular expression.
   • To match the provided text exactly, select “Exact” in Match type.
   • To use a regular expression, select “Regular expression (regex)” in Match type.
   • In Match result, enter how the resulting text is to be displayed.
     For example if the result was digits enclosed in parentheses, you would enter $0 to display the whole matched value including the parentheses, or $1 for only the matched digits without the parentheses.
   • To match text in only specific lines of the output, enter the line number(s) or number range(s) separated by commas in Lines to check. To include a range of lines, use a dash (-), so 1-10 returns content only from lines 1 through 10. To separate lines or ranges, use a comma (,), so 1-10, 13 returns content only from lines 1 through 10 and line 13.
6. In Output type, select whether you want to return a single output or list of outputs.
7. Mark or clear the Case sensitive and Trim Matches checkboxes to produce the results you want.
8. Click Save.
9. (Optional) Click Test to see if you are getting the results you expect.

If you want to create an additional dynamic output, click +ADD DYNAMIC OUTPUT. This displays the dynamic output configuration panel for an additional dynamic output.

For more information on working with dynamic operators, see the Workiva Support page Manage dynamic outputs for a command.

Error actions tab

The Error actions tab allows you to specify what is to happen if an error occurs in processing the command.

To set actions to be taken if this command generates an error:

1. Select the Error Actions tab.
2. Under Error actions, select what action you want the chain to take if the command fails.
   • To follow the chain branching logic, select Continue with chain.
   • To stop the chain temporarily, such as to remedy the issue, select Pause chain. 
     To restart the chain after the issue is resolved, select the command in the chain, and click Resume.
   • To stop the chain completely, select Exit chain.
3. To stop the command if it is running longer than desired, under Timeout conditions, enter the maximum time for the task to run (in seconds).
4. To retry a command if its data source is intermittent or unavailable, enter the number of retries to attempt and how many seconds to wait between attempts.
   

5. Under Error conditions, select the errors to ignore.

   Condition	Description
   Invalid arguments	Marking this causes the command to ignore any invalid arguments.
   General failure	Marking this causes the chain to continue even though this command may have failed.

6. To set the status of the command based on its output, click the green-circled plus sign to the left of Output interpretation.
7. Click +Rule and define the rule —or group of rules— to interpret the output status.
   
   If you want to specify additional conditions, click the blue-circled plus sign to add additional condition definition fields.
   Conditions are evaluated in the order that they are listed (Top to bottom). Grouped conditions are evaluated as a unit, and then the result of that is evaluated in the order that the group appears in the list.

Note: There is not a way to reorder the conditions; if you want to change the order of the conditions, you will have to recreate the list in the order that you want them to be evaluated.

8. Under Log interpretation, select whether to fail the command based on specific outputs.
   • To not fail the command based on specific outputs, select Do not interpret.
   • To fail the command when specific outputs are found, select Fail if output(s) found, and enter the outputs to scan for.
   • To fail the command when specific outputs aren't found, select Fail if output(s) not found, and enter the output to scan for.
   • Separate multiple lines of text with \n.
9. Click Save.

Iterators tab

The Iterators tab allows you to set rules for iterating (cycling or repeating) the Get Workers command.

Note: This tab is disabled by default.

To set the iteration rules, complete the following steps.

1. Select the Iterators tab.
2. Enable the iterators by toggling the switch at the top of the tab. 
   
   Doing this changes the icon next to the tab head (Iterators) from dark grey to blue, and displays the Iterators configuration panel. The marker next to the tab title also becomes green.
   

3. Select the Modifier type to be used.
   Options are List (default) and Repeat until.

   • Selecting List causes the command to repeat the command over:
     • A static list of values, such as regions or entities. This can also be a number, such as "3".
     • A dynamic or variable list of values, such as from a file uploaded as a workspace resource or output from a command earlier in the chain.
   • Selecting Repeat until causes the command to repeat until the specified condition is met.

   Note: Commands are limited to a maximum of 1000 iterations.

4. Enter the rule(s) to control the iterations.
   For more information on using iterators, including how to specify them, see the Workiva Support page Use iterators with commands and command groups.
5. Click Save.