Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Overview

Here is a brief guide on "OAK reportX" software integration together with PBXact.

reportX, it's a popular tool for Call Reporting and Statistics generation.


Requirements

There are some specific requirements for you to set up interaction between reportX and Sangoma's PBXact correctly.

  • OAK reportX Server and Agents work on Windows OS
  • Tested with PBXact 14.0.13.4

Step-by-step guide

OAK Software Installation

To proceed with the configuration of reportX you need, first of all, the Installation of the Server and Agent components on a Windows OS machine.

For the easiness of usage, We've reported some screenshots of the reportX installation path.


Double click on the Setup Icon


Here you can find the Minimum Hardware & Operating System Requirements when using reportX


Initialise a new blank database (if it's your first time using reportX)


choose the Path on your machine where to Install the software


At this point, you are ready to Install Your System so you can hit the "Install" button.


As of the last step you'll need to restart your Windows Machine.


Once done with reportX installation, you need to make some configuration on the PBXact side to allow data access from the reporting tool components.

PBXact Configuration

You'll need to configure your PBXact access to allow the reportX to fetch data from the CDR log file

Access your pbx with ssh on CLI

Edit the following file with your preferred text editor

/etc/asterisk/manager_custom.conf

add these lines

Code Block
[reportX]
read = cdr

These code lines will create rights for the user named reportX to access on AMI port 5038 the cdr log file

Once the file has been edited, reload the new data with the command

Code Block
asterisk -rx "manager reload"


OAK Software Configuration

Once the machine is restarted, you can start configuring the software for interacting with your PBXact and start retrieving call's data.

From Windows Program List Look at "Oak Telecom" and choose the Setup

A login prompt appears

Default user and password for Administrative task are

Username: Supervisor

Passord: red


At this point, you should be in the Setup Panel

Click on the Left Menu on "Telephone System". Right Click on All Sites, and create your own Group "Add Group".

Once again, right-click on the just created Group and "Add Site", This will take you to the configuration of the connection between reportX and your PBXact telephone system.


Start with the Customization of the basics Service's properties.

Site No: 1

Short Name: PBX

Name: PBXact

Area Code: 0


Data Collection Tab allows you to connect to the PBX


Hit the "Configure" button to input connection data you've configured in "PBXact Configuration" section

Switch Address: <pbx-ip-address> - (Your PBX IP address)

Switch Username: "Action: login"

Switch Port: 5038

Switch Password: "Username: reportX" - (you can change it according to "PBXact Configuration" section

Command Script Location: C:\Program Files (x86)\Oak Telecom\Comms Suite\Core\AMI_Script.txt - (or any other location your software was installed in)

IMPORTANT! Look at Switch username and Switch Password parameters! They must be inputed in that specific way you see in the lines above!


You need to choose the right Translator to allow data being fetched and correctly understood by the reportX translator

Manufacturer: SANGOMA

Device: AMI

Translator (VCE): ASTERISK MANAGER PBXACT (PJ SIP)

Translator Authors comments: Pipeline translator


Last step is to choose the database for Call rating in the Costing tab

Tariff Library: C:\Program Files (x86)\Oak Telecom\Common Files\Costing Libraries\ - (or any other location your software was installed in)

Default Tariff: BT Basic Rate (2016) - (or any other available which you prefer)

Default Currency: EUR - (or any other available which you prefer)


Save the configuration by hitting the Save button at the very bottom of the pane.


Querying the Collected Data

From Windows Program List Look at "Oak Telecom" and choose the reportX program


Default user and password are

Username: Supervisor

Passord: red


Once you're logged in, you will be prompted with the reportX interface where you can easily look at collected data

On the left menu, you can choose the way you may query the collected data. Here above there is the Cost reports representation

Hereafter you may find an example of displaying data by "Response Reports" to check per extension/group summary

Play around with all the option on the Left Menu to create all the reports you may need. You may also create Scheduled Reports for automated cron tasks


Web Reports

It's nice to know there is also a web version of Reports running on a local web server on port 9092 (default service port).

The web version of reportX allows you to run the report tool on a Network environment making it accessible from different stations

Here is a Screenshot of the related Webpage default Http address is http://localhot:9092


Happy reportXing!

Content Table


Table of Contents


Useful links:


Website: www.oakinnovate.com