Skip to main content

Function Step

The Function step runs automated logic in your workflow without needing a person to do anything. Use it when you need to call a service, transform data, send a notification, or perform any other background operation.

Configuring the Function Step

Click on the Function step in the canvas to open the properties panel on the right side.

  1. Select the function model you want to run. This is a function you have already created separately as a Workflow Function model.
  2. Set up input mappings to pass data from the workflow into the function.
  3. Set up output mappings to bring results from the function back into the workflow.

Available Steps Inside a Function

When you build a Workflow Function model, you can use any of the following steps to design your logic:

Steps available in the Function model editor

StepWhat It Does
Start / EndEvery function begins with a Start and ends with an End step.
DecisionAdds conditional logic to branch the flow based on values.
ScriptWrite custom code to process data.
FunctionCall another function model from within this one.
Rest ServiceCall an external REST API.
Soap ServiceCall an external SOAP service.
S3 File Upload / Download / DeleteUpload, download, or delete files from S3 storage.
DB EntityRead from or write to database records.
SetAssign values to variables.
CollectionWork with lists of data (filter, map, iterate).
Add ActivityAdd an activity record to the process history.
CounterGenerate sequential numbers.
WaitPause execution for a specified time.
Decision TableEvaluate rules defined in a decision table model.

Data Mappings

The mapping configuration controls how information moves between your workflow and the function.

Input Mappings

Input mappings send data from the running process into the function. For each mapping, you specify:

  • Variable -- the name of the function's input variable
  • Source -- where in the workflow the value comes from

Output Mappings

Output mappings bring results from the function back into the workflow. For each mapping, you specify:

  • Variable -- the name of the function's output variable
  • Target -- where in the workflow to store the result

Common Uses

Use CaseExample
Calling a serviceFetch customer data from an external API.
Transforming dataCalculate totals, convert formats, or enrich process data.
Sending notificationsSend a custom email or SMS outside the standard notification system.
Validating dataRun business rule checks before the process moves forward.
Updating external systemsWrite data to another database or application.