Upgrading from version 9.1.0 with manual migration

The Unica 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 Unica Platform manually.

Before you begin

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

  • The Unica master installer
  • The Unica Platform installer

To upgrade to Unica Platform version 12.1.7 manually, you must run SQL scripts and run some command line utilities to populate the system tables. Ensure that your installation of Unica 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 Unica Platform installation.

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

Procedure

  1. Create a back-up copy of your Unica 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 Unica Platform deployment.
  3. Run the Unica master installer.
    The Unica master installer starts. Use the following instructions after theUnica master installer starts.
    • When the Unica master installer prompts you to choose an installation directory, choose the root installation directory, not the Unica Platform installation directory that is under this root directory.
    • When the Unica master installer prompts you to enter Unica Platform database connection information, enter the information that pertains to your current Unica Platform system tables.

    The Unica master installer pauses and starts the Unica Platform installer.

  4. Complete the following steps while the Unica Platform installer is running.
    1. When the Unica Platform installer prompts you for an installation directory, select the directory of your current Unica Platform installation, usually named Platform.
    2. Allow the installer to create a back-up copy of your previous installation of Unica Platform.
    3. If Contact Central is selected in component selection during installation, select database type.
    4. Provide Contact Central database connection details. Notes. By default only automatic database setup will be executed for Control Center.
    5. Select Manual database setup.
    6. Clear the Run Platform configuration check box.
    7. 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 Unica Platform installation
    ManagerSchema_DB_Type_10upg.sql db\upgrade912to10 directory under your Unica Platform installation
    DB_Type_QRTZ_Scheduler_10_upgrade_Script.sql db\upgrade912to10 directory under your Unica Platform installation
    ManagerSchema_DB_Type_10002upg.sql db\upgrade10001to10002 directory under your Unica Platform installation
    ManagerSchema_DB_Type_101upg.sql db\upgrade10002to101 directory under your Unica Platform installation
    ManagerSchema_DB_Type_11upg.sql db\upgrade101to11 directory under your Unica Platform installation
    ManagerSchema_DB_Type_111upg.sql db\upgrade1101to111 directory under your Unica Platform installation
    ManagerSchema_DB_Type_11102upg.sql db\upgrade1111to11102 directory under your Unica Platform installation
    ManagerSchema_DB_Type_12upg.sql db\upgrade1102to12 directory under your Unica Platform installation
    ManagerSchema_DB_Type_121upg.sql db\upgrade12to121 directory under your Unica Platform installation
    ManagerUpdate_12101upg.sql db\upgrade121to12101 directory under your Unica Platform installation
    ManagerUpdate_12103_DB_Type_upg.sql db\upgrade12101to12103 directory under your Unica Platform installation
    ManagerUpdate_12104_DB_Type_upg.sql and DB_Type_QRTZ_Scheduler_12104_upgrade_Script.sql db\upgrade12103to12104 directory under your Unica Platform installation
    ManagerUpdate_1211_DB_Type_upg.sql db\upgrade12104to1211 directory under your Unica Platform installation
    ManagerUpdate_1212_DB_Type_upg.sql and ContentIntegrationUpdate_1212_DB_Type_upg.sql db\upgrade1211to1212directory under your Unica Platform installation
    ManagerUpdate_1213_DB_Type_upg.sql db\upgrade1212to1213directory under your Unica Platform installation
    ManagerUpdate_1214_DB_Type_upg.sql db\upgrade1213to1214directory under your Unica Platform installation
    ManagerSchema_1215_DB_Type_upg.sql db\upgrade1214to1215 directory under your Unica Platform installation
  6. Use the populateDb utility to populate the system tables with default Unica Platform configuration properties, users and groups, and security roles and permissions.

    The populateDb utility is in the tools\bin directory under your Unica 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 Unica Platform installation
    • Purpose: Import the Unica 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 Unica Platform installation
    • Purpose: Import the Unica 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 Unica Platform installation
    • Purpose: Import the configuration node for the bulk deactivation schedule feature for Unica Plan
    		 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 Unica Platform installation
    • Purpose: Import the Analytics > 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 Unica Platform installation
    • Purpose: Import the Unica 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 Unica Platform installation
    • Purpose: Import the Unica 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 Unica Platform installation
    • Purpose: Import the Unica 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 Unica Platform installation
    • Purpose: Import the Unica 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 Unica Platform installation
    • Purpose: Import the Unica Platform | Scheduler | Scheduler registrations | Unica 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 Unica Platform installation
    • Purpose: Import the Unica 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 Unica Platform installation
    • Purpose: Import the Apply security on static content for all applications property under the Unica 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 Unica Platform installation
    • Purpose: Import the Unica Platform | Security | API Management | Unica 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 Unica Platform installation
    • Purpose: Import the Unica Platform | Security | API Management | Unica 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 Unica Platform installation
    • Purpose: Import the HCL Unica 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 Unica 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 Unica 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"
    • File: APISecurity.xml
    • Location: <PLATFORM_HOME>\conf\upgrade12to121
    • Purpose: Import the Unica Platform | Security | API Management | Unica Platform | License node
    		 configTool -vp -p "Affinium|suite|security" -f "<PLATFORM_HOME>\conf\upgrade12to121\APISecurity.xml"
    • APISecurity_Deliver.xml
    • Location: <PLATFORM_HOME>\conf\upgrade12to121
    • Purpose: Import the Unica Platform | Security | API Management | Unica Deliver configuration node
    		configTool.bat -v -i -p "Affinium|suite|security|apiSecurity" -f "<PLATFORM_HOME>\conf\upgrade12to121\APISecurity_Deliver.xml"
    • LicenseDetailsNavigation.xml
    • Location: <PLATFORM_HOME>\conf\upgrade12to121
    • Purpose: Import the License details navigation option under the Settings menu
    		configTool.bat -vp -p "Affinium| suite|uiNavigation|settingsMenu" -f "<PLATFORM_HOME>\conf\upgrade12to121\LicenseDeatilsNavigation.xml"
    • File: APISecurity_GetInstalledApps.xml
    • Location: <PLATFORM_HOME>\conf \upgrade121to12103
    • Purpose: Import new API configuration
    		 configTool.bat -vp -p "Affinium|suite|security|apiSecurity|manager" -f APISecurity_GetInstalledApps.xml
    • File: PlanJourneyIntegrationOption.xml
    • Location: <PLATFORM_HOME>\conf \upgrade121to12103
    • Purpose: Import Plan Journey integration property
    		 configTool.bat -vp -p "Affinium|suite" -f PlanJourneyIntegrationOption.xml
    • File: SiteMinder_AdditionalHeaderVariables.xml
    • Location: <PLATFORM_HOME>\conf \upgrade121to12103
    • Purpose: Import new property to accept additional header variables for Siteminder
    		 configTool.bat -vp -p "Affinium|suite|security|loginModes|siteMinderPartitionLogin" -f SiteMinder_AdditionalHeaderVariables.xml
    • File: PasswordRules.xml
    • Location: <PLATFORM_HOME>\conf \upgrade12103to12104
    • Purpose: Import new password rules
    		 configTool.bat -vp -p "Affinium|Manager" -f PasswordRules.xml
    • File: support_Collaborate.xml
    • Location: <PLATFORM_HOME>\conf \upgrade12103to12104
    • Purpose: Update CollaborateSupportServer property with new value
    		 configTool.bat -i -o -p "Affinium|suite" -f support_Collaborate.xml
    • File: LookerIntegration.xml
    • Location: <PLATFORM_HOME>\conf \upgrade12104to1211
    • Purpose: Import Google Looker integration configuration
    		 configtool.bat -vp -p "Affinium|Report|integrations" -f LookerIntegration.xml
    • File: OpenInsights_navigation.xml
    • Location: <PLATFORM_HOME>\conf \upgrade12104to1211
    • Purpose: Import navigation configuration for Open Insights menu
    		 configtool.bat -vp -p "Affinium|suite|uiNavigation|mainMenu|Analytics" -f OpenInsights_navigation.xml
    • File: OpenInsightsSeparator_navigation.xml
    • Location: <PLATFORM_HOME>\conf \upgrade12104to1211
    • Purpose: Import configuration for adding separator for Open Insights menu
    		 configtool.bat -vp -p "Affinium|suite|uiNavigation|mainMenu|Analytics" -f OpenInsightsSeparator_navigation.xml

    File: Manager_V2_APIs.xml

    Location: <PLATFORM_HOME>\conf\upgrade1213to1214

    Purpose: Import the Manager V2 API configuration

    		 configtool.bat -vp -p "Affinium|suite|security|apiSecurity" -f Manager_V2_APIs.xml

    File: Manager_AddMenuCategory.xml

    Location: <PLATFORM_HOME>\conf\upgrade1213to1214

    Purpose: Add menuCategory hidden property

    		 configtool.bat -vp -p "Affinium|suite|uiNavigation|mainMenu" -f Manager_AddMenuCategory.xml

    File: segmentCentral_scheduler.xml

    Location: <PLATFORM_HOME>\conf\upgrade1214to1215

    Purpose: Register new schedule type

    		 configTool.bat -vp -p "Affinium|suite|scheduler|taskRegistrations" -f segmentCentral_scheduler.xml

    File: whatsNewUrlConfig.xml

    Location: <PLATFORM_HOME>\conf\upgrade1215to1216

    Purpose: Register What’s new functionality URL

    		 configTool.bat -vp -p "Affinium" -f whatsNewUrlConfig.xml

    File name: managerServerURLInternalConfig.xml

    Location:conf\upgrade1216to1217\

    Purpose: Register server URL Internal

    		 configTool.bat -vp -p "Affinium|Manager|navigation" -f managerServerURLInternalConfig.xml
  8. After you have imported the configuration properties in the previous step, restart the web application server on which Unica 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 Unica 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 12.1.7.0.0 and change the copyright to 2023.
      <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. Use the quartzjobtool to update scheduler jobs. This is a required step. If this upgrade tool is not run, any existing scheduled job fails to start. The quartzjobtool is in the tools\bin directory under Unica Platform installation. Run this utility from the tools\bin directory. Example command (Windows): quartzjobtool.bat Example command (Unix): ./quartzjobtool.sh
  11. Deploy and verify your installation as described in the Deploying Unica Platform.