|
Classic file types are no longer available for use as of January 2021. You can transition your classic files or download a PDF. Learn More

Workiva Support Center

Get Workers command configuration tabs

Get Workers command configuration tabs

  • Last updated on
Note: 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

This 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. Under Worker request criteria mark (check) the checkboxes for the criteria filters. Select the classes of Workers that are to be excluded from the results.

    Class Description
    Inactive Workers Still employed but not currently working.
    Contingent Workers Currently working, on payroll, and performing job functions as a Contract employee.
    Employees Currently working, on payroll, and performing job functions as a Full-time employee.

  6. (Optional) Under Response filter, specify the effective date or entry date values that are to be used.

    Class Description
    As Of Effective Date The date the change becomes active or legally binding in the business world.
    As Of Entry Date The date the transaction was keyed into the system by an HR user or manager.
    Note: The default timezone setting for Workday tenants is Pacific (UCT -7). However, this can be changed, so it is possible for two tenants to have different time registration. 
  7. Under Field Inclusions, mark (check) the checkboxes for the fields that are to be included in the response.
    Note: Although your Workday tenant may store additional data, these are the only options available at this time.
Class Description
Include Company Name of Company that employs the Worker. (Typically this serves as the primary financial reporting unit.)
Include Cost Center The organization used for financial reporting to track and group expenses related to a specific department or project.
Include Department Subdivision of the company that the Worker is assigned to.
Include Location The physical site, office, or campus where the Worker is based or assigned to perform their work.
Include Manager Employee ID The unique Employee ID of the individual to whom the Worker directly reports in the supervisory organization.
Include Employee ID Employee identification number assigned to a Worker when hired, used for tracking and reporting purposes.
Include Employee Type Class of Worker (such as Regular or Contingent) used to categorize the Worker's relationship with the organization.
Include Management Level The Worker's level within the organization’s leadership structure.
Include Employee Email The primary email address (typically work-issued) used for system notifications and professional communication with the Worker.
Include Legal First Name The Worker’s given name as officially recorded on legal documents for payroll and regulatory reporting.
Include Legal Last Name The Worker's surname as it appears on official government-issued identification documents used for payroll and tax compliance.
Include Hire Date The official date on which the Worker began their employment relationship with the organization.
Include field that indicates if the employee is a rehire This field indicates whether the Worker has been previously employed by the organization before their current hire event.
Include Original Hire Date The original date on which the Worker began their employment relationship with the organization. Important for rehires.
Include field that indicates if the employee is active This field indicates whether the Worker is actively employed by the company.
Include field that indicates if the employee is retired This field indicates whether the Worker is retired.
Include field that indicates if the employee is terminated This field indicates whether the Worker has been terminated from the company.
Include Termination Date The official date on which the Worker’s employment legally ended.
Include Last Day of Work Date The final calendar day a Worker is physically present or performing duties before their termination or leave begins.
Include Pay Through Date The final date for which the terminated Worker is eligible to receive compensation, this may extend beyond the last day of actual work.
Include is Exempt This field indicates whether the Worker is exempt from overtime pay requirements according to labor laws such as FLSA.
Include Job Title The descriptive name for the Worker’s position that reflects their specific role or professional rank within the company.

Include is on Leave


 

 This field indicates whether the Worker is currently away from work on PTO/vacation/Sick leave, etc.
Include Leave Type The specific category of a leave of absence, for example: FMLA, Personal, or Military leave, which determines the rules and pay.
Include Primary Home Address Line 1 The first line of the Worker's primary residential address, typically containing the street number and name.
Include Primary Home Address City The specific city associated with the Worker’s primary residence. (Used for tax and contact purposes.)
Include Primary Home Address State The state, province, or territory associated with the Worker's primary residence for tax and legal purposes.
Include Primary Home Address Country The nation where the Worker’s primary residence is located, used for international compliance and formatting.
Include Primary Home Address Postal Code The zip or postal code for the Worker’s primary residence. (Used to determine local tax jurisdictions and mailing.)
Note: The command selections (including the date and which options are chosen) are preserved, so you will see the same selections when you open the command tab again.

 

Notifications tab

The Notifications tab lets you set up a notification email that is 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. 
  5. Click Save.

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

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.

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.
    manage-commands_04.png

  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.
  1. 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.
  2. 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.
Was this article helpful?
0 out of 0 found this helpful
Note: Clicking Cancel on any of these tabs closes the command configuration dialog. Any changes you have made since ...