FAQs Feed‎ > ‎

NetSapiens CDR Export (NCE) Tool

posted Jun 26, 2012, 8:42 PM by mbuch@netsapiens.com   [ updated Sep 4, 2013, 11:18 AM ]


Netsapiens NCE works with an NMS server providing scheduled CDR export and delivery. NCE is a java based application running under Netsapiens-tomcat. Configuration changes can be in the normal SiPbx UI. There are 2 parts, CDR_format and CDR_schedule. Any number of CDR formats can be added/modified through an Ajax based configuration page at System -> CDR export -> CDR Format. Any number of CDR schedules can be added/modified through the configuration page at System -> CDR export -> CDR Format.


  • Confirm netsapiens-tacserver is installed.
  • Install the application
    • "yum install netsapiens-nce"
  • Copy over the configuration file and edit it
    • "cp /etc/netsapiens/netsapiens-nce.conf.example /etc/netsapiens/netsapiens-nce.conf"
    • "vi /etc/netsapiens/netsapiens-nce.conf"
  • Confirm that "CDR export" is running and updating on the Status page of the SiPbx.  If it isn't running, then on the cmd line:
    • "touch /var/lib/tomcat5/webapps/netsapiens-nce.war" and check again

Creating a new CDR Format

  • Go to System -> CDR export -> CDR Format
  • Click "Add"
  • Enter a name and description for the new Format
    • Example: name = "Daily w/ PAC" description = "Daily format including PAC codes"
  • Find the format from the previous page and click "Select"
  • Click and drag available field from the left to the right.
  • Can arrange fields in order desired. Starting from the top down will format cdr field form left to right.
  • Click "Save CDR Format" when all modifications have been made.

Creating a new CDR Schedule

  • Go to System -> CDR export -> CDR Schedule
  • Click "Add"
  • Enter a name for new Schedule
  • Select domain to filter on and User to filter on.
  • Select period to time between cdr pulls and exports.
  • Select CDR Format, created a format in the previous section.
  • If you want to use the normal CDR format, please select "Standard"
  • Select whether or not you want to include the cdr header titles in the .csv file.
  • Select whether or not you want to include the inbound calls.
  • Select whether or not you want to include the outbound calls.
  • Configure (optional) Script
    • Select whether or no a script will run on each export
    • Select from available Scripts on the server
    • To add a script copy the script file it to /usr/local/NetSapiens/SiPbx/bin it +x rights
    • More info in next section
  • Select export method
    • Email
      • Sends email to recipient listed in field "E-mail"
    • Scp Copy
      • Secure copy of file to remote server
      • Uses the remotepath field for destination e.g:
      • SSH key exchange must be setup for the two servers.
    • Ftp Upload
      • Uploads the file to a remote FTP Server
      • Uses hostname field for remote hostname/ip or the ftp server
      • Username and password are required upload a file.
    • Backup Locally
      • Copy of file to local path
      • Uses the remotepath field for destination e.g: /backup/cdr/
  • Set the Next Run Time for the time and date it is to be run
NOTE: The LAST RUN TIME and NEXT RUN TIME should be set in GMT

Script syntax

  • The script will be executed with the temporary .csv file as the first argument
  • A script can echo a new filename if they wish to change the name of the exported file.
  • A script should be customized to a specific CDR Format
  • Example Script : Example Export Script
TAGS: domain related, cdr, exporting, call detail record, call data record, how to, instructions, nce