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 in the background, maintaining synchronization between the external database and the data in 3CX.

Why 3CX Exporter? #

	SIMPLIFIED CUSTOM REPORTING	Discover the capabilities of 3CX Exporter, which enables you to generate customized reports using well-known reporting tools. Store data in SQL or MySQL, opening up numerous opportunities for data analysis and reporting requirements.
	REMOTE CDR ACCESS	Exporter provides a simplified solution by utilizing our Relay. This enables you to access CDR files, eliminating any difficulties. Embrace seamless file retrieval with our user-friendly solution.
	EFFORTLESS DATABASE SYNC	Achieve smooth synchronization between your external database and 3CX using this efficient Windows service. This service operates in the background, ensuring that your data stays up-to-date.
	EASY ARCHIEVING	Archive historical information using 3CX Exporter. 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. 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 V20	3CX Exporter is designed to work seamlessly with this version for enhanced features and performance.
Windows 10 or above / Windows Server 2012 or above	These operating systems provide the necessary environment for the application to run efficiently.
IIS Features and Configuration – VoIPTools	IIS is needed as a web server to host and manage web-based applications and services.
VoIPTools Universal Updater	This component is necessary for updates, ensuring the application remains current and functional.
VoIPTools Relay Service	It 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 servers	This 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 device	Port 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 SOFTWARE	You 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 PREREQUISITES	You 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 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 Exporter.exe
	LOG IN TO THE WEB APPLICATION	You 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 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.

2. 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.

 

 

The installer will download and install the selected applications.

3. 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.

4. 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.

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

5. Click the Close button once the prerequisites are installed.

7. In the confirmation message box, click Yes to reboot the computer.

Step 3: Start the installation process #

1. After all the prerequisites are installed, the 3CX Exporter Setup Wizard appears. Click Next to Continue.

2. 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.
3. Click Next to continue.

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.

4. Click the Test Relay Settings to confirm ‘3CX Exporter’ can communicate with the Relay services running on the 3CX server.
5. 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.

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.

3. 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.

4. Select or enter 3CX Exporter in the Database dropdown.

 

5. In the Test SQL Connections section, click the Tool button to test the connection.

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.

5. Click the Tool button to test the connection.

 

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.

 

POSTGRESQL: #

1. Click the POSTGRESQL radio box to use the POSTGRESQL 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 Username and the Password fields.

5. Click the Tool button to test the connection.

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.

 

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.

2. In the Advanced Installer section, click the Tool button to test the connection.

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.

Step 6: Installing 3CX Exporter #

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

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

2. Click the Finish button when the installation is completed.

 

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.

 

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.

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.

	Left Side Panel	The left navigation pane provides access to the main areas of 3CX Exporter: Reports — Contains Report Designer and Report Viewer. Logs — Provides access to application logs. Settings — Opens the configuration page described above and is highlighted when active.
	Logout Button	Displays the name of the user. You can log out using the Logout button.
	Support Resources Button	The Support Resources tab gives you general information about the software and the VoIPTools company.
	Display Pane	The main content area showing the active page.

 

Settings Menu #

The Settings menu is the first page displayed after you log in to 3CX Exporter. Use this page to configure export settings, data processing, retention policies, role-based access, and custom branding.

Section Name	Purpose of the section
Export Frequency	Ensures timely synchronization of data from your 3CX database to the Exporter database.
Export Tables	Grants control over which data tables are exported to your database.
CDR Settings	Streamlines Call Detail Record (CDR) file management, automating processes and saving resources.
Retention Policy	Allows you to configure the automated deletion of older CDR files, optimizing data storage and system efficiency.
Role Access Permissions	Manages page access and permissions for each user role.
Custom Branding	Configures custom branding settings for the application.

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).

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.

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.

Retention Policy Section #

Use Retention Policy to remove processed CDRs after a set number of days. CDR means Call Detail Record, which contains details about a call.

Enable CDR deletion #

1. Expand Retention Policy.
2. Select Enable automatic deletion of processed CDRs older than.
3. Enter the number of days in Retention Period (Days).
4. Select the time in Delete At (Time).

Processed CDRs that are older than the set retention period are deleted at the selected time each day.

To stop CDR deletion: Do not select Enable automatic deletion of processed CDRs older than.

Role Access Permissions #

Use Role Access Permissions to control which pages each role can access in 3CX Exporter.

Select a role #

1. Expand Role Access Permissions.
2. Select a role from the Role list.
3. Review the permissions shown for that role.

The available roles include User, Receptionist, Supervisor, Department Administrator, Manager, Owner, System Administrator, and System Owner.

Set page permissions #

1. Select or clear Report Designer to allow or block access.
2. Select or clear Report Viewer to allow or block access.
3. Select or clear Logs to allow or block access.
4. Select or clear Settings to allow or block access.

The selected checkboxes show the pages that the chosen role can access.

Reset permissions #

Select Reset to restore the permission settings for the selected role.

System Administrator and System Owner permissions #

System Administrator and System Owner have all four page permissions selected by default. Their checkboxes appear greyed out and cannot be changed from this section.

Custom Branding #

Make the portal look like your own: change the logo, header title, and accent colors.

1. 1. Click Custom Branding to expand the section.
   2. Enter a Header Title to replace the default application name at the top of the portal.
   3. Upload a logo via Choose File, or pick a previously uploaded one from the Select Logo dropdown.

1. Set your colors using the pickers below.
2. Click Apply to save everything.

Color settings #

Reports – Report Designer #

The Report Designer is a visual tool that lets you build and customize report templates for 3CX Exporter. You can add data fields, arrange layout elements, and preview the result before anyone runs a report.

Getting to Report Designer #

1. Open the Reports menu.
   In the left sidebar, click Reports. The section expands to show two options.
2. Click Report Designer.
   The designer workspace opens in the main area.

The Report Designer has four main areas. Understanding what each one does will make the rest of this guide much easier to follow.

Figure 35: Report Designer Overview

	Toolbar	Provides editing actions like cut, copy, paste, undo, redo, and zoom controls.
	Left Sidebar	Contains tools for inserting elements onto the canvas, such as text labels, tables, images, and charts.
	Design Canvas	The main work area where you arrange and preview the report layout.
	Right Panel Tabs	Four icon tabs on the far right that each open a different configuration panel.

 

Left Sidebar – Design Tools #

The left sidebar holds all the elements you can place on a report. Click any icon and then click on the canvas to place that element. The tools are organized into four groups.

The tools are grouped into four categories based on what they do. The groupings below match the visual sections separated by spacing in the sidebar.

Text and Layout Elements #

Tool Name	What it places
Label	A static text block. Use this for headings, column titles, or any text that does not change based on data.
Rich Text	A text field that supports formatted content such as bold, italic, and lists.
Panel	A blank container box used to group and organize other elements within a band.
Character Comb	A fixed-width text field divided into individual cells. Useful for forms where each character needs its own box, such as ID numbers.
Checkbox	A checkbox element that displays a true or false value from a data field.
Picture Box	An image placeholder. Drop a logo, photo, or graphic into this element.
Table	A structured data table for displaying multiple rows and columns of records.

Drawing Elements #

Tool Name	What it places
Line	A straight line. Use it to separate sections or add visual structure to the report layout.
Shape	A geometric shape such as a rectangle, circle, or triangle. Useful for design accents or highlighting areas.
Barcode	A barcode element. Bind it to a data field to generate barcodes or QR codes from your report data.

Data Visualization and Advanced Elements #

Tool Name	What it places
Chart	A visual chart element. Connect it to a data source to generate bar charts, line graphs, pie charts, and more.
Gauge	A circular gauge or dial indicator. Good for showing progress or performance metrics at a glance.
Sparkline	A small inline chart that shows a data trend without axes or labels. Fits inside a table cell.
Cross Tab	A pivot-style table that groups data across both rows and columns. Use it for summary and comparison reports.
Sub Report	An embedded report inside your main report. Use it to pull in a separate report template as a section of this one.
PDF Content	Embeds PDF file content directly into the report layout.
PDF Signature	A signature field for PDF output. Allows a digital signature to be placed in the report.

Page and Structure Controls #

Tool Name	What it places
Table of Content	Generates a table of contents based on bookmarks or report sections. Useful for multi-section reports.
Page Break	Forces the report to start a new page at that point in the layout.
Cross-band Box	A box that spans across multiple bands on the canvas. Use it to draw a border or background that covers more than one section.
Page Info	Displays page numbers, total page count, or print date. Place it in a margin band for standard page footers.
Cross-band Line	A line that spans across multiple bands, similar to Cross-band Box but as a single line instead of a filled box.

Toolbar #

The toolbar runs across the top of the canvas. It gives you quick access to common editing actions.

Control	What it does
☰ (Menu)	Opens a file menu with options to create, open, save, and configure the report. See the Menu section below.
Cut / Copy / Paste	Standard clipboard actions for selected elements on the canvas.
Delete (✕)	Removes the selected element from the canvas.
Undo / Redo	Steps backward or forward through your recent changes.
Zoom controls	Use the minus and plus buttons or the dropdown box to change the canvas zoom level. 💡Tip Set the zoom to 50% or 75% when you want to check the overall page layout. Use 150% or 200% when placing or aligning small elements with precision.
Validate Binding	The Validate Binding button checks all data fields on the canvas to ensure they are connected to valid data sources and highlights any broken or invalid bindings. Run it before entering Preview mode to prevent blank fields or missing data in the report.
Full screen (⛶)	The Full Screen button expands the design canvas to fill your browser window, providing more workspace for designing complex reports. Click it again to return to the standard view while keeping all toolbar controls and panels accessible.
Scripts (📜)	The Scripts button (the page icon at the right of the toolbar) opens a code editor that replaces the visual canvas. It lets you write custom logic for the report using standard HTML and CSS. Use this when you need behavior that the visual design tools cannot produce on their own.
DESIGN / PREVIEW	Switches between editing mode and a live preview of the report.

Menu #

Click the three-line icon (☰) at the far left of the toolbar to open the Menu. This panel gives you file management options for your report template.

Option	What it does
New	Creates a blank report template on the canvas. Any unsaved work on the current report will be lost.
New via Wizard…	Opens a step-by-step guide that helps you build a new report by choosing data fields and layout options. A good starting point for first-time users.
Open…	Loads an existing report template file from your system.
Design in Report Wizard…	Opens the current report in the guided wizard view so you can make changes using the step-by-step interface instead of the free-form canvas.
Add Data Source…	Connects a new database or data feed to the report. This is the same as using the Add Data Source button in the Field List panel.
Localization…	Opens tools for translating the report into other languages.
Save…	Saves the current report template. This option appears grayed out if there are no unsaved changes.
Save As…	Saves a copy of the report template with a new name. Use this to create variations of an existing report without overwriting the original.
Exit	Closes the Report Designer and returns you to the previous screen.

Scripts Toolbar Controls #

When Scripts mode is active, the toolbar changes to show a set of controls specific to code editing.

Report Viewer #

The Report Viewer lets you run, view, and export any report template built in the Report Designer. Set your parameters, click Submit, and the report loads in the preview area ready to print or download.

Getting to Report Viewer #

1. Click Reports in the left sidebar to expand the section.
2. Click Report Viewer. The viewer opens with a blank preview area and a Select Report dropdown at the top right.

Select a Report #

The first thing to do is choose which report to run. The dropdown groups reports by category so you can find the right one fast.

1. Click the Select Report dropdown at the top right of the page.
   

   

2. Choose a report from the list. Reports are grouped under headings such as Default Reports / Call Reports and Default Reports / Queue Reports.

Once you select a report, the preview area shows Waiting for parameter values… and the Preview Parameters panel appears on the right. Fill in the parameters before the report can load.

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.

• Click the Support Resources button on the top right of the application to open the Support Resources screen.

 

 

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.