Difference between revisions of "Call Detail Records"

From FusionPBX
Jump to: navigation, search
 
(13 intermediate revisions by one other user not shown)
Line 3: Line 3:
 
'''Call Detail Record'''s ( also known as '''call data record''' or [http://en.wikipedia.org/wiki/Call_detail_record '''CDR'''] ) are detailed information on the calls. The information contains source, destination, duration, and other useful call details. Use the fields to filter the information for the specific call records that are desired. Then view the calls in the list or download them as comma seperated file by using the ''''csv'''' button.
 
'''Call Detail Record'''s ( also known as '''call data record''' or [http://en.wikipedia.org/wiki/Call_detail_record '''CDR'''] ) are detailed information on the calls. The information contains source, destination, duration, and other useful call details. Use the fields to filter the information for the specific call records that are desired. Then view the calls in the list or download them as comma seperated file by using the ''''csv'''' button.
  
'''RECORDINGS''':
+
Note that this page makes use of XML CDR for reporting.
 +
 
 +
===Post Dial Delay (PDD)===
 +
Post Dial Delay (PDD) is experienced by the sender as the time from the sending of the final dialed digit to the point at which the sender hears ring tone or other in-band information. In other words, the PDD would be the time from when the sender sends the INVITE to receiving the first ringing response.
 +
 
 +
That said, PDD does not take into account the time it takes the receiver to hear the call coming in due to the various factors on how they are setup for inbound calls. For example, call forwarding may affect the time it takes the receiver to know that someone is calling because of call forwarding. The sender might hear a ring tone almost instantly from the time it dials the final digit because they sent out an INVITE, but the receiver of the call might have setup inbound calls to be forwarded to their cell phone, in which now the call must travel through their phone system, to their phone system's gateway carrier to deliver the sender's call to the receiver's cell phone carrier network in order for the cell phone carrier to deliver the sender's call to the receiver's cell phone.
 +
 
 +
===Recordings===
 
Any calls which have the entry in the name column underlined (ie. the name is a link) have a recording available.  Clicking on the name will playback the recording in a new window.  In such cases the number entry will also be a link - clicking on this link will download the recording to your computer as a wav file.
 
Any calls which have the entry in the name column underlined (ie. the name is a link) have a recording available.  Clicking on the name will playback the recording in a new window.  In such cases the number entry will also be a link - clicking on this link will download the recording to your computer as a wav file.
  
'''Note:''' if you have no records showing up under Apps-Call Detail Records this is probably because:
+
===Possible issues===
'''The module is disabled'''
+
====No records showing up under Apps-Call Detail Records====
 +
This is probably because:
 +
 
 +
'''1. The module is disabled'''
 
  - Older installations of FusionPBX had the CDR CSV module enabled and the XML CDR module disabled.
 
  - Older installations of FusionPBX had the CDR CSV module enabled and the XML CDR module disabled.
  - If you reverse this situation you will then get call detail records.  You will also need to start the XML CDR module after you have done this.
+
  - If you reverse this situation you will then get call detail records.  You will also need to start
  Note that if you want to see your old CDR CSV records, after the change, or you really want to continue using CDR CSV you can go to Menu Manager and unhide the CDR CSV menu.
+
the XML CDR module after you have done this.  Note that if you want to see your old CDR CSV records,  
  Note that call recordings can be downloaded from the Call Detail Records page, but this capability is not currently provided in CDR CSV - so if you need to use call recordings it would be better to use XML CDR.
+
after the change, or you really want to continue using CDR CSV you can go to Menu Manager and unhide  
 +
the CDR CSV menu.
 +
 
 +
  Note that call recordings can be downloaded from the Call Detail Records page, but this capability is  
 +
not currently provided in CDR CSV - so if you need to use call recordings it would be better to use  
 +
XML CDR.
  
'''Wrong xml_cdr.conf.xml config'''
+
'''2. Wrong xml_cdr.conf.xml config'''
 
  - check '''<param name="url" value="<nowiki>http://localhost/mod/xml_cdr/v_xml_cdr_import.php</nowiki>"/>''' and adapt it to your situation.
 
  - check '''<param name="url" value="<nowiki>http://localhost/mod/xml_cdr/v_xml_cdr_import.php</nowiki>"/>''' and adapt it to your situation.
 +
 +
====FusionPBX menu bar disappears under certain circumstances when viewing Call Detail Records====
 +
If this happens to you it may be because you are using an old version of xml_cdr.conf.xml
 +
 +
Compare your version (advanced-script editor-files-autoload_configs-xml_cdr.conf.xml) with the current default one that is included in FusionPBX (advanced-php editor-files-includes-templates-conf-autoload_configs-xml_cdr.conf.xml).  If it is different copy the default one over yours.  Then edit the line <param name="url" value="http://{v_domain}/mod/xml_cdr/v_xml_cdr_import.php"/> and replace {v_domain} with the domain or IP address of your FusionPBX server.  Then edit the line <param name="cred" value="{v_user}:{v_pass}"/> and replace {v_user} with a complex name of upper and lowercase and numeric characters so it is really ugly and secure, and do the same for v_pass - make each of them completely unique.  Note that these don't have to match anything else on your server at all - this is because FusionPBX does something very simple but clever here - the xml_cdr module uses this account when it does an http post to FusionPBX of the new data, but FusionPBX looks at the same xml_cdr.conf.xml file that the module uses in order to check if the module is using a valid account and password - so since they both look at the same config file they are using the same account and password and will happily talk to each other!
 +
 +
Once you've made these changes you can save the file.  You could restart your server, or you could reloadxml and then restart the xml_cdr module - either is ok - it is up to you.  And then your changes will have taken effect and you should no longer lose your menu bar when looking at CDR information.
 +
 +
==Additional information==
 +
===XML CDR configuration===
 +
For more detailed configuration go to the XML editor (Advanced menu) and in autoload configs look at xml_cdr.conf.xml
 +
- note that by default only the a-leg of the call is logged THEREFORE if you make a recording of
 +
the b-leg you won't be able to retrieve it using the Call Detail Records.  If you want the b-leg
 +
as well you need to change log-b-leg=true in this config.
 +
===Harddrive space usage===
 +
- note that XML CDR data adds up fast, therefore you may need to clear this data at some point in
 +
the future.  By default freeswitch keeps this in /usr/local/freeswitch/log/xml_cdr/archive and
 +
inside that by year, month and day
 +
- recordings also take up space and have to be manually deleted if you want the space back - these
 +
are kept in /usr/local/freeswitch/recordings/archive and inside that by year, month and day
 +
 +
see [[Storage management]] for more information about things that take up space on your system.

Latest revision as of 22:15, 2 August 2011

Menu: (Apps-Call Detail Records)

Call Detail Records ( also known as call data record or CDR ) are detailed information on the calls. The information contains source, destination, duration, and other useful call details. Use the fields to filter the information for the specific call records that are desired. Then view the calls in the list or download them as comma seperated file by using the 'csv' button.

Note that this page makes use of XML CDR for reporting.

Post Dial Delay (PDD)

Post Dial Delay (PDD) is experienced by the sender as the time from the sending of the final dialed digit to the point at which the sender hears ring tone or other in-band information. In other words, the PDD would be the time from when the sender sends the INVITE to receiving the first ringing response.

That said, PDD does not take into account the time it takes the receiver to hear the call coming in due to the various factors on how they are setup for inbound calls. For example, call forwarding may affect the time it takes the receiver to know that someone is calling because of call forwarding. The sender might hear a ring tone almost instantly from the time it dials the final digit because they sent out an INVITE, but the receiver of the call might have setup inbound calls to be forwarded to their cell phone, in which now the call must travel through their phone system, to their phone system's gateway carrier to deliver the sender's call to the receiver's cell phone carrier network in order for the cell phone carrier to deliver the sender's call to the receiver's cell phone.

Recordings

Any calls which have the entry in the name column underlined (ie. the name is a link) have a recording available. Clicking on the name will playback the recording in a new window. In such cases the number entry will also be a link - clicking on this link will download the recording to your computer as a wav file.

Possible issues

No records showing up under Apps-Call Detail Records

This is probably because:

1. The module is disabled

- Older installations of FusionPBX had the CDR CSV module enabled and the XML CDR module disabled.
- If you reverse this situation you will then get call detail records.  You will also need to start
the XML CDR module after you have done this.  Note that if you want to see your old CDR CSV records, 
after the change, or you really want to continue using CDR CSV you can go to Menu Manager and unhide 
the CDR CSV menu.
Note that call recordings can be downloaded from the Call Detail Records page, but this capability is 
not currently provided in CDR CSV - so if you need to use call recordings it would be better to use 
XML CDR.

2. Wrong xml_cdr.conf.xml config

- check <param name="url" value="http://localhost/mod/xml_cdr/v_xml_cdr_import.php"/> and adapt it to your situation.

FusionPBX menu bar disappears under certain circumstances when viewing Call Detail Records

If this happens to you it may be because you are using an old version of xml_cdr.conf.xml

Compare your version (advanced-script editor-files-autoload_configs-xml_cdr.conf.xml) with the current default one that is included in FusionPBX (advanced-php editor-files-includes-templates-conf-autoload_configs-xml_cdr.conf.xml). If it is different copy the default one over yours. Then edit the line <param name="url" value="http://{v_domain}/mod/xml_cdr/v_xml_cdr_import.php"/> and replace {v_domain} with the domain or IP address of your FusionPBX server. Then edit the line <param name="cred" value="{v_user}:{v_pass}"/> and replace {v_user} with a complex name of upper and lowercase and numeric characters so it is really ugly and secure, and do the same for v_pass - make each of them completely unique. Note that these don't have to match anything else on your server at all - this is because FusionPBX does something very simple but clever here - the xml_cdr module uses this account when it does an http post to FusionPBX of the new data, but FusionPBX looks at the same xml_cdr.conf.xml file that the module uses in order to check if the module is using a valid account and password - so since they both look at the same config file they are using the same account and password and will happily talk to each other!

Once you've made these changes you can save the file. You could restart your server, or you could reloadxml and then restart the xml_cdr module - either is ok - it is up to you. And then your changes will have taken effect and you should no longer lose your menu bar when looking at CDR information.

Additional information

XML CDR configuration

For more detailed configuration go to the XML editor (Advanced menu) and in autoload configs look at xml_cdr.conf.xml

- note that by default only the a-leg of the call is logged THEREFORE if you make a recording of 
the b-leg you won't be able to retrieve it using the Call Detail Records.  If you want the b-leg
as well you need to change log-b-leg=true in this config.

Harddrive space usage

- note that XML CDR data adds up fast, therefore you may need to clear this data at some point in
the future.  By default freeswitch keeps this in /usr/local/freeswitch/log/xml_cdr/archive and
inside that by year, month and day
- recordings also take up space and have to be manually deleted if you want the space back - these 
are kept in /usr/local/freeswitch/recordings/archive and inside that by year, month and day

see Storage management for more information about things that take up space on your system.