Upgrading from Xpress Insight 4

This appendix covers migrating to Xpress Insight 5 which has new features that are not backwards compatible with Xpress Insight 4.

Xpress Insight 5 and later use a different technology stack to Xpress Insight 4. The upgrade process from Xpress Insight 4 to 5 is not an in-place upgrade. The information in this section covers the steps to migrate the data from an existing Xpress Insight 4 system to a new Xpress Insight 5 installation.

Note: Insight 5 introduces breaking changes to some APIs. The Upgrading from Xpress Insight 4 to Xpress Insight 5 chapter of the developer guides lists the changes that might need to be made to an app implementation. The rest of this topic assumes that any upgrading of the app implementation for Insight 5 compatibility has been completed.

The instructions below make the following assumptions:

• The Insight 4 system has been upgraded to the latest available minor/patch version.
• There are new versions of the apps that have been validated as Insight 5 compatible.
• The user is familiar with publishing app updates to an Insight system.

The recommended sequence below performs a test migration for validation and then a final migration. Users who have separate development and production systems should migrate and validate the development system first.

• Use the insightcmd command line tool from the server that Insight 4 is installed on, to perform a repository export to the local file syste,. The insightcmd tool documentation can be found here. You will need to use an administrator account that is assigned the SYS_IMPORTEXPORT authority in Insight 4.
• Transfer the repository export file to the import/export network location of the destination Insight 5 system. The location is configured in the Insight 5 server application.properties file.
• Log into the Insight 5 system with an administrator account that is assigned the SYS_IMPORTEXPORT authority in Insight 5.
• Select the Import Repository option from the Advanced menu on the Home page. This will import the apps, app data and applicable system configuration from the Insight 4 export file. At this stage, the imported app implementations will be Insight 4 compatible and so will not be fully functional in Insight 5.
• Upgrade each app with the updated Insight compatible version. If the Insight 5 server is configured in development mode then the app update can be performed using Xpress Workbench or by uploading the app archive file directly from the Insight 5 Home page. If the Insight 5 server is configured in production mode then the update must be performed by app archive upload.
• The repository import does not migrate the URLs for the workers as the expectation is that the Insight 5 system will not share workers with the Insight 4. Navigate to the Insight 5 Admin page of the user interface and update the URLs for the Insight 5 worker hardware in the Execution Services view.
• Perform a full regression/UAT test of the system.
• If the state of the Insight 4 system has evolved since the repository export was performed (for example because the Insight 4 system was actively used while the Insight 5 regression testing was in progress), then delete all apps in the Insight 5 system and repeat the instructions above to migrate the latest data. Its recommended that all Insight 4 user accounts, other than the administrator account performing the export, be disabled to prevent the Insight 4 system being used after the export point.

Rules for how Insight 4 configuration is imported

Item	Processing rules
App	An app is always imported as a new additional app i.e. repeating an app or repository import will cause duplicate apps to be created.
User	A new user is created for any imported user that doesn't already exist. All imported fields are used, including the imported password (if there is one). An existing user that matches an imported user on username has all fields updated to the imported fields except for the password field. Imported users are assigned the same authority groups and app membership as they were in the Insight 4 export.
Authority Group	A new authority group is created for any imported group that doesn't already exist. An existing authority group that matches an imported group is replaced by the imported group. The following conversions are applied to authorities in the group: PROJECT_IMPORT -> APP_NEW PROJECT_* -> APP_* WORKBOOK_PUBLISH is not imported SYS_SESSION is not imported. Custom authorities are imported.
Execution Service	A new execution service is created for any imported service that doesn't already exist. An existing service that matches an imported service is replaced by the imported service.
Execution Worker	A new execution worker is created for any imported service that doesn't already exist. The worker URL is not imported, and the worker is set to disabled. An existing service that matches an imported service is replaced by the imported service. The worker URL is not updated.
Execution Service to Worker Mapping	A new mapping is created for any imported mapping that doesn't already exist. An existing mapping that matches an imported mapping is replaced by the imported mapping.
Execution Modes to Service Mapping	A new mapping is created for any imported mapping that doesn't already exist. An existing mapping that matches an imported mapping is replaced by the imported mapping.

Note: Systems configured to authenticate with SSO (mandatory for a production deployment) rely on the Insight username matching the username in the Identity Provider. When migrating an Insight 4 system, the imported usernames may not match the Identity Provider usernames. This is commonly the case when the Insight 4 system was using LDAP authentication. Usernames are editable in Insight 5, allowing them to be manually adjusted to match the Identity Provider requirements.

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.