Instant trigger
The flow is triggered programmatically by an Instant trigger from external or internal sources.
The Source property defines which callers are allowed to trigger the flow. When multiple sources are selected, the context must be compatible with all of them.
Forms are not supported.
Instant triggers support input parameters, which allow data to be passed into the flow at the moment it starts. These parameters complement the context data, such as a database model, and can be used throughout the flow. Once defined, input parameters are displayed in the Define mapping panel under the Dynamic content. You can map them to fields in any action within the flow.
Supported sources
Report, enabled by default
ARIS Process Mining insights, enabled by default
API, disabled by default
Properties
Name
Description
Initial check report
Executors (users and user groups)
Privileges
Input parameters
Input parameters allow you to pass data into a flow when it starts, in addition to any context items (like a database model).
Any input parameter has the following fields:
Field | Description |
|---|---|
Name | Display name (mandatory, maximum 255 characters) |
Technical name | Unique identifier used in mappings and APIs. No spaces or special characters are allowed. Auto-populated from the name, but can be changed. |
Description | Optional explanation of what the parameter represents. |
Required | The flow cannot start without a value for this parameter if enabled. When required, you must specify a default value. |
Data type | The data type of the value. |
Allow multiple values | If enabled, the parameter accepts a list of values. |
Default value | Pre-filled value used when no value is provided at start time of the flow. This field is not displayed when the Allow multiple values option is enabled. |
The following data types are supported for input parameters:
Data type | Description |
|---|---|
Text | Any text string |
Number | Integer values |
True/False | Boolean value |
Duration | A time duration, for example 3 days |
Date | A calendar date |
Date and time | A date combined with a time |
The Allow multiple values option is not supported for Duration, Date, and Date and time.
You can edit or delete parameters at any time. Deleting a parameter is permanent. Any mappings, conditions, or API calls that reference the deleted parameter may stop working.
Once defined, input parameters are available in the mapping panel under Dynamic content. You can map them to fields in any action within the flow.
Running a flow with parameters
Start a flow manually
When a flow is started manually in the flow builder using 
Run, the Run Configuration panel is displayed. This panel includes an Input parameters section where values can be provided before execution.
Input values depend on the parameter configuration:
Single value: Enter one value matching the parameter data type.
Multiple values (Text, Number, TRUE/FALSE): Enter values separated by commas, such as apple, ball, cat, or 1, 2, 3.
Required parameters must have a value before the flow can be started.
Values from the previous run are remembered for re-runs. Use the reset icon to clear them.
The Reset context items option only clears the context, such as the selected model. It does not clear parameter values.
Passing parameters via REST API
When a flow is started through the REST API, input parameters can be included directly in the request. This allows external systems to provide the necessary data at the moment the flow is triggered.
If required parameters are missing or contain invalid values, the flow will not start. In such cases, the REST API returns a structured error response that indicates the issue.
In addition, the REST API provides the ability to retrieve the list of supported input parameters for a specific flow. This helps ensure that requests are correctly structured before execution.
The REST API provides two V1 endpoints for working with trigger parameters:
GET /rest/v1/process/{processId}/input
Returns the list of parameters defined for a flow.
POST /rest/v1/process/{processId}/run
Starts a flow with parameter values passed as a flat JSON object.
For full details on request/response format, authentication, and error codes, refer to the documentation of the ARIS Process Management API under https://<ARIS Server>/apidocs.
V0 API (/rest/v0/...) remains unaffected. Use V1 only when working with trigger parameters.
Passing parameters via report 'Flows'
When a flow is started via the ARIS Flows report API, input parameters can be passed. If any required parameters are missing or invalid, the flow will not start and the report API returns an error response.
Use Context.getComponent("Flows") in your report script to access the Flows component and start a flow programmatically:
var flowId = "a1b2c3d4-e5f6-7890-abcd-ef1234567890"; // ID of the flow
var flows = Context.getComponent("Flows");
// Build the run context (what the flow operates on)
var ctx = flows.createRunContext();
ctx.addModel(ArisData.getSelectedModels()[0]);
// Build the input parameters (optional — only for flows that define them)
var params = flows.createRunParameters();
params.setTextParameter("applicantName", "Jane Doe");
params.setNumberParameter("priority", 1);
// Start the flow
var result = flows.runFlow(flowId, ctx, params);
if (result.getResultType() == "SUCCESSFUL") {
Context.setProperty("instanceId",result.getInstanceId());
} else {
Context.setProperty("error",result.getMessages().join(", "));
}
The flow must have the Report source enabled in the Source section of the Trigger configuration panel.
For further details about the ARIS report API and how to use it, refer to the command reference of the API for ARIS reports and macros.
Validation
Design time: Parameters are metadata only. Leaving the default value empty is valid.
Run time: Required parameters must have valid values. Invalid values prevent the flow from starting and error messages are displayed.
API calls: Validation is performed server-side before the flow instance is created.