To upgrade your existing Hyland IdP server, 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.
To run the installer:
Launch the Hyland.Identity.Server.Setup.exe file for the
version you are upgrading to.
In Microsoft Windows, the installer must be launched with elevated administrator privileges.
The Hyland Identity Provider Server page is displayed.
Read and agree to the terms and conditions, then click
Install. A prompt is displayed stating a previous
version was found to be installed.
Click Yes. A prompt about retaining the pre-configured
Hyland IdP server configuration files is displayed.
- Click Yes to retain the pre-configured idpconfig.json and appsettings.json configuration files from the previous version of the Hyland IdP server you are upgrading from. The installation wizard is initialized and launched. The Welcome to the Hyland Identity Provider Server Setup Wizard page is displayed.
Click Next. The IIS Settings | Select the IIS
Website and IIS Application Name page is displayed.
- Select the website to install the Hyland IdP server under from the Web Site drop-down list. This list is populated with the websites configured in IIS and available to the target server.
Enter a name for the Hyland IdP server in the Application
Name field. The default name for the Hyland IdP server is
The Hyland IdP server 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.
- In the Application Pool field, enter a name for the application pool the Hyland IdP server will use. The default name for the application pool is identityproviderAppPool.
Click Next. The IIS Settings | Set the
Application Pool Credentials page is displayed.
Select Specify IIS Application Pool Credentials to
configure a specific account for the Hyland IdP 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 Hyland IdP server 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.
Click Next. The Destination
Folder page is displayed.
Enter the installation directory in the field provided, or click
Change to browse to it. In a default installation,
the Hyland IdP server is installed to C:\Program
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.
If you clicked Change, the Change
destination folder dialog box is displayed.
- Enter the path to the installation directory in the Folder name field, or select an installation directory from the Look in drop-down list.
- Click OK. The location is changed and the Destination Folder page is displayed.
- If you clicked Change, the Change destination folder dialog box is displayed.
- Click Next on the Destination Folder page. The Ready to install Hyland Identity Provider Server page is displayed.
- Click Install. A prompt about running the Hyland IdP server migration utility is displayed. The installation process is complete and the Completed the Hyland Identity Provider Server Setup Wizard page is displayed.
- Click Finish. The wizard completes the installation and closes.
- Click Close on the Hyland Identity Provider Server page.
- 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.