Skip to main content

AD Sync Service Deployment

Overview

This article provides the step-by-step procedure for installing the AD Sync Service.

Before proceeding, ensure you have read the ADSync Tool Usage Guidelines thoroughly.


Prerequisites

  1. Create a customer in Atria to represent the customer you are syncing.

  2. Ensure the web.config file for CortexDotNet is correctly configured using the below info:
    Path: C:\inetpub\Cortex Management\CortexDotNet

    KB000012img2

info

Ensure UserSyncAPIServer is pointing to the correct URL within the cortexweb site.
Example: http://cortexweb.automate101.com/
The URL must be accessible from the end-user's network.

If SSL is used on the cortexweb site, make sure UserSyncAPISSL is set to TRUE.


Installation Steps

  1. On your Provisioning server, run the following command to import the AD Sync service schema:
Import-AtriaServiceSchema -Service ADSync
  1. Enable the service at the top level:

    • From the Atria menu bar, navigate to Configuration > System Manager > Service Deployment, then expand AD Sync.
    • Click Save.
  2. Enable the service at the location level:

    • Under Service Filter, select Active Directory Location Services and choose the Location you wish to deploy the service to.
    • Expand AD Sync.
    • Click Save.
  3. Provision the AD Sync service to the customer.

  4. Create a user account under the customer with the AD Sync Administrator role:

    • Password should be set to never expire

    KB000012img1

  5. On the customer’s Domain Controller, navigate to the your Atria portal.

  6. Log in as the AD Sync Administrator.

  7. Navigate to:
    Services > AD Sync > AD Sync Download

AD Sync Download
  1. Download the AD Sync Installer.

    Alternatively, the service provider can download the installer and share it with the end-user.

  2. Run the AD Sync installer:

Installer

KB000012img4

  1. Enter the account password.
Enter the account

KB000012img5

  1. Select the events to monitor (Users, Contacts, Groups) depending on your sync requirements.
Events to watch

KB000012img6

  1. Modify the sync scope:
  • Remove the default "Users" group
  • Add only the specific users, groups, or contacts that should be synchronized
Sync Scope

KB000012img7

  1. The Connection Information should auto-fill from the web.config.
    If connection fails, revisit your configuration.
Connection Information

KB000012img8

  1. (Optional) Configure a Proxy Server, if required.
Proxy Server

KB000012img9

  1. Choose the installation destination folder.
Installation Destination Folder

KB000012img10

  1. Proceed with the installation.
Installation

KB000012img11

  1. Installation complete.
Complete

KB000012img12

  1. Restart the server.
Restart

KB000012img13


Testing and Verification

  1. Confirm that the AD Sync Service is running under services.msc.
services.msc

KB000012img14

  1. Create a test user in Active Directory and add it to one of the synced groups.
  2. Verify that the new user appears in Atria.

Configuration

For further configuration options, refer to the following:

These resources will help you manage and optimize your AD Sync Service setup.


If you experience any issues or require any assistance with this process, please contact us at support@getatria.com.