Upgrading from version 8.2.0.7 and 8.2.x versions 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. To upgrade to Marketing Platform version 9.1 manually, you must run specific SQL scripts and insert the required configuration properties.
Ensure that you have the following installers in the same directory:
*
The IBM® master installer
*
The Marketing Platform installer
Also, ensure that your installation of Marketing Platform 8.x is fully functional and you can run the command-line tools. Running the command-line tools requires the use of three Marketing Platform utilities that are in the tools/bin directory under your Marketing Platform installation. Complete information about using these utilities, including example commands for common tasks, is available in the following topics:
*
populateDb
*
configTool
*
alertConfigTool
See Marketing Platform upgrade scenarios for information on upgrading from other versions.
1.
Complete the following steps to upgrade manually from version 8.5.0:
2.
Make a backup of your Marketing Platform system table database.
*
Do not skip this step. If upgrade fails, you will not be able to roll back your database and your data will be corrupted.
3.
Undeploy your current version.
4.
Run the IBM® EMM master installer.
The IBM® EMM master installer starts. Use the following instructions after theIBM® EMM master installer starts:
*
When the IBM® EMM 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 IBM® EMM master installer prompts you to enter Marketing Platform database connection information, enter the information that pertains to your current Marketing Platform system tables.
The IBM® EMM master installer pauses and starts the Marketing Platform installer.
5.
Complete the following steps while the Marketing Platform installer is running:
a.
When the Marketing Platform installer prompts you for an installation directory, select the directory of your current Marketing Platform installation, usually named Platform.
b.
Allow the installer to create a back-up copy of your previous installation of Marketing Platform.
c.
Select Manual database setup.
d.
Clear the Run Platform configuration check box.
e.
Follow the remaining steps in the installation wizard and enter the requested information.
6.
Use the configTool utility to complete the following steps to ensure that the SQL scripts that you run in step 7 work correctly:
a.
Export all your configuration properties from the Affinium root node. For example, in Windows™, use the following command to export the properties to the config_property_export.xml file, which is written to the install directory under your Marketing Platform installation:
configTool.bat -x -p "Affinium" -f "C:\Unica\Platform\install\ config_property_export.xml"
b.
Delete all configuration properties from the Affinium root node. For example, in Windows™, use the following command to delete the properties:
configTool.bat -d -o -p "Affinium"
c.
Import the configuration properties that you exported. For example, in Windows™, use the following command to import the properties from the config_property_export.xml file, which is in the installation directory under your Marketing Platform installation:
configTool.bat -i -o -f "C:\Unica\Platform\install\ config_property_export.xml"
7.
In the db\upgrade82to85 directory under your Marketing Platform installation, edit the ManagerSchema_DB_Type_86upg.sql SQL script, where DB_Type is the database type of your system tables database. Use the following guidelines to edit the ManagerSchema_DB_Type_86upg.sql SQL script:
*
For all database types, remove the following statement:
ALTER TABLE USCH_RUN ADD PAYLOAD NVARCHAR(4000);
*
If your database is DB2®, also remove the following statements:
ALTER TABLE qrtz_job_details ALTER COLUMN job_data SET DATA TYPE blob(4000);
ALTER TABLE qrtz_triggers ALTER COLUMN job_data SET DATA TYPE blob(4000);
8.
Use the following table to locate the SQL scripts that are provided with your new Marketing Platform installation against your Marketing Platform system table database:
Scripts for upgrading from version 8.2.0.7 or a later 8.2.x version
Script Name
Location
ManagerSchema_DB_Type_85upg.sql
where DB_Type is the database type of your system tables database.
db\upgrade8207xto85
insert_new_85_locales.sql
db\upgrade82to85
ManagerSchema_DB_Type_86upg.sql
where DB_Type is the database type of your system tables database.
db\upgrade85to86
insert_new_8601_locales.sql
db\upgrade86to8601
active_portlets.sql
db
ManagerSchema_DB_Type_90upg.sql
where DB_Type is the database type of your system tables database.
db\upgrade86to90
ManagerSchema_DB_Type_91upg.sql
or
ManagerSchema_DB_Type_91upg_unicode.sql
where DB_Type is the database type of your system tables database.
db\upgrade90to91
9.
Run one of the following commands:
*
For Windows™:
installation_directory\platform\tools\bin\upgrade90to91.bat
*
For Unix:
installation_directoryplatform/tools/bin/upgrade90to91.sh
10.
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: populateDb -n Manager
11.
Use the configTool utility to import configuration properties as described in the following table:
*
The configTool utility is in the tools/bin directory under your Marketing Platform installation. For complete details on the function of the configuration properties, see the online help for the Configuration page, or the IBM® Marketing Platform Administrator's Guide
The example commands in the following table are for the Windows™ operating system.
Files for upgrading from version 8.2.0.7 or a later 8.2.x version
File details
Example command
Skip this import if the property named LDAP BaseDN periodic search enabled is present under the Platform | Security | Login method details | LDAP synchronization category. This is the property you checked for in step 1 of this procedure.
If the property is not present, perform the following import.
*
File: Ldap_Auto_Sync_BaseDN_Settings.xml
*
Location: conf\upgrade86to90 directory under your Marketing Platform installation
*
Purpose: Import a configuration property that enables LDAP import search by DN
configTool.bat -i -p "Affinium|suite|security|ldapSynchronization|ldapProperties" -f "C:\Unica\Platform\conf\upgrade86to90\Ldap_Auto_Sync_BaseDN_Settings.xml"
*
File: interaction_history_scheduler.xml
*
Location: conf/upgrade85to86rectory under your Marketing Platform installation
*
Purpose: Import the scheduler configuration properties required for Interaction History
configTool.bat -i -p "Affinium|suite|scheduler|taskRegistrations" -f "C:\Unica\Platform\conf\upgrade85to86\interaction_history_scheduler.xml"
*
File: attribution_modeler_scheduler.xml
*
Location: conf/upgrade85to86 directory under your Marketing Platform installation
*
Purpose: Import the scheduler configuration properties required for Attribution Modeler
configTool.bat -i -p "Affinium|suite|scheduler|taskRegistrations" -f "C:\Unica\Platform\conf\upgrade85to86\attribution_modeler_scheduler.xml"
*
Files: coremetrics_configuration.xml and coremetrics_navigation.xml
*
Location: conf directory under your Marketing Platform installation
*
Purpose: Import the configuration properties required for single sign-on with IBM® Digital Analytics
configTool.bat -i -p "Affinium" -f "C:\Unica\Platform\conf\coremetrics_configuration.xml"
configTool.bat -i -p "Affinium|suite|uiNavigation|mainMenu|Analytics" -f "C:\Unica\Platform\conf\coremetrics_navigation.xml"
*
File: cognos10_integration.xml
*
Location: conf/upgrade85to86 directory under your Marketing Platform installation
*
Purpose: Import the configuration properties required for reporting
configTool.bat -i -p "Affinium|Report|integrations" -f "C:\Unica\Platform\conf\upgrade85to86\cognos10_integration.xml"
*
File: No file - removing properties
*
Purpose: Remove JMS configuration properties that are no longer used
configTool.bat -d -o -p "Affinium|suite|jmsServer"
configTool.bat -d -o -p "Affinium|suite|jmsPort"
*
File: LDAP_Anonymous_bind.xml
*
Location: conf/upgrade85to86 directory under your Marketing Platform installation
*
Purpose: Only if you are upgrading from version 8.2.0 or later, import a new LDAP configuration property
configTool -i -p "Affinium|suite|security|loginModes|LDAPPartitionLogin" -f C:\Unica\Platform\conf\upgrade85to86\LDAP_Anonymous_bind.xml
*
File: quicklinks_category.xml
*
Location: conf\upgrade86to90 directory under your Marketing Platform installation
*
Purpose: Import properties for quicklinks dashboard portlets
configTool.bat -i -o -p "Affinium|suite" -f "C:\Unica\Platform\conf\upgrade86to90\quicklinks_category.xml"
*
File: manager_alerts_registration.xml
*
Location: conf directory under your Marketing Platform installation
*
Purpose: Import configuration properties that create the alerts menu items
configTool.bat -i -o -p "Affinium|suite|uiNavigation|alerts -f "C:\Unica\Platform\conf\manager_alerts_registration.xml"
*
File: disablePageTagging.xml
*
Location: conf\upgrade82to85 directory under your Marketing Platform installation
*
Purpose: Import a configuration property that determines whether IBM® can gather basic statistics that track overall product usage trends.
configTool.bat -i -o -p "Affinium|suite" -f "C:\Unica\Platform\conf\upgrade82to85\disablePageTagging.xml"
*
Files: coremetrics_configuration.xml and coremetrics_navigation.xml
*
Location: conf directory under your Marketing Platform installation
*
Purpose: Import the configuration properties required for single sign-on with IBM® Digital Analytics
configTool.bat -i -o -p "Affinium" -f "C:\Unica\Platform\conf\coremetrics_configuration.xml"
configTool.bat -i -o -p "Affinium|suite|uiNavigation|mainMenu|Analytics" -f "C:\Unica\Platform\conf\coremetrics_navigation.xml"
*
File: scheduler.xml
*
Location: db\upgrade90to91 directory under your Marketing Platform installation
*
Purpose: The boolean property to enable or disable the scheduler feature in Marketing Platform
configtool -i -p "Affinium|suite|scheduler" -f "C:\Unica\Platform\conf\upgrade90to91\scheduler.xml"
*
File: unknownPolling.xml
*
Location: db\upgrade90to91 directory under your Marketing Platform installation
*
Purpose: Imports properties for quicklinks dashboard portlets
configtool -i -p "Affinium|suite|scheduler" -f "C:\Unica\Platform\conf\upgrade90to91\unknownPolling.xml"
*
File: communication_email.xml
*
Location: conf\upgrade86to90 directory under your Marketing Platform installation
*
Purpose: Imports configuration properties to enable email notifications. When enabled Marketing Platform attempts to send emails to users for system alerts and notifications.
configTool.bat -i -o -p "Affinium|Manager" -f "C:\Unica\Platform\conf\upgrade86to90\communication_email.xml"
*
File: notification.xml
*
Location: conf\upgrade86to90 directory under your Marketing Platform installation
*
Purpose: Imports configuration properties for the notification feature. The following properties are added:
*
The number of days to retain alerts - 90
*
Frequency in minutes at which emails are sent - 30
*
Maximum number of retries for sending and email - 1
configTool.bat -i -o -p "Affinium|suite" -f "C:\Unica\Platform\conf\upgrade86to90\notification.xml"
*
File: is_clustered.xml
*
Location: conf\upgrade86to90 directory under your Marketing Platform installation
*
Purpose: The boolean property to specify if the Marketing Platform instance is clustered. If you install Marketing Platform in a clustered deployment, set this property to True. Otherwise, retain the default value of False.
configtool -i -p "Affinium|suite" -f "C:\Unica\Platform\conf\upgrade90to91\is_clustered.xml"
*
File: taskNotification.xml
*
Location: conf\upgrade86to90 directory under your Marketing Platform installation
*
Purpose: Imports the Group Name field where you can enter the groups that are notified with scheduled notifications.
configtool -i -p "Affinium|suite|scheduler|taskRegistrations|Campaign|flowchart" -f "C:\Unica\Platform\conf\upgrade90to91\taskNotification.xml"
configtool -i -p "Affinium|suite|scheduler|taskRegistrations|Campaign|mailing" -f "C:\Unica\Platform\conf\upgrade90to91\taskNotification.xml"
configtool -i -p "Affinium|suite|scheduler|taskRegistrations|Campaign|optimize" -f "C:\Unica\Platform\conf\upgrade90to91\taskNotification.xml"
configtool -i -p "Affinium|suite|scheduler|taskRegistrations|InteractionHistory|ETL" -f "C:\Unica\Platform\conf\upgrade90to91\taskNotification.xml"
configtool -i -p "Affinium|suite|scheduler|taskRegistrations|AttributionModeler|TrainingRun" -f "C:\Unica\Platform\conf\upgrade90to91\taskNotification.xml"
configtool -i -p "Affinium|suite|scheduler|taskRegistrations|AttributionModeler|ScoringRun" -f "C:\Unica\Platform\conf\upgrade90to91\taskNotification.xml"
*
File: config_data_filter_cache.xml
*
Location: conf\upgrade90to91 directory under your Marketing Platform installation
*
Purpose: Allows you to configure the data filter cache. If the configuration property is set to True, the data filter cache is enabled for enhanced performance. If the configuration property is set to False, the caching is not enabled, and all operations are completed by connecting to the database for each data filter request. The configuration property is visible on the user interface.
configTool.bat -vp -p "Affinium|Manager|datafiltering" -f "C:\Unica\Platform\conf\upgrade90to91\Config_data_filter_cache.xml"
*
If you change this value, you must restart the Marketing Platform for the changes to take effect.
*
File: Refresh_data_filter_cache.xml
*
Location: conf\upgrade90to91 directory under your Marketing Platform installation
*
Purpose: If data filter caching is enabled, this configuration property ensures that the cache is refreshed every time that there is a change in the data filter definitions.
configTool.bat -vp -p "Affinium|Manager|datafiltering" -f "C:\Unica\Platform\conf\upgrade90to91\Refresh_data_filter_cache.xml"
*
Files: navigation.xml and emm_spss_configuration.xml
*
Location: conf\upgrade90to91
*
Purpose: Import IBM® SPSS® Modeler Advantage Marketing Edition configuration properties.
configTool -i -o -p "Affinium|suite|uiNavigation|mainMenu|Analytics" -f "C:\Unica\Platform\conf\emm_spss_navigation.xml"
configTool -i -o -p "Affinium" -f "C:\Unica\Platform\conf\emm_spss_configuration.xml"
12.
Run the alertConfigTool utility from the tools\bin directory under your Marketing Platform installation to register the Marketing Platform alerts and notifications.
Example command (Windows™):
alertConfigTool.bat -i -f "C:\Platform\conf\Platform_alerts_configuration.xml"
13.
Run the upgrade85Dashboard script from the tools\bin directory under your Marketing Platform installation to upgrade the dashboard.
14.
Go to Help > About and complete the following steps to update the About page:
a.
Use the configTool utility to export the Affinium | Manager | about category.
*
The Affinium | Manager | about 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"
b.
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.
In the following example, change 8.0.0 to your new version:
<property name="releaseNumber" type="string">
<displayNameKey>about.releaseNumber</displayNameKey>
<value>9.1.0.0.0.build_number</value>
</property>
c.
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 -i -p "Affinium|Manager" -f "about.xml" -o
15.
Deploy and verify your installation as described in the Deploying Marketing Platform chapter.
After the upgrade process is successful and the application is up and running, delete the liferay tables by using the drop-liferay-tables.sql script. The drop-liferay-tables.sql is located in the Platform_installation/db/upgrade86to90/drop-liferay-tables.sql directory.
See the IBM® EMM Reports Installation and Configuration Guide for the additional steps that are required for reporting upgrades.
Copyright IBM Corporation 2014. All Rights Reserved.