Jump to: navigation, search

Raise Event Block

Use the Raise Event block for Composer to throw custom events. You specify the event name and a message, which is selection of a dynamic variable.  It is a terminating block (can end an application instead of an Exit block). Orchestration Server 8.1.2+ versions are required for Raise and Cancel Event blocks.

Also see CustomEvents.

The Raise Event block has the following properties:

  • The Raise Event block has no page exceptions.

Name Property

Find this property's details under Common Properties for Callflow Blocks or Common Properties for Workflow Blocks.

Block Notes Property

Find this property's details under Common Properties for Callflow Blocks or Common Properties for Workflow Blocks.

Delay Property

Enter the timeout or select a variable. Maps to send delay.

Enter a value or select a variable. Examples are shown below using Timeout. This property supports the following:

  • Literal integer value. For example: Timeout=4 & Unit=second <send event="'WaitEvent1.wait.timeout'" delay="'4s'"/>.
  • Variable with integer value. For example: Timeout=Variable(4) & Unit=second <send event="'WaitEvent1.wait.timeout'" delay="'4s'"/>.
  • Variable with string value. For example: Timeout=Variable('6') & Unit=second <send event="'WaitEvent1.wait.timeout'" delay="'6s'"/>.
  • Variable with string value including unit. For example: Timeout=Variable('6ms') & Unit=second <send event="'WaitEvent1.wait.timeout'" delay="'6ms'"/>. In this case, the unit specified in the variable is used instead of the static property unit.

Unit Property

Select seconds or milliseconds for the delay. Maps to <send delay>.

Condition Property

Find this property's details under Common Properties for Callflow Blocks or Common Properties for Workflow Blocks.

Logging Details Property

Find this property's details under Common Properties for Callflow Blocks or Common Properties for Workflow Blocks.

Log Level Property

Find this property's details under Common Properties for Callflow Blocks or Common Properties for Workflow Blocks.

Event Property

Maps to send event. Enter a value or select a variable.

Parameters Property

Add a list of key-values. Maps to <param>.

Enable Status

This property controls whether or not a block contributes code to the application. You may wish to use this property if there is a need to temporarily remove a block during debugging or, for other reasons during development, temporarily disable a block. This saves the effort of having to remove the block and then add it back later.

ORS Extensions Property

Starting with 8.1.4, Composer blocks used to build routing applications (with the exception of the Disconnect and EndParallel blocks) add a new ORS Extensions property.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on November 30, 2018, at 10:46.