Monitor Component

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

Description

Multifunctional component that implements many functions for providing operational data from the system.

Table 1. System characteristics

Index

146

Short name

monitor

Script types

All

Start module

r_script_component_monitor

Mode

Asynchronous

Icon

146

Branching type

Branching, closing

Properties

Table 2. Properties
Specification Description

Name: Request Category

Code: category

Visibility condition: no

Default: Accounts

Selecting a group of functions.

Possible values:

  • Accounts (acc, 1) – Information on accounts and their states.

  • Calls (calls, 2) – Information on active calls.

  • Hunts (hunt, 3) – Information on hunt groups and the status of the agents included in them.

  • Queues (huntq, 4) – Information on queues and the composition of objects/tasks waiting in them.

  • Scripts (script, 5) – Information on running scripts.

  • Selectors (selector, 6) – Information on active conference calls and their participants.

  • Text sessions (session, 7) – Information on active text sessions.

  • System (system, 8) – Information on the system.

Name: Method

Code: method_acc

Visibility condition: no

Default: SIP Providers

Select a function for the Accounts category. Possible values:

  • SIP providers (provider, 1) – Returns aggregate information on the status of SIP providers accounts of the current domain in the form of a JSON structure.

  • SIP users (sipuser, 2) – Returns aggregate information on the status of SIP users accounts of the current domain in the form of a JSON structure.

  • Users (user, 3) – Returns aggregate information on the status of users accounts of the current domain in the form of a JSON structure.

Name: Method Code: method_calls Visibility condition: no

Default: Info

Select a function for the Calls category.

Possible values:

  • Info (info, 1) – Returns aggregate information on active calls of the current domain in the form of a JSON structure.

  • Activity diagram (diagram, 2) – Returns a diagram of the call/adjacent calls. Calls are indicated by enumerating CallId, closure is automatically performed (replenishment with all CallIds of all arms connected by call transfers). Depending on the selected mode, returns the content or path to the file, svg or plantuml format.

Name: Method

Code: method_hunt

Visibility condition: no

Default: SIP

Select a function for the Khanty category.

Possible values:

  • SIP (sip, 1) – Returns aggregate information on hunt groups of type sip of the current domain and the states of their agents in the form of a JSON structure.

  • Users (usr, 2) – Returns aggregate information on hunt groups of type user of the current domain and the states of their agents in the form of a JSON structure.

Name: Method

Code: method_huntq

Visibility condition: no

Default: SIP

Select a function for the Queue category.

Possible values:

  • SIP (sip, 1) – Returns aggregate information on queues of type sip of the current domain and the states of objects waiting in them in the form of a JSON structure.

  • Users (usr, 2) – Returns aggregate information on queues of type sip of the current domain and the states of objects waiting in them in the form of a JSON structure.

Name: Method

Code: method_script

Visibility condition: no

Default: Info

Select a function for the Scripts category. Possible values:

  • Info (info, 1) – Returns aggregate information on active running scripts of the current domain in the form of a JSON structure.

Name: Method

Code: method_selector

Visibility condition: no

Default: Info

Select a function for the Selectors category. Possible values:

  • Info (info, 1) – Returns aggregate information on active conference meetings of the current domain in the form of a JSON structure.

Name: Method

Code: method_session

Visibility condition: no

Default: Info

Select a function for the Text sessions category. Possible values:

  • Info (info, 1) – Returns aggregate information on active text sessions of the current domain in the form of a JSON structure.

Name: Method

Code: method_system

Visibility condition: no

Default: General license

Select a function for the System category. Possible values:

  • General license (lic, 1) – Returns aggregate information on the current valid license in the form of a JSON structure. The value is only returned for master domain scripts.

  • Domain licenses (domain_lic, 2) – Returns information on the composition of used licenses in the specified domain from a subtree of child domains in the form of a JSON structure.

Name: Subdomain

Code: subdomain

Visibility condition: no Default: — 

Domain name in the tree of child domains of the current domain.

Name: Reach

Code: scope

Visibility condition: yes

Default: Website

Select coverage for the request.

Possible values:

  • Site (site, 0) – Limits the output to the current site.

  • System (system, 1) – Returns data for the entire system.

Name: Parameters

Code: params

Visibility condition: no

Default: — 

An argument containing a JSON structure in the form of an object with parameters for the request being executed. The following queries are parameterized:

  • Calls, Activity diagram – JSON object contains:

    • call composition (callid: "…​" or callids: ["…​", "…​", …​]),

    • output format (mode: "svg" | "plantuml"),

    • issuing mode (file: true | false).

Name: Time, ms

Code: timeout

Visibility condition: no

Default: 1000

Timeout for waiting for the operation to complete, in milliseconds.

Name: Result into variable

Code: resultVariable

Visibility condition: no Default: — 

Variable for storing the result of the operation.

Name: Transition

Code: transfer

Visibility condition: no

Default: — 

The component to which control is transferred upon successful completion of the operation.

Name: Transition, time Code: transferTimeout Visibility condition: no

Default: — 

The component to which control is transferred after the timeout expires.

Name: Transition, error

Code: transferError

Visibility condition: no

Default: — 

Component to which control is transferred in case of an error.

See also