When upgrading the Hyland IdP Server, you must run the IdP Database Migration Utility to migrate the data models used in the idpconfig.json file to the new data models.
Prior to running the IdP Database Migration Utility, you must complete the following tasks:
Perform the steps described in Upgrading the Hyland IdP Server.
Install Microsoft .NET Core 6.0.0 or higher Server Hosting Bundle for Windows on the workstation running the utility.Note:
The .NET Core Hosting Bundle is a Microsoft product. For installation and configuration procedures, see Microsoft's .NET Core documentation.
To migrate configuration data models:
- Open a command prompt with administrator privileges.
- In the command prompt, navigate to the location of the Hyland Identity Provider Server Database Migration Utility folder. In a default installation, this is located at C:\Program Files\Hyland\Hyland Identity Provider Server Database Migration Utility
Enter the following command where the file path in quotations is the file path to your idpconfig.json configuration file:
dotnet .\Hyland.Identity.Migration.Utility.dll IdPConfigMigration --filePath "C:\Program Files\Hyland\identityprovider\idpconfig.json"Note:
The command name (IdPConfigMigration) and the argument (--filePath) are case sensitive. You must enter these exactly as shown in the example.
Once the command is entered, an [OK] status is displayed and your configuration data is now migrated to the newest data models.Note:
If you receive a [FAIL] status after running the migration utility, see the The Hyland IdP Database Migration Utility Fails.
- If you are migrating data models from a Hyland IdP version of 2.10.1 or below to Hyland IdP version 2.11.0 or above, you must add administrative users or user groups to your migrated idpconfig.json file using the set-admins or set-admin-groups command. See Configuring Administrative Users or Configuring Administrative Groups.
- If you are using Hyland IdP version 2.11.0 or above, run the IdP Database Migration Utility to migrate the IdP server database to ensure compatibility with the Hyland IdP version you are upgrading to. See Migrating the IdP Server Database.