Directory Sync installation guide

Prerequisites

• OpenLM SLM 21 or higher.
• A license file that has support for the Directory Sync extension (contact sales@openlm.com if unsure).
• If installing DSS and DSA on a machine separate from OpenLM SLM, ensure that the machine is on the same network as the AD domain controller.
• A designated schema in any supported database - MariaDB, MS SQL, My SQL.

Directory Synchronization Service installation

1. Get the latest version of DSS from the OpenLM Downloads page. Run the installer.

2. Check the I agree to the license terms and conditions box and select Next.

3. In the next prompt you will be asked to select the database type that you want to use. Select it from the dropdown list and select Next. If you are upgrading and require to migrate data, go to Upgrading from Directory Sync 1.4 (Firebird) to Directory Sync v2x.

4. Provide the database configurations details then select Next:

Note this prompt may be slightly different, depending on the DB type used.

5. You can change the installation folder if you want. The default one is C:\Program Files\OpenLM\OpenLM Directory Synchronization Service. Select Next.

6. Once the setup is complete, select Finish. This will close the Setup Wizard and open the DSS user interface in your browser.

Before you install DSA

Check these first. If any of them is missing, the installation or the first sync fails:

• The DSA machine can reach DSS on port 7026, and port 8081 is free on the DSA machine. See Port configuration for the firewall rules.
• The DSA machine can reach a domain controller of each directory you want to sync, on that directory's LDAP port. One DSA can sync several directories, but a directory on a network the DSA can't reach needs its own DSA installed there.
• You can sign in to EasyAdmin with a user that has the account administrator role in Identity Service. You need it to add the DSA authorization in step 5.
• The installer sets up the OpenLM Directory Synchronization Agent Windows service to run as Local System. Leave it that way, or use an administrator service account.

Directory Synchronization Agent installation

1. Get the latest version of DSA from the OpenLM Downloads page. Run the installer.

2. Check the I agree to the license terms and conditions box and select Next.

3. Enter a descriptive name (no spaces allowed) to recognize the Agent instance and the details of the DSS installation (found in the Directory Sync UI → Service Configuration tab under DSS Server), then select your Server version: On-premise or Cloud. Select Next.

4. The next prompt will require you to authorize. You can skip this step if you don't use Identity Service.

5. To obtain the Authorization file go to EasyAdmin and follow the path: Start→Administration→System&Security→Security→Authorization→Add

   Only a user with the account administrator role in Identity Service can add an authorization. Other users can see the list but can't add to it.

6. Select the Client type from the drop-down list - DSA. Select Save.

Note: The Secret Key will only be displayed once. Make sure to save it before closing the window.

7. Copy or Download the JSON file with the Client ID and Client Secret:

8. Go back to the installation process and import or copy&paste the credentials:

9. You can change the installation folder if you want. Enter the path or select Browse, then select Next when completed.

10. Once the setup is complete, select Finish. At this point, a DSA approval request will have been sent to the DSS. You need to open the DSS user interface and go to the Agent Manager tab to approve it.
    

When completed, follow this guide to configure your Directory Sync Instance.