Raising Events
Processes can be used to raise events when they reach a specific status, this allows you to trigger other chains and processes.
When a process or chain raises an event, the Raiser Comment field contains information on the raiser, this can be further customized.
The default raiser comment is the following:
Event raised by process:${jobid} (${jobdescription}) going to status ${jobstatus}
.
The following substitution parameters are available for raiser comments in process definitions and chains:
${jobid}
- The ID of the raiser process.${jobdescription}
- the raiser name, as displayed by the processes monitor at the time of raising the event.${jobstatus}
- The status of the process at the time it raised the event.
Values
Tab | Field | Description | Default Value |
---|---|---|---|
Raise Events | Event Definition | The event definition the process will raise once it has finished. | |
Raise Events | Raise Comment | The comment the raised event will have. | Event raised by process:${jobid} (${jobdescription}) going to status ${jobstatus}. |
Raise Events | Status To Raise On | The status that makes the process raise the event once it reaches that state. | Completed |
Raise Events | Error Code | The error code of the process. | |
Raise Events | Only Raised When > Time Window | Time window to use for restricting when the event is used, either open or closed in the specified time zone or the default time zone, when omitted. | |
Raise Events | Only Raised When > Expression | Boolean REL expression (returning either true or false ) |
Examples
Attach an event to be raised on Weekends by processes of definition for status Completed.
Choose "Definitions > Processes".
On the Raise Events tab, choose Add.
Select an event definition, fill
Workdays
in the Time Window field, select System_Week_WorkDays, select closed in the is field.Choose Save to save the chain definition.
Attach an event to be raised by process 1 of the first step for status Error only if any of two events is raised.
Choose "Definitions > Chains".
Choose process 1 of the first step.
Choose Raise Events, choose.
Select an event definition, fill
=Event.isEventRaised('Mypartition.MyEvent1') || Event.isEventRaised('Mypartition.MyEvent2')
in the When expression field.Choose Save to save the chain definition.
JobChainRaiseEvent JobDefinitionRaiseEvent ProcessDefinitionRaiseEvent RaiseEvent