Contents
List of statistics to be monitored
Entry Format
2 modes of statistics definitions are supported. In simple mode the statistic type is defined in Configuation Manager and the statistics.yaml entry defines the additional statistics options and the statistic name in HTCC API. In the extended mode the full definition of statistic is provided in statitics.yaml entry. In this case there is no need to use CME for statistic definition. The switch between modes is defined basing on presence of statisticDefinitionEx property. If it's specified mode is considered to be extended and statisticDefinitionName is ignored if present.
Simple Mode Entry Format
Example:
name: test statisticDefinitionName: TestAgentStat objectType: QUEUE timeProfile: OneDay notificationMode: PERIODICAL notificationFrequency: 10 timeRange: Range0-60 timeRange2: Range0-5
The properties meaning are:
- name - the name of statistic as it appears in API request
- statisticDefinitionName - the name of statistic type (definition) as it's in CME (See stat server user guide)
- objectType - the type of objects statistic is applied. Possible values: AGENT|QUEUE|SKILL_Q|SKILL_AG:
- AGENT - statistic is monitored for agents
- QUEUE - statistic is monitored for queues
- SKILL_AG - statistic is monitored for agentGroup, associated with skill
- SKILL_Q - statistic is monitored for virtual queue, associated with skill
- notificationMode - PERIODICAL
- notificationFrequency - the frequency of notification (in seconds)
- timeProfile - the name of timeProfile in CME used for statistic aggregation (See stat server user guide)
- timeRange/timeRange2 - the timeranges names which are defined in CME and are used for calculating statistic. (See stat server user guide).
Extended mode entry format
To use this mode replace the statisticDefinitionName string with statisticDefinitionEx containing full definition of statistic type. Here is the sample format:
name: testServiceLevel
statisticDefinitionEx:
category: TotalNumberInTimeRangePercentage
mainMask: CallAnswered
subject: DNAction
intervalType: GrowingWindow
dynamicTimeProfile: "0:00"
timeRangeLeft: 0
timeRangeRight: 60
objectType: QUEUE
notificationMode: PERIODICAL
notificationFrequency: 10
Fields name, objectType, notificationMode, notificationFrequency have the same meaning as for simple mode. The statisticDefinitionEx defines the statistic to be collected. Please note the indentation here. No tabs can be used (See YAML 1.1 Spec).
The supported properties are:
| Option | Type | Mandatory | Default Value | Note |
|---|---|---|---|---|
| category | String | Y | The statistic's category | |
| mainMask | comma-delimited list | Y | The statistic's main mask | |
| relativeMask | comma-delimited list | N | Empty list | The statistic's relative mask |
| subject | String | Y | The statistic's subject | |
| intervalType | GrowingWindow OR
SinceLogin OR SlidingSelection OR SlidingWindow |
N | The statistic's interval type | |
| dynamicTimeProfile | String | N | The time profile (interval) value to be used | |
| timeRangeLeft | Integer | N | null | The "from/left/start/lower" value of TimeRange interval |
| timeRangeRight | Integer | N | null | The "to/right/end/upper" value of TimeRange interval |
| timeRangeLeft2 | Integer | N | null | The "from/left/start/lower" value of TimeRange2 interval |
| timeRangeRight2 | Integer | N | null | The "to/right/end/upper" value of TimeRange2 interval |
| dynamicFilter | String | N | null | filter to be used |
| distinguishByConnId | Boolean | N | null | look for DCID in StatServerUserGuide |
Please note that those properties are used for defining the statistics. Not all combinations are supported by StatServer. See |File:81fr us-statserver.pdf Stat Server user guide for more info.