Skip to main content

Preparing to upgrade

Before you upgrade your Incentives installation, you must perform some steps to ensure that your upgrade is successful.

  1. Back up all of your configuration files:

    • defaults.json

    • RESTAPI.exe.config

    • RESTAPI.appSettings.config

    • RESTAPI.dbServers.config

    • RESTAPI.smtp.config

    • IBM Cognos Incentives Scheduler Service.exe.config

    • index.html

    • SchedulerService.appSettings.config

    • conf.bundle.js

    • security.properties

    • jdbc.properties

    Important

    You cannot use your existing configuration files with an upgraded version.

  2. Uninstall the current version of the following applications:

    • tenant service

    • REST API

    • admin web application

    • Scheduler service

    • CLI tool

    • Model Upgrader

    • Sales Portal application

  3. Back up all of your models.

Notes on upgrading certain objects

If the model contains compensation plans and tailored reports, upgrading the model removes them. This is applicable when upgrading from version 9.0.2 or below to version 10.0.

Draws must be manually removed prior to an upgrade. If draws still exist in a model that is being upgraded, an error message is displayed during the upgrade process.

If you are upgrading a model that contains star schemas that were created with calculations, you will receive an error message when you try to upgrade your model. As of version 8.0.4, star schemas must be created with data stores. Before you upgrade your model, you must delete any star schemas that were created with calculations and create them with data stores.

Back up any existing models before you upgrade. Save copies of your configuration files so that database and environment settings can be compared with the settings in the configuration files in the upgraded version. When you upgrade, the settings in the configuration files must be manually updated.

After an upgrade, scenarios remain and are remapped using the last calculation and payee group from the compensation plan associated with the scenario. Portal Access filters inside web forms should be reviewed after upgrading.