Pre-upgrade check utility

Before you upgrade from HCL® Campaign v9.1 to v9.1.1, use the preUpgradeTool utility to identify any issues or inconsistencies in the file system and database. Running the utility is optional but recommended.

As part of the upgrade, executable scripts are installed in $CAMPAIGN_HOME/tools/utilities/upgrade/9.1To9.1.1. For Windows, the utility is named preUpgradeTool.bat. For other operating systems, the utility is named preUpgradeTool.sh.

The utility performs the following checks:

  • File existence check: Verifies the HCL Campaign home directory location. This directory must exist in the file system and be accessible to the utility. This check verifies that all files required for the upgrade, such as the database upgrade script and the configuration file, are available in this directory. If any of the files are not accessible, this check fails.
  • Configuration check: Verifies accessibility to campaign_configuration.xml, which is needed to upgrade the configuration. This task also checks if campaign_configuration.xml is a valid xml file. If it is corrupted, the task fails.
  • Platform Configuration accessibility check: Verifies whether the HCL Marketing Platform configuration is accessible.
  • Database upgrade check: Verifies whether the database details that you provided are valid. The utility accesses the database with your user credentials and verifies that the database includes the HCL Campaign system tables. This check also verifies whether you have Create, Drop, and Alter permissions in the database.
  • Campaign and session ses file check: Each campaign, session, and flowchart has files of type ses associated with them. The .ses file stores system data that is related to the campaign, session, or flowchart. If a file is missing, the related object is not usable.

Process overview

Before you run the preUpgradeTool, enter your environment details in the file setenv.bat (Microsoft Windows) or setenv.sh (other operating systems). You can then run the preUpgradeTool utility.

  1. The utility interactively requests information that is required for the upgrade, such as the location of CAMPAIGN_HOME and database details.
  2. After all of the details are collected, they are verified.
  3. The status of each validation step is displayed. All results are also logged.
  4. If all checks pass, a success message is displayed with an option to continue with the upgrade.
  5. All of the data that you provided is automatically passed to the upgrade script.