3CX Exporter User Guide

1.Introduction #

Creating custom records and archiving Call Detail Records was once a difficult task. However, 3CX Exporter has now made the job easy for you. Moving Call Detail Records from 3CX to SQL Server or MySQL reduces the demands on your 3CX server, and allows you to use the tools you already know to create custom reports.

1.1. What is 3CX Exporter?

3CX Exporter automates the export of Call Detail Records (CDR) from 3CX’s internal PostgreSQL database to either Microsoft SQL server or MySQL. This small Windows service runs automatically in the background to keep your external database in sync with the data in 3CX.

1.2. Why 3CX Exporter?

1. Make it possible to create custom reports.

2. To integrate (utilize) that data in other applications (like CRM integrations).

1.3. How to use 3CX Exporter?

3CX Exporter is a onetime installation process. Once you install it, the product will automate the export of Call Detail Records according to the export frequency you set during the installation process. However, in future, you can change both the export frequency and database as well.

2.Prerequisites #

Before installing 3CX Exporter, you need to ensure that your computer meets the minimum requirements mentioned below:

1. 3CX Version 12 – 15.5

2. Windows 7 – 10

3. SQL Server 2008 or above, or MYSQL

4. Windows Server 2008 R2 (64 bit) and above

5. .Net 4.5

6. 3CX Relay Service

7. Installation on a domain controller may require additional assistance

3.Installation #


Download software

You can order 3CX Exporter on-line at http://www.voiptools.com.  Your order confirmation email will include your license key and a link to download the software.

 


Install Prerequisites

There are a number of prerequisites that must be installed prior to installing 3CX Exporter. These prerequisites include Microsoft SQL Server.

 


Install 3CX Exporter

This User Guide contains step-by-step instructions to successfully install 3CX Exporter.  Begin by extracting the installer from the downloaded zip file (Step 1 above), then run the setup program named 3cxExporterInstaller.exe


Register your License Key

You must register your license key to activate 3CX Exporter. Your license key is included in your order confirmation email, and can also be found in your order history on our website.

  • When installing SQL Server, we recommend you install it in “Mixed Mode” to include SQL Authentication, and install SQL Management Studio
  • When installing IIS, be sure to install Basic Authentication, .Net Extensibility, and ASP.Net 4.X

3.1.Step by step Installation Procedure #

The following section guides you through a detailed walk-through of the installation process.

Step 1: Download 3CX Exporter

You can check for the software download link included in your order confirmation email. As an alternative, you can also find the link from your order history on our website.

Exporter must be installed directly on the 3CX server. Installing the application in a server other than 3CX server will not work.

Step 2: Extract the installer from the downloaded .zip file
The file you downloaded in the above step is a compressed .zip file.

1. Position the mouse on the zip file and right-click.

2. From the popup menu, select Extract All to extract the software.

Step 3: Start the installation process

1. From the extracted folder, find the file 3CXExporterInstaller.exe

2. Double-click the file to start the VoIPToys Setup Wizard

3. Click Next to continue.


Figure 1: VoIPToys 3CX Exporter

Special note for Multi-tenant installations:

If you are installing 3CX Exporter on a 3CX Cloud (Multi-tenant) server, an additional screen will display with a combo box containing a list of all installed tenants. Select the correct tenant and continue.

Step 4: Download 3CX Relay (if required)

3CX permits one 3rd party application to communicate with the 3CX server at a time. To overcome this limitation, VoIPTools created the 3CX Relay Service. The Relay is a lightweight application that is installed directly on the 3CX server. The Relay exposes the 3CX Call Control API (and other VoIPTools services) to all our applications, and manages requests and events between by VoIPTools products and 3CX.

The Relay also makes it possible to install our VoIPTools products on a remote server (including over the internet).

1. If you have not previously installed the Relay on your 3CX Server, you can download the Relay installer by clicking on the Download Relay button. The Relay must be installed directly on the 3CX server.

2. If you are installing 3CX Exporter directly on the 3CX server, you can install the Relay simply by clicking the Install/ Upgrade Relay button and following the Relay install instructions.

If you have already installed the Relay, you need not install it again unless a newer version is required.

Step 5: Test Relay Settings

1. In the Relay Services Host field, enter “localhost” if installing 3CX Exporter on the 3CX server. If 3CX resides on a different server, enter the IP address or FQDN of the 3CX server.

2. In the Relay Services Port field, enter the value as 8700

The default port number is 8700 but will likely be different in multi-tenant environment.

3. Click Test Relay Settings to confirm 3CX Exporter can communicate with the Relay services running on the 3CX server


Figure 2: Test Relay Settings

4. Click Next to continue the installation.

Step 6: Run the application

Once the installation is complete, click Run Application


Figure 3: Run Application

Step 7: Register software

1. In the License screen, enter registration information in all the fields.

2. Click Register


Figure 4: Register Software

3. Click Save


Figure 5: Restart dialog box

4. You can restart the service later. Click No

Step 8: Setup the database

In the SQL tab, select the radio button of appropriate server.

1. For MySQL Server, the database will be automatically setup based on the credentials provided.

2. For Microsoft SQL Server, click Setup


Figure 6: Setup Database

Step 9: Test database connection

1. In the Connection Properties box, enter the SQL server name. If using the free SQL Express edition, the default SQL Instance name is \SQLExpress.

  • If you want to use ‘SQL Authentication’, then install SQL Server in ‘Mixed‘ mode.
  • If SQL Server is installed on a server other than the server where 3CX On Call Manager is installed, you will need to configure SQL Server to allow remote connections.

Figure 7: Connection Properties

2. Enter the login credentials.

a. If using Windows integrated security, select Use Windows Authentication. The VoIPTools installer will create a local windows user name as “VoIPToys” and will give sufficient rights to this user to create / update the SQL database.


Figure 8: Windows Authentication

b. If SQL Server authentication is desired, select Use SQL Server Authentication. Be sure to select a SQL Login that has sufficient permissions to alter the database and create SQL objects. Enter the User name and Password, and select appropriate database value from the Select or enter a database name drop down.


Figure 9: SQL Server Authentication

The first time you install 3CX On Call Manager Enterprise, DO NOT enter a database name. Choose Select or enter a database name and leave the database name blank. The installer will create the SQL database automatically and apply the necessary permissions. If upgrading 3CX On Call Manager from a previous version, select the existing database from the list.

3. Click Test Connection button. Test Results message box appears.


Figure 10: Test Results message box

4. Click OK

5. Enter Domain Name, User Name and Password


Figure 11: Windows Credentials

6. Click Save

7. You can restart the service later. Click No

Step 10: Setup export frequency

1. In the Export tab, set Export frequency value. This is the frequency for automatic synchronizing of updates.


Figure 12: Setup Export Frequency

2. Click Save

3. You can restart the service later. Click No

Step 11: Get PBX settings for 3CX Exporter

1. In the 3CX tab, click Get Settings


Figure 13: Get PBX Settings

2. In the Consider message box, click Yes


Figure 14: Consider dialog box

Step 12: Test PBX settings

1. Click Test


Figure 15: Test PBX Settings

2. Click OK


Figure 16: Success message box

3. Click Save

4. Restart the service. Click Yes

4.Call Detail Records (CDR) Files #

In addition to exporting data directly from the 3CX PostgreSQL database, Exporter can also export Call Detail Records (CDR) created by 3CX as text files. Instructions for configuring 3CX to create these optional files are outlined below. The CDR files contain useful information about every phone call including participants, duration, the call chain, etc. While the CDR files do not include the same level of detail available in the PostgreSQL database, the data structure is far easier to understand. If the CDR files contain all the information you need, it is recommended that you utilize the CDR files rather than accessing the PostgreSQL database.

4.1.Configure 3CX to Automatically Create CDR Files #

1. Log in to 3CX Management Console with valid credentials.

2. On the left navigation pane, select Settings from the menu.

3. In the Settings screen, select the $CDR icon to display the CDR Settings screen.


Figure 17: Settings menu

4. Check Generate CDR checkbox

5. Select Separate files for each call from the combo box.

It is important that you configure 3CX to save each call as an individual file.

Figure 18: Configure 3CX to automatically create CDR files

6. Under Configure CDR Output fields section, click Add CDR button.


Figure 19: Add CDR

7. In the Select CDR Output fields to add pop up, you can see a list of CDR Output fields that need to be added to the CDR table.

8. Select all the fields by holding down the shift button and clicking on each field, then press OK to add all the fields.

Be sure not to remove any fields from the list or change the order of the fields. Exporter expects all the fields to be exported in the default order. Therefore, order is important. Below is a list of all the fields in the proper order.

9. Scroll down to confirm all the new CDR Output fields are added to the list. To know the list of supported output fields and what they mean, click here.


Figure 20: Default Order of CDR Fields

10. Once you have added all the CDR fields, Scroll up to the top of the screen. Next to CDR Settings, press OK to save your changes.


Figure 21: CDR Settings – Generate CDR

CDR Records – Output Field Definitions

The following are the supported output fields and what they mean:

historyid This is the call number – each call has a number, internal to 3CX. It is useful for call tracking.
callid This is the Call ID – the unique identifier of the call.
duration Call Duration time.
time-start Call Start time.
time-answered Answered time.
time-end Call terminated time.
reason-terminated Why the call was terminated.
from-no Source caller number.
to-no Destination To Number.
from-dn Distinguished name of caller – this is 3CX Specific Can be omitted by 3rd party developers.
to-dn Distinguished name of To – Destination – this is 3CX Specific Can be omitted by 3rd party developers.
dial-no Dialed number.
reason-changed The Reason why a change occurred in a call – example in a transfer you will see “ReplacedDst” which means that the destination was replaced with something else.
final-number Final Number – the final number which was replaced (In a transfer this will be the final connected number).
final-dn The Distinguished name of the final number entity – this is 3CX Specific and can be omitted by 3rd party dev.
bill-code Billing code dialed after the destination (for example: **Sales).
bill-rate The billing rate that matched the prefix of the rate. This is used to apply a cost calculation variance.
bill-cost The Cost of the call calculated with simple proportion / minute.
bill-name The rate name of the billing variance.
chain All endpoints which were involved in the call.
from-type Source type
to-type Destination type.
final-type Final destination type.
from-dispname Source Display Name.
to-dispname Destination Display Name.
final-dispname Final destination Display Name.

4.2.Configure Exporter to Process CDR Files #

Once 3CX has been configured to generate CDR files, you need to configure Exporter to process the files and import the data into SQL or MySQL.

1. Start 3CX Exporter

2. Select the Export tab


Figure 22: Export tab: Process CDR Files

3. Select the Process CDR Files check box

4. Press Save to save your changes

5. When asked whether to restart the service, chose Yes to restart the Exporter service

Exporter will place the CDR data extracted from the 3CX CDR files into the table named cdr.

5.View 3CX Database Records #

1. Connect to database server.

2. Under Object Explorer navigation pane, expand Databases, and then expand 3CX Exporter and Tables to see various tables.


Figure 23: Object Explorer

3. Right click on any table to see the right click menu

4. Choose Select Top 1000 Rows to view data in the workspace area.

6.View Data in Microsoft SQL Server Database #

To view the exported data in Microsoft SQL Server database, install the SQL Server Management studio and follow the instructions below:

1. Connect to Microsoft SQL Server database server with valid credentials./p>

2. Under Object Explorer navigation pane, expand Databases, and then expand 3CX Exporter and Tables to see dbo.cdr table. You will see that the new CDR Output fields that you just added through 3CX Management Console are now added to the dbo.cdr table in the database server./p>

Figure 24: New CDR Output fields added to dbo.cdr table in the database server

7.Support #

If you need support, would like to request an enhancement to 3CX Exporter, or are interested in discussing a custom solution, you can contact as at the following:

Address:   2306 Shimmering Bay Lane, Cincinnati, OH 45244-2760

Hours:       Monday – Friday (8:00 A.M. – 6:00 P.M. Central Standard Time)

Phone:      USA: +1 801-642-4655

Skype:       VoIPToys

Email:        info@VoIPTools.com

Web:          http://www.VoIPTools.com

Suggest Edit

Get the Best Solution for your Business

Whether through one of our commercial products, or a custom solution built to meet your specific needs, we can help you get the most out of your 3CX investment. Call us today!

Contact Us