Skip to main content

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, make sure 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. Double-click to run the installer.

Screenshot: Directory Synchronization Service installation

  1. Check the "I agree to the license terms and conditions" box and click Next.

  2. 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 click Next. If you are upgrading and require to migrate data, go to step 4.2

Screenshot 2: Directory Synchronization Service installation

  1. Provide the database configurations details then click Next:

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

Screenshot 3: Directory Synchronization Service installation

  1. You can change the installation folder if you want. The default one is C:Program FilesOpenLMOpenLM Directory Sync (DSS) Service . Click Next.

Screenshot 4: Directory Synchronization Service installation

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

Screenshot 5: Directory Synchronization Service installation

Directory Synchronization Agent Installation

  1. Get the latest version of DSA from the OpenLM Downloads page. Double-click to run the installer.

Screenshot: Directory Synchronization Agent Installation

  1. Check the "I agree to the license terms and conditions" box and click Next.

  2. 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. Click Next.

Screenshot 2: Directory Synchronization Agent Installation

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

Screenshot 3: Directory Synchronization Agent Installation

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

Screenshot 4: Directory Synchronization Agent Installation

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

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

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

Screenshot 5: Directory Synchronization Agent Installation

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

Screenshot 6: Directory Synchronization Agent Installation

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

Screenshot 7: Directory Synchronization Agent Installation

  1. Once the setup is complete, click 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.
    Screenshot 8: Directory Synchronization Agent Installation

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