CDR Pro Reporting Module

Introduction

CDR Pro is a commercial module designed to enhance the user experience by providing a simplified presentation of Call Detail Records (CDRs). With CDR Pro, users and administrators can easily access a quick overview of their CDRs within a specific time frame.

This module offers a range of convenient functionalities, including:

  1. Predefined Report Sets:  Users can choose from a variety of predefined report sets, such as "all calls," "inbound," "outbound," "internal," "answered," "missed," "DID summary," "Ring group," and "Queues." This allows for quick and easy access to specific call details.

  2. Flexible Date Selection:  CDR Pro provides the flexibility to select predefined periods or define a custom date and time range to generate the desired report. This empowers users to focus on specific timeframes relevant to their analysis.

  3. Graphical and Tabular Views: Users have the option to view the generated reports in both graphical and tabular formats. This feature enables a visual representation of call data trends or a comprehensive tabular overview for in-depth analysis.

  4. Export Options: CDR Pro enables users to export the reports in various formats, including CSV, Excel, PDF, or JSON. User can even export the graphical view in pdf format. This flexibility ensures compatibility with different software applications and simplifies data sharing and further analysis.

  5. Report Scheduling: CDR Pro also offers the convenience of automated report scheduling. Users can choose from a range of predefined flexible options for scheduling reports, or they can define their own custom date and time range frequency. This feature ensures regular and timely access to the desired call detail reports.

Overall, CDR Pro revolutionizes the way users interact with CDRs, providing a user-friendly interface, customizable options, and streamlined access to vital call data.

 

Included in the feature set for CDR Pro is the ability to record the Asterisk MES (Media Experience Score) for calls. The MES quantifies the audio quality for a specific call, and makes that value available to the administrator as part of the call record. FreePBX requires Asterisk version 20 or higher in order to see the MES features. To update your Asterisk version, see this wiki page:

https://sangomakb.atlassian.net/wiki/spaces/PP/pages/11403311

CDR Pro Home

How to Install the Module

To utilize the CDR Pro commercial module, a valid commercial module license is required.

There are two methods available to install this module: through the module admin section or via the PBX Command Line Interface (CLI).

  1. Installation via Module Admin Section:

    The PBX Module Admin section provides a user friendly GUI for managing and installing modules. To install CDR Pro using this method, follow these steps:

    1. Log in to your PBX administration panel.

    2. Browse to the "Admin" menu and select "Updates" 

    3. Click the “Check Online” button

    4. In the Module Admin section, locate and select the CDR Pro module from the available modules list.

    5. Click on the "Download and Install" or "Purchase and Install" button, depending on whether you have already acquired a license for the module or need to purchase one.

    6. Follow the on-screen prompts to complete the installation process. Once installed, the CDR Pro module will be installed.

  2. Installation via PBX CLI:

    The PBX Command Line Interface (CLI) allows for advanced management of the PBX system. To install CDR Pro using the CLI, follow these steps:

    1. Access the command line interface of your PBX system, either through SSH or directly.

    2. Execute the command fwconsole ma downloadinstall cdrpro.

    3. Wait for the installation to complete, and the CDR Pro module will be installed.

Syncing existing CDR data to CDR Pro compatible format 

The primary challenge with the existing Call Detail Records (CDRs) lies in the difficulty of quickly comprehending the details of a call. The current CDRs display all the possible legs of a call, making it practically impossible to correlate them with the actual number of calls.

CDR Pro addresses this issue by unifying all the legs of a call and presenting a concise summary that allows users to swiftly grasp the overall information of each call. To achieve this, CDR Pro manages its own database table that captures a single, unified entry for each call instead of multiple legs.

To synchronize the data and ensure up-to-date information, users can manually execute the following command. It is important to note that the default synchronization process only considers the last six months of data. 

This is just one time step to populate the CDR Pro data from your existing CDR table , once the module is installed/running , it will keep updating required data to own database tables so no need to do sync again.

fwconsole cdrpro --sync

GUI access for this module

After successfully installing and activating the CDR Pro commercial module, it will become an integral part of the Reporting section within your PBX system.

Once installed, users will notice two options related to CDR Pro:

  1. CDR Pro:

    The "CDR Pro" option provides access to the main functionality of the CDR Pro module. By selecting this option, users can navigate to a dedicated interface where they can view and analyze call detail records in a simplified and user-friendly manner. CDR Pro presents comprehensive summaries of calls, allowing users to quickly gain insights into call patterns and trends.

  2. CDR Report Scheduler:

    The "CDR Report Scheduler" option enables users to schedule automated generation and delivery of CDR reports. This feature offers a range of flexible scheduling options, including predefined frequencies (such as daily, weekly, monthly) as well as the ability to define custom date and time ranges. By leveraging this functionality, users can ensure that they receive regular and timely CDR reports without manual intervention.

By incorporating the CDR Pro commercial module into the Reporting section, FreePBX users can effortlessly access its powerful features for analyzing call detail records, generating insightful reports, and automating report scheduling. This integration enhances the overall reporting capabilities of the system, enabling users to make data-driven decisions and gain valuable insights into their call activities.

How to view Reports

New calls will be listed in the CDDR Pro module within 10 minutes of the call ending.

By default, the landing page of CDR Pro will display the "All Calls" graphical report, presenting the call details from the last 1 month. This provides administrators with a quick overview of their overall call activity within the recent timeframe.

CDR Pro offers a range of pre-defined reporting templates, allowing users to access specific sets of reports tailored to different aspects of call data analysis. These pre-defined reporting templates include:

  1. All Calls : This template focuses on providing detailed information about all the calls performed by the system.

  2. Inbound Calls: This template focuses on providing detailed information about incoming calls received by the system.

  3. Outbound Calls: This template concentrates on displaying comprehensive data related to outgoing calls made from the system.

  4. Internal Calls: This template emphasizes internal call activity within the system, enabling users to analyze communication within the organization.

  5. Answered Calls: This template specifically highlights calls that were successfully answered by the intended recipients.

  6. Missed Calls: This template focuses on displaying calls that were not answered or missed by the intended recipients.

  7. DID Summary: This template provides a summarized overview of calls based on the Direct Inward Dialing (DID) numbers used in the system.

  8. Ring Group: This template presents a consolidated report of calls received by specific ring groups configured within the system.

  9. Queues: This template focuses on call data related to queues, allowing users to analyze performance and activity within queue configurations.

  10. Extension Details: This template focuses on call data related to the extensions.

These pre-defined reporting templates cater to different aspects of call analysis, enabling users to quickly access relevant information without the need for manual data filtering or customization. Users can select the desired template to view reports specifically tailored to their analysis requirements.

We can choose the "Type of report" , Period and then click on "Generate" to view the report. 

Tabular view vs Graphical view

In the top right corner of the CDRPro interface, users will find a toggle switch that allows them to switch between viewing the report in either Tabular or Graphical format. By default, the toggle switch is set to the Graphical format, providing a visual representation of the data.

Graphical View of CDR Reporting

A graphical view of Call Detail Records (CDR) reporting will help to see a proper CDR data visualization and provide a more intuitive understanding of the information.

Graphs or visual information will vary depends on the type of reports. 

Please find the below screenshot of the "All" Reports type which shows the CDRs information for a selected date/time range in below different formats - 

  1. Call Type (Inbound / Outbound / Internals Calls)

  2. Call Disposition ( depends on types of disposition like Answered, Busy , Failed and No Answer)

  3. Time Indicator - Hourly based call volume information

  4. Average MES - Hourly based Average Media Experience score

Graphical view of all CDR report

Tabular view of CDR Reporting 

Tabular view also shows the Call details options to see more details / multiple legs of a call.

Call Recordings

Action column provides the Call Recording play and download option for that particular call. 


Detailed Call Information

Media Experience Score (MES)

Channel Event Logging (CEL)

We can also see the various events of a call from the Call Details column - 


Call Legs Details 

This will show the details of all the legs of this particular call entry -  

Example below first screenshot shows RINGGROUP call flow and second one shows QUEUE call details.

 

Exporting the CDR Reports

Exporting graphical view (PDF) 

Option next to the generate button will export the shown charts/graphs summary into the PDF report.

Exporting tabular view ( CSV, JSON, PDF, EXCEL)

Scheduling reports

Users have two options to configure the scheduling of CDR reports within the CDR Pro module:

  1. Using the "Schedule" Option: Next to the report generation section, users can find the "Schedule" option. By selecting this option, the system will automatically pre-fill the selected report type and period field in the scheduling configuration. Users can then proceed to customize the other scheduling parameters according to their requirements. This option offers a convenient and streamlined approach to schedule reports based on the selected report type and period.

  2. Utilizing the Right Navigator: Another option available to users is to navigate to the "View Scheduled Report" section using the right navigator. By accessing this section, users can configure and manage scheduled reports. They can define the report type, period, and other scheduling parameters from scratch, providing greater flexibility in tailoring the report schedule to their specific needs. This option is ideal for users who prefer a more comprehensive and manual approach to scheduling CDR reports.

Both options allow users to set up scheduled reports efficiently, ensuring regular generation and delivery of CDR reports based on the chosen report type and period. The choice between the two options depends on the user's preference and the level of customization required for the scheduled reports.

CDR Report scheduler 

Within the CDRPro module, the "Report Scheduler" section empowers users to create schedulers for generating the desired types of CDR reports based on configured frequencies. Users can define the scheduling parameters to automatically generate reports at specified intervals. This functionality ensures the consistent generation of CDR reports without manual intervention.

Additionally, the "Email Settings" feature enables users to define the email template according to their preferences. Users can customize the format and layout of the email in which they receive the CDR reports. This customization allows for a personalized and user-friendly presentation of the report data when delivered via email.

By leveraging the Report Scheduler and Email Settings, users can automate the generation and delivery of CDR reports while tailoring the email format to their specific requirements. These features enhance the usability and flexibility of the CDRPro module, providing a seamless and customizable experience for managing and accessing CDR data.

Play button in the action column can be used to run the report immediately , one time only. This could be a useful handy tool to confirm all the report scheduling configuration is proper or not.

Email Template settings - 

Creating the scheduler

To create a scheduler within the CDR Pro module, users can configure the following options:

  1. Report Type: Select the desired type of CDR report from the available options, such as "All Calls," "Inbound," "Outbound," "Internal," "Answered," "Missed," "DID Summary," "Ring Group," "Queues,"  "Extension Details" or other relevant report types. This allows users to specify the specific category of calls they want to include in the generated report.

  2. Frequency: Define the frequency at which the CDR report should be generated. Users can choose from options like daily, weekly, monthly, or create a custom schedule based on their requirements. This setting determines how often the report will be generated and sent.

  3. Date/Time Range: Specify the date and time range for which the report should be generated. Users can select predefined periods (such as the last 24 hours, last 7 days, or last month) or define a custom date/time range. This setting determines the specific timeframe covered by the generated report.

  4. Email Recipients: Provide the email addresses of the recipients who should receive the generated CDR report. Users can add one or multiple email addresses to ensure the report reaches the intended recipients.

  5. Email Template: Customize the email template in which the CDR report will be delivered. Users can define the format, layout, and content of the email, ensuring that the report is presented in a readable and informative manner. This allows users to tailor the email to their preferences and specific reporting needs.

  6. Format : User can select Email attachment format as JSON, PDF, CSV and EXCEL so that email will be sent with selected format as attachment.

By configuring these options, users can create schedulers within the CDR Pro module that generate CDR reports according to the specified parameters. These schedulers automate the report generation process and provide users with timely and relevant call data insights.

 

Schedule option next to report generate: 

CDR Pro Widget for the UCP (User control panel)

Add the CDR Pro widget using the ADD WIDGET option from UCP panel

 

Graphical view of UCP widget

 

Tabular view of UCP widget

Examples of available types of Reports 

All Calls 

All Calls Tabular View
All Calls Graphical view

Inbound Calls 

Inbound Calls Tabular view

Outbound Calls

Outbound Calls Tabular view

Internal Calls 

 Internal Calls Tabular view
Internal Calls Graphical View

 

Missed Calls

Missed Calls Tabular View

 

Missed Calls Graphical View

 

Answered Calls

 

 Answered Calls Tabular View

 

Answered Calls Graphical View

 

Extensions Details

 

 Extensions Details Tabular View

 

Extensions Details Graphical View

 

DID Details

 

DID Details Graphical View

 

 DID Details Tabular View

Ring Group 

 

Ring Group Tabular View

 

Ring Group Graphical View

Queue

Queues Tabular View

 

Queues Graphical View

 

Return to Documentation Home I Return to Sangoma Support