View Categories

Exporter V20

18 min read

Introduction #

Effortlessly Sync and Manage 3CX Data with 3CX Exporter for Real-Time Custom Reports.

Experience seamless synchronization and effortless data management with 3CX Exporter. This tool enables you to sync your 3CX data and Call Detail Records (CDR) files with popular databases like Microsoft SQL Server or MySQL. Let this Windows service work in the background, ensuring your external database remains in harmony with your 3CX system. Gain instant access to real-time information and generate custom reports for your business. Say goodbye to manual hassles and hello to streamlined operations with 3CX Exporter.

What is 3CX Exporter? #

The 3CX Exporter automates the export of Call Detail Records (CDR) from 3CX’s internal PostgreSQL database to Microsoft SQL Server or MySQL. This Windows service runs efficiently in the background, maintaining synchronization between the external database and the data in 3CX.

Why 3CX Exporter? #

SIMPLIFIED CUSTOM REPORTINGDiscover the capabilities of 3CX Exporter, which enables you to generate customized reports using well-known reporting tools. Effortlessly store data in SQL or MySQL, opening up numerous opportunities for data analysis and reporting requirements.
REMOTE CDR ACCESSAccessing CDR files from a cloud-hosted 3CX server can be challenging. Fortunately, our Exporter provides a simplified solution by utilizing our Relay. This enables you to easily access CDR files remotely, eliminating any difficulties. Embrace seamless file retrieval with our user-friendly solution.
EFFORTLESS DATABASE SYNCAchieve smooth synchronization between your external database and 3CX using this efficient Windows service. This service operates automatically in the background, ensuring that your data stays consistently up-to-date.
EASY ARCHIEVINGEfficiently archive historical information using 3CX Exporter. Effectively categorize and structure vital data from your 3CX system, enabling convenient retrieval as required.

How to use 3CX Exporter? #

Optimize your workflow using 3CX Exporter, a user-friendly tool that automates the export of Call Detail Records. Specify your preferred export frequency during installation, and let the tool handle the remaining tasks. Additionally, you benefit from the convenience of adjusting both the export frequency and database settings as needed, granting you seamless control over your data management.

Prerequisites #

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

PREREQUISITE PURPOSE
3CX Version V203CX Exporter is designed to work seamlessly with this version for enhanced features and performance.
Windows 10 or above / Windows Server 2012 or aboveThese operating systems provide the necessary environment for the application to run efficiently.
IIS Features and Configuration – VoIPToolsIIS is needed as a web server to host and manage web-based applications and services.
.NET Framework 4.7.2 (Web Installer)This framework provides essential components for running and developing applications.
VoIPTools Universal UpdaterThis component is necessary for updates, ensuring the application remains current and functional.
VoIPTools Relay ServiceIt is used for proper integration and functionality of the 3CX Exporter within the 3CX environment.
Microsoft SQL Server 2016 or above (Including the free SQL Express edition)3CX requires Microsoft SQL Server 2016 or later for database management.
Static IP for VoIPTools and 3CX serversThis is to ensure proper two-way communication, both the 3CX server (Relay) and the VoIPTools server. Dynamically assigned IP addresses are not supported. Additionally, it is recommended to use HTTPS for secure communication, which requires a FQDN for SSL/TLS certificate validation between the VoIPTools server and the Relay.
Port number 6350 opened on your devicePort 6350 is a specific network port used by 3CX for communication purposes. Opening this port on the device’s firewall allows incoming and outgoing traffic to pass through, enabling the 3CX software to send and receive data over the network effectively.

NOTE:

  • If you are installing 3CX Exporter in a server other than 3CX Server, then you should install ‘C++ 2010 redistribution package (X86)’ in the 3CX Server. You can install it from this link.
  • Installation on a domain controller may require additional assistance

Installation overview #

DOWNLOAD SOFTWAREYou can order 3CX Exporter online at https://www.voiptools.com.  Your order confirmation email will include your license key and a link to download the software.
INSTALL PREREQUISITESYou must install several prerequisites before installing the 3CX Exporter. The Advanced Installer identifies and installs these applications automatically. Click here to learn about the required prerequisites.
INSTALL 3CX EXPORTERThis 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 Exporter.exe
LOG IN TO THE WEB APPLICATIONYou can now log in to the web application using the extension number and the PIN.

NOTE:

  • 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

Step-by-step Installation Procedure #

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

Step 1:  Download 3CX Exporter.   #

Find the software download link in the Order Confirmation Email, or you can download the application by following the procedure,

  1. Open your browser and go to the VoIPTools official website or click here to get redirected to the website.
  2. Search for the Exporter Application and click the Download button to download your application.

Step 2:  Install Prerequisites #

Click on the software installer that was downloaded in step 1 above. The installation wizard will automatically identify the needed prerequisites and assist you with the installation of the prerequisites needed to run ‘3CX Exporter’. These include .NET Framework (Web Installer), SQL Server Express (Web Installer), and SQL Server Management Studio.

  1. Click the downloaded installer executable to launch the Prerequisites Setup Wizard and click Next.
Figure 1: Prerequisites Setup Wizard
  1. In the Prerequisites window, the installer will identify the missing prerequisites. It is important that you install all the required prerequisites. However, you can select/unselect the applications to be installed based on your unique requirements. Click Next to continue.
Figure 2: Select Prerequisites to Install

The installer will download and install the selected applications.

Figure 3: Prerequisites Installation in Progress
  1. In the Microsoft SQL Server License Terms click the Accept button to acknowledge the license terms and continue.
    • This page appears if you do not have SQL Server Express preinstalled in your device.
Figure 4: SQL Server Express: Accept License Terms
  1. View the SQL Server Media target location in the Media Location field. If required, you can click the Browse button to change the location. Click Install to begin the installation of SQL Server Express.
Figure 5: SQL Server Express: Target Location

SQL server installation is in progress. This may take several minutes to complete.

Figure 6: SQL Server Installation In Progress
  1. Click the Close button once the prerequisites are installed.
Figure 7: SQL Server Express: Installed Successfully
  1. In the confirmation message box, click Yes to reboot the computer.
Figure 9: SQL Server Express: Reboot your computer

Step 3: Start the installation process #

  1. After all the prerequisites are installed, the 3CX Exporter Setup Wizard appears. Click Next to Continue.
Figure 10: 3CX Exporter Setup Wizard
  1. On the Select Installation Folder window, the Folder field displays the location where the ‘3CX Exporter’ will be installed. Note that you cannot change the path.
  2. Click Next to continue.
Figure 11: Installation Folder Location

Step 4: Test Relay Settings #

  1. In the 3CX Relay Services window, in the Relay Host field, enter the FQDN of your 3CX server.
  2. Enter 8801 in the Relay Port field.
  3. Enter the public key you took from VoIPTools Relay services in the Public Key text area.
Figure 12: Configure Relay Services
  1. Click the Test Relay Settings to confirm ‘3CX Exporter’ can communicate with the Relay services running on the 3CX server.
  2. If the ‘3CX Exporter’ is successfully able to communicate with the Relay services that run on the 3CX server, a Success message box appears. Click OK. If the test fails, you will not be able to continue until communication with the relay is established.
Figure 13: Test Relay Success Message Box

Step 5: Configuring SQL Connection #

The SQL tab lets you set up the database. You can select either SQL or MYSQL depending on the database you prefer.

SQL: #

You can set up the SQL database using SQL Authentication or Windows Integrated Authentication.

SQL Authentication #

  1. Select the SQL radio box to use the SQL database.
  2. Enter your server name in the Server field.
    •  If using the free SQL Express Edition, the default SQL Instance name is SQLExpress.

NOTE:

  • 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 Exporter is installed, you will need to configure SQL Server to allow remote connections.
  1. Enter your credentials in the Username and Password fields.

NOTE:

Make sure that you select a SQL Login that has sufficient permissions to alter the database and create SQL objects.

  1. Select or enter 3CX Exporter in the Database dropdown.
Figure 14: Configuring SQL Database
  1. In the Test SQL Connections section, click the Tool button to test the connection.
Figure 15: SQL Authentication – Test Connection Success

Windows Integrated Authentication #

  1. To use Windows Integrated Authentication check the Trusted Connection (Windows integrated authentication) checkbox.
    •  The VoIPTools installer will create a local Windows user name as “VoIPToys” and give you sufficient rights to this user to create/update the SQL database.
Figure 16: Windows Integrated Authentication
  1. In the Advanced Installer section, click the Tool button to test the connection.
Figure 17: Windows Integrated Authentication – Test Connection Success

NOTE:

  • We recommend you use SQL Authentication rather than Windows authentication. Many of our tools leverage a Call Flow Designer (CFD) application running on the 3CX. Frequently our CFD applications require access to an SQL database. If the 3CX server and the database server are not in an Active Directory domain, Windows authentication will fail.
  • To use SQL Authentication, you must configure the SQL server to run in Mixed Mode. If you install SQL Server with our tools, we configure SQL in Mixed Mode.

MySQL: #

  1. Click the MySQL radio box to use the MySQL database.
  2. Enter the name of the server in the Server field.
  3. Enter the name of the database in the Database field.
  4. Enter your credentials in the Admin User and the Password fields.
Figure 18: Configuring MySQL Server
  1. Click the Tool button to test the connection.
Figure 19: MySQL Connection Test Successful Message Box

NOTE:

The first time you install 3CX Exporter, 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 Exporter from a previous version, select the existing database from the list.

Step 6: Installing 3CX Exporter #

  1. In the Ready to Install window, click Install to start the installation of the ‘3CX Exporter’.
Figure 20: Install 3CX Exporter

The application installation progresses. It may take several minutes to complete.

Figure 21: Installation of ‘3CX Exporter’ in Progress
  1. Click the Finish button when the installation is completed.
Figure 22: Installation Complete

Step 7: Log in to the Web Application #

  1. Double-click the 3CX Exporter Icon to open the web application.
  2. On the Login page, do the following tasks,
    1. In the Extension field, enter your 3CX extension number.
    2. In the PIN field, enter your 3CX voicemail PIN.
    3. Click the Login button to log in to your account.
Figure 23: Login Page

NOTE:

Access to the 3CX Exporter application is limited to Manager accounts. If you attempt to log in as a User, access will be denied, and the following image will be displayed.

Figure 24: User Login Restriction

NOTE:

It is essential to re-register the Exporter application because the framework application has transitioned from Windows to Blazer.

3CX Exporter Web Application #

Overview of the Web Application: #

This section explains to you the overview of the 3CX Exporter web application.

Figure 25: Overview
Left Side PanelLet you make changes to the Exporter application or register your software with a valid license key.
Settings SectionsYou can configure the Exporter settings by expanding the sections.
Logout ButtonDisplays the name of the user. You can log out using the Logout button.
Restart ButtonOnce you have made the changes to the Exporter settings, click the Restart button to apply your changes.
Support Resources Button The Support Resources tab gives you general information about the software and the VoIPTools company.

Settings Menu #

The Settings menu has Four different sections, each with a specific purpose:

Section NamePurpose of the section
Export FrequencyEnsures timely synchronization of data from your 3CX database to the Exporter database.
Export TablesGrants control over which data tables are exported to your database.
CDR SettingsStreamlines Call Detail Record (CDR) file management, automating processes and saving resources.
Delete PolicyAllows you to configure the automated deletion of older CDR files, optimizing data storage and system efficiency.
Figure 26: Settings Menu

Export Frequency Section #

In the Export Frequency section, you can define how often you want to export tables to the database. This setting controls the automatic synchronization of updates from the 3CX database to the Exporter database.

To set the export frequency, follow the procedure,

  1. In the Settings menu, expand the Export Frequency section.
  2. In the Export Frequency field, set the frequency (in seconds).
Figure 27: Export Frequency Section

Export Tables Section #

In the Export screen, you can set up the exporting of tables. From here, you can select and export the desired tables from the list to the database.

Follow the procedure to export the tables to the database,

  1. In the Settings menu, expand the Export Tables section.
  2. Select the tables to export to the database and click the Save button.

You can set the export frequency in the Export Frequency section.

Figure 28: Export Tables Section

CDR Settings Section #

The CDR Settings section lets you manage and process your CDR (Call Detail Record) files within the 3CX Console. By configuring the CDR Settings and Delete Policy, you can streamline the storage and maintenance of your call records. This ensures that older processed CDR files are automatically deleted, saving you time and resources.

Follow the procedure to process CDR files or Click to learn how to configure 3CX to create CDR files,

  1. In the Settings menu, expand the CDR Settings section.
  2. Check the Process CDR Files check box.
  3. Click the Restart button to save your settings.

You can configure the delete policy of the CDR files in the Delete Policy section.

Figure 29: CDR Settings Section

Delete Policy Section #

The Delete Policy section lets you configure the automatic deletion of processed CDR (Call Detail Record) files that are older than a specified number of days at a scheduled time. This allows for the management and maintenance of CDR data, ensuring that older records are regularly removed to free up storage space and maintain system efficiency.

Follow the procedure to configure the delete policy for the CDR files,

  1. In the Settings menu, expand the Delete Policy section.
  2. Check the Delete processed CDRs older than the check box to enable the delete policy.
  3. In the Days field, enter the number of days to delete the the processed CDR files older than the specified number of days automatically at the scheduled Delete At time.
  4. In the Delete at time box, enter the time using the up and down arrows to delete the processed CDR files older than the specified number of days at the scheduled time.
Figure 30: Delete Policy Section

Support Resources Screen #

The Support Resources screen displays the version number of the application and the contact information of VoIPTools. Click on the link to learn about the comprehensive support provided by VoIPTools.

Figure 31: About Tab
  • Click the Support Resources button on the top right of the application to open the Support Resources screen.
Figure 32: Support Resources button

Configure 3CX to Automatically Create CDR Files #

Besides extracting data directly from the 3CX PostgreSQL database, Exporter efficiently exports Call Detail Records (CDR) as text files. These CDR files encapsulate valuable call information, encompassing participants, durations, and the call chain. While not as extensive as the PostgreSQL database, the CDR files offer a more user-friendly data structure. If the CDR files fulfill your data requirements, it’s advisable to prioritize their use over accessing the PostgreSQL database.

Follow the procedure to configure 3CX to create these CDR files,

  1. Log in to the 3CX Management Console with valid credentials.
  2. On the left navigation pane, click the Advanced option.
Figure 33: Left Side Panel – Advanced Menu
  1. In the Advanced Menu dropdown, click the CDR option.
Figure 34: Advanced Menu Dropdown – CDR Option
  1. In the CDR Log Type dropdown, select the Single File For Each Call option.
Figure 35: CDR Log Type Dropdown
  1. In the Manage CDR Output Fields popup, select the desired output fields and click the OK button.
Figure 36: Select CDR Output Fields
  1. Once 3CX has been configured to generate CDR files, you must configure Exporter to process the files and import the data into SQL or MySQL.

NOTE:

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

NOTE:

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.

Once you have successfully configured 3CX to automatically create CDR files, all the CDR data from then on will be exported into the Exporter database.

NOTE:

Exporter will place the CDR data extracted from the 3CX CDR files into the table named cdr. Click the link to learn how to view the 3CX CDR files.

CDR Records – Output Field Definitions #

The following are the supported output fields and what they mean

HISTORYIDThis is the call number – each call has a number, internal to 3CX. It is useful for call tracking.
CALLIDThis is the Call ID – the unique identifier of the call.
DURATIONCall Duration time.
TIME-STARTCall Start time.
TIME-ANSWEREDAnswered time.
TIME-ENDCall terminated time.
REASON-TERMINATEDWhy the call was terminated.
FROM-NOSource caller number.
TO-NODestination To Number.
FROM-DNDistinguished name of caller – this is 3CX Specific Can be omitted by 3rd party developers.
TO-DNDistinguished name of To – Destination – this is 3CX Specific Can be omitted by 3rd party developers.
DIAL-NODialed number.
REASON-CHANGEDBilling code dialed after the destination (for example **Sales).
FINAL-NUMBERFinal Number – the final number which was replaced (In a transfer this will be the final connected number).
FINAL-DNThe distinguished name of the final number entity – this is 3CX Specific and can be omitted by 3rd party dev.
BILL-CODEAll endpoints that were involved in the call.
BILL-RATEThe Cost of the call is calculated with simple proportion/minute.
BILL-COSTThe billing rate matched the prefix of the rate. This is used to apply a cost calculation variance.
BILL-NAMEThe rate name of the billing variance.
CHAINThe Distinguished Name of the final number entity – this is 3CX Specific and can be omitted by 3rd party dev.
FROM-TYPESource type
TO-TYPEDestination type.
FINAL-TYPEFinal destination type.
FROM-DISPNAMESource Display Name.
TO-DISPNAMEDestination Display Name.
FINAL-DISPNAMEFinal destination Display Name.
MISSED-QUEUE-CALLSThe number of missed calls for an extension in a queue.

Uploading images in the DN table #

Follow the procedure to upload images to the DN table,

  1. Open your 3CX Electron Phone application.
  2. In the left side menu, click the General tab.
  3. Click the Image Upload icon to upload an image from your local device.
Figure 37: Upload Icon
  1. Open your database application and you can see the image added to the extension in the Pv_Contact_Image column.
Figure 38: Image Added to the Database

NOTE:

The pv_contact_image column in your database will be visible if there is an image associated with at least one extension in the 3CX Electron Phone application.

Figure 39: No Extension Having Picture

View 3CX Database Records #

  1. Connect to database server.
  2. Under the Object Explorer navigation pane, expand Databases, and then expand 3CX Exporter and Tables to see various tables.
  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.
Figure 40: View 3CX Records – List of Tables

View Data in Microsoft SQL Server Database #

To view the exported data in the 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.
  2. Under the Object Explorer navigation pane, expand Databases, and then expand 3CX Exporter and Tables to see the dbo.cdr table.
Figure 41: dbo.cdr Table
  1. Right-click to open the Right Click menu and click on the Execute option to view the new CDR Output fields that you added through the 3CX Management Console.
Figure 42: New CDR Output Fields Added to the dbo.cdr table in the Database Server

Need Support? #

You get quick answers to most of your inquiries in our online manual. If you prefer direct contact, we offer various support channels, including phone, email, live chat, and our helpful VoIPTools forums.

24/7 Support Availability #

Rest assured, our dedicated team is here to assist you around the clock, every day of the year. Whether you’re based in the USA or India, we’re ready to provide prompt responses to your technical queries.

Windows Event Log for VoIPTools Applications and Services #

For troubleshooting any application errors, our Windows Event Log contains a comprehensive list of error messages, warnings, and informative notes related to all our VoIPTools applications and services. It’s a valuable resource to help you pinpoint and resolve any issues you may encounter.

Join Our Forum Community #

Are you looking to collaborate with other VoIPTools customers facing similar challenges? Our forum is the perfect platform to exchange ideas, solutions, and best practices. Join the conversation at: https://www.voiptools.com/community/

Real-Time Live Chat Assistance #

Got questions that need immediate answers? Our chat support team is available to assist you in real time. Just click on the Live Chat button located at the lower right corner of our website, and we’ll acknowledge your queries right away.

Efficient Email Support #

To ensure a thorough understanding of your concerns, email us at support@voiptools.com. Describe your issue in detail, and we’ll get back to you within one business day with the support you need.

Reach Us by Phone #

If you prefer to speak with a representative directly, you can reach us at +1 801-642-4655. Our attentive team is available to take your calls from 8:00 AM to 6:00 PM (Central Standard Time).

Comprehensive support services: #

Free Support #

If you’ve purchased our products through a VoIPTools Partner, rest assured that they provide first-level support at no additional cost. Partners have access to 100% free technical assistance and actively participate in the troubleshooting process.

VoIPTools customers enjoy access to our online manuals and receive support through emails (with responses within one business day) and live chat. However, please note that we do not provide remote server login assistance.

Paid Support #

For a more hands-on experience, consider our “Installation Support” package. Our expert support team can log in to your servers, and install and configure all our tools. This comprehensive service includes setting up SQL Server Express and Internet Information Server if necessary. We’ll work closely with you to tailor our applications to meet your requirements.

We’re committed to providing top-notch support to ensure your VoIPTools experience is smooth and hassle-free. Contact us today, and let us assist you in making the most of our powerful tools!

What are your Feelings

Powered by BetterDocs