Component Pause

Table of Contents

Description

Performs a script delay before executing the next component. If a zero timeout is specified - the component is skipped.

In some cases, when working with large scenarios, it is convenient to use the Pause component as a blank. To align the visual representation of the script, for easy and quick property changes. For example, by exit branches from the "Menu" component, where each transition property is set inside a special window by selecting one object from the list of all scenario objects.

Table 1. System Characteristics

Index

103

Short title

pause

Types of scenarios

All of them

Starter module

r_script_component_pause

Mode

Asynchronous

Icon

103

Branching pattern

Non-branching

Properties

Table 2. Properties
Specification Description

Title: Time, ms
Code: timeoutMs
Visibility: no
Default: — 

Pause duration, in milliseconds.
In case of negative values, the component operates in synchronous mode.
In case 0, the component operates in asynchronous mode with zero wait.

Title: Clear events
Visibility: no
Default: `None'

Specifies the behavior of the component with the raw event queue.

Unprocessed events accumulate in the queue if the component executing at the time the event arrives is not called to process them, and remain in the queue until the next component processes them (or the script terminates).
Only asynchronous components, that is, those that conduct asynchronous operations and wait for events, can handle events.

The set of events under consideration DOES NOT include events handled by the scripting machine itself, such as cross-scenario communication events, script swapping, termination or owner swapping, etc.

Accumulative events include:

  • Incoming DTMF signals;

  • Incoming SIP messages INFO;

  • Incoming SIP messages MESSAGE;

  • The PAUSE component in the accumulation mode collects in a queue all other events coming to the components for processing.

Possible values:

  • No (no,0) - raw events are accumulated and added to the end of the current queue of raw events inherited from previous comonents.

  • Yes (yes,1) - accumulated unprocessed events are discarded and new events are not stored until control is passed to the next component.

The use of a zero timeout component with event queue clear mode can be used in those places in the scenario where it is logically important to clear accumulated tails. For example, previously entered DTMF signals.

Title: Transition
Code: transfer
Visibility: no
Default: — 

Component to which control is passed.

See also