Avaya CDR Configuration Job Aid
    • 15 May 2023
    • 5 Minutes to read
    • Contributors
    • Dark
    • PDF

    Avaya CDR Configuration Job Aid

    • Dark
    • PDF

    Article Summary


    This document is designed to assist Nectar Foundation users in the deployment of Nectar’s Call Detail Record (CDR) Module when monitoring an Avaya Communication manager (ACM). This guide assumes that you are proficient with Nectar Foundation and have had Nectar Foundation Operator training.


    Nectar leverages a Custom CDR Feed from the ACM. If the Custom Feed is already in use, the Enhanced Unformatted Feed can be used. Using Enhanced Unformatted will degrade Nectar’s functionality. Enhanced Unformatted rounds call start times to the nearest minute, and this makes it very difficult to match a CDR record to the underlying VoIP legs of the call.

    In addition, there is no Universal Call-ID (UCID) in the Enhanced Unformatted Feed. Therefore, you will not be able to link Conferenced and Transferred Call legs.

    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.

    Nectar Foundation Configuration

    Both the ACM Module and Avaya Aura Module need to be enabled.

    NOTE: You will not onboard the Aura module. You will continue to use the ACM Module to monitor the health of your Communication Manager.

    • Navigate to RIG > Module Configuration. Ensure that both Avaya CM and Avaya Aura CM are checked.
    • Click Apply.
    • If both were already active, move to the next section. If not, the RIG must be restarted. Navigate to RIG > Admin > Restart. This should only take 1-3 minutes.

    ACM Module: Navigate to Modules > Avaya > CM > VKM Options and set:

    • cdrEnable = false
    • cdrFormat = custom
    • cdrListenPort = 9001 (Avaya’s default)
    • cdrSecurePort = true/false (depends on whether encrypted)
    • enableCallDetails = true
    • Set cmDateFormat (date format) to match your output; default is month/day. If you are using day/month, please edit this field using its drop-down box.
    • Set cmLocalTZ (time zone) to match your time zone offset.

    Aura Module: Navigate to Modules > Avaya > Aura CM > VKM Options and set:

    • cdrLegacy = true

    Nectar Custom CDR Definition

    Nectar XML file

    NOTE: If you are using Nectar’s default CDR output, you can skip this section (default configuration can be seen on Page 11). If not, proceed with the following steps.

    • Open the Nectar CDR definition XML file with a text editor.
      • The file is named customized.xml. Do not change the file name.
    • This file contains all possible Avaya CDR fields in the required format.
    • Select and delete any rows that are NOT part of your CDR output.
      • Your CDR definition is found via SAT command change system-parameters cdr, page 2.
    • Rearrange the rows to match the sequence of your CDR output.
    • Save the file.

    Upload XML file

    1. Create a folder in the etc.directory
      1. You can RDC to the Foundation Server or use Nectar’s File Manager tool via the Nectar client.
    2. Name the folder acmcdr.
    3. Upload the customized.xml file to this directory.

    Avaya Administration

    Special Applications (Green Features)

    The following Special Applications, also known as Green Features, need to be activated in the ACM.

    • SA8201 – Start Time and 4-Digit Year CDR Custom Fields
      • This feature provides the user with the capability to customize the CDR (Call Description Record) using five new keywords. These five new keywords allow the user to add start date and end date in one of two formats either DDMMYY or DDMMYYYY format and to add start time and end time in HHMMSS format.
    • SA8202 – Intra-switch CDR by COS
      • This feature provides the user with the capability to define an unlimited number of stations to generate CDR records. It allows the customer to designate which stations will generate intra-switch CDR records based on the station’s COS. It will override the current intra-switch CDR table that required each station to be administered individually. Using (SA# 8202) each COS (0-15) will have an “n/y” field titled “Intra-switch CDR”. If this field is set to “yes” for a given station’s COS, station-station calls in which that station is the calling, or the called party, will generate a CDR record.
    • SA8702 – CDR Enhancements for Network
      • This feature provides the user with the capability to customize the CDR (Call Detail Record) using five new keywords. These five new keywords allow the user to add UCID, internal and trunk codes, a 32-bit sequence number and a combined charge field. Also, the SA8702 Green feature 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 station call-conference/drop and station call-transfer operations on a system wide basis.
      • Warning: This feature is not to be used with Avaya IQ.

    These features are activated in the ACM by command entry change system-parameters special-applications. Set the features listed above to y.

    Special Applications

    Copy UCID for Station Conference/Transfer

    Navigate to change system-parameters features-related, page 5 in the ACM. Set the Copy UCID for Station Conference/Transfer field to y.

    Feature-Related System Parameters

    Class of Service (COS)

    SA8202 will enable the Intra-switch CDR field at the bottom of the change cos-group 1 screen. Enter y for all COS that apply to stations you wish to collect internal call details to and from.

    Class of Service

     CDR Output 

    The output can be either Primary or Secondary, as long as it is customized as shown below. You will configure these settings by going to command entry change system-parameters cdr.

    • Set the Output Format to customized
    • Set Incoming and Outgoing Trunk Call Splitting to
    CDR System Parameters (1) 
    • The following is Nectar’s default configuration. If using this format, you do NOT need to upload the XML file.
    CDR System Parameters (2)

    CDR Link

    • Add a node-name for the Nectar RIG by entering command entry change node-names IP.
    • Navigate to change ip-services
      • On Page 1
        • Input the node-name just created as the Remote Node for the CDR Feed
          • In our example it is Watchdog_Beta
      • Set the Remote Port to match cdrListenPort entered in Section 2: Nectar Foundation Configuration.
    Remote Port Configuration 
    • On Page 3
      • Set the Reliable Protocol to y
    Reliable Port Configuration


    In the ACM use the status cdr-link command to verify. You should see Link State: up.

    CDR Link Status

    In the RIG, navigate to Health > Quality Management > Call Details. You should see data begin to populate.

    Using the CDR Module

    When viewing a CDR record, Health > Quality Management > Call Details, right-clicking presents you with multiple options.

    Find Calling Number Media Sessions

    This option will only be present if the call included an IP endpoint. Selecting it will split the screen and present the related Media Sessions (VoIP RTCP metrics) for that originating number. If the dialed number (call-ED party) is an IP phone, you will have the option to Find Dialed Number Media Sessions.

    CDR Finding Number of Media Sessions

    Find Media Sessions by Time

    Selecting this presents all Media Sessions that began plus or minus 30 seconds, from the time of the selected record. As mentioned in Section 1, due to the time range, this is cumbersome in a large switch.

    CDR Finding Media Sessions by Time

    Filter Call Legs

    Selecting this will filter the CDR View to display any related records based on UCID. These include Conferenced and Transferred Calls. You can then use the options above to correlate to QoS records.

    Macintosh HD:private:var:folders:zn:vxm5vm2j2lbfvnzv05rhz4x80000gn:T:com.skitch.skitch:Nectar_RIG__nectar-cip1_nectarvoip_com_443.jpgFiltering Call Legs


    Your RIG is now collecting ACM CDR data, and you can link from a CDR record to the underlying VoIP legs of the conversation.

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.

    Eddy, a super-smart generative AI, opening up ways to have tailored queries and responses