Procedure: Fast upgrade Campaign

Campaign pre-upgrade

Procedure

  1. Import the Campaign system tables backup from the old / base version to the system tables schema used in the clean 11.0.1 environment.
  2. Take a File system backup of the “CAMPAIGN_HOME/partitions/partition1? directory.
  3. Copy all the partitions data from the old environment's partition folders to the clean 11.0.1 environment Campaign partition folder.

Upgrading Campaign

Procedure

  1. This step is not applicable to Fast Upgrade from version 11.0 to version 11.0.1. Update the setenv.sh file the with required values for the Campaign upgrade. For details on environment variables in the setenv.sh file, refer to the Campaign 11.0.1 Upgrade guide.
    1. Navigate to the path: <installation path>/Campaign/tools/upgrade/10.1+to11.0.1/

      Set the following variables in the setenv.sh file:

      Set JAVA_HOME='<Installation Path >/jre'

      Set CAMPAIGN_HOME='<Installation Path>/Campaign'

      Set LOG_TEMP_DIR='<Installation Path>/Campaign/logs'

      Set JDBCDRIVER_CLASSPATH=<JDBC DRIVER CLASSPATH>

    2. Add the JVM Option “-DFAST_UPGRADE_VERSION=<BASE_VERSION>�?

      For example:

      JAVA_OPTIONS="${JAVA_OPTIONS} -DFAST_UPGRADE_VERSION=8.6.x

    3. Supported versions in fast upgrade:
      Upgrade from Version JVM Option
      8.6.x -DFAST_UPGRADE_VERSION=8.6.x
      9.0.x -DFAST_UPGRADE_VERSION=9.0.x
      9.1.x.x (9.1.x, 9.1.1.x and 9.1.2.x) -DFAST_UPGRADE_VERSION=9.1.x
      10.0.x -DFAST_UPGRADE_VERSION=10.0.x
      10.1.x -DFAST_UPGRADE_VERSION=10.1.x
      11.0.0 No need to execute upgrade tool
      11.0.1 No need to execute upgrade tool
  2. Pre-requisite to complete before running the Campaign upgrade tool: The <CAMPAIGN_HOME>/install directory “jdbc.properties�? file contains the correct JDBC URL, Platform system database userID and encrypted password. User will need to copy paste jdbc.properties file from Platform/tools/bin directory to Campaign/install directory. If this information is incorrect Campaign upgrade tool will fail with database authentication related errors.
  3. This step is not applicable for Fast Upgrade from version 11.0 to version 11.0.1. Execute Campaign “acUpgradeTool.sh�?. This Upgrade tool execution is similar to the usual acUpgradeTool execution. During the upgrade tool execution when prompted for “select base version to upgrade�?, you can see the upgrade version specified with the JVM option “-DFAST_UPGRADE_VERSION=<BASE_VERSION>�?. Select the fast upgrade base version to upgrade from.

Campaign post-upgrade

Setting the Campaign – Help About > Version

Procedure

  1. Change the Campaign version in the Marketing Platform registration:
    1. Export the version configuration using the following command on clean 11.0.1 environment:./configTool.sh -x -p "Affinium|Campaign|about" -f <PLATFORM_HOME>/conf/campaign_about.xml
    2. Edit the campaign_about.xml file generated by the above command. Change the version to 11.0.1.0.0.GA_BUILD".<GA_BUILD> - Please replace this with build number referring to version.txt from installation location.

      <property id="xxxxxx" name="releaseNumber" type="string_property" width="40">

      <value>11.0.1.0.0.GA_BUILD</value>

      </property>

    3. If Contact Optimize is also being upgraded update following tag:

      <displayNameKey>Optimize Version</displayNameKey>

      <displayName>Optimize Version</displayName>

      <value>11.0.1.0.0.GA_BUILD</value>

    4. Import the above edited file using the following command:./configTool.sh -v -i -o -p "Affinium|Campaign" -f <PLATFORM_HOME>/Platform/conf/campaign_about.xml
  2. Execute the following command to upgrade Campaign Security Policies from the base version to version 11.0.1:

    Navigate to <Platform_Home/tools/bin>

    ./populateDb.sh -n Campaign

Campaign configuration changes

Procedure

  1. Note: This step is not applicable to Fast Upgrade from version 11.0 to version 11.0.1.Campaign “Campaign REST API Filter�? registration:
    1. Navigate to the PLATFORM_HOME/tools/bin directory.
    2. Execute the following command:./configTool.sh -vp -p "Affinium|suite|security|apiSecurity|campaign" -f <CAMPAIGN_HOME>/conf/API_Filter.xml
  2. Note: This step is not applicable to Fast Upgrade from version 11.0 to version 11.0.1.Campaign “Engage REST API�? registration:
    1. Navigate to the PLATFORM_HOME/tools/bin directory.
    2. Execute the following command:./configTool.sh -vp -p "Affinium|suite|security|apiSecurity|campaign" -f <CAMPAIGN_HOME>/conf/Engage_API_Filter.xml
  3. Change Campaign configurations in the Marketing Platform configuration:
    1. Change the Campaign navigation URLs.
    2. Change the “serverHost�? under Settings for 'unicaACListener'(Affinium|Campaign|unicaACListener).
    3. Change DSN under UA_SYSTEM_TABLES if required.
    4. Change the JNDI name under UA_SYSTEM_TABLES if required.
    5. Remap all system tables in the Campaign table mapping. This can be done using the following steps:
      1. Stop the listener.
      2. Remove “unica_tblcache.mgr�? from <CAMPAIGN_HOME>/partitions/partition/conf.
      3. Start the listener.
      4. Navigate to Campaign settings > Table mapping.
  4. Platform – DBResourceBundle: The steps underneath will import resource bundles in Marketing Platform. Execute the script underneath as specified:
    1. Navigate to <platform_home>/tools/bin
    2. DBResourceBundle.sh /bat -P Campaign -F <Campaign_home>/resourcebundles

Campaign post-upgrade functional check

Perform UAT on Campaign application. Ensure that all the flowchart are opening and the run is successful.

Upgrading eMessage

(This can be skipped if eMessage is not in use): You should manually execute the following scripts provided in the table underneath on the HCL Campaign database while upgrading from various base versions:

About this task

Versions Scripts to Execute
8.6.x to 11.0 Navigate to <CAMPAIGN_HOME>/eMessage/ddl/upgrade on the Newly install Campaign 11.0.1 setup.

Execute all scripts after "-- 8.6.0.0 Updates --" from ace_upgrade_<DATABASE_TYPE>.sql
9.0.x to 11.0 Navigate to <CAMPAIGN_HOME>/eMessage/ddl/upgrade on the Newly install Campaign 11.0.1 setup.

Execute all scripts after "-- 9.0.0.0 Updates --" from ace_upgrade_<DATABASE_TYPE>.sql
9.1.x to 11.0 Navigate to <CAMPAIGN_HOME>/eMessage/ddl/upgrade on the Newly install Campaign 11.0.1 setup.

Execute all scripts after "-- 9.1.0.0 Updates --" from ace_upgrade_<DATABASE_TYPE>.sql
9.1.1.x to 11.0 Does not require any script execution.
9.1.2.x to 11.0 Does not require any script execution.
10.0.x to 11.0 Does not require any script execution.