Engine Steps

 Last updated: January 22, 2018     


Decision

Verify conditions and route workflow paths based on the results.

  • Step Name: Text field (required); set a name for the step. Must be unique.
  • Step Description: Text field; Allows you to give some insight into what expression you are searching for to provide more detail to people looking at the workflow.
  • Doc Launcher Config Name: Text field; Enter the exact name of the Doc Launcher Form as it appears in Preferences > Doc Launcher > Doc Launcher Forms.
  • Doc Launcher Config Template Name: Text field; Enter the exact name of the template used for the merge as it appears in SpringCM (with the .docx added to the end).
  • Salesforce Object ID: Text field; Will most likely be a <%#%> variable pointing to the Salesforce Object from which the Doc Launcher will be grabbing fields, if necessary.
  • Update Values: Text field; Enter the target identifiers and corresponding values that will then be merged into the document. Repeat this as necessary.
  • Output: Variable picker; allows you to store the outputted document and/or templates in separate variables to be used later in workflow.

Finish

This step is the final step of a workflow. Must be present and reached to resume a parent workflow (if waiting).

  • Step Name: Text field (required); set a name for the step. Must be unique.
  • Step Description: Text field; allows you to enter an optional description to provide more detail about the step.

For-Each Loop

Set an iterator for looping through an XML variable's data.

  • Step Name: Text field (required); set a name for the step. Must be unique.
  • Step Description (optional): Text field; allows you to enter an optional description to provide more detail about the step.
  • Iterator: Chooser window; set the XML iterator upon which you will be looping through. The XML iterator is an XML variable you have already configured with the type of "Iterator" and selected which XML variable you will be iterating/looping through.
  • Execution Method: Radio buttons; execution can be either serial or parallel. Default is serial.
  • Outputs:
    • Step - the line/output that is followed for the first step in the loop
    • Loop End - the line/output that is followed if the loop is done
  • Failure - the line/output that is followed if the step fails

For Loop

Iterations or cycles to run on the current context of the workflow lifecycle.

  • Step Name: Text field (required); set a name for the step. Must be unique.
  • Step Description: Text field; Step description is displayed below the step in the workflow designer and in the process monitor. It is used to describe a step in a meaningful way to be helpful in workflow administration and troubleshooting.
  • Variable: Number; The counter variable based on which the iterations or cycle will run. For every successful complete cycle, the counter variable will increase by 1.
  • Number of Loops: Number; defines how many times the loop should run. Whenever the variable value matches the number of loops value, the workflow control exists the loop.

Get Next Autonumber Value

Retrieves the next generated autonumber set up under Account preferences.

  • Step Name: Text field (required); set a name for the step. Must be unique.
  • Step Description: Text field; Step description is displayed below the step in the workflow designer and in the process monitor. It is used to describe a step in a meaningful way to be helpful in workflow administration and troubleshooting.
  • Name: Text field; you can drag and drop variables into this field as well as use expression builder to specify this field. Name of autonumber being referenced. Autonumbers are created and maintained in Account Preferences> Auto Numbers.
  • Output Variable: variable to which the user wants to save the generated autonumber. This can later be referenced in the workflow.

Logger

This step gives the user the ability to write a message that will be logged within the workflow monitor. This message can also be created using variables and expressions.

  • Message: Text field; create the message that is to be logged when the workflow reaches the step. Can also be written as an expression.

Next Loop

Increases a linked activity's loop count by one, only useful in combination with a For-Loop or ForEach-Loop.

  • Step Name: Text field (required); set a name for the step. Must be unique.
  • Step Description (optional): Text field; allows you to enter an optional description to provide more detail about the step.
  • Outputs:
    • Next Step - the line/output that is followed if the step runs without error
    • Failure - the line/output that is followed if the step fails

Resource Variable

This step is used to pass identifying information about a SpringCM User or a SpringCM Security Group to load the user(s) information into an Actor variable. This can be used when needing to access information only available about a user from the Actor variable or a check to verify if an email address stored in a simple variable matches a user in the SpringCM Address Book.

  • Step Name: Text field (required); set a name for the step. Must be unique.
  • Step Description: Step description is displayed below the step in the workflow designer and in the process monitor. It is used to describe a step in a meaningful way to be helpful in workflow administration and troubleshooting.
  • User: This will accept an Email Address, a User GUID, a Security Group Name, or a Security Group ID.
  • Expand Groups: Select Yes to include all users within selected groups. This is required to be set to True if the input is a Group Name or Group ID.
  • Output Variable: Identify user(s)/group(s) to be saved into variable. This variable should be an Actor variable type.

Rule

Examine a condition and route workflow based on results. Leverage to help automate workflow processes, such as to trigger different workflow steps based off a rule.

  • Step Name: Text field (required); set a name for the step. Must be unique.
  • Step Description: Text field; allows you to enter an optional description to provide more detail about the step.
  • Condition: Specify the condition which should be evaluated in this step.
  • Output: True or False

Set Workflow Output

Passes child workflow output to parent workflow.

  • Workflow Output: Text Field; Output to be passed back to parent workflow when step is reached. Can also be written as an expression.

Start

Every workflow canvas includes a Start step. The Start step is there as a marker so that you can easily locate the beginning of your workflow.

  • Workflow Name: Text field; the name of the workflow that displays in the Configure Workflows list.
  • Send notification when workflow encounters an error: Checkbox; sends an email when the workflow runs into an error in one of the steps.
  • Users To Receive Notification: Picklist; allows you to choose users from the Address Book who should receive notifications.
  • Track and record workflow activity: Checkbox; captures SpringCM TrackIt data, which provides information for reporting and analysis features in SpringCM.
  • Monitoring completed workflows: Dropdown menu; specifies a timeframe for capturing completed workflow data. Once the specified period is up, SpringCM no longer captures workflow activity data.
  • Monitoring failed workflows: Dropdown menu; specifies a timeframe that SpringCM captures workflow failure data. Once the specified period is up, SpringCM no longer captures workflow failure data.

Update Parent Value

Update parent workflow variable from a child workflow.

  • Step Name: Text field (required); set a name for the step. Must be unique.
  • Step Description: Text field; allows you to enter an optional description to provide more detail about the step.
  • Variable: Indicate the variable from the parent workflow you wish to update. Select the version of the parent workflow which should be updated with the variable value of the child workflow.
  • New Variable Value: Choose the variable whose value should be passed to the parent workflow.

Update Variable from CSV

This step allows for variable data that is stored in a csv to be accessed by the workflow. This step requires that the csv be constructed with rows and columns where the step will find a value determined by the workflow in a specific column header name to isolate the specific row of the csv. Once the row is found, then variable data can be retrieved from one or many columns identified by column header name where one variable can be updated per column header.

The lookup column should contain a unique list of values. If the list is not unique, then the first row in the list that matches will be used in the step.

  • Step Name: Text field (required); set a name for the step. Must be unique.
  • Step Description: Step description is displayed below the step in the workflow designer and in the process monitor. It is used to describe a step in a meaningful way to be helpful in workflow administration and troubleshooting
  • Upload CSV: Identify CSV file, which contains at least 2 columns of data. First row of such CSV file must contain header row with names of each column. CSV must be in SpringCM.
  • Field Name: Enter the column header name in CSV for the column that will be used searched for the row of data that contains the variables being retrieved
  • Search Field Value: Enter the value to be searched in the CSV column identified above
  • Repeating Set: The following two fields can be added multiple times for as many Column and Variable combinations should be updated from the csv.
  • Variable: The variable to be updated with value from CSV.
  • Field Name/Index: The column header from CSV, where the value to be saved to the variable should be found
  • Outputs:
    • Success - This is the line/output that is followed if the Search Field Value was found in the Field Name column of the csv.
    • Failure - This is the line/output that is followed if the Search Field Value was NOT found in the Field Name column of the csv.

Update Variable From XML

This step allows for an XML variable to be updated from an XML file located in the SpringCM account by using an XPath expression to identify the portion or node that should be loaded from the XML file into the variable.

  • Step Name: Text field (required); set a name for the step. Must be unique.
  • Step Description: Step description is displayed below the step in the workflow designer and in the process monitor. It is used to describe a step in a meaningful way to be helpful in workflow administration and troubleshooting
  • Upload XML: The XML file located in SpringCM from which variable data will be retrieved.
  • XPath: The XPath expression that will be used to retrieve the portion of the XML file that will be saved to the variable.
  • Variable: The Variable that has been defined within the workflow to store the data being retrieved from the XML file.
  • Outputs:
    • Success - This is the line/output that is followed if the variable was successfully updated.
    • Failure - This is the line/output that is followed if the variable was NOT successfully updated

Update Variable

This step allows for the storage of specific piece(s) of information for later use in the workflow process. Both XML and Simple variables can be updated using this step. Specific variable data stored only within the single workflow execution instance and is not available to other workflow instances unless the variable data is passed to another workflow explicitly by starting a sub-workflow via the “Workflow” step, updating variable of a parent workflow by using the “Update Parent Variable” step or by setting a workflow output of the parent workflow by using the “Set Workflow Output” step.

  • Step Name: Text field (required); set a name for the step. Must be unique.
  • Step Description: Step description is displayed below the step in the workflow designer and in the process monitor. It is used to describe a step in a meaningful way to be helpful in workflow administration and troubleshooting
  • Repeating Set: This set of fields allow for as many variables to be updated as required.
  • Variable: The variable to be updated within the workflow
  • New Variable Value: The input that defines the value to be stored in the Variable
  • Outputs:
    • Updated: This is the line/output that will be followed if the all the variables defined in the step are updated
    • Not Updated: This is the line/output that will be followed if any one of the variables defined in the step are NOT updated
    • Failure: This is the line/output that will be followed if any one of the variables defined in the step Fail in setting the value.