Cancel Block

Use the Cancel block to remove a route request from a queue and from target consideration. Can be used for both voice and multimedia interactions. For more information, see the Orchestration Server Developer’s Guide, Queue Interface, Action Elements, <cancel> Action Element.

Name Property

Find this property's details under Common Properties.

Block Notes Property

Find this property's details under Common Properties.

Condition Property

Find this property's details under Common Properties.

Enable Status Property

Find this property's details under Common Properties.

Logging Details Property

Find this property's details under Common Properties.

Log Level Property

Find this property's details under Common Properties.

Interaction ID Property

Set to a meaningful value or keep the default value, which is the system variable system.ANI. If the queue is present, then all outstanding requests are cleared from the defined queue. The interactionid attribute is only used in conjunction with the queue attribute and is only needed when your application is handling multiple interactions. For more information, see the Orchestration Server Developer’s Guide, Queue Interface, Action Elements, <cancel> Action Element, Interactionid.

Request ID Property

Specify either:

• a variable holding the request ID of an outstanding queuing request;
• or a Target/Route Interaction block (Block Reference)

Queue Property

Optional.  To specify a queue:

1. Click under Value to display the button.
2. Click Add to open the Configure Queue dialog box. Do one of the following:

• If you are connected to Configuration Server, select Configuration Server. Select the queue from the Value field. This is the queue containing the route request to be cancelled. Queues listed here were previously defined with the Interaction Queue block.
• Select Literal and enter the name of the queue in the Value field.  
• Select Variable and select the variable that contains the value.

3. Click OK.

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.