Procedure: Fast upgrade Unica Plan
Plan pre-upgrade
About this task
- Existing customers who want to upgrade to JBOSS + 12.0, must perform the following steps:
- Clear the recent items for all the users. Note: Administrator: Please communicate to all the users to clear their respective recent items prior to the migration to JBOSS.
- Clear the directory <plan_home>/recentdata.
- Migrate to JBOSS + 12.0.
- No change is required to be done by new customers who are installing JBOSS + 12.0. This is because recent items will not be present in their case.
- No change is required to be done by new customers who are installing JBOSS + 12.0. This is because recent items will not be present in their case.
Procedure
- Import the plan system tables backup from the old version to the system tables schema used in a clean 12.0 environment.
-
Take a file system backup of the source and the destination of the following folders:
“Plan_HOME/ accountattachments" directory.
“Plan_HOME/ approvalitems" directory.
“Plan_HOME/ assets" directory.
“Plan_HOME/ componentattachments" directory.
“Plan_HOME/ images" directory.
“Plan_HOME/ invoiceattachments" directory.
“Plan_HOME/ planattachments" directory.
“Plan_HOME/ programattachments" directory.
“Plan_HOME/ projectattachments" directory.
“Plan_HOME/ templates" directory.
- Copy or merge all files mentioned in step 2 in 12.0 from the source folders to the destination Plan respective folders.
- Also copy “Plan_HOME/ conf/ plan_log4j.xml and “Plan_HOME/ conf/ plan_ehcache.xml" in 12.0 environment from source to destination respective folders.
- Rename ext folder to ext_data on the destination server at the <PLAN_HOME>\messages\com\hcl\umo\ path.
- Copy ext folder from source <PLAN_HOME>\messages\com\hcl\umo\ext to <PLAN_HOME>\messages\com\hcl\umo\ext.
- If there are marketing objects in the source setup, copy following files on 12.0 from <Plan_Home>/conf/en_US from source to 12.0. mo_creatives_state.xml globalstates.xml sysmenu.xml sysmodules.xml
-
In Plan_HOME/conf/xx_XX/sysmenu.xml (where xx_XX is the locale) change the
value of
<display>
toPlan
(see the following xml section).<sysmenu> <menugroups> <default-startup-item>projectmanagement</default-startup-item> <menugroup id='projectmanagement'> <display>Plan</display>
-
In
Plan_HOME/conf/resourcebundles/com/unica/manager/configuration/plan*.properties
files, update the value ofMARKETING_OPERATIONS_SETTINGS
toPlan settings
.Note: Ensure that you restart Plan application server and synchronize menus. -
In
Plan_HOME/conf/en_US/sysmodules.xml
(where en_US is the locale), change the value of<display>
toPlan
(see the following xml section).Run the following commands at:
<sysmodules> <section> <module id='analysis'> <display>Plan analytics</display>
-
Perform this step if you have installed Plan and chose manual database.
Ignore this step if you have chosen the automatic database.
-
Ensure that the following JVM parameters are present. If not add
them:
-Dlog4j2.contextSelector=org.apache.logging.log4j.core.async.AsyncLogger
ContextSelector
-Dlog4j2.configurationFile=file:///<Plan_home>\conf\plan_log4j.xml
-Dlog4j.configuration=file:/// <Plan_home>\conf\plan_log4j_1x.xml
Note:- If there is a plan_log4j12.0.xml file apart from the plan_log4j.xml, use the plan_log4j12.0.xml.
- In the
Dlog4j2.configurationFile=file:///<Plan_home>\conf\plan_log4j.xml
setting, if you have customized the plan_log4j.xml and made some changes to suit your organization, then ensure that you make those settings in the plan_log4j.xml specified here as per the Dlog4j2.configurationFile that we have deployed to you now. If you have used the plan_log4j12.0.xml file, make your changes in that file. - In Windows, the file path contains a back slash, whereas, in UNIX, it must contain a forward slash.
Upgrading Unica Plan
Updating JDBC files
About this task
Procedure
-
Take a back up of the jdbc.properties file from the 12.0 environment
(Plan/tools/bin /umo_jdbc.properties). Update the username of the 12.0
Platform system database / schema name in the umo_jdbc.properties
file.
Example of umo_jdbc.properties:
Name: umo_data_source.url
Description: URL reference for the Unica Plan system table database.
Example values for supported databases are:
SQL Server:
jdbc:sqlserver://sqlserverHost:1433;databaseName=databaseName
IBM DB2:
jdbc:db2://db2Host:50000/databaseName
Oracle:
jdbc:oracle:thin:@oracleHost:1521:databaseName
umo_data_source.url=jdbc:oracle:thin:@<databaseHostName>:1521:<sid>
Name: umo_data_source.login
Description: Name of login for Unica Plan database-login account must have database administrative rights.
Name of login for Unica Plan database. login account must have database administrative rights.
umo_data_source.login=xmsp
Name: umo_data_source.password
Description: Password for Unica Plan database for login id provided in umo_data_source.login property
umo_data_source.password=ENC(+1Kd731xEuzqdDfqjQ9wnw==)
Note: If you have used the same user in the Platform and Plan, you can take the encrypted password from the Platform/tools/bin/jdbc.properties file. -
Under Plan_Home/tools/bin, update the setenv.bat
file with the correct DB driver path for the parameter
DBDRIVER_CLASSPATH
.
Upgrade to 12.0 config
About this task
Procedure
-
Add jboss-logging-3.3.2.Final.jar and classmate-1.3.4.jar in CLASSPATH
in setenv . These files are located in
<Platform_HOME>/tools/lib.
For example: You can add like following in the classpath
${TOOLS_LIB}/../../../Platform/tools/lib/jboss-logging-3.3.2.Final.jar:${TOOLS_LIB}/../../../Platform/tools/lib/classmate-1.3.4.jar
- Copy the 8.6 plan_registration.xml file from source to the respective destination UMO_HOME\conf folder. Replace 8.6 with your existing source version.
-
Run the following commands at
Platform_Home/tools/bin:
./configTool.sh -vp -p "Affinium|Plan|umoConfiguration" -f Plan_Home/conf/plan_approvals_settings_10.0.0.2.xml
./configTool.sh -vp -p "Affinium|Plan|umoConfiguration" -f Plan_Home/conf/plan_workflowservice_settings_10.0.0.2.xml
-
Run config_migration.sh in Plan_Home/tools/bin.
Prerequisite: Set or update PLAN_HOME in the
config_migration.sh file.
./config_migration.sh -p Plan_Home -b 8.6.0.0 (Replace 8.6 with your existing source version.)
-
Run the following command to enable encodeCSV feature:
configTool -vp -p "Affinium|Plan|umoConfiguration" -f Plan_Home\conf\Plan_encodeProperty_11.1.xml
Upgrading Plan database
Procedure
Unica Plan post-upgrade
Unica Plan Configuration changes
About this task
About log4j upgrade
Prior to 12.0 log4j1x API was used by Plan source (config file being used for that was plan_log4j.xml).
With 12.0
- log4j2x API is used by Plan source (config file being used for that is plan_log4j.xml for fresh install and plan_log4j.12.0.xml for upgrade).
- log4j1x API is still used by unica_common.jar inside Plan JVM since Platform source (which results in unica_common) has not been changed to use log4j2x.
Hence additionally we also ship plan_log4j_1x.xml which is as per the log4j1x syntax . This file is not used by source code in Unica Plan.
With 12.0, you must not use existing system properties related to log4j1x setting and instead use the new additional system properties.
Procedure
- Log in as an admin user.
-
In (Affinium|Plan|umoConfiguration) update the location for the nodes
lised underneath:
templates
attachmentFolders
integrationServices
- Update notifyPlanBaseURL in Affinium|Plan|umoConfiguration|notifications.
- Update serverURL in Affinium|Plan|navigation.
- If the new application URL is different than the old one, then you must connect to Plan database and access UAP_WS_ALERTS table. Records in this table may contain the pre upgrade application URL. You need to update this table and replace the old application URL by new one.
- Restart the application server.
- Go to Settings -> Plan -> Plan Upgrade.
- Select all the checkboxes.
- Click the “Upgrade" button.
Setting the Plan – Help About > Version
About this task
Procedure
-
Export the version configuration using the following command on clean
12.0 environment.
configTool.sh -x -p "Affinium|Plan|about" -f <PLATFORM_HOME>/conf/plan_about.xml
-
Edit the plan_about.xml file generated by the above command. Change the
version to 12.0.0.0.GA_BUILD".
<property id="xxxxxx" name="releaseNumber" type="string_property" width="40"> <value>12.0.0.0.GA_BUILD</value> </property>
Change display name as below: <property id="3214" name="displayName" type="string_property" width="40"> <value>Unica Plan</value> </property>
-
Import this edited xml file using the following command:
configTool.sh -v -i -o -p "Affinium|Plan" -f <PLATFORM_HOME>/conf/plan _about.xml
Plan Post Upgrade Functional check
About this task
Perform UAT on the plan application. Ensure that all the Plans, Programs, Projects, Tasks, Approvals are opening and that the data is successfully imported. Ensure if all the configurations nodes are available.
Configure BIRT reports with Plan
About this task
Procedure
-
Create an XML file with the following property and name it as
plan_dbtypeProperty_12.0.xml.
<property name="DBType" type="dropdown"> <value predefined="true" selected="true">DB2</value> <value predefined="true" selected="false">INFORMIX</value> <value predefined="true" selected="false">MARIADB</value> <value predefined="true" selected="false">ORACLE</value> <value predefined="true" selected="false">SQLSERVER</value> </property>
-
Set the selected to
true
in the XML created above for the respective database which is being used. -
Run the configtool with the following command to update the property
under the
Affinium|Plan|umoConfiguration
.configTool -vp -p "Affinium|Plan|umoConfiguration" -f Plan_Home/conf/plan_dbtypeProperty_12.0.xml - For Reports pack configurations, see the BIRT Reports Installation and Configuration guide.