Running the Installer - Running the Installer - Perceptive Content - OnBase - Other - Identity and Access Management Services - Other/Identity-and-Access-Management-Services/5.3/Identity-and-Access-Management-Services/Installation/Upgrade-Considerations/Upgrading-Hyland-IdS/Running-the-Installer - 5.3 - 5.3

Identity and Access Management Services
Platform
Other
Product
Identity and Access Management Services
Release
5.3
License
ft:lastPublication
2026-05-22T12:39:50.585000
ft:locale
en-US

To upgrade your existing Hyland IdS, you must first run the installer for the version you are upgrading to. Do not uninstall any of the IAM Services components from the previous version currently installed.

Note: If you are running the Hyland IdS installer from the command line and want to retain the configuration files during the upgrade, you must enter the RETAINCONFIGFILES command line switch to the installation command. For more information on running the installer from the command line, see Running the Hyland IdS Installer from the Command Line.

To run the installer:

  1. Launch the Hyland.Identity.Server.Setup.exe file for the version you are upgrading to.
    Note:

    In Microsoft Windows, the installer must be launched with elevated administrator privileges.

    The Hyland Identity Service page is displayed.
  2. Read and agree to the terms and conditions, then click Install.
    A prompt is displayed stating a previous version was found to be installed.
    Hyland Identity Service Setup prompt
  3. Click Yes.
    A prompt about retaining the pre-configured Hyland IdS configuration files is displayed.
    Retain pre-configured IdS configuration file prompt
  4. Click Yes to retain the pre-configured identity service configuration file and appsettings.json file from the previous version of Hyland IdS you are upgrading from.
    The installation wizard is initialized and launched. The Welcome to the Hyland Identity Service Setup Wizard page is displayed.
  5. Click Next.
    The IIS Settings | Select the IIS Website and IIS Application Name page is displayed.
    Hyland IdS ISS Settings page
    Note: The values for the Web Site, Application Name, and Application Pool fields display the values from the currently installed version of Hyland IdS.
  6. Select the website to install Hyland IdS from the Web Site drop-down list.
    This list is populated with the websites configured in IIS and available to the target server.
  7. Enter a name for Hyland IdS in the Application Name field. The default name for Hyland IdS is identityservice.
    Note:

    IdS cannot have the same application name as other applications on the website. The application name should use all lowercase letters. It is a best practice not to use parentheses in the application name.

  8. In the Application Pool field, enter a name for the application pool that Hyland IdS will use. The default name for the application pool is identityserviceAppPool.
  9. Click Next.
    The IIS Settings | Set the Application Pool Credentials page is displayed.
    IIS Settings App Pool Credentials page
  10. Select the Specify IIS Application Pool Credentials option to configure a specific account for the Hyland IdS application pool to run under. If this option is deselected and no account is specified, the application pool runs under the ApplicationPoolIdentity account.

    If you select Specify IIS Application Pool Credentials, the Username, Password, and Confirm password fields are enabled. Enter the application pool credentials in the corresponding fields.

    Note:

    The identity running the Identity Service application pool must have Read access to the private key of the encryption certificate. For details on configuring certificate permissions, see the documentation provided by Microsoft for the Certificate Manager tool.

  11. Click Next.
    The Destination Folder page is displayed.
    Hyland IdS Service Setup Destination Folder page
  12. Enter the installation directory in the field provided, or click Change to browse to it. In a default installation, Hyland Identity Service is installed to C:\Program Files\Hyland\identityservice\.
    Note: When choosing to retain the previously configured idpconfig.json and appsettings.json configuration files from Hyland IdP versions prior to 3.1.0, you must use the same installation directory where the previous version was installed.
    1. If you clicked Change, the Change destination folder dialog box is displayed.
      Hyland IdS Setup Change Destination Folder Page
    2. Enter the path to the installation directory in the Folder name field, or select an installation directory from the Look in drop-down list.
    3. Click OK. The location is changed and the Destination Folder page is displayed.
  13. Click Next on the Destination Folder page.
    The Ready to install Hyland Identity Service page is displayed.
  14. Click Install.
    A prompt about running the Hyland Identity Service migration utility is displayed. The installation process is complete and the Completed the Hyland Identity Service Setup Wizard page is displayed.
  15. Click Finish.
    The wizard completes the installation and closes.
  16. Click Close on the Hyland Identity Service page.
  17. Run the Identity Service Database Migration Utility to migrate the data models used in the idsconfig.json file to the new data models. See Migrating Configuration Data Models.