Flow Management Step Glossary

A user can have more than one end point in a Flow and this step allows them to define additional outputs to a Flow. A user is expected to have different End Step names and they can define different data outputs at each End Step. If a user uses this Flow as a Subflow, they will see different outcome paths branching as a result.

The Branch Step allows for the process of multiple Flow steps in parallel rather than sequentially. Note that all branches must get merged back together using a 'Merge Step.'

This step joins back Branched paths of a Flow. When a Branched path reaches this step, it will wait by default, until all branched paths reach this step. To only be used after a Branch step or a Branch ForEach step, the AllowCancelMerge option allows the Flow to determine if the other branches should wait at this step for all to complete, or if there are circumstances where the Flow should continue. The MergeType option allows a user to determine whether this merge should be limited to this Flow, or if should include all subflows that contain branches as well. 

Leaps to the step specified in the enumerated list, "GoToStepName." This reduces the clutter of Flow lines that normally criss-cross and make a workflow difficult to follow.

Temporarily halts a Flow for a particular amount of time. An input data field allows the designer to designate when the Flow may resume operation and continue along the outcome path. The "SaveFlowDataOnPause" allows the user to ensure that the Flow data is saved to the database when the step is started.

The Step Statistics - Store step is used to store statistics pertaining to the steps that proceed the Step Statistics - Store step in a Flow. To store information, users simply place the step after the steps they wish to record statistics. Running the Flow will return a 'Done' result and update the Flow Step Statistics Report with the newly recorded statistics. Note: the Flow Step Statistics Report exists within the System > Designers > Catalog > System Defaults Folder.

The Log step is one of the best ways to record debugging level information in a Flow. The logging system uses a log level system and only logs when necessary which makes it very efficient. Use the LogStep instead of using Popups or Email in the Flow to get information about a Flow's execution.

The Output Data step is a powerful debugging/logging step. When executed, this step will output an array of all of a Flow's data including user defined types and Flow metadata. This step can be used to create logs after an exception is thrown, send emails with Flow details to designers, etc.

The Cancel Current Flow Execution step is used to stop the Flow presently running. This step is simply placed after the point in the Flow where the user wishes to cancel the Flow. This can be helpful to users who may want to stop a Flow or cut off a specific section of a Flow.

The Create Flow Parameters step is used to establish specific parameters for a Flow. The step works by utilizing a Data Definitions editor to establish the Parameters, similarly to how a Create Data step functions. Users then create the Parameters giving each one a Name, selecting a Data Type and establishing its Input. This step can be helpful to establish information that is associated with the Flow, such as a Task name or Due Date to establish what the Flow does and when its completion is due. Once the step has been set up, these Parameters may be altered and viewed via right-click Action within the Portal. For more info on this step, see linked documentation.

The Branch ForEach step creates a branch for each of array items passed in as input. It's important to note that a merge step will be needed following the process and that forms included within the branch will need to be encapsulated into a linked flow or sub-flow. 

The Is Flow Complete step is used to track progress and process logic for Flows.  The step does this by analyzing a Flow via its flow Tracking Id; this can be particularly helpful for tracking an externally ran Flow, or a Sub Flow. The step Outputs three paths based on its evaluation of the tracked Flow's progress; one for if it is 'Done' or complete, one denoting that it is 'In Progress', and one used for 'Error' handling. 

The Output Data to Current Folder step is used to Output an Array of all a Flow's data including User Defined Types, and Flow's Meta Data to the Folder that the Flow resides in. This step can be used to create logs after an exception is thrown, send Emails with flow details to designers, etc. 

This step checks for existing Flow Data or System Constants within the current Flow. 

The Add Comment to Sub State step is used in Process tracking to add additional information via a Comment, to a Sub State in a Process Flow. The step includes multiple String Inputs: comment, comment Description, state Name, and sub State Name, which are used to identify which State and Sub State the user-defined Comment is affiliated with.

The Add File to Sub State is a step used in Process tracking to add file to a Sub State in a Process Flow. The step takes in the file via the data Input; the name Input is used to name the uploaded file. The other two Inputs on the step pertain to the Process itself and allow the user to set a Name for both the State and the Sub State. This particular example utilizes an Approval State and a Sub State called Awaiting Signature denoting that the attached file entitled Sign And Return must be signed. 

The Complete Sub State step is used in Process tracking to mark when a Sub State in a Process Flow is completed. The Step takes in both the state and sub State via String Input. Upon completion, the user-defined Sub State will be marked as Complete in the Process Folder. The example utilizes a simple Approval State, with the Sub State being Awaiting Signature. A user would use this step to set the Sub State to Complete, denoting when the signature is obtained.

This step allows you to add some handling in the flow for paths or scenarios that are not connected to a step. You can even constrain which unconnected outcomes will be captured either by the name of the path and/or by the data output from that step. Catch Outcome step will return any data defined to capture and previous step information. 

The Step Statistics - Store step is used to store statistics pertaining to the steps that proceed the Step Statistics - Store step in a Flow. To store information, users simply place the step after the steps they wish to record statistics. Running the Flow will return a 'Done' result and update the Flow Step Statistics Report with the newly recorded statistics. The Flow Step Statistics Report exists within the System > Designers > Catalog > System Defaults Folder.

You can process a list of items with the ForEach Step. The ForEach Step can be used to create a flow loop to perform the same actions on each item within a list from the "Next" outcome. The "Done" outcome is used when all of the items in a list have been processed. The step will attempt to recognize the type of the list passed into the "Collection" input.