Introduction #

Efficiently retrieve your existing user settings from your Active Directory Server with the seamless integration of the 3CX Phone System. Leveraging the LDAP protocol, this integration allows you to effortlessly query essential user data, including first and last names, mobile numbers, and email addresses. With just a simple click, extensions are automatically generated, saving administrators valuable time and resources. Discover the time-saving benefits of the 3CX Phone System’s smooth integration with your Active Directory Server.

What does it do? #

To ensure seamless synchronization between Microsoft Active Directory (AD) and 3CX, the ‘3CX Active Directory Sync’ application provides an automated solution. When a user is deleted from AD, it’s important to remove the corresponding user from 3CX. The ‘3CX Active Directory Sync’ simplifies this process by performing a series of actions automatically.

Using valid credentials, the application logs into AD and retrieves a list of users in AD with a specified extension. It then compares this list with the users in 3CX. During the comparison, if the application finds an extension in 3CX that doesn’t exist in AD, it takes the necessary steps to remove that extension from 3CX.

For added convenience, you have the flexibility to configure the ‘Schedule Timer’ according to your preferences. Whether you want a specific frequency, a particular time of the day, or an on-demand trigger, you can set up the ‘Schedule Timer’ to initiate the ‘3CX Active Directory Sync’ and perform the synchronization actions.

By utilizing the ‘3CX Active Directory Sync’ and its configurable ‘Schedule Timer’, you can ensure smooth and accurate synchronization between Microsoft Active Directory and 3CX. This saves time and effort for your company, simplifying the management of user data.

Features of 3CX Active Directory Sync #

	REDUCED ADMINISTRATION	Experience Streamlined Administration for Organizations of Any Size Whether you lead a small team of 10 or oversee a large workforce of 10,000, the prospect of streamlining administrative tasks is undeniably enticing.
	AUTO BACKUPS	By proactively utilizing our Auto Backups feature, you can have peace of mind, knowing that your vital audio files are securely duplicated and readily accessible whenever you need them.
	SIMPLE TO USE	Stay ahead of the game with Active Directory Sync’s straightforward setup process. Its intuitive design and step-by-step guidance allow you to swiftly configure the synchronization settings, eliminating any hassle or confusion.
	AUTOMATICALLY DELETE RIGHTS	With just a few clicks, our automated system will remove all rights to the phone system, promptly severing the connection between the former employee and your company’s communication infrastructure. This ensures that sensitive information remains secure and confidential.

Prerequisites #

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

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

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.

Installation overview #

	DOWNLOAD SOFTWARE	You can order 3CX Active Directory Sync online at https://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 the 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 Active Directory SyncInstaller.exe
	REGISTER YOUR SOFTWARE	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.

Step 1: Download 3CX Active Directory Sync #

1. Find the software download link in the Order Confirmation Email, or you can find it in your order history on our website and download the 3CX Active Directory Sync application.
2. In the Microsoft Defender SmartScreen, click the More Info option.

3. Click the Run Anyway option to start the installation.

Step 2: Install the Prerequisites #

Click on the software installer downloaded in Step 1. The installation wizard will automatically identify the prerequisites and assist you with each installation required to 3CX Active Directory Sync. It includes .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.

2. In the Prerequisites window, install all the required prerequisites identified by the installer, or select/ unselect the applications based on your requirements and click Next to continue.

The installer will download and install the selected applications. It may take several minutes to complete.

3. The Microsoft SQL Server License Terms page gets displayed if you install SQL Server Express. Click Accept to acknowledge the license terms and continue.

4. In the Media Location field, browse to change the location and click Install to begin the installation of SQL Server Express.

5. Click Close when you install the prerequisites.

Installation is in progress. It may take several minutes to complete the installation.

6. Click Yes in the Confirmation Message Box to reboot the computer.

Figure 8: Reboot the computer

Step 3: Start the installation process #

1. Click Next on the 3CX Active Directory Sync Setup Wizard screen.

2. On the Select Installation Folder window, the Folder field displays the path where the 3CX Active Directory Sync gets installed. You cannot change the location path.
3. Click Next to continue

Step 4: Test Relay Settings #

You must configure the Relay settings to communicate with 3CX. Follow the procedure to configure the Relay settings,

1. On the 3CX Relay Services window in the Relay Host field, enter the FQDN of your 3CX server.
2. Paste the JWT public key in the Public Key field copied from the VoIPTools Relay Services application. Click here to know more.
3. Click the Test Relay Settings to test the relay connection.

NOTE:

• Relay Port must be 8801 only.
• Do not add “https://” to the Relay host data
• Once you have successfully tested the connection to the Relay, the “Next” button will be enabled

3. The Next button will be enabled when the test connection is successful. Click OK in the Success message box to continue with the installation.

NOTE:

If the Relay test fails, you cannot continue the installation until you establish communication with the Relay.

Step 5: Configure the database #

To communicate with Microsoft SQL Server, you must enter the following configuration information,

1. On the SQL Database window in the Server field, select the desired instance of SQL Server.
2. Uncheck the Trusted Connection checkbox to use SQL Authentication.
3. In the Username field, enter valid SQL login account credentials.
   • The default username is ‘sa‘ when SQL is installed automatically in “mixed” mode.
4. In the Password field, enter the valid SQL login account credentials.
   • The default password is ‘V01PT0y5‘ when SQL is installed automatically in “mixed” mode.
5. Click the Tool buttons to confirm connectivity to SQL Server. and click OK on the Test Results message box.

NOTE:

• We encourage you to 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 a 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, your SQL Server must be configured to run in “Mixed Mode”.  If you installed SQL Server with one of our tools, we configure SQL in “Mixed Mode”.

6. The Next button gets enabled when the test connection is successful. Click OK in the Test Results message box to proceed with the installation.

Step 6: Installing 3CX Active Directory Sync #

1. Click Install in the Ready to Install window.

The application installation may take several minutes to complete.

2. Click Finish when the installation is complete.

Step 7: Register your Software #

To ensure the authorization of your license key, it is necessary to complete the registration process. By registering with VoIPTools, you gain access to a range of benefits:

Key Replacement Assistance	In the unfortunate event of a lost license key, registering with VoIPTools lets us provide you with a replacement key promptly.
Product Updates and Reminders	By registering, you will receive timely notifications from VoIPTools regarding any product updates. Additionally, we will send reminders when your key is nearing its renewal date, ensuring uninterrupted access to our services.s

Follow the procedure, to register your software.

1. Double-click and open the 3CX Active Directory Sync Settings desktop application.
2. On the License tab in the License Key field, enter the valid license key.
3. Enter appropriate details in all the other fields and click the Register button.

NOTE:

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

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.

Web Portal #

You have the following choices to access the ‘3CX Active Directory Sync’ web portal,

• Click the Web Portal button on the configuration program.
• Click on the 3CX Active Directory Sync Web Desktop Icon created during the installation process.
• Browse the application using https://<your_voiptools_server_FQDN>:5650 URL.

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 the Login button to log in to your account.

Sync Screen #

The Syncscreen 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 the user’s extension number. (IP Phone, Fax, Mobile, etc. for instance)
3. Build the list of users associated with an Organizational Unit along with their respective extensions 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.

4. Build the list of users and their respective extensions in 3CX.
5. Compare the list built in AD with that built-in 3CX.
6. Delete the extensions in 3CX that are found in 3CX but not in AD.
7. Archive voicemails and recordings of the deleted extension to the configured extension (this is optional).

Configure Active Directory Settings #

1. In the Sync 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 the 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.

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

6. 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,
   • DC=com is a standard value.
   • For instance, to add an Organizational Unit with the name INDIAOffice, you can type: OU=INDIAOffice,DC=VOIPTEST,DC=com

7. Click Save to save the AD information that you have just configured and click OK in the Success message box.

NOTE:

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

Settings #

• In the Settings section, check Disable/Delete Extension and then select the following as per your requirement:
  1. Check the Diable or Delete boxes to perform the following function,
     • Disable – so that ‘Active Directory Sync’ disables/inactivates the extensions in 3CX which are found in AD but not in 3CX.
     • Delete – so that ‘Active Directory Sync’ deletes the extensions in 3CX which are found in AD but not in 3CX.

2. Click Save to save the configuration. and click the Yes option in the Danger alert popup.

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.

• Check the 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:

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

2. 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:
   1. 1. 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.
      2. Create Missing Group – check this option so that the ‘Active Directory Sync’ will create the missing group of the respective missing extension in 3CX.

NOTE:

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

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

3. Click Save to save the settings and click Yes in the Information popup. 

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.

4. Once the settings are successfully saved, a Success message box appears. Click OK.

Start/ Stop Windows Service #

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

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.

Site Screen #

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

• Customize the gradient color of the ‘Application Header’
• Customize grid color in screens that display grid data
• Customize logo on the ‘Application Header’
• Customize ‘Header Title Prefix’ on the ‘Application Header’

A) Customize Application Title Header – Gradient Color #

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

B) Customize Grid Color #

1. 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:

C) Customize ‘Header Title Prefix’ Text #

1. In the Header Title field, enter the text that you want the application to display as ‘prefix’ for the existing title in application header.

Final sample display after applying all the site settings configuration.

About Screen #

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

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.