Pause component

:icons:font :hardbreaks: :imagesdir: ../../../assets/images :toc-title: Contents :toc:

Description

Delays the script before executing the next component. If zero timeout is specified, the component is skipped. :description1: In some cases when working with large scripts it is convenient to use the "Pause" component as a dummy. To align the visual representation of the script and for convenient and quick property changes. For example, on the exit branches of the "Menu" component, where each transition property is set inside a special window by selecting one object from the list of all script objects. // limitations

Table 1. System characteristics

Index

103

Short name

pause

Script types

All

Start module

r_script_component_pause

Mode

Asynchronous

Icon

103

Branching type

Non-branching

Properties

Table 2. Properties
Specification Description

Name: Time, ms Code: timeoutMs Visibility condition: no Default: — 

Pause duration, in milliseconds. With negative values the component works in synchronous mode. With 0 the component works in asynchronous mode with zero wait.

Name: Clear events Code: flushEvents Visibility condition: no Default: No

Determines component behavior with the unprocessed event queue.

Unprocessed events accumulate in the queue if the component executing when the event arrives is not intended to process them, and remain in the queue until a subsequent component processes them (or the script completes). Only asynchronous components can process events, i.e., performing asynchronous operations and waiting for events.

The considered event set does NOT include events processed by the script machine itself, for example inter-script interaction events, script replacement, completion or owner replacement, etc.

Accumulated events include:

  • Incoming DTMF signals;

  • Incoming SIP INFO messages;

  • Incoming SIP MESSAGE messages;

  • The PAUSE component in accumulation mode queues all other events arriving for processing in components.

Possible values:

  • No (no,0) — unprocessed events accumulate and are added to the end of the current unprocessed event queue received from previous components.

  • Yes (yes,1) — accumulated unprocessed events are discarded, and new ones are not saved until control is transferred to the next component.

Using the component with zero timeout and event queue clearing mode can be applied where from a logic standpoint it is important to discard accumulated tails. For example, previously entered DTMF signals.

Name: Save script state Code: storeState Visibility condition: no Default: No

Enabling IVR script state saving for possible further conversation recovery with servicing continued from the saved position.

Possible values:

  • No (no,0) — normal pause.

  • Yes (yes,1) — state is saved.

Applied together with the sip_restore_enabled mode. Makes sense only for IVR scripts. If the script state was not saved, then on conversation recovery (if the IVR node disappears or the server with the IVR node crashes) the script starts from the very beginning from the moment the script was routed to the feature code.

The state includes the entire nested call stack, values of all local variables, start parameters, storage, script code, component number, start time, counters, etc. Script metadata is not stored. Execution starts directly from the component following the current 'Pause' component performing the save. The script will be loaded from the domain center, so if it changed significantly (component numbers shifted or the saved component number is absent), correct continuation will be impossible. The state can be large, so the state saving operation should not be applied after every component in long intensive loops without pauses.

When the script handler completes, the saved state is automatically deleted from storage. The call session is preserved on conversation recovery regardless of whether the IVR script state was saved.

The state is saved to object storage managed by the store microservice. If the number of saves is known to be large and the store microservice is loaded, it should be multiplied on the site.

The recovered script handler instance loses connection with temporary files of the previous handler used by it in the :TEMP and :LOCAL macro paths. The getscriptref() function of the new instance has a new value. The context can be recovered an arbitrary number of times.

Name: Transition Code: transfer Visibility condition: no Default: — 

Component to which control is transferred.

See also