Component Monitor

Table of Contents

Description

A multifunctional component that implements multiple functions to provide operational data from the system.

Table 1. System Characteristics

Index

146

Short title

monitor

Types of scenarios

All of them

Starter module

r_script_component_monitor

Mode

Asynchronous

Icon
146

Branching pattern

Branching, closing

Properties

Table 2. Properties
Specification Description

Title: Query Category
Code: category
Visibility: no
Default: `Accounts'

Function Group Selection.
Possible values:

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

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

  • Hunt (hunt, 3) - Information on hunt groups and the states of their member agents.

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

  • Scripts (script, 5) - Information on executable scripts.

  • Selectors (selector, 6) - Information on active selector meetings and their participants.

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

  • System (system, 8) - System information.

Title: Method
Code: method_acc
Visibility: no
Default: SIP Providers

Select a function for the Accounts category.
Possible values:

  • SIP Providers (provider, 1) - Returns aggregate account state information SIP providers of the current domain as a JSON structure.

  • SIP-users (sipuser, 2) - Returns aggregate account state information SIP-users of the current domain as a JSON structure.

  • Users (user, 3) - Returns aggregate account state information of users of the current domain as a JSON structure.

Title: Method
Code: method_calls
Visibility: 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 as a JSON structure.

  • Activity Diagram (diagram, 2) - Returns a diagram by call/related calls. Calls are specified by enumeration of CallId, automatically closures (populating all CallIds of all arms of related call transfers) are performed. Depending on the selected mode returns the content or path to the file, svg format or plantuml.

Title: Method
Code: method_hunt
Visibility: no
Default: `SIP'

Select a function for the Hanty' 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 as 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 as a JSON structure.

Title: Method
Code: method_huntq
Visibility: no
Default: SIP

Select a function for the SIP category`.
Possible values:

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

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

Title: Method
Code: method_script
Visibility: no
Default: `Info'

Select a function for the Scenarios' category.
Possible values:

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

Title: Method
Code: method_selector
Visibility: no
Default: `Info'

Select a function for the Selectors' category.
Possible values:

  • Info (info, 1) - Returns aggregate information on active selector meetings of the current domain as a JSON structure.

Title: Method
Code: method_session
Visibility: 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 as a JSON structure.

Title: Method
Code: method_system
Visibility: no
Default: `General License'

Select a function for the System' category.
Possible values:

  • Aggregate License (lic, 1) - Returns aggregate information on the currently active license as a JSON structure. The value is output only for master-domain scenarios.

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

Title: Subdomain
Code: subdomain
Visibility: no
Default: — 

The name of the domain in the child domain tree of the current domain.

Title: Scope
Code: scope
Visibility: yes
Default: Site

Select the scope for the query.
Possible values:

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

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

Title: Parameters
Code: params
Visibility: no
Default: — 

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

  • Calls, Activity Diagram - JSON object contains:

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

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

    • issuance mode (file: true | false).

Title: Time, ms
Code: timeout
Visibility: no
Default: 1000

Timeout to wait for operation execution, in milliseconds.

Title: Result to variable
Code: resultVariable
Visibility: no
Default: — 

Variable to save the result of the operation.

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

The component to which control is passed when the operation is successful.

Title: Transition, Time
Code: transferTimeout
Visibility: no
Default: — 

The component to which control is passed when the wait timeout expires.

Title: Transition, Error
Code: transferError
Visibility: no
Default: — 

The component to which control is passed if an error occurs.

See also

  • Personalization
  • Increase font size
  • Decrease font size