---
title: "Avaya CDR Configuration Guide"
slug: "avaya-cdr-configuration-guide"
updated: 2023-05-15T17:41:31Z
published: 2023-05-15T17:41:31Z
canonical: "support.nectarcorp.com/avaya-cdr-configuration-guide"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.nectarcorp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Avaya CDR Configuration Guide

## 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).

NOTE

*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.*

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****.*

### 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**.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-qvqk6j96.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)RIG > Module Configuration

The **Module Configuration** window appears.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-y8ofkgoo.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)Enable Avaya CDR

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**.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-s69a4fec.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)Restart

NOTE*You will know that Avaya CM is enabled when you see* ***Avaya > CDR Data*** *and **C******M*** *under the* ***Modules*** *menu.*

## Configure the ACM

Configuring the ACM includes the following:

###### [Special Applications](/docs/avaya-cdr-configuration-guide#_bookmark12)

###### [Procedure](/docs/avaya-cdr-configuration-guide#_bookmark13)

### Special Applications

| **Application** | **Description** |
| --- | --- |
| **SA8201 - Start Time and 4-Digit Year CDR Custom Fields** | - Customize the CDR using five new key words. - Use the five new keywords and one of the following formats to add start and end dates: ***DDMMYY DDMMYYYY*** - Use the five new keywords and the following format to add start and end times: ***HHMMSS*** |
| **SA8202 - Intra-Switch CDR by COS** | - Used to define an unlimited number of stations to generate CDRs. - Used to designate which stations generate intra-switch CDRs based on the station’s COS. - Overrides the current intra-switch CDR table that requires each station to be administered individually. - Each COS (0-15) has an **n/y** field titled **Intra-switch CDR**. If this field is set to **Yes** for a given station’s COS, then the station-to-station calls in which that station is the called party generates a CDR. |
| **SA8702 - CDR Enhancements for Network** | - Customize the CDR using five new key words. - Use the five new keywords to add the following: - UCID - Internal and trunk codes - 32-bit sequence number - Combined charge field - Adds the **Copy UCID for Station Conference/Transfer** field to the **system-parameters features related** form. 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:

1. Navigate to **change system-parameters special applications**. The **Special Applications** window appears.
2. Set the following features to **y**:

- #### SA8201
- #### SA8202
- #### SA8702

1. 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.

1. Navigate to **change cos-group 1**.

The **Class of Service** window appears.

1. 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.*

1. 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****.*

1. Set the following parameters to **y**:

##### Incoming Trunk Call Splitting

##### Outgoing Trunk Call Splitting

1. Navigate to **CDR System Parameters (Tab 2)** window.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-fmnvyc0b.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)

*Figure 3-1CDR System Parameters - Tab 2*

1. Set the field identifiers as shown in [***Figure 3-1***](/docs/avaya-cdr-configuration-guide#_bookmark14).

***Note***

*Not all fields are available.*

*The total Record Length must be 154 as indicated on the bottom of the window.*

1. Navigate to **change node-names IP** and create a node name for the Nectar RIG.
2. Navigate to **change ip-service**.

The **IP Services (Tab 1)** window appears.

1. Enter the new node name for the Nectar RIG in the **Remote Node** field for CDR2.
2. Enter the **Remote Port** as **9001**.
3. Navigate to **IP Services (Tab 3)**.

The **Session Layer Timers** window appears.

1. Set the **Reliable Protocol** for CDR2 to **y**.

## 4.Verify the ACM

Follow these steps to verify the ACM:

1. In the ACM, navigate to **status cdr-link**. The **CDR Link Status** window appears.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-xnuvoosi.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)

*Figure 4-1CDR Link Status*

1. View the **Link State: up** status for Primary and Secondary.
2. In the RIG, navigate to **Modules > Avaya > CDR Data**. The **CDR Data** window appears.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-k9j34c7c.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)

*Figure 4-2CDR Data*

The CDR data begins to populate.

## View CDR Data

Viewing CDR data includes the following tasks:

###### [Access CDR Data Options](/docs/avaya-cdr-configuration-guide#_bookmark19)

###### [Find Calling Number Media Sessions](/docs/avaya-cdr-configuration-guide#_bookmark20)

###### [Find Media Sessions by Time](/docs/avaya-cdr-configuration-guide#_bookmark21)

###### [Filter Call Legs](/docs/avaya-cdr-configuration-guide#_bookmark22)

### Access CDR Data Options

Follow these steps to access the CDR data options:

1. Navigate to **Modules > Avaya > CDR Data**. The **CDR Data** window appears.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-mpzmq9z3.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)

*Figure 5-1CDR Data Options*

1. 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.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-7ye40sv8.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)

*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.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-7bewzd0t.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)

*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.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-op7v2oa7.jpe?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)

*Figure 5-4Filter Call Legs*

## 6.Configure the RIG

Follow these steps to configure the Nectar RIG:

1. Navigate to **Modules > Avaya > CM**. The **ACM** window appears.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-1fli9h5l.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)

1. Select **VKM Options.**

*Figure 6-1VKM Options*

The **Avaya VKM Options** window appears.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-ehs262ej.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)

*Figure 6-2VKM Options*

Notice that **cdrEnable** is set to **true**.

1. Verify that **cdrListenPort** is set to **9001**, which is the default value.
2. Select **cdrFormat**, right-click, and select **Edit**. The **Edit VKM Option** window appears.

![](https://cdn.document360.io/f8330b7a-360f-4ca0-b0ac-2664b7c04c49/Images/Documentation/avaya-cdr-configuration-guide-image-mbsc4q91.png?sv=2026-02-06&spr=https&st=2026-11-08T17%3A20%3A32Z&se=2026-11-08T18%3A20%3A32Z&sr=c&sp=r&sig=X0UORV0XwSnTVBysPpG6bFLDD1OarYiYxfi5J0ZQBzw%3D)

*Figure 6-3Edit VKM Option*

1. Select one of the following:
  - unformatted
  - enhancedUnformatted
  - custom

***Note***

*As previously stated,* ***enhancedUnformatted*** *is not recommended.*

1. Click **Update**.

***Note***

*If during RIG setup, some parameters, such as* ***cdrListenPort*** *or* ***cdrFormat*** *are changed, the CDR reader should be restarted:*

1. *Select* ***cdrEnable****, right-click, select* ***Edit*** *from the pop-up window, then select*

***false*** *from the drop-down list; click* ***Update****.*

1. Select ***cdrEnable***, right-click, select ***Edit*** from the pop-up window, then select

***true*** from the drop-down list; click ***Update***.