Wait For Event

Waits durably until a named external event is delivered, or a timeout passes.

Behaviour

Built-in workflow activity · type id velophex.waitforevent

Properties#

Input#

Event name#

EventName · String · Required · Default: event

Name hosts deliver the event to: letters, digits and . _ - : / only.

Payload type#

PayloadType · Type · Optional · Default: Not specified

Type the payload must have; leave empty to accept no payload.

Correlation key#

CorrelationKey · String · Optional · Default: Not specified

Optional string hosts can deliver the event by instead of the instance ID.

Output#

Payload to#

PayloadTarget · Payload type · Optional · Default: Not specified

Variable or argument that receives the payload.

Timed out to#

TimedOutTarget · Boolean · Optional · Default: Not specified

Boolean variable or argument set to true on timeout and false when the event arrived.

Options#

Timeout#

Timeout · TimeSpan · Optional · Default: Not specified

Optional duration after which the wait ends with a timeout instead of an event.

Common#

Continue on error#

ContinueOnError · Boolean · Optional · Default: False

When True and the activity fails (after its retries), the fault is logged as a warning and the workflow continues with the next activity; its output variables keep their values. A stop is never swallowed. Empty: False.

How it works#

Wait For Event waits durably for a named external event. While it waits, the instance holds no thread and can be unloaded. A host delivers the event by instance ID or by correlation key; only a hash of the correlation key is stored. The payload is validated against Payload type before anything changes. When Timeout passes first, the wait ends with a timeout outcome instead of an event.

Properties

Input

Output

Options

Common

How it works