Upgrade your database manually

The installer can upgrade the Unica Plan database during the upgrade process. Use the database setup utility, umodbsetup, to upgrade the tables manually if your company policy doesn't allow you to upgrade the database.

The umodbsetup utility does one of the following actions:

  • Option 1: Upgrades the system tables in the Unica Plan database and populates the tables with required default data.
  • Option 2: Outputs the database upgrade and population scripts to a file that you or your database administrator can then run in your own database client.

Configuring environment variables

Before you run the umodbsetup, complete the following steps to configure the environment variables properly:

  1. From the <Plan_Home>\tools\bin directory, locate and open the setenv file in a text editor.
  2. Verify that the JAVA_HOME variable indicates the correct directory for your installation of Java™, and that the JDBC drivers are the first entry for the DBDRIVER_CLASSPATH variable. For more information about setting the environment variable, see the Plan Installation Guide.
  3. Save and close the file.
  4. From the <Plan_Home>\tools\bin directory, locate and open the umo_jdbc.properties file.
  5. Set values for the following parameters:
    • umo_driver.classname
    • umo_data_source.url
    • umo_data_source.login
    • umo_data_source.password
  6. Save and close the file.

Database setup utility

From a command prompt or UNIX™ shell, navigate to the <Plan_Home>\tools\bin directory. Run the umodbsetup utility and provide appropriate input for the parameters required for your situation.

For example, the following command runs an upgrade, sets the locale to en_US, and sets the logging level to medium:

./umodbsetup.sh -t upgrade -L en_US -l medium

The following is the description of all the possible variables for the utility:

Table 1. Variables for the umodbsetup.sh utility

This two-columned table describes variables in one column, and description in the second column.
Variable Description
-b For upgrades only. Identifies the base version of the database that you are attempting to upgrade.

By default, the utility detects the version of the database you are upgrading. However, if an earlier attempt to upgrade the database failed in some way, the version may have been updated even though the upgrade failed. When you have corrected the problem and run the utility again, you use this variable with the -f variable to specify the correct base version.

For example, -f -b 12.1.0.0
-f For upgrades only. Instructs the utility to use the base version specified by the -b variable, overriding the base version it may detect in the database. See the description of the -b variable.
-h Provides help for the utility.
-l Records the output from the actions that the umodbsetup utility performs in the umo-tools.log file. This file is located in the <HCL_Unica_Home>\<Plan_Home>\tools\logs directory. This variable specifies the logging level.

You can set the logging level to high, medium, or low.
-L Sets the default Locale for the installation. For example, use -L de_DE for a German installation.

The valid entries for locales include de_DE, en_GB, en_US, es_ES, fr_FR, it_IT, ja_JP, ko_KR, pt_BR, ru_RU, zh_TW, and zh_CN.
-m

Outputs the scripts to a file in the <HCL_Unica_Home>\<Plan_Home>\tools directory, which you can then run manually. Use this option if there is a reason you need to run scripts from your own database client application. When you use this variable, the umodbsetup tool does not run the script.
-t Type of database installation. Valid values are full and upgrade. For example, -t full
-v Verbose.

Running database scripts manually, if necessary

If you used the -m variable to output the scripts so you can run them from your own database client application, run the scripts now.

Do not deploy the plan.war file before you upgrade and populate the system tables.