Configuring Active Directory Synchronization

Procedure

1. Go to Administration → Settings → Active Directory and Compliance Settings.
2. Click the Active Directory Settings tab.
3. Select Enable Active Directory synchronization.
4. Click Save.
5. Download the Active Directory synchronization tool.

   WARNING Clicking Download the Active Directory synchronization tool will deactivate any previously downloaded Active Directory synchronization tools and stop synchronizing Active Directory servers configured using the deactivated tool.

   1. Click the Download the Active Directory synchronization tool link.
      The file MD5 hash value for the synchronization agent appears.
   2. Save the Apex_Central_ADSyncAgent_*.zip file.
   3. Extract the Apex_Central_ADSyncAgent_*.zip file.
6. Execute the synchronization tool on any Windows endpoint that can connect to the Active Directory server.

   Important Ensure that .NET Framework 4.6.1 is installed on the Windows endpoint before executing the tool.

   1. Open a command prompt.
   2. Use the following command to locate the directory which contains the ADSyncAgentTool.exe file:
      cd <Apex_Central_ADSyncAgent_directory>

      Important Make sure the file path for the synchronization tool contains only printable ASCII characters.

   3. Configure Active Directory server settings by executing the following command:
      ADSyncAgentTool.exe -i
   4. (Optional) Configure proxy server settings by executing the following command:
      ADSyncAgentTool.exe -p
   5. Synchronize configured servers manually by executing the following command:
      ADSyncAgentTool.exe -s

      Note You may also use Windows Task Scheduler to synchronize configured servers using a scheduled task that has a time interval of at least 2 hours between each task repetition. For more information, refer to the Microsoft documentation.

7. Verify the Active Directory synchronization.
   1. Go to Administration → Settings → Active Directory and Compliance Settings.
   2. Click the Active Directory Settings tab.
      The synchronized server information appears.

   Note The Active Directory server connection status icon ( or ) appears in front of the server address. You may also use the Command Tracking screen to monitor the synchronization status.

8. To remove a synchronized Active Directory server:
   1. Clear the Enable Active Directory synchronization check box.
   2. Click Clear Data to purge the Apex Central server of data from the removed Active Directory server.
      Apex Central removes the synchronized Active Directory server.

      Note Clicking Clear Data triggers a scheduled task, which runs every 2 minutes, to purge all data of the removed Active Directory servers from the Apex Central database.