- 15 May 2023
- 5 Minutes to read
- Print
- DarkLight
- PDF
Avaya CDR Configuration Guide
- Updated on 15 May 2023
- 5 Minutes to read
- Print
- DarkLight
- PDF
Overview
This guide is designed to assist a Nectar Unified Communications Management Platform (UCMP) user with deploying the Nectar Call Detail Record (CDR) module when monitoring an Avaya Communication Manager (ACM).
Nectar uses a Custom CDR Feed from the ACM.
If the custom feed is already in use, the Unformatted Feed can be used. However, using this feed degrades the Nectar functionality. It rounds call start times to the nearest minute, which makes it very difficult to match a CDR record to the underlying call VoIP legs.
In addition, Universal Call-ID (UCID) is unavailable in the Unformatted and Enhanced Unformatted Feed. Therefore, you cannot link conference and transfer call legs.
About this Guide
This guide explains how to:
Configure the ACM
Enable Avaya CM
Verify the ACM
View CDR Data
Configure the RIG
Supported Software Versions
- Nectar v8.7.1
- Nectar CDR for ACM
CDR Licensing
The CDR requires a Nectar Enterprise license.
Enable Avaya CM
Enabling activates the specific feature module in the RIG server AFTER a restart. This also reduces the load/overhead on the RIG server.
Follow these steps to enable Avaya CM:
1. Navigate to RIG > Module Configuration.
The Module Configuration window appears.
2. Select Avaya CM under Standard Modules and Call Detail under Premium Modules.
3. Click Apply.
4. To restart the RIG and apply the changes.
a. Navigate to RIG > Admin > Restart.
b. When the following message appears, click Yes.
Configure the ACM
Configuring the ACM includes the following:
Special Applications
Procedure
Special Applications
Application | Description |
SA8201 - Start Time and 4-Digit Year CDR Custom Fields |
DDMMYY DDMMYYYY
HHMMSS |
SA8202 - Intra-Switch CDR by COS |
|
SA8702 - CDR Enhancements for Network |
When this field is set to y, the UCID associated with a call is preserved for the second call legs associated with the station call-conference/drop and station call-transfer operations on a system-wide basis. Warning: This feature is not used with Avaya IQ. |
Note
Nectar clients using Avaya CDR (call detail records) functionality in the RIG should have the Avaya system clock set via NTP (network time protocol). Accurate timestamps are critical when matching CDR to call quality statistics in Nectar DXP.
The following special applications (or Green Features) must be activated in the ACM:
Table 3-1 Special Applications
Procedure
Follow these steps to configure the ACM:
- Navigate to change system-parameters special applications. The Special Applications window appears.
- Set the following features to y:
SA8201
SA8202
SA8702
- Navigate to change system-parameters features-related (Tab 5). The Feature-Related System Parameters window appears.
Set Copy UCID for Station Conference/Transfer to y.
- Navigate to change cos-group 1.
The Class of Service window appears.
- Set Intra-switch CDR to y for all classes of service (COS) that apply to stations from which you want to collect internal call details.
Note
Feature SA8202 enables the Intra-switch CDR field.
- Navigate to change system-parameters cdr.
The CDR System Parameters (Tab 1) window appears.
Set Secondary Output Format to customized.
Note
The output format can be either Primary or Secondary as long as it is customized.
- Set the following parameters to y:
Incoming Trunk Call Splitting
Outgoing Trunk Call Splitting
- Navigate to CDR System Parameters (Tab 2) window.
Figure 3-1CDR System Parameters - Tab 2
- Set the field identifiers as shown in Figure 3-1.
Note
Not all fields are available.
The total Record Length must be 154 as indicated on the bottom of the window.
- Navigate to change node-names IP and create a node name for the Nectar RIG.
- Navigate to change ip-service.
The IP Services (Tab 1) window appears.
- Enter the new node name for the Nectar RIG in the Remote Node field for CDR2.
- Enter the Remote Port as 9001.
- Navigate to IP Services (Tab 3).
The Session Layer Timers window appears.
- Set the Reliable Protocol for CDR2 to y.
4.Verify the ACM
Follow these steps to verify the ACM:
- In the ACM, navigate to status cdr-link. The CDR Link Status window appears.
Figure 4-1CDR Link Status
- View the Link State: up status for Primary and Secondary.
- In the RIG, navigate to Modules > Avaya > CDR Data. The CDR Data window appears.
Figure 4-2CDR Data
The CDR data begins to populate.
View CDR Data
Viewing CDR data includes the following tasks:
Access CDR Data Options
Find Calling Number Media Sessions
Find Media Sessions by Time
Filter Call Legs
Access CDR Data Options
Follow these steps to access the CDR data options:
- Navigate to Modules > Avaya > CDR Data. The CDR Data window appears.
Figure 5-1CDR Data Options
- Select or highlight one of the sessions, right-click and select one of following options:
- Find Calling Number Media Sessions
Note
This option is only present if the call included an IP endpoint.
- Find Media Sessions by Time
- Filter Call Legs
- Copy to Clipboard
Find Calling Number Media Sessions
Note
A session must be selected or highlighted in order for the data for these options to populate when selecting them from the pop-up drop-down list.
- Only present when the call includes an IP endpoint.
- Splits the window and presents the related media sessions (VoIP RTCP metrics) for the originating number.
- If the dialed number (call-ED party) is an IP phone, you have the option to Find Dialed Number Media Sessions.
-One must select a call, then right-click for the Find Dialed Number Media Sessions option to appear in the pop-up drop-down list.
Figure 5-2Find Calling Number Media Sessions
Find Media Sessions by Time
- Presents all media sessions that begin plus or minus 30 seconds from the time of the selected record.
- Presents a problem in a large switch because of the time range.
Figure 5-3Find Media Sessions by Time
Filter Call Legs
- Filters the CDR View to display any related records based on the UCID.
- Includes conference and transfer calls.
- Use with options to correlate to QoS records.
Figure 5-4Filter Call Legs
6.Configure the RIG
Follow these steps to configure the Nectar RIG:
- Navigate to Modules > Avaya > CM. The ACM window appears.
- Select VKM Options.
Figure 6-1VKM Options
The Avaya VKM Options window appears.
Figure 6-2VKM Options
Notice that cdrEnable is set to true.
- Verify that cdrListenPort is set to 9001, which is the default value.
- Select cdrFormat, right-click, and select Edit. The Edit VKM Option window appears.
Figure 6-3Edit VKM Option
- Select one of the following:
- unformatted
- enhancedUnformatted
- custom
Note
As previously stated, enhancedUnformatted is not recommended.
- Click Update.
Note
If during RIG setup, some parameters, such as cdrListenPort or cdrFormat are changed, the CDR reader should be restarted:
- Select cdrEnable, right-click, select Edit from the pop-up window, then select
false from the drop-down list; click Update.
- Select cdrEnable, right-click, select Edit from the pop-up window, then select
true from the drop-down list; click Update.