Upgrading from version 9.1.0 with manual migration

The Marketing Platform upgrade installer can perform all of the data migration that is required for an upgrade automatically. However, if the policy of your organization does not allow automatic migration, you must complete the migration procedure to upgrade Marketing Platform manually.

Before you begin

Ensure that you have the following installers in the same directory.

  • The HCL® master installer
  • The Marketing Platform installer

To upgrade to Marketing Platform version 11.0 manually, you must run SQL scripts and run some command line utilities to populate the system tables. Ensure that your installation of Marketing Platform is fully functional so that you can run the utilities. Complete information about using these utilities, including example commands for common tasks, is available in the following topics.

The utilities are in the tools\bin directory under your Marketing Platform installation.

See Marketing Platform upgrade scenarios for information about upgrading from other versions.

Procedure

  1. Create a back-up copy of your Marketing Platform system table database.
    Important: Do not skip this step. If the upgrade operation fails, you cannot roll back your database and your data is corrupted.
  2. Undeploy your Marketing Platform deployment.
  3. Run the HCL® Marketing Software master installer.
    The HCL Marketing Software master installer starts. Use the following instructions after theHCL Marketing Software master installer starts.
    • When the HCL Marketing Software master installer prompts you to choose an installation directory, choose the root installation directory, not the Marketing Platform installation directory that is under this root directory.
    • When the HCL Marketing Software master installer prompts you to enter Marketing Platform database connection information, enter the information that pertains to your current Marketing Platform system tables.

    The HCL Marketing Software master installer pauses and starts the Marketing Platform installer.

  4. Complete the following steps while the Marketing Platform installer is running.
    1. When the Marketing Platform installer prompts you for an installation directory, select the directory of your current Marketing Platform installation, usually named Platform.
    2. Allow the installer to create a back-up copy of your previous installation of Marketing Platform.
    3. Select Manual database setup.
    4. Clear the Run Platform configuration check box.
    5. Follow the remaining steps in the installation wizard and enter the requested information.
  5. Run the following scripts against your system tables, where DB_Type is the database type.
    Table 1. SQL scripts for upgrades from version 9.1.0
    File details File location
    ManagerSchema_DB_Type_911upg.sql db\upgrade91to911 directory under your Marketing Platform installation
    ManagerSchema_DB_Type_10upg.sql db\upgrade912to10 directory under your Marketing Platform installation
    DB_Type_QRTZ_Scheduler_10_upgrade_Script.sql db\upgrade912to10 directory under your Marketing Platform installation
    ManagerSchema_DB_Type_10002upg.sql db\upgrade10001to10002 directory under your Marketing Platform installation
    ManagerSchema_DB_Type_101upg.sql db\upgrade10002to101 directory under your Marketing Platform installation
    ManagerSchema_DB_Type_11upg.sql db\upgrade101to11 directory under your Marketing Platform installation
  6. Use the populateDb utility to populate the system tables with default Marketing Platform configuration properties, users and groups, and security roles and permissions.

    The populateDb utility is in the tools\bin directory under your Marketing Platform installation. Example command: populateDb -n Manager

  7. Use the configTool utility to import configuration properties as described below.
    Important: Perform the imports in the order shown in the following table.
    Table 2. Configuration properties for upgrades from version 9.1.0
    File details Example command
    • File: AuditEvents.xml
    • Location: conf\upgrade91to911 directory under your Marketing Platform installation
    • Purpose: Import the HCL Marketing Platform | Audit Events configuration node
    		 configTool.bat -i -p "Affinium|suite" -f C:\Unica\Platform\conf\upgrade91to911\ AuditEvents.xml
    • File: FederatedAuthentication.xml
    • Location: conf\upgrade91to911 directory under your Marketing Platform installation
    • Purpose: Import the HCL Marketing Platform | Security | Federated Authentication configuration node
    		 configTool.bat -i -p "Affinium|suite|security" -f C:\Unica\Platform\conf\upgrade91to911\ FederatedAuthentication.xml
    • File: MO_bulk_deactivation_scheduler.xml
    • Location: conf\upgrade91to911 directory under your Marketing Platform installation
    • Purpose: Import the configuration node for the bulk deactivation schedule feature for Marketing Operations
    		 configTool.bat -i -p "Affinium|suite|scheduler| taskRegistrations" -f C:\Unica\Platform\conf\upgrade91to911\MO_bulk_deactivation_scheduler.xml
    • File: emm_audit_navigation.xml
    • Location: conf directory under your Marketing Platform installation
    • Purpose: Import the Analytics > Marketing Platform menu item for Audit Event reports
    		 configTool.bat -i -p "Affinium|suite|uiNavigation|mainMenu|Analytics" -f C:\Unica\Platform\conf\emm_audit_navigation.xml
    • File: APISecurity.xml
    • Location: conf\upgrade911to912 directory under your Marketing Platform installation
    • Purpose: Import the HCL Marketing Platform | Security | API management configuration node
    		 configTool.bat -i -p "Affinium|suite|security" -f C:\Unica\Platform\conf\upgrade911to912\APISecurity.xml
    • File: APISecurity.xml
    • Location: conf\upgrade912to10 directory under your Marketing Platform installation
    • Purpose: Import the HCL Marketing Platform | Security | API management configuration node
    		 configTool.bat -vp -p "Affinium|suite|security" -f C:\Unica\Platform\conf\upgrade912to10\APISecurity.xml

    Note that this version of the APISecurity.xml file is different from the one shown in the previous row and is in a different location.
    • File: SAMLAuthentication.xml
    • Location: conf\upgrade912to10 directory under your Marketing Platform installation
    • Purpose: Import the HCL Marketing Platform | Security | SAML2.0 configuration node
    		 configTool.bat -vp -p "Affinium|suite|security" -f C:\Unica\Platform\conf\upgrade912to10\SAMLAuthentication.xml
    • File: SAMLAuthenticationDetails.xml
    • Location: conf\upgrade912to10 directory under your Marketing Platform installation
    • Purpose: Import the HCL Marketing Platform | Security | Login method details | SAML 2.0 configuration nodes
    		 configTool.bat -vp -p "Affinium|suite|security|loginModes" -f C:\Unica\Platform\conf\upgrade912to10\SAMLAuthenticationDetails.xml
    • File: ExternalScheduler.xml
    • Location: conf\upgrade912to10 directory under your Marketing Platform installation
    • Purpose: Import the HCL Marketing Platform | Scheduler | Scheduler registrations | HCL Marketing Platform configuration node
    		 configTool.bat -vp -p "Affinium|suite|scheduler| taskRegistrations" -f C:\Unica\Platform\conf\upgrade912to10\ExternalScheduler.xml
    • File: JWTAuthentication.xml
    • Location: conf\upgrade912to10 directory under your Marketing Platform installation
    • Purpose: Import the HCL Marketing Platform | Security | JWT authentication configuration node
    		 configTool.bat -vp -p "Affinium|suite|security" -f C:\Unica\Platform\conf\upgrade912to10\JWTAuthentication.xml
    • File: SecureSuiteStaticContent.xml
    • Location: conf\upgrade912to10 directory under your Marketing Platform installation
    • Purpose: Import the Apply security on static content for all applications property under the HCL Marketing Platform configuration node
    		 configTool.bat -vp -p "Affinium|suite" -f C:\Unica\Platform\conf\upgrade912to10\SecureSuiteStaticContent.xml
    • File: APISecurity_interactCollection.xml
    • Location: conf\upgrade10to1001 directory under your Marketing Platform installation
    • Purpose: Import the HCL Marketing Platform | Security | API Management | IBM Campaign configuration node
    		 configTool.bat -vp -p "Affinium|suite|security|apiSecurity|campaign" -f <Platform_Home>\conf\upgrade10to1001\APISecurity_interactCollection.xml
    • File: APISecurity_triggeredMessages.xml
    • Location: conf\upgrade10to1001 directory under your Marketing Platform installation
    • Purpose: Import the HCL Marketing Platform | Security | API Management | IBM Campaign configuration node
    		 configTool.bat -vp -p "Affinium|suite|security|apiSecurity|campaign" -f <Platform_Home>\conf\upgrade10to1001\APISecurity_triggeredMessages.xml
    • File: supportServer_config.xml
    • Location: conf\upgrade10to101 directory under your Marketing Platform installation
    • Purpose: Import the HCL Marketing Software configuration nodes
    		 configTool.bat -vp -p "Affinium" -f <Platform_Home>\conf\upgrade10to101\supportServer_config.xml
    • File: cognos11_integration.xml
    • Location: conf\upgrade101to11 directory under your Marketing Platform installation
    • Purpose: Import the Affinium|Report|integrations|cognos11 configuration node
    		 configTool.bat -vp -p "Affinium|Report|integrations" -f <Platform_Home>/conf/upgrade101to11/cognos11_integration.xml
    • File: watsonAssistant_navigation.xml
    • Location: <PLATFORM_HOME>\conf\watsonAssistant_navigation.xml directory under your Marketing Platform installation
    • Purpose: Import the Affinium|suite|uiNavigation|mainMenu|Analytics|Watson Assistantconfiguration node configuration node
    		 configtool.bat -vp -p "Affinium|suite|uiNavigation|mainMenu|Analytics" -f "<PLATFORM_HOME>\conf\watsonAssistant_navigation.xml"
  8. After you have imported the configuration properties in the previous step, restart the web application server on which Marketing Platform is deployed so the changes are applied.
  9. Complete the following steps to update the Help > About page.
    1. Use the configTool utility to export the Affinium | Manager | about category.
      Note: The Affinium | Manager | about category is not visible on the Configuration page because it is marked hidden.
      Example (Windows™):

      configTool.bat -x -p "Affinium|Manager|about" -f "C:\Unica\Platform\conf\about.xml"

    2. Edit the exported XML file that you just created (about.xml in the example) to change the version number and display name.

      Find the releaseNumber property and change the value to the current version of Marketing Platform. Change the value of the copyright property to the appropriate copyright year.

      In the following example, change the release number from 9.1.0.0.0 to 11.0.0.0.0 and change the copyright to 2017.
      <property name="releaseNumber" type="string">
<displayNameKey>about.releaseNumber</displayNameKey>
<value>9.1.0.0.0.build_number</value>
</property>
</property>
<property id="541" name="copyright" type="string_property" width="40">
<value>2016</value>
</property>
    3. Use the configTool utility to import the revised file.

      You must use the -o option to overwrite the node. You must specify the parent node when you import.

      Example (Windows):

      configTool.bat -vp -i -p "Affinium|Manager" -f "C:\Unica\Platform\conf\about.xml" -o

  10. Deploy and verify your installation as described in the Deploying Marketing Platform.