On Event Timeout

Copyright © Cloud Software Group, Inc. All Rights Reserved

Chapter 5 General Activities Palette : On Event Timeout

On Event Timeout

Process Starter

The On Event Timeout process starter specifies a process to execute when a Wait For ... activity discards an incoming event due to a timeout. A Wait For ... activity’s event timeout is specified by the Event Timeout field on the Event tab of the activity.

The default behavior for an event timeout is to confirm and then discard the event. You can override the default behavior by creating a process definition using the On Event Timeout process starter.

You can specify an On Event Timeout process definition for a specific event source (that is, a specific Wait For... activity). You can specify one or more On Event Timeout process definitions for specific event sources, but you should not create more than one process definition for the same event source. Once a Wait For... activity experiences a timeout, that timeout can only apply to one On Event Timeout process definition.

You can also specify that an On Event Timeout process definition applies to any event source that experiences a timeout. If there is no On Event Timeout specified for a particular event source, the process engine calls the On Event Timeout process definition whose Any Event Source field is checked.

Configuration

The Configuration tab has the following fields.

Field

Description

Name

The name to appear as the label for the resource.

Description

Short description of the process starter.

Any Event Source

Specifies that this process starter should execute when any event source experiences an event timeout, and there is no On Event Timeout process definition specified for the event source.

Event Source

Only appears when the Any Event Source field is unchecked. This field allows you to specify for which event source this process should execute when there there is an event timeout.

Only one On Event Timeout process definition can correspond to any event timeout. That is, you cannot create multiple process definitions and use the same Wait For ... activity the Event Source field.

Output

The output for the activity is the following.

Output Item

Datatype

Description

originatingProcess

string

The name of the process definition containing the activity that had the event timeout.

originatingActivity

string

The name of the activity that had an event timeout.

<event>

complex

The schema of the discarded event. If the Any Event Source field is checked on the Configuration tab, this appears as an element of type any. If a specific activity is supplied in the Event Source field, the output schema of that activity is provided.

Field	Description
Name	The name to appear as the label for the resource.
Description	Short description of the process starter.
Any Event Source	Specifies that this process starter should execute when any event source experiences an event timeout, and there is no On Event Timeout process definition specified for the event source.
Event Source	Only appears when the Any Event Source field is unchecked. This field allows you to specify for which event source this process should execute when there there is an event timeout. Only one On Event Timeout process definition can correspond to any event timeout. That is, you cannot create multiple process definitions and use the same Wait For ... activity the Event Source field.

Output Item	Datatype	Description
originatingProcess	string	The name of the process definition containing the activity that had the event timeout.
originatingActivity	string	The name of the activity that had an event timeout.
<event>	complex	The schema of the discarded event. If the Any Event Source field is checked on the Configuration tab, this appears as an element of type any. If a specific activity is supplied in the Event Source field, the output schema of that activity is provided.