Upgrade OpenLM to version 21 and Identity Service Configuration -KB1001 - OpenLM Software License Management
Israel +972 4 6308447         USA +1 619 831 0029              JAPAN +81 505 893 6263 担当:萩原

Upgrade OpenLM to version 21 and Identity Service Configuration -KB1001

You are here:
< All Topics

 

Prerequisites :

  • Your current version of the OpenLM Server must be 5.6, the migration from Firebird to MariaDB/MSSQL/ MySQL executed
  • Note: Identity Service, DSS, and OpenLM Server require individual schemas
  • OpenLM v21 requires a new license file which will be stored in the OpenLM root folder, ex: C:\Program Files\OpenLM\OpenLM Server\license

This guide covers:

Upgrading the OpenLM Server 

Installation and configuration of the Identity Service 

Configure the Identity Service to secure the OpenLM components

Configure the OpenLM Server to work in a secure environment

Upgrading DSS

Requirements

Configure DSS to work in a secure environment with the Identity Service:

Reports Scheduler

Upgrading ServiceNow Adapter

Configure ServiceNow to work in a secure environment with the Identity Service: 

The guide will provide instructions on how to upgrade to the OpenLM Server v21 and configure it with the Identity Service. Understanding the installation process will allow you to properly set up OpenLM, configure the initial steps required to activate the Identity Server and clarify any of the options presented by the OpenLM Server installer.

 

Upgrading the OpenLM Server

  1. Contact our support department to obtain the OpenLM Server v21
  2. Once obtained, double click on the MSI installer, then strike the Next button.
    Note: the message in red will only appear if you have not migrated the database before the Server upgrade from Firebird to any supported databases, otherwise space will be blank.

 

wizard

 

3. If you agree to the terms and want to continue with the upgrading, click the “I Agree” radio button. Clicking the radio button will enable the Next button. Clicking Cancel will exit the installer without any changes.

 

wizard

 

4. Select where the Server will be located. The default path is C:\Program Files (x86)\OpenLM\OpenLM Server, then click Next

5. The installer is ready to run. Click Install

 

wizard

 

6. You will be directed to the Finish Prompt:

 

wizard

 

Make sure to store the new license file for v21 in C:\Program Files (x86)\OpenLM\OpenLM Server\License.

 

At this point, locate the OpenLM Server Process in the Services list and right-click on it to restart:

 

services

 

7. Open up the EasyAdmin. Hover over the logo to check if the update is successful:

 

check the version

Installation and configuration of the Identity Service

 

The Identity Service is a secured solution that manages the authentication for all the OpenLM products. It uses the industry-standard OAuth 2.0 and it serves to log a user right away.

Below is a short guide on how to install and configure the Identity Service:

  1. On the OpenLM website, obtain the OpenLM Identity Service. Double click on it to trigger the installation process:

wizard

 

2. Read carefully the terms and conditions. If compliant, tick the box to accept then click Next

 

wizard

 

3.The Identity Service requires an empty database. Make sure you have one before continuing with the installation:

 

wizard

 

4. The next prompt will disclose the temporary username and password. We strongly recommend changing them right away:

 

wizard

 

5. Immediately after you will be directed to the database configuration tool prompt. Type in all the required details. Test the connection. If successful, click Approve

 

powershell prompt

 

 

6.  Enter the port number then click Enter. The default is 5000:

powershell prompt

 

7. In the next steps, the database will be created and the Identity Service configured:

powershell prompt

 

8.When the configuration is completed, press Enter

 

wizard

 

9. Hit the Finish button. You will be redirected automatically to the OpenLM Identity Service UI. Type in the single-use credentials:

 

Identity service login

 

10. You will then be asked to change the temporary password. Type in a new reliable password, confirm it then hit the Change button:

 

Identity service change password prompt

 

11. Once the password has been changed, you will be redirected to the login page. Use your new credentials to access the Identity Service account

 

Change password confirmation prompt

 

Configure the Identity Service to secure the OpenLM components

 

To configure the OpenLM components to work in a secure environment, all select the Settings Icon in the Identity Service window:

 

Identity service settings

Select the Security Configuration tab:

Identity service configuration tab

Further, we will upgrade each component to v21 then configure to work in a secured environment with the Identity Service.

Configure the OpenLM Server to work in a secure environment

  1. In the Identity Service UI, select the Settings tab, then Security Configuration
  2. Turn on the Server toggle switch
  3. Provide the OpenLM Server IP or URL
  4. Type in the username (Admin by default)
  5. Click Save

identity service

6. Go to Services and restart both the Identity Service and the OpenLM Server

In the EasyAdmin Dashboard, we can now see the logout button:

dashboard with login

Instead, if we turn off the Server’s toggle switch, the logout/in button will disappear( each time we turn on or off, the Server Service must be restarted):

dashboard without login

Upgrading DSS

Requirements

The Directory Synchronization Service no longer supports the Firebird database engine, thus, it is mandatory to create a schema in any supported databases. (MariaDB, MySQL, MS SQL Server). The data will be migrated automatically from Firebird to the target DB. The migration will be done only for agents, domains, sync definitions. Entities and Relations will be recreated after syncs.

A license file that has support for the Directory Synchronization extension (contact sales@openlm.com if unsure).

If installing DSS and DSA on a machine separate from OpenLM Server, make sure that the machine is on the same network as the domain controller.

  1. Obtain version 21 of DSS from the OpenLM Downloads page. Double-click to run the installer.

wizard

 

2. Check the “I agree to the license terms and conditions” box and click Next.

 

licence agreement

3. Choose the database type, tick the box then click Next.

4. Provide the Database configuration details then click Next

 

db configuration

 

5. Select the path you want to install the DSS, the default one is:

wizard

 

6. The installation is ready to run. Thick the box if you want to create a desktop icon then click Next:

 

dss wizard

 

 

7. Wait for the upgrade process to complete then click Finish:

 

upgrade ended

8. You will be then directed to the DSS UI, which is for the moment unsecured.

Configure DSS to work in a secure environment with the Identity Service:

 

  1. Go to the Identity Service URL
  2. Select the Settings tab, then Security Configuration
  3. Turn on the toggle button for the DSS
  4. Type in the DSS URL
  5. Click Save

 

dss identity service

6. To complete the configuration, restart the DSS Service:

warning

 

services

7. Use the desktop Icon  or the Start Menu ->Administration ->  in order to access the already secured environment.

Reports Scheduler

  1. Double click on the installer to trigger the installation then click Next

 

wizard

2. Accept the terms and conditions and strike Next

licence agreement

 

3. Select the Destination folder. The default path is C:\Program Files\OpenLM\OpenLM Reports Scheduler. Click Next

 

default path

 

4. Select the features you want to install then click Install

 

components to install

 

5. The installation is completed. Click Next then Finish

 

wizard

 

wizard

Upgrading ServiceNow Adapter

1. Obtain the latest External Platforms Service & ServiceNow Adapter installer v21.x file (OpenLM_ServiceNow_Adapter_Installer_#.#.###.msi) from our Downloads page

2. Double-click the installer file to run it.

3. Check the “I agree to the license terms and conditions” box.

licence agreement

4. Click Next.

5. If you want to install the External Platforms & ServiceNow Adapter to a different location, click Browse and navigate to the destination folder of your choosing.

select destination folder

6. Click Next to begin the installation. Please note that this step may take up to several minutes depending on your hardware specifications.

7. When the next prompt pops out, make sure to follow the instructions, then click Finish:

wizard

 

8. You will be redirected to the ServiceNow Adapter UI, which is at the moment unsecured.

Configure ServiceNow to work in a secure environment with the Identity Service:

  1. Go to the Identity Service UI
  2. Select the Settings tab then Security Configuration
  3. Turn on the ServiceNow toggle button
  4. Type in the Service now adapter URL
  5. Save the configuration

identity service

6. Restart the ServiceNow Adapter Service

services

 

Previous OpenLM Release number unification
Table of Contents