Contents
XML Output Values Described
This page describes Output values that appear on the pages in the below groups:
Usage-Tenant
Where this variable is output: RM Real-time Detailed CDR Reporting Services, RM Historical Detailed CDR Reporting Services
When the Resource Manager (RM) associates a session with a given tenant, it records CDR property usage-tenant, representing the number of concurrent sessions for the given tenant. This number takes into consideration the current session. This should be shown for each tenant along the tenancy hierarchy.
Burst-Tenant
Where this variable is output: RM Real-time Detailed CDR Reporting Services, RM Historical Detailed CDR Reporting Services
The current number of in-progress calls depends on the provisioned usage limit and Burst levels. The RM records CDR property Burst-Tenant, based on Burst Levels and the Usage-Tenant recorded above. This should be shown for each tenant along the tenancy hierarchy.
The Burst Level is defined as follows:
Level 1: The current number of in-progress calls is at or below the provisioned usage limit.
Level 2: The current number of in-progress calls is at or below the provisioned Burst Limit (Level 2), and greater than the provisioned usage limit.
Level 3: The current number of in-progress calls is greater than the provisioned Burst Limit (Level 2). Note that this implies that the current number of calls is at or below the provisioned Burst Limit (Level 3), since the RM will not permit call densities exceeding that limit.
This should be shown for each tenant along the tenancy hierarchy.
The burst level thresholds are configured in section [gvp.policy]. Note that both parameters can be specified either in the IVR Profile, or in the tenant’s Annex.
Session-Start-Origin
Where this variable is output: CCP Real-time Detailed CDR Reporting Services
CCP CDRs contain parameter Session-Start-Origin, a string that specifies the following:
- The connection id of the initiating call, for calls initiated by an existing connection.
- The eventsource URI, for externally created sessions.
- The session id of the parent session, for forked sessions.
Usage-Profile
Where this variable is output: RM Real-time Detailed CDR Reporting Services, RM Historical Detailed CDR Reporting Services
When the RM associates a session with an IVR profile, it records CDR property Usage-Profile, representing the number of concurrent sessions for the given IVR Profile. Note that this number takes into consideration the current session.
The levels burst thresholds are configured in section [gvp.policy]. Note that both parameters can be specified either in the IVR Profile, or in the tenant’s Annex.
Burst-Profile
Where this variable is output: RM Real-time Detailed CDR Reporting Services, RM Historical Detailed CDR Reporting Services
The RM records CDR property Burst-Profile, more specifically the burst level at which the session originated. The recorded value must be one of1, 2 or 3.
Note: As the burst level is only recorded once the RM has associated a session with an IVR profile.
Usage-Tenant
Where this variable is output: RM Real-time Detailed CDR Reporting Services, RM Historical Detailed CDR Reporting Services
When the RM associates a session with a given tenant, it records CDR property Usage-Tenant, representing the number of concurrent sessions for the given tenant. This number takes into consideration the current session. This should be shown for each tenant along the tenancy hierarchy.
Burst-Tenant
Where this variable is output: xxxxxxx
Based on Burst Levels and the Usage-Tenant recorded above. The RM records CDR property. This should be shown for each tenant along the tenancy hierarchy.
Call-Notes
Where this variable is output: xxxxxxx
The platform provides an extension to the <log> tag, using label=com.genesyslab.var.CallNotes, that allows application developers to associate free-form notes with a call. Call Notes is limited to 4K (4096 bytes), and cannot be empty. Any content beyond the limit will be truncated.
A VAR CDR contains any call notes logged by the application.
Call-Result
Where this variable is output: xxxxxxx
The platform provides an extension to the <log> tag, using label=com.genesyslab.var.CallResult, that allows application developers to specify a Result for a call. The syntax is as follows:
<log label="com.genesyslab.var.CallResult">result[|reason]</log>
result must be one of SUCCESS, FAILED or UNKNOWN (default). Call Result is not case-sensitive. Preceeding or trailing whitespace is ignored.
reason is an optional, textual reason for the Call Result. The max length of the reason is 256 characters—any text beyond the limit will be truncated. Case is not sensitive.
If the developer specifies a Call Result other than those specified in the above, then “Unknown” will be assumed.
A VAR CDR contains the call result reason, if one is specified by the application
End-Reason
Where this variable is output: xxxxxxx
Specifies the reason for which the session was ended. Possible values include: EXIT, KILL, DOCINIT, ERROR, SYSERR etc. Note that the end reason will not be present for in-progress or timed out calls.
Category (Latency Category)
Where this variable is output: xxxxxxx
Each Latency Category contains the summarized data for the latency detail belonging to it, including:
- The number of time the latency was measured in the period;
- The average latency for that period;
- The minimum measured latency;
- The maximum measured latency;
- The standard deviation of the measurement during the period.
Bin (Latency Bin)
Where this variable is output: xxxxxxx
Each Latency Bin contains the latency detail information for that time period, organized by Latency Categories. Each latency detail contains:
- The number of time the latency was measured in the period;
- The average latency for that period;
- The minimum measured latency;
- The maximum measured latency;
- The standard deviation of the measurement during the period;
- The estimated at nth-percentile latency for the bin (where n is part of the configured latency threshold as configured on the Reporting Server, and as presented in the <manifest>.