Events
The Events section is available in the left menu under Events.
An event is a situation that can occur during a process. It may influence or be influenced by the process state. The term "event" includes process starts or completions, activity executions, document state changes, new messages, sub-process calls/returns, and more.
Events are generated using the Trigger Event activity and processed using the Wait for Event activity.
Event Processing
Events can be propagated and processed in different contexts:
- Within a single process instance
- By selected process instances
- By any instances of any processes
For event transmission between applications, an interface is used. Each event is uniquely identified by its name and can carry additional information. Processing can be:
- Synchronous – the event is triggered immediately.
- Asynchronous – the event is executed in the background.
The full event lifecycle includes:
- Event generation
- Data transmission
- Event identification
- Processing within the process
Event Attributes
Each event has the following attributes:
- Name – A unique event identifier.
- Description – A brief event description.
- Rules – Define event execution conditions.
- If an event is manually triggered within a case, rules are optional.
- Otherwise, rules must be defined as described below.
Event Rule Actions
Wait for Event
A task "Task Name" from the template "Template Name" waits for this event. The rule is automatically generated when using the Wait for Event activity in a template. More details [here].
Start Process
A process can be started when the Trigger Event activity is used in a template. More details [here].
- Process Template – Selects the template for the new process instance.
Respond to Event
Replies to an activated event as defined in the rule settings.
Start Cases from CSV
Creates new cases based on data from a CSV file or a dynamic table, using the selected process template and variable mapping. The CSV file can be selected from Administration > CSV, or dynamically defined via a case variable using curly brackets (e.g., {variable_name}
).
Update Case Variables from CSV
For each row in the CSV file:
- If a primary key matches an existing case, the case variables are updated based on mapping.
- If no matching case exists, no action is taken.
- CSV or a dynamic table can be used, with the file name defined dynamically.
Start and Update Cases from CSV
For each row in the CSV file:
- If a primary key matches an existing case, the case variables are updated.
- If no matching case exists, a new case is created, and variables are set according to mapping.
- CSV or a dynamic table can be used, with dynamic file naming.
Update a Single Case from CSV
Updates a single existing case based on the provided data and mapping.
- CSV or a dynamic table can be used, with dynamic file naming.
Update Dynamic Lists from CSV (Deprecated in v4.0)
From Version 4.0, user-defined dynamic list variables cannot be updated. They have been replaced with dynamic tables, which support both user updates and CSV imports. When upgrading from older versions, dynamic lists remain visible but cannot be modified. Attempting to execute a rule that uses this feature will cause an error and halt the process.
Export All Cases as CSV
Creates a CSV file containing all cases from the selected template. The processing time depends on the number of cases. While there is no limit to the number of cases, processing time is subject to server timeout settings.
Scripts & Integrations
REST Connector
Allows integration with REST APIs. It serves as a predecessor to using curl functions in calculations. The following parameters are required:
- Rest URL – The target URL of the request.
- Rest Method (GET/POST) – Defines the request type.
- Rest Body (NEON/JSON format) – The request body.
- Rest Headers (JSON format) – The request headers.
- Calc Binding – Allows calculations after request execution, using TAS functions and special variables:
@error
– Stores errors from the script.@result
– Stores the script output.
Attach Document
Maps a document reference to a case, appearing as a regular attachment. Variables can be inserted using {variable}
syntax.
Input Variables:
- FILE_PATH – Full document path (e.g.,
/scan/sorted/CZ-test/Email_text_2310547.pdf
). - IPROC_ID – The case ID where the document will be attached.
- USER_ID – The ID of the user uploading the document (defaults to Admin unless otherwise specified).
- FILE_NAME – The resulting file name.
Output Variables:
- result/error – Stores the output of the script execution.
Updated
by Anna Gernát