Active Directory Sync V18

1. Introduction #

3CX Phone System has the ability to download all of your current user settings from your Active Directory Server via the LDAP protocol. All the user’s data such as first and last names, mobile numbers, and email addresses will be queried from the Active Directory and extensions will be created with a click of a button. This will save the administrator a great amount of time and resources.

1.1. What does it do? #

Companies that use Microsoft Active Directory (AD) may want to ensure that when a user is deleted from AD, then the user is deleted from the 3CX too. The ‘3CX Active Directory Sync’ application automates this process by performing a series of actions like logging into AD with valid credentials, followed by collecting the list of users in AD that have an extension specified, and then by comparing them with those in 3CX. During the process, if it is found that a specific extension exists in 3CX but not in AD, then the ‘3CX Active Directory Sync’ deletes the extension from the 3CX. You can configure ‘Schedule Timer’ in various modes (Frequency/ Specific Time of the Day/ On Demand) to initiate ‘3CX Active Directory Sync’ to perform these actions.

2. Prerequisites #

Before installing ‘3CX Active Directory Sync’, you need to ensure that your computer meets the minimum requirements mentioned below:

  1. 3CX Version V16 and V18
  2. Windows 10 or above / Windows Server 2012 or above
  3. Microsoft SQL Server 2014 or above (Including the free SQL Express edition)
  4. Internet Information Server (IIS) 7.0 or above
  5. .Net 4.7.2 or above


  • 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. Installation #

Download software

You can order ‘3CX Active Directory Sync’ on-line at  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 Active Directory Sync’. These prerequisites include Microsoft Internet Information Server (IIS) and Microsoft SQL Server

Install 3CX Active Directory Sync

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

Register your License Key

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

4. Step By Step Installation Procedure #

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

Step 1:  Download 3CX Active Directory Sync

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.

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 3CXActiveDirectorySyncInstaller.exe
  2. Double-click the file to start the VoIPTools Setup Wizard.
  3. Click Next to continue.
Figure 1: Setup Wizard

Step 4: Download the VoIPTools 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 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 Active Directory Sync’ directly on the 3CX server, you can install the Relay simply by clicking the Install/ Upgrade Relay button and following the Relay install instructions.

Note: 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 3CX Server Platform drop down, select Windows for old Relay or Linux for new Relay based on the 3CX version of your application.
Figure 2: Test VoIPTools 3CX Relay settings

Note: If you choose ‘3CX Server Platform’ as ‘Windows’ then ‘3CX Active Directory’ will communicate with old Relay Service, and if you choose ‘Linux’ then it will communicate with new Relay Service.

  1. In the Relay Services Host field, enter “localhost” if installing ‘3CX Active Directory’ 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 for Windows or 8800 for Linux.
Figure 3: Relay Services Port

Note: The ‘3CX Active Directory’ will take default port as 8700 for Windows and 8800 for Linux. If the default port number doesn’t appear automatically, you can manually enter the respective default port number.

  1. Click Test Relay Settings to confirm ‘3CX Active Directory’ can communicate with the Relay services running on the 3CX server.
  2. If the ‘3CX Active Directory’ is successfully able to communicate with the Relay services that run on the 3CX server, a Success message box appears. Click OK.
Figure 4: Success message box
  1. Click Next to continue the installation.

Step 6: Configure the database

If this is your first install then, select a valid SQL server and if you are reinstalling then select the existing database.

  1. When prompted for the database connection information, click Configure.
Figure 5: Configure Database
  1. In the Connection Properties dialog 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 Active Directory Sync’ is installed, you will need to configure SQL Server to allow remote connections
Figure 6: Connection Properties
  1. Enter the login credentials.
    • 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.
    • 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.

Note: The first time you install ‘3CX Active Directory Sync’, 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 Active Directory Sync’ from a previous version, select the existing database from the list.

  1. Click Test Connection button to confirm you can connect to SQL
  2. Click OK to save the SQL Connection information
  3. Click Next to create the required SQL database objects.
Figure 9: Configure Database

Step 7: Installation Complete

  1. The server installation status screen will display the installation progress.
Figure 10: Installation in Progress
  1. When the software installation is complete, click Close
Figure 11: Installation Complete

5. 3CX Active Directory Sync Configuration Screen #

The 3CX Active Directory Sync Settings configuration screen enables you to register software and, update your application to latest version

5.1. Register Software #

Registration is required to authorize your license key. Registering also makes it possible for VoIPTools to provide a replacement key if your license key is ever lost. Also, it enables VoIPTools to notify you of any product updates, and reminders if your key is reaching the renewal date.

  1. In the 3CX Active Directory Sync Settings configuration screen, in the License tab, and in the License Key field, enter the valid license key.
  2. Enter appropriate details in all the other fields of the page.
  3. Click Register
Figure 12: Register Software

Note: The license key permits you to install this software on one computer. This is not free software.

5.2. Check for Updates #

You can update your application to latest version by clicking on Check for Updates button at the footer of the configuration screen.

6. Web Portal #

To access the ‘3CX Active Directory Sync’ web portal, click the Web Portal button on the configuration program, or click on the desktop icon that was created during the installation process (‘3CX Active Directory Sync’ Web).

When connecting to the web portal, you will be asked to provide login credentials.

  1. In the Extension field, enter your 3CX extension number.
  2. In the PIN field, enter your 3CX voicemail PIN.
  3. Click Login button to login to your account.
Figure 13: ‘3CX Active Directory Sync’ Web Portal Login

6.1. Removal Screen #

The Removal screen enables you to configure settings to trigger the ‘Schedule Timer’ in desired mode so that the ‘3CX Active Directory Sync’ will perform the following series of actions:

  1. Log into Active Directory with valid credentials to access the information in AD.
  2. Look in AD for the field that denotes user’s extension number. (IP Phone, Fax, Mobile etc. for instance)
  3. Build the list of users associated to an Organizational Unit along with their respective extension in AD.

Note: If multiple ‘Organizational Units’ exist then, the ‘3CX Active Directory Sync’ collects the extensions from each Organizational Unit one after the other and adds them to the same list.

  1. Build the list of users and their respective extensions in 3CX.
  2. Compare the list built in AD with that built in 3CX.
  3. Delete the extensions in 3CX that are found in 3CX but not in AD.
  4. Archive voicemails and recordings of the deleted extension to the configured extension (this is optional).
Figure 14: Removal Screen

6.1.1. Configure Active Directory Settings #

  1. In the Removal screen, under Active Directory section and in the Domain field, enter valid domain with which you want to log into AD.
  2. In the User Name and Password fields, enter valid credentials for the respective domain.
  3. Click Test button to confirm that the user can log into AD with the provided credentials. Once the login is successful, success message will be displayed.
  4. From the AD Phone Field drop down list, select the desired field to denote the user’s extension number.
Figure 15: AD Phone Field dropdown list
  1. From the Archive Extension drop down list, select the desired extension to which you want to archive all the voicemails and recordings of the extension that you want to delete. (This is optional).
Figure 16: Archive Extension dropdown list
  1. If you want to add a new Organizational Unit, beside Organizational Unit, click Add and enter the details for Organization Unit (OU) and Domain Control (DC) in the format: OU=MyDomain Users, DC=MyDomain, DC=com, with DC=com as standard value. For instance, to add an Organizational Unit with name INDIAOffice, you can type as: OU=INDIAOffice,DC=VOIPTEST,DC=com
Figure 17: Add Organizational Unit
  1. Click Save to save the AD information that you have just configured.

Note: By default, archiving voicemails and recordings of deleted extensions is turned on.

6.1.2. Settings #

  1. In the Settings section, check Disable/Delete Extension and then select the following as per your requirement:
    1. Disable – so that ‘Active Directory Sync’ disables/inactivates the extensions in 3CX which are found in AD but not in 3CX.
    2. Delete – so that ‘Active Directory Sync’ deletes the extensions in 3CX which are found in AD but not in 3CX.
Figure 18: Settings – Disable/Delete Extension

Note: ·

  • If you do not select any option then by default, the ‘Active Directory Sync’ will consider ‘Delete’ option.
  • Active Directory Sync automatically saves the values once you select ‘Disable’ or ‘Delete’ option. You need not save the updates manually.
  1. Check Add Missing Extensions From Active Directory checkbox if you want to add the missing extensions to AD, and then select the following as per your requirement:
Figure 19: Settings – Add Missing Extensions From Active Directory

i). From the Template Extension dropdown list, select the desired extension so that the ‘Active Directory Sync’ will apply the settings of the selected extension to the missing extensions while creating them in the 3CX.

Figure 20: Settings – Template Extension

ii). Check Add Extensions to 3CX Groups checkbox if you want to add the missing extensions to their respective groups and then the following options will appear:

a). AD Group Field – select the field name (usually, ‘Department’) so that the ‘Active Directory Sync’ will check for that field in AD where the group name of the missing extension is specified.

b). Create Missing Group – check this option so that the ‘Active Directory Sync’ will create the missing group of the respective missing extension in 3CX.

Figure 21: Settings – Add Extensions to 3CX Groups

Note: If you uncheck Create Missing Group checkbox then the ‘Active Directory Sync’ will add the missing extensions to ‘Default’ group.

iii). The ‘Active Directory Sync’ saves the settings to database and will execute according to the scheduled time.

6.1.3. Configure Extension Update Schedule #

  1. In the Extension Update Schedule section, select Frequency option if you want to trigger the Schedule Timer to run for every specified Minutes of time.
  2. Select Time option if you want to trigger the Schedule Timer to run at the specified Time of the Day.
  3. Select On Demand option if you want to trigger the Schedule Timer to run instantly.
  4. Click Save to save the Schedule Update Extension settings.
  5. Once the settings are successfully saved, Success message box appears. Click OK.

6.1.4. Start/ Stop Windows Service #

  1. Click Start to start the windows service.
  2. Click Stop to stop the windows service.

6.2. Log Screen #

The Log screen enables you to view the summary of all the events that take place during the time when the Scheduler runs and instigates the ‘3CX Active Directory Sync’ to perform the actions as per the configured Application Settings. From here, you can also export the information to the desired format. If you do not want to see the logs anymore, you can clear them.

Figure 22: Log Screen

6.3. Site Screen #

The Site Settings enable you to customize branding settings for the application that include the following:

  1. Customize the gradient color of ‘Application Header’
  2. Customize grid color in screens that display grid data
  3. Customize logo on the ‘Application Header’
  4. Customize ‘Header Title Prefix’ on the ‘Application Header’
Figure 23: Site Screen

Custom Brand Settings

  1. In the Site screen and in the Custom Branding Settings form, perform the following Brand Setting Customizations:
    1. Customize Application Title Header – Gradient Color
      • Beside Header Gradient Color and from the Top Color palette, select the desired color that you want to display as the top color for the ‘Application Title Header’.
      • From the Bottom Color palette, select the desired color that you want to display at the bottom of the ‘Application Title Header’ in gradient to the selected Top Color.
    2. Customize Grid Color
      • From the Grid Color palette, select the color that you want to display for the grid in screens that display grid data.
      • The final display after applying ‘Grid Color’ branding settings:
    3. Customize Logo
      • If you are uploading the logo for the first time then, beside Upload New Logo field, click Browse and select the logo that you want to apply. You will now observe that the logo is added to the Custom Logo drop down list.
      • From the Custom Logo drop down list, select the logo that you have just uploaded.
    4. Customize ‘Header Title Prefix’ Text
      • In the Header Title field, enter the text that you want the application to display as ‘prefix’ for the existing title in application header.
  2. Once you perform desired customizations, click Apply.
Figure 29: Display of Customized Brand Settings

6.4. About Screen #

The About screen displays current version of the application and contact details.

Figure 30: About Screen

7. Support #

Visit our website to access our on-line manuals and receive quick answers to most of your questions. Otherwise, you can contact us by phone, email, live chat and on the VoIPTools forums.

  • Support Hours (USA and India)

Our team is ready to assist you with answers to your technical questions, during normal business hours, which is Monday through Friday, 8:00 AM to 6:00 PM (Central Standard Time), and 8:00 AM to 12:00 AM (Indian Standard Time).

  • Windows Event Log (Applications and Services > VoIPTools)

The Windows Event Log lists various errors, information messages and warnings related to all our VoIPTools applications and services. The data here can be used for troubleshooting various application errors.

  • Forums

Our forum is intended for VoIPTools customers to collaborate on real-life challenges, solutions and best practices. You can participate on our forum at:

  • Submit a Bug

If you suspect a bug in any of our VoIPTools products, you can bring it to our notice by reporting your issue at:

  • Live Chat

Our chat support team is ready to acknowledge your queries in real-time. You can start a live chat with us by simply clicking on the Live Chat button at the lower right corner of our web page.

  • Email

You can email us at: Be sure to describe your issue in detail. We’ll get back to you within one business day of receiving your request.

  • Phone

You can call us at +1 801-642-4655 to reach a representative. VoIPTools will accept calls at this number from 8:00 AM to 6:00 PM (Central Standard Time).

  • Support Services
  • Free Support:

If you purchased our products through a VoIPTools Partner, your Partner will provide first level support. Partners have access to 100% free technical support, provided they participate actively in the troubleshooting process.

VoIPTools customers have access to our on-line manuals and we will respond to emails (next business day) and live chat, but we will not login to your servers remotely.

  • Paid Support:

If you purchase “Installation Support’ our support team can login to your servers and install and configure all our tools for you. This includes installing SQL Server Express and Internet Information Server if required. Our team will work with you to configure our applications to best meet your needs.