Course10:Advanced - Reporting Application

From innovaphone-wiki

Jump to: navigation, search

This book describes the concept of the Reporting application.

Contents

Concept

The innovaphone PBX can create a Call Detail Record(CDR) for each call, either internal (i.e. between PBX users) or external (e.g. to the PSTN). The CDR are XML-data structures containing information about a call, for example calling number, called number, time, etc. Until v8 this information had to be interpreted, stored and displayed by a 3rd party application. Since v9 the reporting application will solve this tasks.

The reporting application runs on the Linux - based fish-help.png innovaphone application platform.

screenshot.bmp concept

The reporting application uses an HTTP server to receive the CDRs from the PBX and a database to store them. The call data can then be inspected by the user via the call-list of his/her myPBX client or by using a web - browser. The administration/configuration of the reporting application is also web-based(HTTP).

Configuration

The configuration is described very exactly in the wiki. Please make sure to read the fish-help.png Reporting article.

Reports

By creating reports the stored CDR data can be presented to a user. Reports can be displayed in a web-browser or in a file (PDF, XML, CSV). It's possible to send the files also by email to a specific daytime and date.
Additional it's possible to set an interval to mail the reporting file, like daily, weekly or monthly and send it to different (comma separated) recipients.

PDF's can be configured with an own logo.
The logo must be an jpeg oder png with 32x32 pixels and footer can have a maximum width of 450 pixels and a maximum height of 50 pixels.

It is important to understand that the report shows calls from the view of PBX - objects and not from a call - centred view.
A call from User 1001 to User 1002 will have two entries:
  1. 1001 -> calls -> 1002
  2. 1002 <- is called by <- 1001
This are 2 entries representing the same (one) call.

A report is a call-list of an object. A report for User 1001 would show that he had an outgoing call, a report for User 1002 would show that he had an incoming call.

You can delete CDRs for certain/all users in a certain timespan. For more informations howto do this, please read the fish-help.png chapter database


User

Multi-User capability

You can configure multiple users, who shall have access to reports without having access to the whole reporting configuration.

The user can login with his user name and password on:

http(s)://Linux-IP/apps/innovaphone-reporting/user/login.php

The admin can assign one or more base filters to the user. A base filter is explained fish-help.png here.

If the user creates new reports, new own filters or report mails, he has to use one of his assigned base filters.


LDAP

The administrator has the possibility to configure several LDAP servers and dialing locations, that will be used to resolve numbers (CGPN or CDPN) into their respective directory entries.

PBX field must correspond to a name of a PBX since PBX's names are available in CDRs. The received CDR is parsed to get the PBX name and this name will be used to find the corresponding LDAP server and dialing location needed to resolve names.

fish-help.png Screenshot LDAP Configuration

Each configured LDAP server and dialing location can be activated/deactivated with the active flag.

If the country where you configure LDAP does not have Trunk/National prefix you should leave "National Prefix" and "Area Code" empty.

Filters

Filters are set up to create reports which are based on certain conditions.

I.e. show only calls between 08:00 am and 04:00 pm, show only incomming calls where state is "No response" and of a specific weekday or deeper conditions like the duration of ringing...

A filter can have multiple conditions and multiple filters can be combined on report creation.
A filter has a unique name with an optional description.

For detailed informationen how to define filter, please take a look fish-help.png here

Backup

The database and the configuration of the reporting application (e.g. filter) can be saved for backup manually or automatically. The fish-help.png backup mechanism of the Application Platform is used for this purpose. The restore procedure can be done only manually.

Replication



It is possible to have a second report application running as a backup for another report application. The PBX will use both CDR interfaces to send data to both of them, i.e. CDR0 sends CDRs to the master and CDR1 sends CDRs to the standby.

Additionally, the standby and master application synchronize their CDR - data. By this it is ensured that in case one of reporting instances is down, no CDR data is lost. The time interval between synchronisations is by default 15 minutes but can be adjusted as needed (from 1 to 60 minutes).

The replication is done incrementally, this means that only new CDR information is copied to the standby system. This way the network bandwidth required for the synchronisation of the master and standby system is minimized.

In case that the master application is down, the standby application will continue to receive and store CDRs. While the master reporting system is down, new filters cannot be created. A filter can be created only on the master application.

When the master system is available again, the new CDRs are copied from the standby application.

screenshot.bmp replication


Licensing

fish-help.png Reporting10 licenses must be installed on the PBX sending the CDRs, otherwise the received CDRs will be discarded by the reporting application.
The amount of Reporting10 - licenses depends on the amount of objects that should be monitored.
Each object needs one Reporting10 - license.

The PBX administrator can decide for each object whether or not it should be used for the reporting application, by activating the Reporting checkbox in the License Tab of the object - configuration menu.

If you have UC-Licenses but no Reporting-licenses you can use the myPBX call list (for myPBX call lists the Reporting Application is required), but not create reports at all.

Debugging

First make sure you have installed the Linux Application Plattform correctly, either on a xx10 gateway or on a vmware platform. Since the used default passwords depend on the used platform and also on the application, here an screenshot.bmp overview of the different users / password involved in the Linux Application Plattform.

Secondly, you should check if the PBX is sending CDRs to the Application Platform:
  • make sure that the PBX generates CDRs (Generate CDRs checkbox is activated in the fish-help.png PBX/Config/General page
  • check that the generated CDRs are sent to the correct IP-address through the fish-help.png CDR0 or fish-help.png CDR1 interfaces.
  • ensure that the device sending the CDRs has HTTP-access to the reporting application
  • finally you can verify that the CDRs are received by the reporting application by making a pcap trace. Have a look at the HTTP - messages and make sure that the CDRs sent by the PBX are accepted with a 200 OK - HTTP answer message.
Next check that the licensing is without errors:
(Overall Description) Reporting Licenses are not needed for myPBX call list service usage only.

If you still have problems, have a look at the fish-help.png reporting logs of the Application platform.

Finally, you can configure the fish-help.png Alarm Server of the Application Platform to send Alarms and Events to your PBX. These Alarms and Events are tagged with Linux as source in the fish-help.png Maintenance/Diagnostics/Events menu.

Reporting still doesn't work?
Please read the few configurations steps again fish-help.png Reporting article

If none of the above suggestions helped, post your question/problem into the Reporting forum wink


Personal tools