Process Definitions: Wait Events Tab

Raise Events and Wait Events are not specific types of event objects. Rather, they are fields on a Process Definition or Chain Definition. A Process Definition or Chain Definition with a Wait Event will not execute until that event is raised.

A Process Definition or Chain Definition can have more than one Wait Event. Processes based on such definitions will not execute until all of their Wait Events have been raised. When a process is created for a Process Definition, that process must wait for all associated events to be raised. A process that is waiting for an event is given the EventWait status.

Note: A process waits only once for a specific event. So if the event was raised, but the process did not start (for example, due to the closing of a Queue), the process does not wait again for an event from the same event definition the next time the Queue is released.

The Wait Events tab of the Process Definition editing pop-up window includes the following controls.

Name Description
Event Definition The event the Process Definition should wait for.
Auto Submit

Lets you control what happens when the Wait Event is raised. Make sure that all parameters (if any) have default parameter values and a default Queue is set. The options are as follows.

  • Never: The process will not be automatically submitted when the Wait Event is raised.
  • Always: The process will always be automatically submitted when the Wait Event is raised.
  • Only one: The process will be automatically submitted only if there is no other process based on this Process Definition that has reached the status of Running.

Note: A process that is waiting for an event must be scheduled before it reaches the EventWait status.

Clears Event If this is box is checked, the process triggered by the Wait Event will clear the event. This allows other processes that share this Wait Event and execute later to react when the Wait Event is next raised.
Clear Comment The comment to be automatically logged by this process when the Wait Event is cleared.
Only Waited For When > Time Window

Lets you use a Time Window to control whether the Wait Event should trigger the process. You can specify that the Time Window must be open or closed in a particular time zone in order for the Wait Event to apply.

A few notes about this setting:

  • To make this calculation, a time zone must be known for the Time Window. If the Time Window does not have an associated time zone, the default time zone is assumed for that Time Window.

  • If the Wait Event is raised, and then the Process is submitted during the Time Window, the Process runs.

  • If a Process is submitted during the Time Window, and then the Wait Event is raised, the Process runs when the Event is raised.

Only Waited For When > Expression

Lets you control whether the process is triggered by the Wait Event using a Boolean REL expression. If the REL expression evaluates to false, the Wait Event does not trigger the process.

For example: =Event.isEventRaised('MyPartition.MyEvent1') || Event.isEventRaised('MyPartition.MyEvent2')

Note: If both a Time Window and a Boolean REL expression are associated with a Wait Event, the REL expression will always be evaluated first. In this case, the Time Window will be evaluated only if the REL expression evaluates to true.