Flow Step Types

About Flow Steps

Flow steps are the building blocks of your flow. Each step has a specific job, helping the flow do different tasks. By using these steps, you can build complete flows. Let's look at each step type and what it does.

Add Item To Collection

Used to add a new item into an existing list or collection.

Parameter	Required	Description
Collection	Yes	The list or collection where the item will be added.
Item	Yes	The item to be added (must be of the same type as the list)

New Variable

Used to create a new variable with a specified type.

Parameter	Required	Description
Type	Yes	The data type of the new variable (e.g., boolean, integer, decimal, float, money, string, entity, option set...).
Is List	No	A boolean flag indicating if the variable represents a list.

Assign Variable

Used to set a specific value to an existing variable.

Parameter	Required	Description
Variable	Yes	Choose from the previously created variables to which you want to assign a value.
Value	Yes	The value to be assigned, which depends on the selected variable's type.

Set Output

Used to set a value, to one or more of the available output variables

Parameter	Required	Description
Output's	Yes	Allow you to set a value, to one or more of the available output variables

Loop

Used to repeat a set of actions until a particular condition is met.

Parameter	Required	Description
Start Index	Yes	The starting point for the loop iteration
Count	Yes	Number of times the loop should iterate

Raise Error

Used to trigger an error condition, typically to handle unexpected scenarios or specific conditions within the flow.

Parameter	Required	Description
Error Code	Yes	A unique code associated with the error to aid in identification.
Error Message	Yes	A descriptive message providing details about the triggered error.

Remove Item From Collection

Used to delete a specific item from a list or collection.

Parameter	Required	Description
Collection	Yes	The list or collection from which the item will be removed.
Item	Yes	The item to be removed from the collection.

Switch

Used to evaluate a specific operand and direct the flow based on its value.

Parameter	Required	Description
Operand	Yes	The value or variable to be evaluated in the switch step.

Condition

This step evaluates a specific expression and directs the flow based on its result.

Parameter	Required	Description
Condition (Expression)	Yes	The logic or formula to be evaluated in the condition step.

Iterator

Used to processes each item in a collection one by one.

Parameter	Required	Description
Collection	Yes	The list or collection to be iterated over.

Run Logic Block

Executes a predefined flowOn block.

Parameter	Required	Description
Logic Block Type	Yes	The specific logic block to run.
Inputs	No	The data/inputs that the logic block will use (e.g., entity).
Outputs	No	The expected output from the logic block (e.g., result) to be added to the flow context.

Run Logic Flow

Executes a predefined flowOn flow.

Parameter	Required	Description
Logic Flow Type	Yes	The specific logic flow to execute.
Inputs	No	The data that the logic flow will use
Outputs	No	The expected output from the logic flow to be added to the current flow context

Associate Relationship

Creates a link between two entities, denoting a relationship.

Parameter	Required	Description
Entity	Yes	The primary entity you're working with.
Entity ID	Yes	The unique identifier of the primary entity.
Relationship	Yes	The type or name of the relationship being formed.
Entity Reference	Yes	The reference to the secondary entity you're linking to the primary entity.

Associate Multiple Relationship

Establishes multiple relationships between a primary entity and several other entities.

Parameter	Required	Description
Entity	Yes	The main entity you're working with.
Entity ID	Yes	The unique identifier of the main entity.
Relationship	Yes	The type or name of the relationships being formed.
Entities	Yes	References to the other entities you're linking to the primary entity.

Disassociate Relationship

Removes a previously established relationship between two entities.

Parameter	Required	Description
Entity	Yes	The main entity you're working with.
Entity ID	Yes	The unique identifier of the main entity.
Relationship	Yes	The name of the relationship to disassociate.
Entity Reference	Yes	The reference to the other entity to unlink.

Disassociate Multiple Relationship

Removes multiple relationships that have been previously established between a primary entity and several other entities.

Parameter	Required	Description
Entity	Yes	The main entity you're working with.
Entity ID	Yes	The unique identifier of the main entity.
Relationship	Yes	The name of the relationships to disassociate.
Entities	Yes	References to the other entities being unlink.

Execute Query

Facilitates running a specific query against an entity to fetch or manipulate data, based on various conditions and criteria.

Parameter	Required	Description
Multiplicity	Yes	Determines how many records the query should return (Single, Multiple).
Entity	Yes	The specific entity type you're querying against.

Execute Multiple Requests

Execute multiple entity-related actions in a batch, encompassing creation, update, and deletion operations.

Parameter	Required	Description
Entities To Create	No	List of entities you intend to create within the crm.
Entities To Update	No	List of entities that need updates, specified with their changes.
Entities To Delete	No	List of entities that you want to remove from the crm.

Get Entity By ID

Retrieves an entity instance using its unique identifier.

Parameter	Required	Description
Entity	Yes	The type of entity you're looking to retrieve. (e.g., Account, Contact)
Entity ID	Yes	The unique identifier of the entity.
Properties	Yes	Specific attributes or fields you want to fetch.

Get Entities By Relationship

Fetches entities based on their relationship with a specified entity.

Parameter	Required	Description
Relationship Type	Yes	Specifies the nature of relationship (e.g., one to one, many to many).
Entity	Yes	The main entity you're working with.
Entity ID	Yes	The unique identifier of the main entity.
Relationship	Yes	The specific relationship used to determine which entities to retrieve based on their link with the main entity.

Set Entity Properties

Assigns or modifies the attributes or properties of an entity.

Step Type	Required	Set Entity Properties
Entity Type	Yes	The type of the entity being modified (e.g., Account, Contact)
Entity	Yes	The specific entity instance you're modifying
Properties	Yes	Attributes or properties of the entity that you wish to modify. You can choose to: Set (Assign or modify values.), Unset (Remove or clear values.)

Save Entity

Saves or updates an entity instance in the crm.

Step Type	Required	Save Entity
Entity	Yes	The specific entity instance you're saving.

Delete Entity

Removes a specific entity from the crm using it's ID.

Parameter	Required	Description
Entity	Yes	The type of entity you want to delete.
Entity ID	Yes	The unique identifier of the entity.

Halt

Used to immediately terminate the flow. It's especially beneficial when encountering errors or particular conditions that require an abrupt stop. It's important to note that once a "Halt" step is integrated into the flow, no additional steps can be added below it.