Data steps

Describes how to use the data steps.

Create record

General info
CategoryDescription
DataThis step generates a new record instance within the database.
Inputs
LabelTypeRequiredVisibilityDescription
EntityentityyesAlwaysEntity to create a new record instance.
DatadataBodyyesAlwaysData to be used to create record.
Outputs
NameTypeDescription
createRecordrecordCreate record instance.
Sample
Create record flow step image
The flow begins, and the "create record" step generates a new record. Following this, the execution concludes with the "end" step. Should an error occur during the record creation process, the error will be logged, and the execution will terminate.

Delete data

General info
CategoryDescription
DataThis step deletes data from the specified entity.
Inputs
LabelTypeRequiredVisibilityDescription
EntityentityyesAlwaysThe entity to delete data.
Queryquerynoconfig.entityThe query used to filter records to be deleted.
Wait task to finishbooleannoAlwaysFlag to set if the deletion should wait for the job to finish.
Outputs
NameTypeDescription
taskIdtextThe task ID in charge of the execution of the deletion.
Sample
Delete data flow step image
The flow initiates, and the "delete data" step removes data from an entity. Subsequently, the execution concludes with the "end" step. If any errors arise during the data deletion process, they will be logged, and the execution will be terminated.

Delete record

General info
CategoryDescription
DataThis step deletes the specified record.
Inputs
LabelTypeRequiredVisibilityDescription
RecordrecordyesAlwaysThe record instance to be deleted.
Outputs
NameTypeDescription
deletedRecordrecordThe deleted record.
Sample
Delete record flow step image
The flow initiates, and the "delete record" step deletes a specific record. Subsequently, the execution concludes with the "end" step. If any errors occur during the record deletion process, they will be logged, and the execution will be terminated.

Execute action on data

General info
CategoryDescription
DataThis step performs an action on the records returned by a query.
Inputs
LabelTypeRequiredVisibilityDescription
EntityentityyesAlwaysThe entity to which the actions belongs.
ActionentityActionyesAlwaysThe action to be executed
Queryqueryyesconfig.entityA filter used to identify the records on which to execute the action.
DatadataBodynoAlwaysPrecise data to be transmitted to the action.
Wait task to finishbooleannoAlwaysA flag to indicate whether the action should wait for the task to finish.
Outputs
NameTypeDescription
taskIdtextThe task ID in charge of the execution of the action.
Sample
Execute action on data flow step image
The flow begins, and the "execute action on data" step executes actions on the identified records. Subsequently, the execution concludes with the "end" step. If an error occurs during the action execution, the error will be logged, and the execution will be terminated.

Execute action on record

General info
CategoryDescription
DataThis step performs an action on one record
Inputs
LabelTypeRequiredVisibilityDescription
EntityentityyesAlwaysThe entity to which the actions belongs.
ActionentityActionyesAlwaysThe action to be executed.
RecordrecordyesAlwaysThe record to be modified by the action.
DatadataBodynoAlwaysPrecise data to be transmitted to the action.
Outputs
NameTypeDescription
actionResultobjectA record or a custom response, depending on the action’s configuration.
Sample
Execute action on record flow step image
The flow initiates, and the "execute action on record" step performs actions on a record. Subsequently, the execution concludes with the "end" step. In the event of an error during the action execution, the error will be logged, and the execution will terminate.

Execute global action

General info
CategoryDescription
DataThis step executes an action at the entity level, which implies that the action does not require any parameters to specify affected records.
Inputs
LabelTypeRequiredVisibilityDescription
EntityentityyesAlwaysThe entity to which the actions belongs.
ActionentityActionyesAlwaysThe action to be executed.
DatadataBodynoAlwaysPrecise data to be transmitted to the action.
Wait task to finishbooleannoAlwaysA flag to indicate whether the action should wait for the task to finish.
Outputs
NameTypeDescription
taskIdtextThe task ID in charge of the execution of the action.
Sample
Execute global action flow step image
The flow begins, and the "execute global action" step executes an action at the entity level. Subsequently, the execution concludes with the "end" step. If an error occurs during the action execution, the error will be logged, and the execution will be terminated.

Find data

General info
CategoryDescription
DataThis step retrieves data using a specified query.
Inputs
LabelTypeRequiredVisibilityDescription
EntityentityyesAlwaysThe entity to which the data belongs.
Queryquerynoconfig.entityThe query used to filter records
Outputs
NameTypeDescription
recordsResultSetresultSetA collection of records that can be iterated through.
Sample
Find data flow step image
The flow initiates, and the "find data" step conducts a search for data using a query. Following this, the retrieved data is logged, and the execution concludes with the "end" step.

Find record

General info
CategoryDescription
DataThis step retrieves a record using a specified query.
Inputs
LabelTypeRequiredVisibilityDescription
EntityentityyesAlwaysThe entity to which the data belongs.
Queryquerynoconfig.entityThe query used to filter records
Outputs
NameTypeDescription
resultRecordrecordThe record instance that matches the filtering.
Sample
Find record flow step image
The flow begins, and the "find record" step searches for a specific record using a query. Subsequently, the located record is logged, and the execution concludes with the "end" step.

Find record by Id

General info
CategoryDescription
DataThis step retrieves a record using it ID.
Inputs
LabelTypeRequiredVisibilityDescription
EntityentityyesAlwaysThe entity to which the data belongs.
Record IDtextyesAlwaysID of the record.
Outputs
NameTypeDescription
resultRecordrecordThe record instance.
Sample
Find record flow step image
The flow begins, and the "find record by id" step searches for a specific record by its unique identifier. Following this, the identified record is logged, and the execution is finalized with the "end" step.

Lock record

General info
CategoryDescription
DataAcquires a lock for a specified record. This method is recommended when multiple threads attempt to access the same record, especially in scenarios involving concurrent execution of listeners or actions.
Inputs
LabelTypeRequiredVisibilityDescription
RecordrecordyesAlwaysThe record instance to be locked.
Outputs

No configuration required.

Sample
Find record by id flow step image
The flow initiates, and the "lock" step obtains a lock for a specified record to prevent any listener or action from altering the record while we perform subsequent actions. Following this, the "update record" step modifies the record's data, and these changes are saved using the "save record" step. Subsequently, a success message is logged with the "logger" step, and the execution concludes with the "end" step.
In the event that the lock cannot be acquired, an error message will be logged using the "logger" step.

Update record

General info
CategoryDescription
DataThis step manipulates a record, applying changes to it and storing these modifications in the database, effectively making the changes permanent.
Inputs
LabelTypeRequiredVisibilityDescription
RecordobjectyesAlwaysThe record instance to be saved into the database after applying changes.
DatadataBodyyesAlwaysData to be used to update record.
Outputs
NameTypeDescription
updatedRecordrecordThe updated record instance.
Sample
Update record flow step image
The flow begins, and the "update record" step modifies the data of a record. Subsequently, the changes are saved by the "save record" step, and the execution concludes with the "end" step. If an error occurs, it will be logged, and the execution will be terminated.

Save record

General info
CategoryDescription
DataThis step saves a record in the database, rendering the changes made to it permanent.
Inputs
LabelTypeRequiredVisibilityDescription
RecordobjectyesAlwaysThe record instance to be saved into the database after applying changes.
Outputs
NameTypeDescription
savedRecordrecordThe saved record instance.
Sample
Update record flow step image
The flow begins, and the "find record by id" step searches for a specific record by its unique identifier. Following this, the identified record is logged, and the execution is finalized with the "end" step.