From Pbxnsip Wiki

Contents 1 General 1.1 Requirements 1.1.1 Webserver 1.1.2 PHP 1.1.3 MySQL 1.1.4 Ready-to-use bundles of Apache/PHP/MySQL 1.1.5 Hosting Accounts 1.2 Before installing 1.3 Download 2 Installation 2.1 Installing the CDR Tool on the local machine 2.1.1 Specify the install location 2.1.2 Local web server settings 2.1.3 Review configuration 2.2 Installing the CDR Tool on a remote server 2.2.1 Specify FTP details 2.2.2 Select an installation directory 2.2.3 Web server settings 2.2.4 Review configuration 3 Setting up the connection and application settings 3.1 Licensing 3.2 Database setup 3.3 Table setup 3.4 Administrative user 3.5 Application settings 3.6 Save configuration 3.7 Setup Finished 4 Configuring the PBX 4.1 The 'General' settings tab 4.2 SOAP CDR URL 4.3 Save 5 Login to the CDR Tool

General

This document will describe how to install the pbxnsip CDR Tool that is used to monitor the calls on the pbxnsip PBX. There are two methods to install the CDR Tool: Local install and remote install.

Requirements

Webserver

A Webserver (e.g. Apache, Microsoft IIS, etc.) is required to serve the statistic pages of the tool.

PHP

The CDR Tool is written in PHP and an interpreter needs to be loaded in your webserver.

• Loaders for ionCube Encoded Files are required to run the tool.

These can be obtained directly from the ionCube (http://www.ioncube.com/loaders.php) Website

Here's an installation HOWTO: http://www.ioncube.com/loader_installation.php

• The required PHP version is 4.x

More information and PHP downloads can be found here: http://www.php.net/.

MySQL

A MySQL server is required to store the information the CDR Tool recieves from the PBX. Both MySQL 4.x and 5.x will work. You can get a free copy here:

- MySQL Community Server Version 5.1

- MySQL Community Server Version 5.0

- MySQL Community Server Version 4.1

Ready-to-use bundles of Apache/PHP/MySQL

There are also a lot of ready-to-use bundles of the software, so called 'lamp' or 'wamp' packages (Linux/Windows Apache, MySQL, PHP). If you are new to this topic these packages are an ideal starting point. They are pretty easy to configure and to set up.

Wikipedia (LAMP) is a good page to get more information about the software bundles and XAMPP from Apachefriends is a very good bundle that will work right out of the box on Windows, Linux and MacOS.

A note on bundles: The bundles mentioned above are designed for development or testing environments and will not fit the security needs of a production system. Please make sure you change the configuration of the bundles or build the packages yourself to ensure a reasonable level of security on the production system.

Hosting Accounts

The CDR Tool can be installed on hosting accounts (e.g. GoDaddy), too. Please make sure that you have a MySQL database and PHP 4 purchased together with the hosting account.

Before installing

Before installing the CDR Tool the following steps needs to be performed:

• Create a MySQL database and make sure it is accessible from the install location over the network
• Loader for ionCube Encoded files
  • Please refer to the ionCube support page on how to install the loaders properly
  • In some cases the loaders can be loaded automatically
  • The loaders can be obtained from the ionCube Website
  • A FAQ on the ionCube loaders is available here: http://www.ioncube.com/faqs/loaders.php
• If installing to a remote machine, make sure you have a FTP account with read/write permissions ready

Download

You can download the installation executable here:

• http://www.pbxnsip.com/download/cdrsys-1_0_1.exe

Installation

Installing the CDR Tool on the local machine

You can install the CDR Tool on a local machine. The advantage of this method is the easy configuration and the speed of installation. You also have instant access to the services (Webserver, MySQL) and their configuration in case you need to change anything.

Click 'Next' to proceed.

Specify the install location

The CDR Tool must be installed in a place, where it is reachable from the web. If you are running Apache this folder is called htdocs, if you are running Microsoft IIS this folder is often located in C:\inetpub\www. Please refer to the manual of your web server how to find this folder and how it is configured in detail.

In this example we are using the XAMPP package, so our folder is called C:\xampp\htdocs. The installer will create a subfolder automatically, so just specify the folder you want it to be put in. You may also change the name of the folder that will be created, that is optional.

Local web server settings

You have selected a folder to install to on the previous screen. In our example it's C:\xampp\htdocs. Now you have to specify how this folder is reached from the web. As we are installing to a local machine, in almost all cases this value should be set to http://localhost.

Review configuration

Now the connection to the web server will be tested and some settings of the web server will be detected. You can see a summary on this screen.

If everything is set up properly you are ready to install. Click 'Next' to start the file copying process.

The Setup is now finished. Please click 'Finish' and you will be taken to the second step of the installation:

Setting up the connection and application settings

Installing the CDR Tool on a remote server

If you are installing to a remote server, this may be a server in a co-location, a server in your network or a hosting account, you must have FTP access to copy all necessary files to the site. Please consult the network administrator or manuals from your hosting provider how to get access.

Select 'Install to a remote machine' and click 'Next'.

Specify FTP details

Please enter your FTP account as shown on the screenshot.

After that, please click the 'Browse' button. This will perform two steps:

Verify your account details

Select a folder for the installation (see below)

Select an installation directory

Please select the folder you want the CDR Tool to be created in. The installer will automatically create a folder for the CDR Tool in the folder you select here.

It is recommended to select the top level (in our example: ftp.acme.com). This will install the CDR Tool to acme.com/cdrsys.

Please note: If you select the main directory as the installation destination and click 'OK' the installation folder will remain empty. That is ok, it indicates that it will create the folder on the top level.

Web server settings

Please enter the address where the folder you selected in the previous screen will be reachable. In this example it is http://www.acme.com because we selected the top level directory of our web server.

Click 'Next' to proceed.

Review configuration

Now the connection to the web and ftp server will be tested and some settings of the web server will be detected. You can see a summary on this screen.

If everything is set up properly you are ready to install. Click 'Next' to start the file copying process.

The Setup is now finished. Please click 'Finish' and you will be taken to the second step of the installation:

Setting up the connection and application settings

Setting up the connection and application settings

After you have finished the setup routine it is time to set the connection and application settings. To do so, please follow these instruction.

Licensing

In order to start using the CDR Tool please provide a valid license file.

Ask your reseller, if you experience problems with the license file.

Database setup

Please enter the following information:

• Host

Where your database is located. If you are installing on a local machine and the database is on the same machine, you can enter localhost

• User

Which user to use to connect to the MySQL server

• Password

Password of this user

• Database

Database to use. Note: This database needs to be created before it can be used.

Once all the information is entered you can click on the button 'Test connection and database settings' to verify the connection. If everything is ok, please continue to the next step.

Table setup

The CDR Tool needs to setup some tables to work properly. These tables can be setup automatically by the wizard. To do so, please click 'Setup tables'.

Once the tables are set up, proceed to the next step.

Administrative user

An administrator needs to be created who will administer the CDR Tool. The administrator will be able to manage the user accounts and update the settings.

The username of the administrative user will be admin. Please choose a reasonably secure password for the administrator since he will have full control of elementary settings of the CDR Tool.

Please also provide an e-mail address where the administrator can be reached.

When you provided all information click 'Setup administrator'.

Application settings

These are elementary settings for the tool.

• Working directory

Please provide the absolute path to the CDR Tool directory. Per default it should be /cdrsys/. Please note the trailing slash ('/').

• Image directory

Please set the image directory to use. Per default it should be /cdrsys/img/. Please note the trailing slash ('/').

Experienced users: You may also change it to a directory of your choice to customize the appearance of the CDR Tool

• CDR Entries Per Page

How many entries should be displayed per page

• 12 Hour Format

If checked, the time format will be HH:MM am/pm, if unchecked a 24 Hour Format representation will be used.

• Debug Log / CDR Process Log

This will give a lot of debug information during the operation of the CDR Tool. Please don't use this setting unless you know what it does and really need it!

• SOAP/XML Dump

This will dump the recieved SOAP/XML CDRs also to files. This should not be set until you need to have separate dumps of the SOAP/XML packets.

If you have set up all necessary fields, you may continue to the last step.

Save configuration

Please review all settings and click 'Save settings and finish configuration' to finish the setup.

Setup Finished

Here you can see the necessary information for setting up the pbxnsip PBX to publish the CDR information to the CDR Tool.
Please note the URL's given here. In our example you will see that the login to the CDR Tool can be found at http://www.acme.com/cdrsys/login.php and the SOAP CDR URL for the PBX is http://www.acme.com/cdrsys/processCDR2.php. In your installation the URLs will be different depending of the domain and sub directory you are using but the pages login.php and processCDR2.php will remain the same.

Please take a look at Configuring the PBX now.

Configuring the PBX

The pbxnsip PBX needs to publish the call data to the CDR Tool so it can be viewed from there. To do the necessary configuration you have to login to your PBX. Please read the Login page to learn more.

The 'General' settings tab

After logging in to your PBX please navigate to 'Settings' and click on the 'General' tab.

SOAP CDR URL

Scroll down to the 'Appearance' part and enter the URL that was generated during the installation process on the last screen into the SOAP CDR URL field as shown on the screenshot (see also Setup Finished section).

Save

Click on 'Save' to save the setting and logout from the PBX. You are now ready to login to the CDR Tool.

Login to the CDR Tool

Now everything should be set up and you are ready to login to the CDR Tool. Please navigate to the login URL that was generated during the installation process (see Setup Finished section).