Skip to content

Trigger Process Activity

The Trigger Process activity enables the scheduling and execution of other processes or itself within a larger workflow. It allows users to define specific frequencies, times, and intervals for process initiation. Each triggered process runs as a child process, configured with a defined time period.

Field Description Requirement
Run once Allows the process to be run a single time. Optional
Run immediately Allows the process to execute without delay upon activity activation. Optional
Process key The unique identifier (Model Key) of the process to be triggered. This key is defined during process creation. Required
App key The application key, which must include level keys. Lower levels are separated by underscores. Optional
Priority Sets the execution priority order for the triggered process. Optional
Quartz definition A Cron expression defining the frequency, time, and timeframe for process execution (e.g., CRON/CRONTAB Expressions). Optional
Start date The scheduled start date and time for the triggered process. Must be a future or current date/time. Optional
End date The expiration date and time for the triggered process. Optional
Worker name The name of the worker assigned to execute the triggered process. Optional
Retry count The number of times the process should attempt to re-execute if it fails. Optional
Parameters Parameters to be passed to the triggered process, formatted as a JSON string. Allows multiple variables to be sent. Optional
Custom process instance name A dynamic name assigned to the resulting scheduled process instance, in place of the default auto-generated name. Supports variables (e.g., ${invoiceId}). Optional

Action Types & Examples

String Format (for Process Key, App Key, Worker Name)

  • Format: string
  • Example Result: ICU_Process

Cron Expression Format (for Quartz Definition)

  • Format: string
  • Example Result: 0 * * ? * *

Date/Time Format (for Start Date, End Date)

  • Format: string (YYYY-MM-DD HH:mm:ss)
  • Example Result: 2023-10-27 14:30:00

Integer Format (for Priority, Retry Count)

  • Format: digit
  • Example Result: 40

JSON String Format (for Parameters)

  • Format: string (JSON)
  • Example Result: {"from": "${sender}", "to": "${recipient}", "message": "${message}"}

Boolean Format (for Run once, Run immediately)

  • Format: boolean
  • Example Result: true

Implementation Examples

Field Setup - Process key: ICU_Process - App key: TopLevel_MiddleLevel_SubLevel_Appkey - Priority: 40 - Worker name: MyWorker - Run once: true - Custom process instance name: Invoice-${invoiceId}

Execution Parameters - Quartz definition: 0 * * ? * * (Runs every minute) - Start date: 2023-10-27 14:30:00 - End date: 2023-10-27 15:00:00 - Parameters: {"from": "${sender}", "to": "${recipient}", "message": "${message}"}

Technical Notes

Cron/Crontab expressions are used to schedule commands, scripts, or applications at specified times or intervals. They consist of seven fields: Second, Minute, Hour, Day of Month, Month, Day of Week, and Year. An asterisk (*) in a field indicates "every" unit of that field. For example, 0 * * ? * * means "at second 0 of every minute."

For detailed information and to generate Cron expressions, refer to: https://www.freeformatter.com/cron-expression-generator-quartz.html#crongenerator.

Custom process instance name lets a scheduled instance be identified by a meaningful name (e.g., an invoice number or customer name) instead of the default auto-generated instance name, making it easier to find a specific run on the Scheduled Processes screen. A date-time stamp is automatically appended to the name you provide.