Running the Installer - Identity and Access Management Services - 3.0 - 3.0 - Other - external

Identity and Access Management Services

Platform
Other
Product
Identity and Access Management Services
Release
3.0
License

To upgrade your existing Hyland IdP server, you must first run the installer for the version you are upgrading to.

To run the installer:

  1. Create a backup copy of the Hyland IdP server configuration file (idpconfig.json). In a default installation, the Hyland IdP configuration file is located at C:\Program Files\Hyland\identityprovider. This file contains information on the tenants, providers, and clients configured for use with the Hyland IdP server.
  2. Create a backup copy of the Hyland IdP server application settings configuration file (appsettings.json). In a default installation, the Hyland IdP application settings configuration file is located at C:\Program Files\Hyland\identityprovider\config.
  3. Uninstall the following IAM Services components:
    • Hyland Identity Provider (IdP) server

    • Hyland IdP Administration client (included with the Hyland IdP server)

    • Hyland SCIM server

      Note:

      The Hyland SCIM server is only installed for OnBase environments with the Hyland API Server. To uninstall the Hyland SCIM Server, the API Server should be uninstalled.

  4. Run the Hyland IdP server installer for the version you want to upgrade to. See Installing the Hyland Identity Provider (IdP) Server.
    Note:

    Do not complete any further installation steps such as initialization or configuration after the installer has completed installing the IdP server.

  5. Replace the default idpconfig.json file with the backup copy you created from the previously existing version of the Hyland IdP server. In a default installation, the idpconfig.json file is located at C:\Program Files\Hyland\identityprovider
  6. Replace the default appsettings.json file with the backup copy you created from the previously existing version of the Hyland IdP server. In a default installation, the appsettings.json file is located at C:\Program Files\Hyland\identityprovider\config
    Note:

    If you are replacing the default appsettings.json file with a backup copy, additional backwards compatibility settings may have been added to the appsettings.json file since you created the backup copy. See Hyland IdP 2.11.0 for more information on these settings.

  7. Run the IdP Database Migration Utility to migrate the data models used in the idpconfig.json file to the new data models. See Migrating Configuration Data Models.