IBM Marketing Platform Installation Guide

Version 10 Release 0
February 2017
IBM Marketing Platform Installation
Guide
IBM
Note
Before using this information and the product it supports, read the information in “Notices” on page 69.
This edition applies to version 10, release 0, modification 0 of IBM Marketing Platform and to all subsequent
releases and modifications until otherwise indicated in new editions.
© Copyright IBM Corporation 1999, 2017.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Chapter 1. Installation overview . . . . 1
Installation roadmap. . . . . . .
How the installers work . . . . .
Modes of installation . . . . . .
Marketing Platform documentation and
. .
. .
. .
help
.
.
.
.
.
.
.
.
.
.
.
.
1
3
3
4
Chapter 2. Planning the Marketing
Platform installation . . . . . . . . . 5
Prerequisites . . . . . . . . . . . .
Marketing Platform installation worksheet . .
Installation order for IBM Marketing Software
products . . . . . . . . . . . . . .
.
.
. 5
. 7
.
. 8
Chapter 3. Creating the Marketing
Platform data sources . . . . . . . . 11
Creating the JDBC connection in the web
application server . . . . . . . . . . .
Configuring the web application server for your
JDBC driver . . . . . . . . . . . . .
Information for creating JDBC connections . .
. 12
. 12
. 13
Chapter 4. Installing Marketing Platform 17
Installing Marketing Platform using the GUI mode
Creating an EAR file after running the installer
Installing Marketing Platform using the console
mode . . . . . . . . . . . . . . .
Installing Marketing Platform silently . . . .
Sample response files . . . . . . . . .
Marketing Platform components . . . . . .
Creating and populating the Marketing Platform
system tables manually . . . . . . . . .
17
22
.
.
.
.
23
24
25
26
. 26
Chapter 5. Deploying Marketing
Platform . . . . . . . . . . . . . . 29
Guidelines for deploying Marketing Platform on
WebLogic . . . . . . . . . . . . . .
Guidelines for deploying Marketing Platform on
WebSphere . . . . . . . . . . . . .
Verifying your Marketing Platform installation .
. 29
. 30
. 31
Chapter 6. Configuring Marketing
Platform after deployment . . . . . . 33
Default password settings . . . . . . . .
Set the web application session timeout (optional)
Additional configuration for enhanced security .
Disabling the X-Powered-By flag . . . . .
Configuring a restrictive cookie path . . . .
Disabling caching of Campaign and Marketing
Platform configuration property values . . . .
. 33
33
. 34
. 34
. 34
. 35
Chapter 7. Installing Marketing Platform
in a cluster . . . . . . . . . . . . . 37
Creating a WebSphere profile for the primary node
of a cluster . . . . . . . . . . . . . .
Creating profiles for additional nodes . . . . .
Adding existing nodes to the cluster nodes . . . .
Creating a WebSphere cluster . . . . . . . .
Creating the web server in the cluster . . . . .
Starting the nodes, web server, and cluster . . . .
Creating JDBC providers in a cluster . . . . . .
Installing IBM Marketing Software products in a
cluster . . . . . . . . . . . . . . . .
Configuring the IBM HTTP Server as a load
balancer . . . . . . . . . . . . . . .
Configure property to control the Scheduler in a
clustered environment . . . . . . . . . . .
Configuring Marketing Platform logs in a cluster . .
Sharing the location where Marketing Platform is
installed . . . . . . . . . . . . . .
Setting Marketing Platform home in a Java
parameter . . . . . . . . . . . . . .
Enabling single-user logging. . . . . . . .
Chapter 8. Marketing Platform utilities
Setting up Marketing Platform
machines . . . . . . .
Marketing Platform utilities .
alertConfigTool . . . .
configTool . . . . . .
datafilteringScriptTool . .
encryptPasswords . . .
partitionTool . . . . .
populateDb . . . . .
restoreAccess . . . . .
scheduler_console_client .
utilities
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
. . .
on
.
.
.
.
.
.
.
.
.
.
40
40
41
41
41
42
42
45
additional
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
. . . .
47
47
47
48
52
53
54
56
57
59
Chapter 9. Marketing Platform SQL
scripts . . . . . . . . . . . . . . . 61
ManagerSchema_DeleteAll.sql . . .
ManagerSchema_PurgeDataFiltering.sql
SQL scripts for creating system tables
ManagerSchema_DropAll.sql . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
61
61
62
63
Chapter 10. Uninstalling Marketing
Platform . . . . . . . . . . . . . . 65
Before you contact IBM technical
support . . . . . . . . . . . . . . 67
Notices . . . . . . . . . . . . . . 69
Trademarks . . . . . . . . . . . . .
Privacy Policy and Terms of Use Considerations .
© Copyright IBM Corp. 1999, 2017
37
38
38
38
39
39
40
. 71
. 71
iii
iv
IBM Marketing Platform Installation Guide
Chapter 1. Installation overview
An installation of Marketing Platform is complete when you install, configure, and
deploy Marketing Platform. The Marketing Platform Installation Guide provides
detailed information about installing, configuring, and deploying Marketing
Platform.
Use the Installation Roadmap section to obtain a broad understanding about using
the Marketing Platform Installation Guide.
Installation roadmap
Use the installation roadmap to quickly find the information that you need for
installing Marketing Platform.
You can use Table 1 to scan the tasks that must be completed for installing
Marketing Platform. The Information column in the following table provides links
to the topics that describe the tasks for installing Marketing Platform:
Table 1. Marketing Platform installation roadmap
Topic
Information
Chapter 1, “Installation overview”
This chapter provides the following
information:
v “How the installers work” on page 3
v “Modes of installation” on page 3
v “Marketing Platform documentation and
help” on page 4
Chapter 2, “Planning the Marketing Platform This topic provides the following
installation,” on page 5
information:
v “Prerequisites” on page 5
v “Marketing Platform installation
worksheet” on page 7
v “Installation order for IBM Marketing
Software products” on page 8
Chapter 3, “Creating the Marketing Platform This topic provides the following
data sources,” on page 11
information:
v “Creating the JDBC connection in the web
application server” on page 12
v “Configuring the web application server
for your JDBC driver” on page 12
© Copyright IBM Corp. 1999, 2017
1
Table 1. Marketing Platform installation roadmap (continued)
Topic
Information
Chapter 4, “Installing Marketing Platform,”
on page 17
This topic provides the following
information:
v “Installing Marketing Platform using the
GUI mode” on page 17
v “Installing Marketing Platform using the
console mode” on page 23
v “Installing Marketing Platform silently”
on page 24
v “Marketing Platform components” on
page 26
v “Creating and populating the Marketing
Platform system tables manually” on page
26
Chapter 5, “Deploying Marketing Platform,”
on page 29
This topic provides the following
information:
v “Guidelines for deploying Marketing
Platform on WebLogic” on page 29
v “Guidelines for deploying Marketing
Platform on WebSphere” on page 30
v “Verifying your Marketing Platform
installation” on page 31
Chapter 6, “Configuring Marketing Platform
after deployment,” on page 33
This topic provides the following
information:
v “Default password settings” on page 33
Chapter 8, “Marketing Platform utilities,” on This topic provides the following
page 45
information:
v “Setting up Marketing Platform utilities
on additional machines” on page 47
v “alertConfigTool” on page 47
v “configTool” on page 48
v “datafilteringScriptTool” on page 52
v “encryptPasswords” on page 53
v “partitionTool” on page 54
v “populateDb” on page 56
v “restoreAccess” on page 57
v “scheduler_console_client” on page 59
Chapter 9, “Marketing Platform SQL
scripts,” on page 61
This topic provides the following
information:
v “ManagerSchema_DeleteAll.sql” on page
61
v “ManagerSchema_PurgeDataFiltering.sql”
on page 61
v “SQL scripts for creating system tables”
on page 62
v “ManagerSchema_DropAll.sql” on page
63.
Chapter 10, “Uninstalling Marketing
Platform,” on page 65
2
IBM Marketing Platform Installation Guide
This topic provides information about how
to uninstall Marketing Platform.
How the installers work
You must use the suite installer and the product installer when you install or
upgrade any IBM® Marketing Software product. For example, for installing
Marketing Platform, you must use the IBM Marketing Software suite installer and
the IBM Marketing Platform installer.
Make sure that you use the following guidelines before you use the IBM Marketing
Software suite installer and the product installer:
v The suite installer and the product installer must be in the same directory on the
computer where you want to install the product. When multiple versions of a
product installer are present in the directory with the master installer, the master
installer always shows the latest version of the product on the IBM Marketing
Software Products screen in the installation wizard.
v If you are planning to install a patch immediately after you install an IBM
Marketing Software product, make sure that the patch installer is in the same
directory as that of the suite and product installers.
v The default top-level directory for IBM Marketing Software installations is
/IBM/IMS for UNIX or C:\IBM\IMS for Windows. However, you can change the
directory during installation.
Modes of installation
The IBM Marketing Software suite installer can run in one of the following modes:
GUI mode, console mode, or silent mode (also called the unattended mode). Select
a mode that suits your requirements when you install Marketing Platform.
For upgrades, you use the installer to perform many of the same tasks that you
perform during the initial installation.
GUI mode
Use the GUI mode for Windows or the X Window System mode for UNIX to
install Marketing Platform by using the graphical user interface.
Console mode
Use the console mode to install Marketing Platform by using the command line
window.
Note: To display the Installer screens correctly in console mode, configure your
terminal software to support UTF-8 character encoding. Other character encoding,
such as ANSI, will not render the text correctly, and some information will not be
readable.
Silent mode
Use the silent or unattended mode to install Marketing Platform multiple times.
The silent mode uses response files for installation, and does not require user input
during the installation process.
Note: Silent mode is not supported for upgrade installations in clustered web
application or clustered listener environments.
Chapter 1. Installation overview
3
Marketing Platform documentation and help
IBM Marketing Platform provides documentation and help for users,
administrators, and developers.
Table 2. Get up and running
Task
Documentation
View a list of new features, known issues, and
workarounds
IBM Marketing Platform Release Notes
Learn about the structure of the Marketing Platform
database
IBM Marketing Platform System Tables
Install or upgrade Marketing Platform and deploy the
Marketing Platform web application
One of the following guides:
v IBM Marketing Platform Installation Guide
v IBM Marketing Platform Upgrade Guide
®
Implement the IBM Cognos reports provided with IBM
Marketing Software
IBM Marketing Software Reports Installation and
Configuration Guide
Table 3. Configure and use Marketing Platform
Task
Documentation
v Adjust configuration and security settings for IBM
products
IBM Marketing Platform Administrator's Guide
v Integrate with external systems such as LDAP and
web access control
v Implement single sign-on with diverse applications
using SAML 2.0-based federated authentication or
single sign-on
v Run utilities to perform maintenance on IBM products
v Configure and use audit event tracking
v Schedule runs of IBM Marketing Software objects
Table 4. Get help
Task
Instructions
Open online help
1. To open a context-sensitive help topic, choose Help > Help for this page.
2. To view complete online help, choose Help > Product documentation and click the
IBM Marketing Platform in Knowledge Center link.
You must have web access to view context-sensitive online help. Contact IBM Support
for more information about accessing and installing IBM Knowledge Center locally for
offline documentation.
Obtain PDFs
Use either of the following methods:
v Choose Help > Product documentation to access Marketing Platform PDFs and
help.
v Choose Help > All IBM Marketing Software Documentation to access
documentation for all products.
Get support
4
Go to http://www.ibm.com/support to access the IBM Support Portal.
IBM Marketing Platform Installation Guide
Chapter 2. Planning the Marketing Platform installation
When you plan your Marketing Platform installation, you must ensure that you
have set up your system correctly, and that you have configured your environment
to deal with any failures.
Prerequisites
Before you install or upgrade any IBM Marketing Software product, you must
ensure that your computer complies with all of the prerequisite software and
hardware.
System requirements
For information about system requirements, see the Recommended Software
Environments and Minimum System Requirements guide.
In order for Opportunity Detect to connect to the DB2 database, the DB2
installation must include the install header files in the /home/db2inst1/include
directory on client machine. To include the header files in the installation, select
the Custom Install option when you install DB2 and select the Base Application
Development Tools feature.
DB2 requirements
In order for Opportunity Detect to connect to the DB2 database, the DB2
installation must include the install header files in the home/db2inst1/include
directory on client machine. To include the header files in the installation, select
the Custom Install option when you install DB2 and select the Base Application
Development Tools feature.
Network domain requirements
The IBM Marketing Software products that are installed as a suite must be
installed on the same network domain to comply with the browser restrictions that
are designed to limit the security risks that can occur with cross-site scripting.
JVM requirements
IBM Marketing Software applications within a suite must be deployed on a
dedicated Java™ virtual machine (JVM). IBM Marketing Software products
customize the JVM that is used by the web application server. If you encounter
errors that are related to the JVM, you must create an Oracle WebLogic or
WebSphere® domain that is dedicated to the IBM Marketing Software products.
Knowledge requirements
To install IBM Marketing Software products, you must have a thorough knowledge
of the environment in which the products are installed. This knowledge includes
knowledge about operating systems, databases, and web application servers.
© Copyright IBM Corp. 1999, 2017
5
Internet browser settings
Make sure that your internet browser complies with the following settings:
v The browser must not cache web pages.
v The browser must not block pop-up windows.
Access permissions
Verify that you have the following network permissions to complete the
installation tasks:
v Administration access for all necessary databases
v Read and write access to the relevant directory and subdirectories for the
operating system account that you use to run the web application server and
IBM Marketing Software components
v Write permission for all files that you must edit
v Write permission for all directories where you must save a file, such as the
installation directory and backup directory if you are upgrading
v Appropriate read, write, and execute permissions to run the installer
Verify that you have the administrative password for your web application server.
For UNIX, all installer files for IBM products must have full permissions, for
example, rwxr-xr-x.
JAVA_HOME environment variable
If a JAVA_HOME environment variable is defined on the computer where you install
an IBM Marketing Software product, verify that the variable points to a supported
version of JRE. For information about system requirements, see the IBM Marketing
Software Recommended Software Environments and Minimum System Requirements
guide.
If the JAVA_HOME environment variable points to an incorrect JRE, you must clear
the JAVA_HOME variable before you run the IBM Marketing Software installers.
You can clear the JAVA_HOME environment variable by using one of the following
methods:
v Windows: In a command window, enter set JAVA_HOME= (leave empty) and
press Enter.
v UNIX: In the terminal, enter export JAVA_HOME=(leave empty) and press Enter.
The IBM Marketing Software installer installs a JRE in the top-level directory for
the IBM Marketing Software installation. Individual IBM Marketing Software
application installers do not install a JRE. Instead, they point to the location of the
JRE that is installed by the IBM Marketing Software installer. You can reset the
environment variable after all installations are complete.
For more information about the supported JRE, see the IBM Marketing Software
Recommended Software Environments and Minimum System Requirements guide.
6
IBM Marketing Platform Installation Guide
Marketing Platform installation worksheet
Use the Marketing Platform installation worksheet to gather information about the
Marketing Platform database and about other IBM Marketing Software products
that are required for the installation of Marketing Platform.
Use the following table to gather information about the database that contains your
Marketing Platform system tables:
Table 5. Information about the database
Field
Notes®
Database type
Database name
Database account user name
Database account password
JNDI name
UnicaPlatformDS
ODBC name
Checklist for Marketing Platform database
The installation wizards for each IBM Marketing Software product must be able to
communicate with the Marketing Platform system table database to register the
product. Each time that you run the installer, you must enter the following
database connection information for the Marketing Platform system table database:
v Database type
v JDBC connection URL
v Database host name
v Database port
v Database name or schema ID
v User name and password for the database account
Checklist for IBM Marketing Platform deployment on the web
application server
Obtain the following information before deploying Marketing Platform:
v Protocol: HTTP or HTTPS if SSL is implemented in the web application server.
v Host: The name of the machine on which the Marketing Platform will be
deployed.
v Port: The port on which the web application server listens.
v
Domain name: The company domain of each machine where IBM products are
installed. For example, mycompany.com. All IBM products must be installed in the
same company domain, and you must enter the domain name in all lower-case
letters.
If there is a mis-match in domain name entries, you may encounter problems
when you attempt to use Marketing Platform features or navigate among
products. You can change the domain name after the products are deployed by
logging in and changing values of the relevant configuration properties in the
product navigation categories on the Settings > Configuration page.
Chapter 2. Planning the Marketing Platform installation
7
Checklist for enabling Marketing Platform utilities
If you plan to use the Marketing Platform utilities, obtain the following JDBC
connection information before you start to install the Marketing Platform.
v Path to the JRE. The default value is the path to the 1.7 version of the JRE that
the installer places under your IBM installation directory.
You can accept this default or specify a different path. If you specify a different
path, you must point to the 1.7 version of the Sun JRE.
v JDBC driver class. The installer automatically provides this, based on the
database type you specifiy in the installer.
v JDBC connection URL. The installer provides the basic syntax, including the host
name, database name, and port. You can customize the URL by adding
additional parameters.
v JDBC driver classpath on your system.
Information about the web component
Obtain the following information for all IBM Marketing Software products that
have a web component, which you deploy on a web application server:
v The name of the systems on which the web application servers are installed. You
can have one or several web application servers, depending on the IBM
Marketing Software environment that you are setting up.
v The port on which the application server listens. If you plan to implement SSL,
obtain the SSL port.
v The network domain for your deployment system. For example,
mycompany.com.
IBM Site ID
If you are installing an IBM Marketing Software product in one of the countries
listed on the Country for Install screen of your product installer, you must enter
your IBM Site ID in the space provided. Your IBM Site ID can be found on one of
the following documents:
v IBM Welcome letter
v Tech Support Welcome letter
v Proof of Entitlement letter
v Other communications that are sent when you purchase your software
IBM might use the data that is provided by the installed software to better
understand how customers use our products and to improve customer support.
The data that is gathered does not include any information that identifies
individuals. Complete the following actions if you do not want to have such
information to be collected:
1. After Marketing Platform is installed, log on to Marketing Platform as a user
with administration privileges.
2. Go to Settings > Configuration, and set the Disable Page Tagging property
under the Platform category to True.
Installation order for IBM Marketing Software products
When you install or upgrade multiple IBM Marketing Software products, you must
install them in a specific order.
8
IBM Marketing Platform Installation Guide
The following table provides information about the order that you must follow
when you install or upgrade multiple IBM Marketing Software products.
Table 6. Installation or upgrade order for IBM Marketing Software products
For this product or combination:
Install or upgrade in this order:
Campaign (with or without
eMessage)
1. Marketing Platform
2. Campaign
Note: eMessage is installed automatically when you install Campaign.
However, eMessage is not configured or enabled during the Campaign
installation process.
Interact
1. Marketing Platform
2. Campaign
3. Interact Design Time environment
4. Interact Run Time environment
5. Interact Extreme Scale Server
If you want to install or upgrade the Interact design time environment only,
then install or upgrade the Interact design time environment in the following
order:
1. Marketing Platform
2. Campaign
3. Interact Design Time environment
If you want to install or upgrade the Interact runtime environment only, then
install or upgrade the Interact runtime environment in the following order:
1. Marketing Platform
2. Interact Run Time environment
If you want to install the Interact Extreme Scale Server only, then install the
Interact Extreme Scale Server in the following order:
1. Marketing Platform
2. Interact Run Time environment
3. Interact Extreme Scale Server
Marketing Operations
1. Marketing Platform
2. Marketing Operations
Note: If you are integrating Marketing Operations with Campaign, you must
also install Campaign. The order of installation for those two products does
not matter.
Distributed Marketing
1. Marketing Platform
2. Campaign
3. Distributed Marketing
Contact Optimization
1. Marketing Platform
2. Campaign
3. Contact Optimization
Opportunity Detect
1. Marketing Platform
2. Opportunity Detect
Chapter 2. Planning the Marketing Platform installation
9
Table 6. Installation or upgrade order for IBM Marketing Software products (continued)
For this product or combination:
Install or upgrade in this order:
Interact Advanced Patterns
1. Marketing Platform
2. Campaign
3. Interact
4. Interact Advanced Patterns
®
IBM SPSS Modeler Advantage
Enterprise Marketing Management
Edition
10
1. IBM SPSS Modeler Advantage Enterprise Marketing Management Edition
IBM Marketing Platform Installation Guide
Chapter 3. Creating the Marketing Platform data sources
You must create Marketing Platform data sources before you can install Marketing
Platform.
Procedure
Complete the following steps to prepare the data sources for Marketing Platform:
1. Create a database or a database schema for the Marketing Platform system
tables. The following table provides information about vendor-specific
guidelines for creating a database or a database schema for the Marketing
Platform system tables.
Table 7. Guidelines for creating data sources
Database vendor
Guideline
Oracle
Enable the auto commit feature for the
environment open. See the Oracle
documentation for instructions.
DB2®
Set the database page size to at least 16k
(32k if you need to support Unicode). See
the DB2 documentation for instructions.
SQL Server
Use either SQL Server authentication only, or
both SQL Server and Windows
authentication, because the Marketing
Platform requires SQL Server authentication.
If necessary, change the database
configuration so that your database
authentication includes SQL Server. Also be
sure that TCP/IP is enabled in your SQL
Server.
Note: If you plan to enable locales that use multi-byte characters (for example,
Chinese, Korean, and Japanese), ensure that the database is created to support
them.
2. Create a system user account. The system user account must have the following
rights:
v CREATE TABLES
v CREATE VIEWS (for reporting)
v CREATE SEQUENCE (Oracle only)
v CREATE INDICES
v ALTER TABLE
v INSERT
v UPDATE
v DELETE
3. Configure the web application server for your JDBC driver.
4. Create JDBC connections in the web application server.
© Copyright IBM Corp. 1999, 2017
11
Creating the JDBC connection in the web application server
About this task
The Marketing Platform web application must be able to communicate with its
system table database using a JDBC connection.
You must create this JDBC connection in the web application server where you
plan to deploy Marketing Platform.
You can allow the installer to create this data source when you install Marketing
Platform. To enable automatic data source creation during installation, on the
Datasource Creation panel, select the Create Marketing Platform Datasource check
box and supply information about your application server.
v The installer creates the data source using UnicaPlatformDS as the JNDI name.
v Note that, if you are using WebLogic, you must add the JDBC driver to your
classpath manually even if you allow the installer to create the data source. The
installer does this automatically for WebSphere.
Follow these guidelines if you decide to create the data source manually.
v In WebSphere, set the classpath for your database driver during this process.
v You must use UnicaPlatformDS as the JNDI name. This name is required, and is
noted in the “Marketing Platform installation worksheet” on page 7.
v When the Marketing Platform system tables are created in a different schema
from the default schema of the database login user, you must specify that
non-default schema name in the JDBC connection used to access the system
tables.
Configuring the web application server for your JDBC driver
The web application server where you plan to deploy Marketing Platform must
contain the correct JAR file to support JDBC connections. This enables your web
application to connect to the system tables. The location of the JAR file must be
included in the class path of the web application server.
About this task
If you are using WebSphere, and if you allow the installer to create the data source
when you install the product, you can skip the step in this procedure about setting
the classpath. To enable automatic data source creation during installation, on the
Datasource Creation panel, select the Create Marketing Platform Datasource check
box and supply information about your application server. If you do not want to
allow the installer to create the data source, then perform this entire procedure.
If you are using WebLogic, you must perform this entire procedure.
Procedure
1. Obtain the latest vendor-provided Type 4 JDBC driver for your system table
database that is supported by IBM Marketing Software, as described in the
Recommended Software Environments and Minimum System Requirements guide.
Use the following guidelines after you obtain the JDBC driver.
v If the driver does not exist on the server where you plan to deploy
Marketing Platform, obtain it and unpack it on the server. Unpack the
drivers in a path that does not include spaces.
12
IBM Marketing Platform Installation Guide
v If you obtain the driver from a server where the data source client is
installed, verify that the version is the latest supported by Marketing
Platform.
2. Add the full path to the driver, including the file name, to the class path of the
web application server where you plan to deploy Marketing Platform.
Use the following guidelines.
v For all supported versions of WebLogic, set the class path in the
setDomainEnv script in the WebLogic_domain_directory/bin directory where
environment variables are configured. Your driver entry must be the first
entry in the class path list of values, before any existing values, to ensure
that the web application server uses the correct driver. For example:
UNIX
CLASSPATH="/home/oracle/product/11.0.0/jdbc/lib/ojdbc6.jar:
${PRE_CLASSPATH}${CLASSPATHSEP}${WEBLOGIC_CLASSPATH}
${CLASSPATHSEP}${POST_CLASSPATH}${CLASSPATHSEP}${WLP_POST_CLASSPATH}"
export CLASSPATH
product="Campaign DAOP DistMkt eMessage Interact Leads MktOps
Optimize Platform AttribMod IntHist"> Windows
set CLASSPATH=c:\oracle\jdbc\lib\ojdbc6.jar;%PRE_CLASSPATH%;
%WEBLOGIC_CLASSPATH%;%POST_CLASSPATH%;%WLP_POST_CLASSPATH%
v For all supported versions of WebSphere, set the class path when you set up
the JDBC providers for Marketing Platform.
3. Make a note of the database driver class path in the Marketing Platform
installation worksheet, as you must enter the path when you run the installer.
4. Restart the web application server so that your changes take effect.
During startup, monitor the console log to confirm that the class path contains
the path to the database driver.
Information for creating JDBC connections
Use default values when you create JDBC connections if specific values are not
provided. For more information, see the application server documentation.
Note: If you are not using the default port setting for your database, make sure
that you change it to the correct value.
WebLogic
Use the following values if your application server is WebLogic:
SQLServer
v Database Driver: Microsoft MS SQL Server Driver (Type 4) Versions: 2012, 2012
SP1 and SP3, 2014, 2014 SP1
v Default port: 1433
v Driver class: com.microsoft.sqlserver.jdbc.SQLServerDriver
v Driver URL: jdbc:sqlserver://<your_db_host>[\\
<named_instance>]:<your_db_port>;databaseName=<your_db_name>
v Properties: Add user=<your_db_user_name>
Oracle
v Driver: Other
v Default port: 1521
v Driver class: oracle.jdbc.OracleDriver
Chapter 3. Creating the Marketing Platform data sources
13
v Driver URL:
jdbc:oracle:thin:@<your_db_host>:<your_db_port>:<your_db_service_name>
Enter the driver URL by using the format that is shown. IBM Marketing
Software applications do not allow the use of Oracle's RAC (Real Application
Cluster) format for JDBC connections.
v Properties: Add user=<your_db_user_name>
DB2
v Driver: Other
v Default port: 50000
v Driver class: com.ibm.db2.jcc.DB2Driver
v Driver URL: jdbc:db2://<your_db_host>:<your_db_port>/<your_db_name>
v Properties: Add user=<your_db_user_name>
WebSphere
Use the following values if your application server is WebSphere:
SQLServer
v Driver: N/A
v Default port: 1433
v Driver class:
com.microsoft.sqlserver.jdbc.SQLServerConnectionPoolDataSource
v Driver URL: N/A
In the Database Type field, select User-defined.
After you create the JDBC Provider and data source, go to the Custom Properties
for the data source, and add, modify properties as follows.
v
v
serverName=<your_SQL_server_name>
portNumber =<SQL_Server_Port_Number>
v
databaseName=<your_database_name>
Add the following custom property:
Name: webSphereDefaultIsolationLevel
Value: 1
Datatype: Integer
Oracle
v Driver: Oracle JDBC Driver
v Default port: 1521
v Driver class: oracle.jdbc.OracleDriver
v Driver URL:
jdbc:oracle:thin:@<your_db_host>:<your_db_port>:<your_db_service_name>
Enter the driver URL by using the format that is shown. IBM Marketing
Software applications do not allow the use of Oracle's RAC (Real Application
Cluster) format for JDBC connections.
14
IBM Marketing Platform Installation Guide
DB2
v Driver: JCC Driver Provider
v Default port: 50000
v Driver class: com.ibm.db2.jcc.DB2Driver
v Driver URL: jdbc:db2://<your_db_host>:<your_db_port>/<your_db_name>
Add the following custom property:
Name: webSphereDefaultIsolationLevel
Value: 2
Datatype: Integer
Chapter 3. Creating the Marketing Platform data sources
15
16
IBM Marketing Platform Installation Guide
Chapter 4. Installing Marketing Platform
You must run the IBM Marketing Software installer to start the installation of
Marketing Platform. The IBM Marketing Software installer starts the Marketing
Platform installer during the installation process. Make sure that the IBM
Marketing Software installer and the product installer are saved at the same
location.
Each time that you run the IBM Marketing Software suite installer, you must first
enter database connection information for the Marketing Platform system tables.
When the Marketing Platform installer starts, you must enter the required
information for Marketing Platform.
After installing Marketing Platform, you can create an EAR file for your product,
and you can install the reports package for your product. Creating the EAR file
and installing the reports package are not mandatory actions.
Important: Before you install Marketing Platform, make sure that the available
temporary space on the computer where you install Marketing Platform is more
than three times the size of the Marketing Platform installer.
Installation files
The installation files are named according to the version of the product and the
operating system on which they must be installed, except UNIX. For UNIX,
different installation files exist for the X Window System mode and the console
mode.
The following table displays examples of the installation files that are named
according to the product version and the operating system:
Table 8. Installation files
Operating system
Installation file
Windows: GUI and console mode
Product_N.N.N.N_win.exe,
where Product is the name of your product, N.N.N.N is
the version number of your product, and Windows 64-bit
is the operating system on which the file must be
installed.
UNIX: X Window System mode
Product_N.N.N.N_linux.bin, where Product is the name
of your product, and N.N.N.N is the version number of
your product.
UNIX: Console mode
Product_N.N.N.N.bin, where Product is the name of your
product, and N.N.N.N is the version number of your
product. This file can be used for installation on all
UNIX operating systems.
Installing Marketing Platform using the GUI mode
For Windows, use the GUI mode to install Marketing Platform. For UNIX, use the
X Window System mode to install Marketing Platform.
© Copyright IBM Corp. 1999, 2017
17
Before you begin
Important: Before you use the GUI mode to install Marketing Platform, make sure
that the available temporary space on the computer where you install Marketing
Platform is more than three times the size of the Marketing Platform installer.
Make sure that the IBM Marketing Software installer and the Marketing Platform
installers are in the same directory on the computer where you want to install
Marketing Platform.
Procedure
Complete the following actions to install Marketing Platform by using the GUI
mode:
1. Go to the folder where you have saved the IBM Marketing Software installer
and double-click the installer to start it.
2. Click OK on the first screen to see the Introduction window.
3. Follow the instructions on the installer, and click Next. Use the information in
the following table to take the appropriate actions on each window in the IBM
Marketing Software installer.
Table 9. IBM Marketing Software installer GUI
Window
Description
Introduction
This is the first window of the IBM Marketing Software installer. You can open
the Marketing Platform installation and upgrade guides from this window. You
can also see a link for the installation and upgrade guides for the products
whose installers are saved in the installation directory.
Click Next to go to the next window.
Response Files Destination
Click the Generate Response File check box if you want to generate response
files for your product. Response files store the information that is necessary for
the installation of your product. You can use response files for an unattended
installation of your product, or to get pre-filled answers if you rerun the
installer in the GUI mode
Click Choose to browse to a location where you want to store the response
files.
Click Next to go to the next window.
IBM Marketing Software products
In the Install Set list, select Custom to select the products that you want to
install.
In the Install Set area, you can see all the products whose installers are in the
same directory on your computer.
In the Description field, you can view the description of the product that you
select in the Install Set area.
Click Next to go to the next window.
Installation Directory
In the Specify the installation directory field, click Choose to browse to the
directory where you want to install your product.
If you want to install the product in the folder where the installers are stored,
click Restore Default Folder.
Click Next to go to the next window.
18
IBM Marketing Platform Installation Guide
Table 9. IBM Marketing Software installer GUI (continued)
Window
Description
Select Application Server
Select one of the following application servers for the installation:
v IBM WebSphere
v Oracle WebLogic
Click Next to go to the next window.
Platform Database Type
Select the appropriate Marketing Platform database type.
Click Next to go to the next window.
Platform Database Connection
Enter the following information about your database:
v Database host name
v Database port
v Database name or System ID (SID)
v Database user name
v Database password
Click Next to go to the next window.
Platform Database Connection
(continued)
Review and confirm the JDBC connection.
Preinstallation Summary
Review and confirm the values that you added during the installation process.
Click Next to go to the next window. The URL can be customized with
additional parameters if needed.
Click Install to start the installation process.
The Marketing Platform installer opens.
4. Use the information in the following table to navigate the Marketing Platform
installer.
Table 10. IBM Marketing Platform installer GUI
Window
Description
Introduction
This is the first window of the Marketing Platform installer. You can open the
Marketing Platform installation and upgrade guides from this window.
Click Next to go to the next window.
Software Licence Agreement
Carefully read the agreement. Use Print to print the agreement. Click Next after
you accept the agreement.
Country for Install
If you are installing Marketing Platform in one of the countries that are listed in
this window, click Yes.
If you are installing Marketing Platform in one of the countries that are not
listed in this window, click No.
Click Next to go to the next window.
IBM Page Tagging
You can see this window if you selected Yes in the Country for Install window.
Select your preferences for page tagging and click Next.
IBM Site ID
You can see this window if you have selected No in the Country for Install
window.
Enter your IBM site ID and click Next.
Chapter 4. Installing Marketing Platform
19
Table 10. IBM Marketing Platform installer GUI (continued)
Window
Description
Installation Directory
Click Choose to browse to the directory where you want to install your
product, or accept the default value.
Click Next to go to the next window.
Platform Components
In the Install Set list, select Custom to select the components that you want to
install.
In the Install Set area, you can see all the Marketing Platform components.
You can select the following components:
v IBM Marketing Platform utilities
v IBM Marketing Platform web application
v Reports for IBM Cognos 10 BI
If you are using Cognos reports, you must select this option for a new or
upgrade installation. This option installs authentication-related files and the
latest GlobalStyleSheet.css file for Cognos reports.
Install Reports for IBM Cognos 10 BI in the same location where IBM
Cognos 10 BI is installed.
In the Description field, you can view the description of the product that you
select in the Install Set area.
Click Next to go to the next window.
Platform Connection Settings
Select one of the following connections types:
v HTTP
v HTTPS
Enter the following information:
v Network domain name, such as example.com
v Host name
v Port number
Important: If IBM Marketing Software products are installed in a distributed
environment, you must use the machine name rather than an IP address in the
navigation URL for all of the applications in the suite.
Click Next to go to the next window.
Platform Database Setup
Select one of the following options for setting up the Marketing Platform
database:
v Automatic database setup
v Manual database setup
If you select Manual database setup, use the Run Platform Configuration
check box if you want to run the Marketing Platform configuration.
If you select Manual database setup, you must populate the Marketing
Platform system tables after the installation is complete.
Click Next to go to the next window.
20
IBM Marketing Platform Installation Guide
Table 10. IBM Marketing Platform installer GUI (continued)
Window
Description
Platform Utilities Settings
Enter the following information if you plan to use the Marketing Platform
command-line tools:
v JDBC driver class
v JDBC connection URL
v JDBC driver classpath
Click Next to go to the next window.
Platform Utilities Settings
(continued)
Click Choose to specify the directory where Java is installed.
Datasource creation
The installer can create the JDBC data source in your web application server
(WebSphere or WebLogic). This data source is required to enable the Marketing
Platform web application to connect to the Marketing Platform system tables.
You have the option to skip this step in the installer and create the data source
in the administration console of your web application server after installation is
complete.
Click Next to go to the next window.
If you select the Create Marketing Platform Datasource check box, the installer
creates the data source using information you provide..
v Your application server must be running.
v Enter any name for the datasource.
The installer creates the JNDI name automatically (UnicaPlatformDS).
v Enter the directory in which the application server is installed.
For WebSphere, this is the directory that contains the profiles directory. You
must restart WebSphere after the installer finishes and before you use this
data source.
For WebLogic, this is the directory that contains the common directory.
Click Next to go to the next window.
Application server information
(WebSphere)
Applies only if your application server is WebSphere.
v Enter the application server profile where you plan to deploy Marketing
Platform.
v Enter the name of the server in the profile.
v If security is enabled in WebSphere, enter the administrator user ID and
password.
Click Next to go to the next window.
Application server information
(WebLogic)
Applies only if your application server is WebLogic.
Enter the domain server name and the administrator user ID and password. If
SSL is enabled, enter the HTTP port for the domain.
Note that you must add the database driver classpath to WebLogic in the
WebLogic administration console.
Click Next to go to the next window.
Default locale
Select a default locale for your installation. English is selected by default.
Click Next to go to the next window.
Chapter 4. Installing Marketing Platform
21
Table 10. IBM Marketing Platform installer GUI (continued)
Window
Description
IBM Cognos 10 BI Location
You can see this window if you selected to install the Cognos reports in the
Platform Components window.
Click Choose to specify the directory where IBM Cognos 10 BI is installed.
Click Next to go to the next window.
Preinstallation Summary
Review and confirm the values that you added during the installation process.
Click Install to start the installation process.
The Marketing Platform installer opens.
Installation Complete
Click Done to close the Marketing Platform installer and go back to the suite
installer.
5. Follow the instructions on the IBM Marketing Software installer to finish
installing Marketing Platform. Use the information in the following table to
take the appropriate actions on each window in the IBM Marketing Software
installer.
Table 11. IBM Marketing Software installer GUI
Window
Description
Deployment EAR file
Specify whether you want to create an enterprise archive (EAR) file to deploy
your IBM Marketing Software products.
Click Next to go to the next window.
Package EAR file
You can see this window if you select Create an EAR file for deployment in
the Deployment EAR file window.
Select the applications that you want to package in the EAR file.
EAR file details
Enter the following information for your EAR file:
v Enterprise application identifier
v Display name
v Description
v EAR file path
EAR file details (continued)
Select Yes or No to create an additional EAR file. If you select Yes, you must
enter the details for the new EAR file.
Click Next to complete the installation of your product.
Deployment EAR file
Specify whether you want to create another EAR file to deploy your IBM
Marketing Software products.
Click Next to go to the next window.
Installation Complete
This window provides the locations of the log files that are created during
installation. You can view the log files when you exit from the installer.
Click Previous if you want to change any installation details.
Click Done to close the suite installer.
Creating an EAR file after running the installer
You can create an EAR file after you install IBM Marketing Software products. You
might do this to create an EAR file with a desired combination of products.
22
IBM Marketing Platform Installation Guide
About this task
Note: Run the installer in console mode from the command line.
Use the following procedure if you want to create an EAR file after you install IBM
Marketing Software products:
Procedure
1. If this is the first time you are running the installer in console mode, make a
backup copy of the installer's .properties file for each of your installed
products.
Each IBM product installer creates one or more response files with a
.properties extension. These files are in the same directory where you placed
the installers. Be sure to back up all files with the .properties extension,
including the installer_productversion.properties files and the file for the
IBM installer itself, which is named installer.properties.
If you plan to run the installer in unattended mode, you must back up the
original .properties files, because when the installer runs in unattended mode,
it clears these files. To create an EAR file, you need the information that the
installer writes in the .properties files during the initial installation.
2. Open a command window and change directories to the directory that contains
the installer.
3. Run the installer executable with this option:
-DUNICA_GOTO_CREATEEARFILE=TRUE
On UNIX type systems, run the .bin file rather than the .sh file.
The installer wizard runs.
4. Follow the instructions in the wizard.
5. Before you create more EAR files, overwrite the .properties file or files with
the backups you created before you ran in console mode for the first time.
Installing Marketing Platform using the console mode
The console mode allows you to install Marketing Platform using the
command-line window. You can select various options in the command-line
window to complete tasks such as selecting the products to install, or selecting the
home directory for the installation.
Before you begin
Before you install Marketing Platform, ensure that you have configured the
following.
v An application server profile
v A database schema
To display the installer screens correctly in console mode, configure your terminal
software to support UTF-8 character encoding. Other character encodings, such as
ANSI, do not render the text correctly, and some information is not readable with
these encodings.
Procedure
1. Open a command-line prompt window and navigate to the directory where
you have saved the IBM Marketing Software installer and the Marketing
Platform installer.
Chapter 4. Installing Marketing Platform
23
2. Complete one of the following actions to run the IBM Marketing Software
installer.
v For Windows, enter the following command:
ibm_ims_installer_full_name -i console
For example, IBM_Marketing_Software_Installer_10.0.0.0_win.exe -i
console
v For UNIX, invoke the ibm_ims_installer_full_name.sh file.
For example: IBM_Marketing_Software_Installer_10.0.0.0.sh
3. Follow the directions that are displayed in the command-line prompt. Use the
following guidelines when you have to select an option in the command-line
prompt:
v The default options are defined by the symbol [X].
v To select or clear an option, type the number that is defined for the option,
and then press Enter.
For example, suppose that the following list displays the components that you
can install:
1 [X] Marketing Platform
2 [X] Campaign
3 [ ] Contact Optimization
4 [ ] Distributed Marketing
If you want to install Distributed Marketing, and do not want to install
Campaign, enter the following command: 2,4
The following list would then display the options that you selected:
1 [X] Marketing Platform
2 [ ] Campaign
3 [ ] Contact Optimization
4 [X] Distributed Marketing
Note: Do not clear the option for Marketing Platform unless you have already
installed it.
4. The IBM Marketing Software installer launches the Marketing Platform installer
during the installation process. Follow the instructions in the command-line
prompt window of the Marketing Platform installer.
5. After you enter quit in the Marketing Platform installer command-line prompt
window, the window shuts down. Follow the instructions in the command-line
prompt window of the IBM Marketing Software installer to complete the
installation of Marketing Platform.
Note: If any error occurs during the installation, a log file is generated. You
must exit the installer to view the log file.
Installing Marketing Platform silently
Use the unattended or silent mode to install Marketing Platform multiple times.
Before you begin
Before you install Marketing Platform, make sure that you have configured the
following elements:
v An application server profile
24
IBM Marketing Platform Installation Guide
v A database schema
About this task
When you install Marketing Platform by using the silent mode, response files are
used to obtain the information that is required during installation. You must create
response files for a silent installation of your product. You can create response files
by using one of the following methods:
v Using the sample response files as a template for creating your response files.
The sample response files are included with your product installers in the
ResponseFiles compressed archive. For more information about sample response
files, see “Sample response files.”
v Running the product installers in the GUI (Windows) or X Window System
(UNIX) mode or the console mode before you install the product in the silent
mode. One response file is created for the IBM Marketing Software suite
installer, and one or more response files are created for your product installer.
The files are created in the directory that you specify.
Important: For security reasons, the installer does not save database passwords
in the response files. When you create response files, you must edit each
response file to enter database passwords. Open each response file and search
for PASSWORD to find where you must edit the response file.
When the installer runs in the silent mode, it looks for the response files in the
following directories sequentially:
v In the directory where the IBM Marketing Software installer is saved
v In the home directory of the user who installs the product
Make sure that all response files are in the same directory. You can change the path
where response files are read by adding arguments to the command line. For
example: -DUNICA_REPLAY_READ_DIR="myDirPath" -f myDirPath/
installer.properties
Procedure
Use the following command for Windows:
v ibm_ims_installer_full_name -i silent
For example:
IBM_Marketing_Software_Installer_10.0.0.0_win.exe -i silent
Use the following command for Linux:
v ibm_ims_installer_full_name _operating_system .bin -i silent
For example:
IBM_Marketing_Software_Installer_10.0.0.0_linux.bin -i silent
Sample response files
You must create response files to set up a silent installation of Marketing Platform.
You can use sample response files to create your response files. The sample
response files are included with the installers in the ResponseFiles compressed
archive.
The following table provides information about sample response files:
Chapter 4. Installing Marketing Platform
25
Table 12. Description of sample response files
Sample response file
Description
installer.properties
The sample response file for the IBM Marketing Software
master installer.
installer_product intials and product version
number.properties
The sample response file for the Marketing Platform
installer.
For example, installer_umpn.n.n.n.properties is the
response file of the Marketing Platform installer, where
n.n.n.n is the version number.
installer_report pack initials, product initials,
and version number.properties
The sample response file for the reports pack installer.
For example, installer_urpcn.n.n.n.properties is the
response file of the Campaign reports pack installer,
where n.n.n.n is the version number
Marketing Platform components
The Marketing Platform application contains the IBM common navigation,
reporting, user administration, security, scheduling, and configuration management
features. For each IBM Marketing Software environment, you must install and
deploy the Marketing Platform once.
To use the Marketing Platform utilities on additional computers, you must install
the utilities and the web application on the additional computers. This is needed
because the utilities use the jar files in the web application. However, when you
install the Marketing Platform to use the utilities, you do not have to deploy the
Marketing Platform again, and you do not have to create additional Marketing
Platform system tables.
The following table describes the components that you can select when you install
Marketing Platform:
Table 13. Marketing Platform components
Component
Description
Marketing
Platform utilities
Command line tools that allow you to work with the Marketing
Platform system table database from the command line to import and
export configurations, create partitions and data filters, and restore the
platform_admin user. Install this on every machine where you want to
be able to use Marketing Platform utilities.
Marketing
Platform web
application
The web application that supplies the common user interface, security,
and configuration management for IBM Marketing Software. Install this
on the machine where you plan to deploy the Marketing Platform.
Reports for IBM
Cognos BI
Reports integration components for IBM Cognos. Install this
component only on the Cognos system.
Creating and populating the Marketing Platform system tables
manually
When you install Marketing Platform, you can select the option where the installer
creates the Marketing Platform system tables automatically. Alternatively, you can
manually create the system tables.
26
IBM Marketing Platform Installation Guide
Procedure
Complete the following tasks to create and populate the system tables manually:
1. Run the IBM installer as described in “Installing Marketing Platform using the
GUI mode” on page 17, but with the following differences in your choices
when it launches the Marketing Platform installer.
v Select Manual database setup.
v Deselect the Run Platform configuration checkbox.
2. After the installer finishes, create the system tables manually by running the
following SQL scripts appropriate for your database type against your
Marketing Platform system table database, as described in “SQL scripts for
creating system tables” on page 62.
Run the scripts in this order.
v ManagerSchema_DBType.sql
If you plan to support multi-byte characters (for example, Chinese, Japanese,
or Korean) and your database is DB2, use the
ManagerSchema_DB2_unicode.sql script.
v ManagerSchema__DBType_CeateFKConstraints.sql
v active_portlets.sql
v quartz__DBType.sql
3. Run the populateDB utility to populate the system tables with default users and
roles.
Use this command:
populateDb -n Manager
See “populateDb” on page 56 for complete details on using this utility.
4. Run the IBM installer again, making the following selections when it launches
the Marketing Platform installer.
v Select Manual database setup.
v
Select the Run Platform configuration checkbox.
This adds default configuration properties to the system tables.
Chapter 4. Installing Marketing Platform
27
28
IBM Marketing Platform Installation Guide
Chapter 5. Deploying Marketing Platform
You must follow a set of guidelines when you deploy Marketing Platform in your
web application server. There is a different set of guidelines for deploying
Marketing Platform on WebLogic and on WebSphere.
When you ran the IBM installer, you completed one of the following actions:
v You included Marketing Platform in an EAR file.
v You created the WAR file of Marketing Platform (unica.war).
If you included other products in an EAR file, you must follow the deployment
guidelines that are provided in the individual installation guides for the products
that are included in the EAR file.
We assume that you know how to work with your web application server. Consult
your web application server documentation for details such as navigation in the
Administration console.
Guidelines for deploying Marketing Platform on WebLogic
You must follow a set of guidelines when you deploy Marketing Platform on the
WebLogic application.
Use the following guidelines when you deploy the Marketing Platform products
on any supported version of WebLogic:
v IBM Marketing Software products customize the Java virtual machine (JVM) that
is used by WebLogic. If you encounter errors related to JVM, you can create a
WebLogic instance that is dedicated to IBM Marketing Software products.
v Open the startWebLogic.cmd file and verify that the SDK that is selected for the
WebLogic domain that you are using is the Sun SDK for the JAVA_VENDOR
variable.
The JAVA_VENDOR variable must be set to Sun (JAVA_VENDOR=Sun). If
theJAVA_VENDOR variable is set to JAVA_VENDOR, it means that JRockit is selected.
You must change the selected SDK, because JRockit is not supported. Refer to
the BEA WebLogic documentation to change the selected SDK.
v Deploy Marketing Platform as a web application.
v If you are configuring WebLogic to use the IIS plug-in, review the BEA
WebLogic documentation.
v Complete the following tasks if your installation must support non-ASCII
characters, for example for Portuguese or for locales that require multi-byte
characters:
1. Edit the setDomainEnv script in the bin directory under your WebLogic
domain directory to add -Dfile.encoding=UTF-8 to JAVA_VENDOR.
2. In the WebLogic console, click the Domain link on the home page.
3. In the Web Applications tab, select the Archived Real Path Enabled check
box.
4. Restart WebLogic.
5. Deploy and start the EAR file or the unica.war file.
v If deploying in a production environment, set the JVM memory heap size
parameters to 1024 by adding the following line to the setDomainEnv script:
© Copyright IBM Corp. 1999, 2017
29
Set MEM_ARGS=-Xms1024m -Xmx1024m -XX:MaxPermSize=256m
Guidelines for deploying Marketing Platform on WebSphere
You must follow a set of guidelines when you deploy Marketing Platform on
Websphere.
Make sure that the version of WebSphere meets the requirements that are
described in the IBM Enterprise Products Recommended Software Environments and
Minimum System Requirements document, including any necessary fix packs. Use
the following guidelines when you deploy Marketing Platform on WebSphere:
v Specify the following custom property in the server:
– Name: com.ibm.ws.webcontainer.invokefilterscompatibility
– Value: true
v See http://www-01.ibm.com/support/docview.wss?uid=swg21284395 for
instructions on setting a custom property in WebSphere.
v Deploy the IBM EAR file or unica.war file as an enterprise application. When
you deploy the EAR file or the unica.war file, ensure that the JDK source level
of the JSP compiler is set to Java 17, and that JSP pages are precompiled
according to the following information:
– In the form where you browse to and select the WAR file, select Show me all
installation options and parameters so the Select Installation Options
wizard runs.
– In step 1 of the Select Installation Options wizard, select Precompile
JavaServer Pages files.
– In step 3 of the Select Installation Options wizard, ensure that the JDK
Source Level is set to 17.
If you deployed an EAR, set the JDK Source Level for each WAR file.
– In step 8 of the Select Installation Options wizard, select UnicaPlatformDS
as the matching Target Resource.
– In step 10 of the Select Installation Options wizard, the context root must be
set to /unica, all lower case.
v In the Web Container Settings > Web Container > Session Management section
of the server, enable cookies. Specify a different session cookie name for each
application that is deployed. Use one of the following procedures to specify a
cookie name:
– Select the Override session management check box under Session
Management.
If you deployed separate WAR files for your IBM Marketing Software
products, in the WebSphere console, in the Applications > Enterprise
Applications > [deployed_application] > Session Management > Enable
Cookies > Cookie Name section of the server, specify a unique session cookie
name.
If you deployed EAR files for your IBM Marketing Software products, in the
WebSphere console, in the Applications > Enterprise Applications >
[deployed_application] > Module Management > [deployed_module] >
Session Management > Enable Cookies > Cookie Name section of the
server, specify a unique session cookie name.
– If your installation must support non-ASCII characters, for example for
Portuguese or for locales that require multi-byte characters, add the following
arguments to Generic JVM Arguments at the server level:
-Dfile.encoding=UTF-8
30
IBM Marketing Platform Installation Guide
-Dclient.encoding.override=UTF-8
Navigation tip: Select Servers > Application Servers > Java and Process
Management > Process Definition > Java Virtual Machine > Generic JVM
Arguments. See the WebSphere documentation for additional details.
v In the Applications > Enterprise Applications section of the server, select the
EAR file or WAR file that you deployed, then select Class loading and update
detection and specify the following properties.
– If you are deploying a WAR file:
- For Class loader order, select Classes loaded with local class loader first
(parent last).
- For WAR class loader policy, select Single class loader for application.
– If you are deploying an EAR file:
- For Class loader order, select Classes loaded with local class loader first
(parent last).
- For WAR class loader policy, select Class loader for each WAR file in
application.
v Start your deployment. If your instance of WebSphere is configured to use a
JVM version 1.6 or newer, complete the following steps to work around an issue
with the time zone database.
1. Stop WebSphere.
2. Download the IBM Time Zone Update Utility for Java (JTZU) from the IBM
web site:
http://www.ibm.com/developerworks/java/jdk/dst/index.html
3. Follow the steps provided by the IBM (JTZU) to update the time zone data
in your JVM.
4. Restart WebSphere.
v In Websphere Enterprise Applications, select Your Application > Manage
Modules > Your Application > Class Loader Order > Classes loaded with local
class loader first (parent last).
v The recommended minimum heap size for the basic functioning of the
application is 512, and the recommended maximum heap size is 1024.
Complete the following tasks to specify the heap size:
1. In WebSphere Enterprise Applications, select Servers > WebSphere
application servers > server1 > Server Infrastructure > Java and Process
Management > Process definition > Java Virtual Machine.
2. Set the initial heap size to 512.
3. Set the maximum heap size to 1024
See the WebSphere documentation for more information about sizing.
Verifying your Marketing Platform installation
After you install and deploy Marketing Platform, you must verify that there are no
errors in your Marketing Platform installation and deployment. You can configure
your Marketing Platform installation after the verification.
Procedure
Complete the following tasks to verify your Marketing Platform installation:
1. Access the IBM Marketing Software URL in a supported web browser.
Chapter 5. Deploying Marketing Platform
31
If you entered a domain when you installed Marketing Platform, the URL is the
following, where host is the machine where Marketing Platform is installed,
domain.com is the domain in which the host machine resides, and port is the
port number on which the web application server listens.
http://host.domain.com:port/unica
2. Log in using the default administrator login, which is asm_admin with password
as the password.
You will be asked to change the password. You can enter the existing
password, but for good security you should choose a new one.
The default home page is the dashboard, which you will configure later.
3. Under the Settings menu, check the Users, User Groups, and User Permissions
pages to verify that the pre-configured users, groups, roles, and permissions are
present, as described in the Marketing Platform Administrator's Guide.
4. Add a new user and group and verify that data is entered into the Marketing
Platform system table database.
5. Under the Settings menu, check the Configuration page to verify that the
Marketing Platform configuration properties exist.
What to do next
There are additional configuration tasks, such as configuring the dashboard, setting
up user access to IBM applications, and integrating with an LDAP or web access
control system (optional). See the IBM Marketing Platform Administrator's Guide for
instructions.
32
IBM Marketing Platform Installation Guide
Chapter 6. Configuring Marketing Platform after deployment
For a basic installation of Marketing Platform, you must configure Marketing
Platform after deployment if you use the IBM Marketing Software reporting
feature, or if you want to use a password policy.
If you use the IBM Marketing Software reporting feature, see the IBM Marketing
Software Reports Installation and Configuration Guide. If you want to use a password
policy in mind, see “Default password settings” to determine whether you must
change the default password settings.
The Marketing Platform has additional properties on the Configuration page that
perform important functions that you can optionally adjust. See the context help
for the properties, or the IBM Marketing Platform Administrator's Guide to learn
more about what they do and how to set them.
Default password settings
IBM Marketing Software provides default settings for using passwords. However,
you can use the General > Password settings category on the IBM Marketing
Software Configuration page to change the default settings, and create your
password policies.
The default password settings apply to passwords for users that are created within
IBM Marketing Software. The settings do not apply to the users that are imported
through synchronization with an external system, such as Windows Active
Directory, a supported LDAP directory server, or web access control server. The
exception is the Maximum failed login attempts allowed setting, which affects
both internal and external users. Also note that this property does not override any
similar restriction set in an external system.
The following settings are the default password settings that IBM Marketing
Software:
v Maximum failed login attempts allowed - 3
v Password history count - 0
v Validity (in days) - 30
v Blank passwords allowed - True
v Allow identical user name and password - True
v Minimum number of numeric characters - 0
v Minimum number of letter characters - 0
v Minimum character length - 4
See the online help for descriptions of the default settings.
Set the web application session timeout (optional)
The session timeout determines how long an inactive HTTP session can remain
open before it expires.
© Copyright IBM Corp. 1999, 2017
33
Procedure
Set the session timeout on your web application server:
v WebSphere: Use the IBM WebSphere Application Server Administrative Console
to set the Session timeout in minutes. You can adjust this setting at the server
and Enterprise Application levels. See your WebSphere documentation for
details.
v WebLogic: Use the WebLogic console to set the Session Timeout in seconds, or
adjust the TimeoutSecs parameter value for the session-descriptor element in
the weblogic.xml file.
Additional configuration for enhanced security
The procedures in this section describe some additional configurations in the web
application server. They are optional, but you might want to perform them for
enhanced security.
Disabling the X-Powered-By flag
If your organization is concerned that the X-Powered-By flag in the header variable
is a security risk, you can disable it using this procedure.
Procedure
1. If you are using WebLogic, in the administration console, under domainName >
Configuration > Web Application, set X-Powered-By Header to X-Powered-By
Header will not be sent.
2. If you are using WebSphere, perform the following steps.
a.
In the WebSphere administration console, navigate toServers > Server
Types > WebSphere application servers > server_name > Web Container
Settings > Web container.
b. Under Additional Properties select Custom Properties.
c. On the Custom Properties page, click New.
d. On the Settings page, create a custom property named
com.ibm.ws.webcontainer.disablexPoweredBy and set the value to false.
e. Click Apply or OK.
f. Click Save on the console task bar to save your configuration changes.
g. Restart the server.
Configuring a restrictive cookie path
In your web application server, you can restrict cookie access to a specific
application for enhanced security. If not restricted, cookies are valid across all the
deployed applications.
Procedure
1. If you are using WebLogic, perform the following steps.
a. Extract the weblogic.xml file from the WAR or EAR package where you
want to add the restrictive cookie path.
b. Add the following to the weblogic.xml file, where context-path is the context
path for the deployed application. For IBM Marketing Software applications
the context path is typically /unica.
34
IBM Marketing Platform Installation Guide
<session-descriptor>
<session-param>
<param-name>CookiePath</param-name>
<param-value>/context-path> </param-value>
</session-param>
</session-descriptor>
c. Rebuild the WAR or EAR file.
2. If you are using WebSphere, perform the following steps.
a. In the WebSphere administration console, navigate to the Session Manager
> Cookie tab.
b. Set the Cookie Path to the context path of your application.
For IBM Marketing Software applications the context path is typically
/unica.
Disabling caching of Campaign and Marketing Platform configuration
property values
If you encounter an issue where configuration properties are not being picked up
by Campaign or Marketing Platform, you can disable caching as described in this
procedure.
About this task
Set generic JVM arguments in the web application server where Marketing
Platform is deployed, as described in the following steps.
Procedure
1. Set the following JVM argument, which disables the Hibernate L2 cache.
-DUNICA_PLATFORM_CACHE_ENABLED=false
By default, this value is set to true, which provides the best performance.
2. Set the following JVM argument, which enables local caching. This improves
performance when the Hibernate cache is disabled.
-DUNICA_PLATFORM_LOCAL_CACHE_ENABLED=true
When this local caching mechanism is enabled, configurations are updated at
60 minute intervals. If you want configuration changes to be picked up
immediately, you must restart the application server.
Chapter 6. Configuring Marketing Platform after deployment
35
36
IBM Marketing Platform Installation Guide
Chapter 7. Installing Marketing Platform in a cluster
Marketing Platform supports an IBM WebSphere Application Server cluster
deployment. Clustering is not supported on WebLogic.
Process overview
The following steps are an overview of the process for setting up a Marketing
Platform cluster deployment.
1. Set up WebSphere clusters on two or more servers.
2. Create a profile for the primary node in WebSphere.
3. Create WebSphere cluster nodes.
4. Create a WebSphere cluster
5. Add existing nodes to the cluster (optional)
6. Start the nodes, web server, and cluster
7. Create JDBC providers
8. Install and deploy IBM Marketing Software products
9. Configure the IBM HTTP Server as a load balancer
10. Configure Marketing Platform logs.
Prerequisites
The following are prerequisites that must be met before you perform the
procedures described in this section.
v The IBM HTTP Server and the IBM HTTP Server plugins must be installed on
the server machine on which you plan to create the WebSphere Deployment
Manager profile is being created. The IBM HTTP Server is included with
WebSphere at no charge.
v The IBM HTTP Server is up and running.
Creating a WebSphere profile for the primary node of a cluster
Follow these guidelines to create a WebSphere profile for the primary node of a
Marketing Platform cluster.
About this task
Perform the following steps in the WebSphere profile creation wizard.
See the following video for a demonstration: https://www.youtube.com/
watch?v=RREp9n2Yy_o
Procedure
1. Select Cell (Deployment manager and a federated application server) as the
type.
2. On the Web Server Definition Part 1 screen, do the following.
a. Select Create a Web Server definition.
b. Select IBM HTTP Server as the web server type.
© Copyright IBM Corp. 1999, 2017
37
c. Enter the web server name.
In a later step you create a web server in the cluster using this name.
Examples in this guide use IMPWebServer as the web server name.
d. Enter the web server host and port.
3. On the Web Server Definition Part 2 screen, do the following.
a. Web server installation directory path
b. Web server plug-in installation directory path
Creating profiles for additional nodes
Follow these guidelines to create additional nodes for a Marketing Platform cluster.
About this task
Create WebSphere nodes on multiple servers. You can create the node profiles
using the Profile Management tool or the manageprofile command.
Adding existing nodes to the cluster nodes
Optionally, you can add your existing WebSphere profiles as nodes in the cluster
environment.
About this task
Follow these guidelines to add existing nodes to the cluster.
Procedure
1. Start the Websphere Deployment Manager as follows.
a. Log in to the server where the WebSphere Deployment Manager is installed.
b. Navigate to the Deployment Manager profile location
Example location: /data/webservers/IBM/WASND85/profiles/Dmgr01/bin
c. Execute the startmanager script.
2. Add the WebSphere profile node to the cluster as follows.
a. Log in to server where the WebSphere profile is created.
b. Navigate to the WebSphere profile location.
Example location: /data/webservers/IBM/WASND85/profiles/AppSrv01/bin
c. Execute command: ./addNode.sh DEPLOYMENT_MANAGER_HOST
DEPLOYMENT_MANAGER_SOAP_PORT
For example: ./addNode.sh example.com 8879
You can obtain the SOAP Port can be from the Deployment Manager –
AboutThisProfile.txt.
Creating a WebSphere cluster
Use the WebSphere Deployment Manager profile to create the cluster.
About this task
For information, see the following video: https://www.youtube.com/
watch?v=wK06h2kVq5w
38
IBM Marketing Platform Installation Guide
Creating the web server in the cluster
The IBM HTTP Server can be configured to connect with the nodes in the cluster
and serve as a load balancer.
About this task
Use the WebSphere Deployment Manager profile to create the web server in the
cluster.
For information, see the following video: https://www.youtube.com/
watch?v=rfOFBRX7Kjc
Give your web server the name you used in the step "Creating a WebSphere profile
for the primary node of a cluster." Examples in this guide use IMPWebServer as the
web server name.
Starting the nodes, web server, and cluster
Start the nodes, IBM HTTP Server, and cluster, in that order.
About this task
Before you start the WebSphere cluster from WebSphere console, start all of the
nodes you created in previous steps, and start the IBM HTTP Server. The IBM
HTTP Server is included with WebSphere at no charge.
Procedure
1. Start the nodes on each server by navigating to the appropriate profile under
data/webservers/IBM/WASND85/profiles under your WebSphere installation and
executing the startNode script.
2. Start the IBM HTTP Server as follows.
a. Open the IBM HTTP Server conf file and verify that the IBM HTTP Server
listen port is 80.
The conf file is located in the conf directory under your IBM HTTP Server
installation. The typical install location is data/webservers/IBM/IHS.
Look for Listen 80 in the file.
b. To start the server, navigate to the data/webservers/IBM/IHS/bin directory
under your IBM HTTP Server installation and execute this command:
./apachectl start.
a. Verify that the IBM HTTP Server is started successfully by launching the
URL of the server.
3. Start the cluster from WebSphere Deployment Manager as follows.
a. Navigate to Servers > Clusters > WebSphere application server cluster.
b. Select your cluster and click Start.
If the cluster does not star, do the following. :
v Verify that your cluster nodes are running on each server.
v Verify that the application servers are started. You can navigate to cluster
members and start each application server manually.
Chapter 7. Installing Marketing Platform in a cluster
39
Creating JDBC providers in a cluster
Creating JDBC providers is slightly different in a clustered environment than in a
non-clustered environment.
About this task
See the following video for information: https://www.youtube.com/
watch?v=fGYgwNvSC7c
Installing IBM Marketing Software products in a cluster
Follow the installation guide for your IBM Marketing Software product to install
and deploy the product, with the additional configuration described in this
procedure.
About this task
v Install your product on the primary node, following the instructions in the
product Installation Guide.
v During the installation, provide the port of the cluster manager machine as the
HTTP port for the application.
If you do not provide this port, you must change the value of the product's
navigation URL configuration property on the Settings > Configuration page.
v Share or mount the product installation directory from the primary machine to
all of the node machines. For AIX/Linux you can mount the installation drive.
v Deploy the product web application on the WebSphere cluster.
Configuring the IBM HTTP Server as a load balancer
Follow these steps to configure the IBM HTTP Server as a load balancer with
Marketing Platform.
Procedure
1. In the WebSphere administrative console, navigate to Servers > Server Types >
Web Servers.
2. Select the server name and click Generate Plug-in. Then select the server name
and click Propogate Plug-in.
Verify that the plugin-cfg.xml file is generated. Note the path of this file.
Open the file and verify that it contains the correct URIGroups and cluster
server information. If the information is not correct, modify the file and then
repeat the steps in this procedure.
3. Open the IBM HTTP Server conf file and add the following two lines to the
bottom of the file.
The conf file is located in the conf directory under your IBM HTTP Server
installation. The typical install location is data/webservers/IBM/IHS.
LoadModule was_ap22_module
IBM HTTP SERVER HOME/Plugins/bin/64bits/mod_was_ap22_http.so
WebSpherePluginConfig
IBM HTTP SERVER HOME/config/vmw009113022209/plugin-cfg.xml
4. Restart the cluster.
40
IBM Marketing Platform Installation Guide
Configure property to control the Scheduler in a clustered
environment
In a clustered environment, the various instances of the IBM EMM Scheduler
provided by Marketing Platform all run scheduling tasks, which can result in
conflicts. To prevent the conflict, disable the Scheduler on all nodes except one.
About this task
In the WebSphere administration console, set the
DISABLE_SCHEDULER_CLIENT_ON_CURRENT_NODE JVM parameter with the -D option in
all the nodes except one. this disables the Scheduler on the application server
clustered node.
For example: -DDISABLE_SCHEDULER_CLIENT_ON_CURRENT_NODE=true.
When you configure this JVM parameter on all nodes except one, then all the
scheduled jobs are run on the application server cluster node where this parameter
is not set.
Important: If the node where the Scheduler is enabled goes down, no scheduled
tasks run.
Configuring Marketing Platform logs in a cluster
You can generate logs for each node where you deploy Marketing Platform. You
can specify different logging levels for each node in your cluster.
You have two options for generating Marketing Platform logs for each node in the
cluster:
v Sharing the location where Marketing Platform is installed
v Setting Marketing Platform home in a Java parameter.
Both methods are described in this section.
Sharing the location where Marketing Platform is installed
Use this procedure to share the Marketing Platform installation location on all
nodes of the cluster.
Before you begin
To share the location, you must install Marketing Platform on a shared drive that is
accessible from all nodes.
Procedure
1. In the WebSphere administration console, add the
-DPLATFORM_LOG4J_PROPERTIES_FILE Java parameter in each node.
For example: -DPLATFORM_LOG4J_PROPERTIES_FILE=log4j_node1.properties
where log4j_node1.properties is a copy of the log4j.properties file.
Note: If XML logging is configured, then in the WebSphere administration
console, add the -DPLATFORM_LOG4J_XML_FILE Java parameter in each node.
Chapter 7. Installing Marketing Platform in a cluster
41
For example: -DPLATFORM_LOG4J_XML_FILE=log4j_node1.xml where
log4j_node1.xml is a copy of the log4j.xml file.
2. Use the following command to set the log file name in each node. Ensure that
the log file names are different so that it is easy to identify the file that is
generated from each node.
In the WebSphere administration console, add
-Dlog4j.appender.System.File=Log_File_Name
For example: -Dlog4j.appender.System.File=platform_node1.log.
Note: This property can be used in case of XML logging or properties file
logging.
3. Restart the cluster.
All the log files are created in the Platform/logs directory under your
Marketing Platform installation.
Setting Marketing Platform home in a Java parameter
Use this procedure to set the Marketing Platform home directory in a Java
parameter that points to the location where the logs are generated.
Procedure
1. Use the following command to specify the Java parameter in the WebSphere
administration console.
-DUNICA_PLATFORM_HOME=path_where_log_files_are_placed
For example: UNICA_PLATFORM_HOME=/opt/Platform
2. Create the following directories at the location you specified above: conf and
logs
3. Provide the write permission to the logs directory.
4. Copy the log4j.properties file to the conf directory.
The log4j.properties is located in the conf directory under the Marketing
Platform installation directory.
5. Replicate the Marketing Platform installation directory structure on all nodes of
the cluster, as follows.
a. Create a same directory structure on each node as far as the
PLATFORM_HOME/Platform/conf directory.
b. Create the logs directory in the PLATFORM_HOME/Platform directory, and
provide write permission to the logs directory.
c. Copy the log4j.properties file in the conf directory.
6. Restart the cluster.
Enabling single-user logging
If you have installed the Marketing Platform 10.0.0.1 FixPack, you can enable
single-user logging.
About this task
Logging is configured using one of two files: log4j.properties or log4j.xml. By
default, the log4j.properties file is used.
42
IBM Marketing Platform Installation Guide
If you have installed the Marketing Platform 10.0.0.1 FixPack, you can enable
per-user logging by configuring logging to use the XML file and then editing the
XML file. If Marketing Platform is configured in a cluster deployment, copy the
XML file to each node.
Note: With XML logging enabled, a thread is created that periodically checks if the
XML configuration file has been created or modified. If a change or file creation is
detected, then the XML file is read to configure log4j. The polling interval is 60
seconds.
Procedure
1. Configure logging to use log4j.xml by setting the following JVM parameter.
-DENABLE_PLATFORM_LOG4J_XML_LOGGING=true
The value must be set to true to enable per-user logging.
If Marketing Platform is configured in a cluster deployment, set this JVM
parameter in each node of the cluster.
2. To specify the user account to be logged in per-user logging, edit the log4j.xml
file as shown in the following example.
In the example, asm_admin is the user, but you can substitute any Marketing
Platform user name.
<filter class="com.unica.manager.logger.UserMatchFilter">
<param name="StringToMatch" value="asm_admin" />
</filter>
3. If Marketing Platform is configured in a cluster deployment, copy the edited
XML file to each node of the cluster.
You can use a command like the one shown in the following example.
-DPLATFORM_LOG4J_XML_FILE=log4j_node1.xml
The log4j_node1.xml file is a copy of the log4j.xml file. You can use any name
for the copied file.
Chapter 7. Installing Marketing Platform in a cluster
43
44
IBM Marketing Platform Installation Guide
Chapter 8. Marketing Platform utilities
This section provides an overview of the Marketing Platform utilities, including
some details that apply to all of the utilities and which are not included in the
individual utility descriptions.
Location of utilities
Marketing Platform utilities are located in the tools/bin directory under your
Marketing Platform installation.
List and descriptions of utilities
The Marketing Platform provides the following utilities.
v
“alertConfigTool” on page 47 - registers alerts and configurations for IBM
Marketing Software products
v
“configTool” on page 48 - imports, exports, and deletes configuration settings,
including product registrations
v
“datafilteringScriptTool” on page 52 - creates data filters
v
“encryptPasswords” on page 53 - encrypts and stores passwords
v
“partitionTool” on page 54 - creates database entries for partitions
v
“populateDb” on page 56 - populates the Marketing Platform database
v
“restoreAccess” on page 57 - restores a user with the platformAdminRole role
v “scheduler_console_client” on page 59 - lists or starts IBM Marketing Software
Scheduler jobs that are configured to listen for a trigger.
Prerequisites for running Marketing Platform utilities
The following are prerequisites for running all Marketing Platform utilities.
v Run all utilities from the directory where they are located (by default, the
tools/bin directory under your Marketing Platform installation).
v On UNIX, the best practice is to run the utilities with the same user account that
runs the application server on which Marketing Platform is deployed. If you run
a utility with a different user account, adjust the permissions on the
platform.log file to allow that user account to write to it. If you do not adjust
permissions, the utility is not able to write to the log file and you might see
some error messages, although the tool should still function correctly.
Authentication of utilities
Utilities such as configTool and other IBM Marketing Software back end utilities
are designed to be used by system administrators and require physical access to
the host servers for them to be invoked. For this reason, authentication for these
utilities has been designed to be independent of the UI authentication mechanism.
Access to these utilities is available to users with Marketing Platform administrator
privileges. Access to these utilities is expected to be locally defined in Marketing
Platform and authenticated against the same.
© Copyright IBM Corp. 1999, 2017
45
Troubleshooting connection issues
All of the Marketing Platform utilities except encryptPasswords interact with the
Marketing Platform system tables. To connect to the system table database, these
utilities use the following connection information, which is set by the installer
using information provided when the Marketing Platform was installed. This
information is stored in the jdbc.properties file, located in the tools/bin directory
under your Marketing Platform installation.
v JDBC driver name
v JDBC connection URL (which includes the host, port, and database name)
v Data source login
v Data source password (encrypted)
In addition, these utilities rely on the JAVA_HOME environment variable, set either in
the setenv script located in the tools/bin directory of your Marketing Platform
installation, or on the command line. The Marketing Platform installer should have
set this variable automatically in the setenv script, but it is a good practice to
verify that the JAVA_HOME variable is set if you have a problem running a utility.
The JDK must be the Sun version (not, for example, the JRockit JDK available with
WebLogic).
Special characters
Characters that are designated as reserved characters in the operating system must
be escaped. Consult your operating system documentation for a list of reserved
characters and how to escape them.
Standard options in Marketing Platform utilities
The following options are available in all Marketing Platform utilities.
-l logLevel
Set the level of log information displayed in the console. Options are high, medium,
and low. The default is low.
-L
Set the locale for console messages. The default locale is en_US. The available
option values are determined by the languages into which the Marketing Platform
has been translated. Specify the locale using the ICU locale ID according to ISO
639-1 and ISO 3166.
-h
Display a brief usage message in the console.
-m
Display the manual page for this utility in the console.
-v
Display more execution details in the console.
46
IBM Marketing Platform Installation Guide
Setting up Marketing Platform utilities on additional machines
On the machine where the Marketing Platform is installed, you can run the
Marketing Platform utilities without any additional configuration. However, you
might want to run the utilities from another machine on the network. This
procedure describes the steps required to do this.
Before you begin
Ensure that the machine on which you perform this procedure meets the following
prerequisites.
v The correct JDBC driver must exist on the machine or be accessible from it.
v The machine must have network access to the Marketing Platform system tables.
v The Java runtime environment must be installed on the machine or be accessible
from it.
Procedure
1. Gather the following information about the Marketing Platform system tables.
v The fully qualified path for the JDBC driver file or files on your system.
v The fully qualified path to an installation of the Java runtime environment.
The default value in the installer is the path to the supported version of the
JRE that the installer places under your IBM Marketing Software installation
directory. You can accept this default or specify a different path.
v Database type
v Database host
v Database port
v Database name/system ID
v Database user name
v Database password
2. Run the IBM Marketing Software installer and install the Marketing Platform.
Enter the database connection information that you gathered for the Marketing
Platform system tables. If you are not familiar with the IBM Marketing
Software installer, see the Campaign or Marketing Operations installation
guide.
You do not have to deploy the Marketing Platform web application if you are
installing the utilities only.
Marketing Platform utilities
This section describes the Marketing Platform utilities, with functional details,
syntax, and examples.
alertConfigTool
Notification types are specific to the various IBM Marketing Software products.
Use the alertConfigTool utility to register the notification types when the installer
has not done this automatically during installation or upgrade.
Syntax
alertConfigTool -i -f importFile
Chapter 8. Marketing Platform utilities
47
Commands
-i -f importFile
Import alert and notification types from a specified XML file.
Example
v Import alert and notification types from a file named
Platform_alerts_configuration.xml located in the tools\bin directory under
the Marketing Platform installation.
alertConfigTool -i -f Platform_alerts_configuration.xml
configTool
The properties and values on the Configuration page are stored in the Marketing
Platform system tables. You can use the configTool utility to import and export
configuration settings to and from the system tables.
When to use configTool
You might want to use configTool for the following reasons.
v To import partition and data source templates that are supplied with Campaign,
which you can then modify and duplicate by using the Configuration page.
v To register (import configuration properties for) IBM Marketing Software
products, if the product installer is unable to add the properties to the database
automatically.
v To export an XML version of configuration settings for backup or to import into
a different installation of IBM Marketing Software.
v To delete categories that do not have the Delete Category link. You do this by
using configTool to export your configuration, then manually deleting the XML
that creates the category, and by using configTool to import the edited XML.
Important: This utility modifies the usm_configuration and
usm_configuration_values tables in the Marketing Platform system table database,
which contains the configuration properties and their values. For best results,
either create backup copies of these tables, or export your existing configurations
by using configTool and back up the resulting file so you have a way to restore
your configuration if you make an error when you use configTool to import.
Syntax
configTool -d -p "elementPath" [-o]
configTool -i -p "parent ElementPath" -f importFile [-o]
configTool -x -p "elementPath" -f exportFile
configTool -vp -p "elementPath" -f importFile [-d]
configTool -r productName -f registrationFile [-o] configTool -u
productName
Commands
-d -p "elementPath" [o]
48
IBM Marketing Platform Installation Guide
Delete configuration properties and their settings, specifying a path in the
configuration property hierarchy.
The element path must use the internal names of categories and properties. You
can obtain them by going to the Configuration page, selecting the wanted category
or property, and looking at the path that is displayed in parentheses in the right
pane. Delimit a path in the configuration property hierarchy by using the |
character, and surround the path with double quotation marks.
Note the following.
v Only categories and properties within an application can be deleted by using
this command, not whole applications. Use the -u command to unregister a
whole application.
v To delete categories that do not have the Delete Category link on the
Configuration page, use the -o option.
When you use -d with the -vp command, the configTool deletes any child nodes in
the path you specify if those nodes are not included in the XML file you specify.
-i -p "parentElementPath" -f importFile [o]
Import configuration properties and their settings from a specified XML file.
To import, you specify a path to the parent element under which you want to
import your categories. The configTool utility imports properties under the
category you specify in the path.
You can add categories at any level below the top level, but you cannot add a
category at same level as the top category.
The parent element path must use the internal names of categories and properties.
You can obtain them by going to the Configuration page, selecting the required
category or property, and looking at the path that is displayed in parentheses in
the right pane. Delimit a path in the configuration property hierarchy by using the
| character, and surround the path with double quotation marks.
You can specify an import file location relative to the tools/bin directory or you
can specify a full directory path. If you specify a relative path or no path,
configTool first looks for the file relative to the tools/bin directory.
By default, this command does not overwrite an existing category, but you can use
the -o option to force an overwrite.
-x -p "elementPath" -f exportFile
Export configuration properties and their settings to an XML file with a specified
name.
You can export all configuration properties or limit the export to a specific category
by specifying a path in the configuration property hierarchy.
The element path must use the internal names of categories and properties, which
you can obtain by going to the Configuration page, selecting the wanted category
or property, and looking at the path that is displayed in parentheses in the right
Chapter 8. Marketing Platform utilities
49
pane. Delimit a path in the configuration property hierarchy by using the |
character, and surround the path with double quotation marks.
You can specify an export file location relative to the current directory or you can
specify a full directory path. If the file specification does not contain a separator (/
on UNIX, / or \ on Windows), configTool writes the file to the tools/bin
directory under your Marketing Platform installation. If you do not provide the
xml extension, configTool adds it.
-vp -p "elementPath" -f importFile [-d]
This command is used mainly in manual upgrades, to import configuration
properties. If you applied a fix pack that contains a new configuration property,
and you then upgrade, importing a configuration file as part of a manual upgrade
process can override values that were set when the fix pack was applied. The -vp
command ensures that the import does not override previously set configuration
values.
Important: After you use the configTool utility with the -vp option, you must
restart the web application server on which Marketing Platform is deployed so the
changes are applied.
When you use -d with the -vp command, the configTool deletes any child nodes in
the path you specify if those nodes are not included in the XML file you specify.
-r productName -f registrationFile
Register the application. The registration file location can be relative to the
tools/bin directory or can be a full path. By default, this command does not
overwrite an existing configuration, but you can use the -o option to force an
overwrite. The productName parameter must be one of those names that are listed
above.
Note the following.
v When you use the -r command, the registration file must have <application> as
the first tag in the XML.
Other files can be provided with your product that you can use to insert
configuration properties into the Marketing Platform database. For these files,
use the -i command. Only the file that has the <application> tag as the first tag
can be used with the -r command.
v The registration file for the Marketing Platform is named Manager_config.xml,
and the first tag is <Suite>. To register this file on a new installation, use the
populateDb utility, or rerun the Marketing Platform installer as described in the
IBM Marketing Platform Installation Guide.
v After the initial installation, to re-register products other than the Marketing
Platform, use configTool with the -r command and -o to overwrite the existing
properties.
The configTool utility uses product names as parameters with the commands that
register and unregister products. With the 8.5.0 release of IBM Marketing Software,
many product names changed. However, the names that are recognized by
configTool did not change. The valid product names for use with configTool are
listed below, along with the current names of the products.
50
IBM Marketing Platform Installation Guide
Table 14. Product names for configTool registration and unregistration
Product name
Name used in configTool
Marketing Platform
Manager
Campaign
Campaign
Distributed Marketing
Collaborate
eMessage
emessage
Interact
interact
Contact Optimization
Optimize
Marketing Operations
Plan
CustomerInsight
Insight
Digital Analytics for On Premises
NetInsight
Opportunity Detect
Detect
Leads
Leads
IBM SPSS Modeler Advantage Enterprise
Marketing Management Edition
SPSS
Digital Analytics
Coremetrics
-u productName
Unregister an application that is specified by productName. You do not have to
include a path to the product category; the product name is sufficient, and it is
required. The process removes all properties and configuration settings for the
product.
Options
-o
When used with -i or -r, it overwrites an existing category or product registration
(node).
When used with -d, you can delete a category (node) that does not have the
Delete Category link on the Configuration page.
Examples
v Import configuration settings from a file named Product_config.xml in the conf
directory under the Marketing Platform installation.
configTool -i -p "Affinium" -f Product_config.xml
v Import one of the supplied Campaign data source templates into the default
Campaign partition, partition1. The example assumes that you placed the Oracle
data source template, OracleTemplate.xml, in the tools/bin directory under the
Marketing Platform installation.
configTool -i -p "Affinium|Campaign|partitions|partition1|dataSources" -f
OracleTemplate.xml
v Export all configuration settings to a file named myConfig.xml in the D:\backups
directory.
configTool -x -f D:\backups\myConfig.xml
Chapter 8. Marketing Platform utilities
51
v Export an existing Campaign partition (complete with data source entries), save
it to a file named partitionTemplate.xml, and store it in the default tools/bin
directory under the Marketing Platform installation.
configTool -x -p "Affinium|Campaign|partitions|partition1" -f
partitionTemplate.xml
v Manually register an application named productName, by using a file named
app_config.xml in the default tools/bin directory under the Marketing Platform
installation, and force it to overwrite an existing registration of this application.
configTool -r product Name -f app_config.xml -o
v Unregister an application named productName.
configTool -u productName
datafilteringScriptTool
The datafilteringScriptTool utility reads an XML file to populate the data
filtering tables in the Marketing Platform system table database.
Depending on how you write the XML, you can use this utility in two ways.
v Using one set of XML elements, you can auto-generate data filters based on
unique combinations of field values (one data filter for each unique
combination).
v Using a slightly different set of XML elements, you can specify each data filter
that the utility creates.
See IBM Marketing Platform the Administrator's Guide for information about creating
the XML.
When to use datafilteringScriptTool
You must use datafilteringScriptTool when you create new data filters.
Prerequisites
The Marketing Platform must be deployed and running.
Using datafilteringScriptTool with SSL
When the Marketing Platform is deployed using one-way SSL you must modify
the datafilteringScriptTool script to add the SSL options that perform handshaking.
To modify the script, you must have the following information.
v Truststore file name and path
v Truststore password
In a text editor, open the datafilteringScriptTool script (.bat or .sh) and find the
lines that look like this (examples are Windows version).
:callexec
"%JAVA_HOME%\bin\java" -DUNICA_PLATFORM_HOME="%UNICA_PLATFORM_HOME%"
com.unica.management.client.datafiltering.tool.DataFilteringScriptTool %*
Edit these lines to look like this (new text is in bold). Substitute your truststore
path and file name and truststore password for myTrustStore.jks and myPassword.
52
IBM Marketing Platform Installation Guide
:callexec
SET SSL_OPTIONS=-Djavax.net.ssl.keyStoreType="JKS"
-Djavax.net.ssl.trustStore="C:\security\myTrustStore.jks"
-Djavax.net.ssl.trustStorePassword=myPassword
"%JAVA_HOME%\bin\java" -DUNICA_PLATFORM_HOME="%UNICA_PLATFORM_HOME%"
%SSL_OPTIONS%
com.unica.management.client.datafiltering.tool.DataFilteringScriptTool %*
Syntax
datafilteringScriptTool -r pathfile
Commands
-r path_file
Import data filter specifications from a specified XML file. If the file is not located
in the tools/bin directory under your installation, provide a path and enclose the
path_file parameter in double quotation marks.
Example
v Use a file named collaborateDataFilters.xml, located in the C:\unica\xml
directory, to populate the data filter system tables.
datafilteringScriptTool -r "C:\unica\xml\collaborateDataFilters.xml"
encryptPasswords
The encryptPasswords utility is used to encrypt and store either of two passwords
that Marketing Platform uses internally.
The two passwords that the utility can encrypt are as follows.
v The password that the Marketing Platform uses to access its system tables. The
utility replaces an existing encrypted password (stored in the jdbc,properties
file, located in the tools\bin directory under your Marketing Platform
installation) with a new one.
v The keystore password used by the Marketing Platform when it is configured to
use SSL with a certificate other than the default one supplied with the Marketing
Platform or the web application server. The certificate can be either a self-signed
certificate or a certificate from a certificate authority.
When to use encryptPasswords
Use encryptPasswords as for the following reasons.
v When you change the password of the account used to access your Marketing
Platform system table database.
v When you have created a self-signed certificate or have obtained one from a
certificate authority.
Chapter 8. Marketing Platform utilities
53
Prerequisites
v Before running encryptPasswords to encrypt and store a new database password,
make a backup copy of the jdbc.properties file, located in the tools/bin
directory under your Marketing Platform installation.
v Before running encryptPasswords to encrypt and store the keystore password,
you must have created or obtained a digital certificate and know the keystore
password.
Syntax
encryptPasswords -d databasePassword
encryptPasswords -k keystorePassword
Commands
-d databasePassword
Encrypt the database password.
-k keystorePassword
Encrypt the keystore password and store it in a file named pfile.
Examples
v When the Marketing Platformwas installed, the login for the system table
database account was set to myLogin. Now, some time after installation, you have
changed the password for this account to newPassword. Run encryptPasswords as
follows to encrypt and store the database password.
encryptPasswords -d newPassword
v You are configuring an IBM Marketing Software application to use SSL and have
created or obtained a digital certificate. Run encryptPasswords as follows to
encrypt and store the keystore password.
encryptPasswords -k myPassword
partitionTool
Partitions are associated with Campaign policies and roles. These policies and roles
and their partition associations are stored in the Marketing Platform system tables.
The partitionTool utility seeds the Marketing Platform system tables with basic
policy and role information for partitions.
When to use partitionTool
For each partition you create, you must use partitionTool to seed the Marketing
Platform system tables with basic policy and role information.
See the installation guide appropriate for your version of Campaign for detailed
instructions on setting up multiple partitions in Campaign.
Special characters and spaces
Any partition description or user, group, or partition name that contains spaces
must be enclosed in double quotation marks.
54
IBM Marketing Platform Installation Guide
Syntax
partitionTool -c -s sourcePartition -n newPartitionName [-u
admin_user_name] [-d partitionDescription] [-g groupName]
Commands
The following commands are available in the partitionTool utility.
-c
Replicates (clones) the policies and roles for an existing partition specified using
the -s option, and uses the name specified using the -n option. Both of these
options are required with c. This command does the following.
v Creates a new IBM Marketing Software user with the Admin role in both the
Administrative Roles policy and the global policy in Campaign. The partition
name you specify is automatically set as this user's password.
v Creates a new Marketing Platform group and makes the new Admin user a
member of that group.
v Creates a new partition object.
v Replicates all the policies associated with the source partition and associates
them with the new partition.
v For each replicated policy, replicates all roles associated with the policy.
v For each replicated role, maps all functions in the same way that they were
mapped in the source role.
v Assigns the new Marketing Platform group to the last system-defined Admin
role created during role replication. If you are cloning the default partition,
partition1, this role is the default Administrative Role (Admin).
Options
-d partitionDescription
Optional, used with -c only. Specifies a description that appears in the output from
the -list command. Must be 256 characters or less. Enclose in double quotation
marks if the description contains spaces.
-g groupName
Optional, used with -c only. Specifies the name of the Marketing Platform Admin
group that the utility creates. The name must be unique within this instance of
Marketing Platform
If not defined, the name defaults to partition_nameAdminGroup.
-n partitionName
Optional with -list, required with -c. Must be 32 characters or less.
When used with -list, specifies the partition whose information is listed.
When used with -c, specifies the name of the new partition, and the partition
name you specify is used as the password for the Admin user. The partition name
Chapter 8. Marketing Platform utilities
55
must match the name you gave the partition in when you configured it (using the
partition template on the Configuration page).
-s sourcePartition
Required, used with -c only. The name of the source partition to be replicated.
-u adminUserName
Optional, used with -c only. Specifies the user name of the Admin user for the
replicated partition. The name must be unique within this instance of Marketing
Platform.
If not defined, the name defaults to partitionNameAdminUser.
The partition name is automatically set as this user's password.
Examples
v Create a partition with the following characteristics.
– Cloned from partition1
– Partition name is myPartition
– Uses the default user name (myPartitionAdminUser) and password
(myPartition)
– Uses the default group name (myPartitionAdminGroup)
– Description is "ClonedFromPartition1"
partitionTool -c -s partition1 -n myPartition -d "ClonedFromPartition1"
v
Create a partition with the following characteristics.
– Cloned from partition1
– Partition name is partition2
– Specifies user name of customerA with the automatically assigned password of
partition2
– Specifies group name of customerAGroup
– Description is "PartitionForCustomerAGroup"
partitionTool -c -s partition1 -n partition2 -u customerA -g
customerAGroup -d "PartitionForCustomerAGroup"
populateDb
The populateDb utility inserts default (seed) data in the Marketing Platform system
tables.
The IBM Marketing Software installer can populate the Marketing Platform system
tables with default data for Marketing Platform and for Campaign. However, if
your company policy does not permit the installer to change the database, or if the
installer is unable to connect with the Marketing Platform system tables, you must
insert default data in the Marketing Platform system tables using this utility.
For Campaign, this data includes security roles and permissions for the default
partition. For Marketing Platform, this data includes default users and groups, and
security roles and permissions for the default partition.
56
IBM Marketing Platform Installation Guide
Syntax
populateDb -n productName
Commands
-n productName
Insert default data into the Marketing Platform system tables. Valid product names
are Manager (for Marketing Platform) and Campaign (for Campaign).
Examples
v Insert Marketing Platform default data manually.
populateDb -n Manager
v Insert Campaign default data manually.
populateDb -n Campaign
restoreAccess
The restoreAccess utility allows you to restore access to Marketing Platform if all
users with PlatformAdminRole privileges have been inadvertently locked out or if
all ability to log in to the Marketing Platform has been lost.
When to use restoreAccess
You might want to use restoreAccess under the two circumstances described in
this section.
PlatformAdminRole users disabled
It is possible that all users with PlatformAdminRole privileges in Marketing
Platform might become disabled in the system. Here is an example of how the
platform_admin user account might become disabled. Suppose you have only one
user with PlatformAdminRole privileges (the platform_admin user). Assume the
Maximum failed login attempts allowed property property in the General |
Password settings category on the Configuration page is set to 3. Then suppose
someone who is attempting to log in as platform_admin enters an incorrect
password three times in a row. These failed login attempts cause the
platform_admin account to become disabled in the system.
In that case, you can use restoreAccess to add a user with PlatformAdminRole
privileges to the Marketing Platform system tables without accessing the web
interface.
When you run restoreAccess in this way, the utility creates a user with the login
name and password you specify, and with PlatformAdminRole privileges.
If the user login name you specify exists in Marketing Platform as an internal user,
that user's password is changed.
Only a user with the login name of PlatformAdmin and with PlatformAdminRole
privileges can universally administer all dashboards. So if the platform_admin user
is disabled and you create a user with restoreAccess, you should create a user
with a login of platform_admin.
Chapter 8. Marketing Platform utilities
57
Improper configuration of NTLMv2 authentication
If you implement NTLMv2 authentication with improper configuration and can no
longer log in, use restoreAccess to restore the ability to log in.
When you run restoreAccess in this way, the utility changes the value of the
Platform | Security | Login method property to Marketing Platform. This change
allows you to log in with any user account that existed before you were locked
out. You can optionally specify a new login name and password as well. You must
restart the web application server on which Marketing Platform is deployed if you
use the restoreAccess utility in this way.
Password considerations
Note the following about passwords when you use restoreAccess.
v The restoreAccess utility does not support blank passwords, and does not
enforce password rules.
v If you specify a user name that is in use, the utility resets the password for that
user.
Syntax
restoreAccess -u loginName -p password
restoreAccess -r
Commands
-r
When used without the -u loginName option, reset the value of the Platform |
Security | Login method property to Marketing Platform. Requires restart of the
web application server to take effect.
When used with the -u loginName option, create a PlatformAdminRole user.
Options
-u loginNname
Create a user with PlatformAdminRole privileges with the specified login name.
Must be used with the -p option.
-p password
Specify the password for the user being created. Required with -u.
Examples
v Create a user with PlatformAdminRole privileges. The login name is tempUser
and the password is tempPassword.
restoreAccess -u tempUser -p tempPassword
v Change the value of the login method to IBM Marketing Platform and create a
user with PlatformAdminRole privileges. The login name is tempUser and the
password is tempPassword.
58
IBM Marketing Platform Installation Guide
restoreAccess -r -u tempUser -p tempPassword
scheduler_console_client
Jobs configured in the IBM Marketing Software Scheduler can be listed and kicked
off by this utility, if they are set up to listen for a trigger.
What to do if SSL is enabled
When the Marketing Platform web application is configured to use SSL, the JVM
used by the scheduler_console_client utility must use the same SSL certificate
that is used by the web application server on which the Marketing Platform is
deployed.
Take the following steps to import the SSL certificate
v Determine the location of the JRE used by the scheduler_console_client.
– If JAVA_HOME is set as a system environment variable, the JRE it points to is
the one used by the scheduler_console_client utility.
– If JAVA_HOME is not set as a system environment variable, the
scheduler_console_client utility uses the JRE set either in the setenv script
located in the tools/bin directory of your Marketing Platform installation, or
on the command line.
v Import the SSL certificate used by the web application server on which the
Marketing Platform is deployed to the JRE used by scheduler_console_client.
The Sun JDK includes a program called keytool that you can use to import the
certificate. Consult the Java documentation for complete details on using this
program, or access the help by entering -help when you run the program.
v Open the tools/bin/schedulerconsoleclient file in a text editor and add the
following properties. These differ depending on the web application server on
which Marketing Platform is deployed.
– For WebSphere, add these properties to the file.
-Djavax.net.ssl.keyStoreType=JKS
-Djavax.net.ssl.keyStore="Path to your key store JKS file"
-Djavax.net.ssl.keyStorePassword="Your key store password"
-Djavax.net.ssl.trustStore="Path to your trust store JKS file"
-Djavax.net.ssl.trustStorePassword="Your trust store password"
-DisUseIBMSSLSocketFactory=false
– For WebLogic, add these properties to the file.
-Djavax.net.ssl.keyStoreType="JKS"
-Djavax.net.ssl.trustStore="Path to your trust store JKS file"
-Djavax.net.ssl.trustStorePassword="Your trust store password"
If the certificates do not match, the Marketing Platform log file contains an error
such as the following.
Caused by: sun.security.provider.certpath.SunCertPathBuilderException:
unable to find valid certification path to requested target
Prerequisites
The Marketing Platform must be installed, deployed, and running.
Chapter 8. Marketing Platform utilities
59
Syntax
scheduler_console_client -v -t trigger_name user_name
scheduler_console_client -s -t trigger_name user_name
Commands
-v
List the scheduler jobs configured to listen for the specified trigger.
Must be used with the -t option.
-s
Send the specified trigger.
Must be used with the -t option.
Options
-t trigger_name
The name of the trigger, as configured in the scheduler.
Example
v List jobs configured to listen for a trigger named trigger1.
scheduler_console_client -v -t trigger1 myLogin
v Execute jobs configured to listen for a trigger named trigger1.
scheduler_console_client -s -t trigger1 myLogin
60
IBM Marketing Platform Installation Guide
Chapter 9. Marketing Platform SQL scripts
This section describes the SQL scripts provided with Marketing Platform to
perform various tasks relating to the Marketing Platform system tables.
The Marketing Platform SQL scripts are located in the db directory under your
Marketing Platform installation.
The scripts are designed to be run against the Marketing Platform system tables,
using the database client.
ManagerSchema_DeleteAll.sql
The Manager_Schema_DeleteAll.sql script removes all data from the Marketing
Platform system tables without removing the tables themselves. This script
removes all users, groups, security credentials, data filters, and configuration
settings from Marketing Platform.
When to use ManagerSchema_DeleteAll.sql
You might want to use ManagerSchema_DeleteAll.sql if corrupted data prevents
you from using an instance of Marketing Platform.
Additional requirements
To make Marketing Platform operational after running
ManagerSchema_DeleteAll.sql , you must perform the following steps.
v Run the populateDB utility. The populateDB utility restores the default
configuration properties, users, roles, and groups, but does not restore any users,
roles, and groups you have created or imported after initial installation.
v Use the configTool utility with the config_navigation.xml file to import menu
items.
v If you have performed any post-installation configuration, such as creating data
filters or integrating with an LDAP server or web access control platform, you
must perform these configurations again.
v If you want to restore previously existing data filters, run the
datafilteringScriptTool utility using the XML originally created to specify the
data filters.
ManagerSchema_PurgeDataFiltering.sql
The ManagerSchema_PurgeDataFiltering.sql script removes all data filtering data
from the Marketing Platform system tables without removing the data filter tables
themselves. This script removes all data filters, data filter configurations,
audiences, and data filter assignments from Marketing Platform.
When to use ManagerSchema_PurgeDataFiltering.sql
You might want to use ManagerSchema_PurgeDataFiltering.sql if you need to
remove all data filters without removing other data in the Marketing Platform
system tables.
© Copyright IBM Corp. 1999, 2017
61
Important: The ManagerSchema_PurgeDataFiltering.sql script does not reset the
values of the two data filter properties, Default table name and Default audience
name. If these values are no longer valid for the data filters you want to use, you
must set the values manually on the Configuration page.
SQL scripts for creating system tables
Use the scripts described in the following table to create Marketing Platform
system tables manually, when your company policy does not allow you to use the
installer to create them automatically.
The scripts are shown in the order in which you must run them.
Table 15. Scripts for creating system tables
Datasource Type
IBM DB2
Microsoft SQL Server
Oracle
Script Names
v
ManagerSchema_DB2.sql
If you plan to support multi-byte characters (for example,
Chinese, Japanese, or Korean), use the
ManagerSchema_DB2_unicode.sql script.
v
ManagerSchema__DB2_CeateFKConstraints.sql
v
active_portlets.sql
v
ManagerSchema_SqlServer.sql
v
ManagerSchema__SqlServer_CeateFKConstraints.sql
v
active_portlets.sql
v
ManagerSchema_Oracle.sql
v
ManagerSchema__Oracle_CeateFKConstraints.sql
v
active_portlets.sql
If you plan to use the scheduler feature that enables you to configure a flowchart
to run at predefined intervals, you must also create the tables that support this
feature. To create the scheduler tables, run the appropriate script, as described in
the following table.
Table 16. Scripts for enabling the IBM Marketing Software Scheduler
Data Source Type
Script Name
IBM DB2
quartz_db2.sql
Microsoft SQL Server
quartz_sqlServer.sql
Oracle
quartz_oracle.sql
When to use the create system tables scripts
You must use these scripts when you install or upgrade Marketing Platform if you
have not allowed the installer to create the system tables automatically, or if you
have used ManagerSchema_DropAll.sql to delete all Marketing Platform system
tables from your database.
62
IBM Marketing Platform Installation Guide
ManagerSchema_DropAll.sql
The ManagerSchema_DropAll.sql script removes all Marketing Platform system
tables from a database. This script removes all tables, users, groups, security
credentials, and configuration settings from Marketing Platform.
Note: If you run this script against a database containing an earlier version of the
Marketing Platform system tables, you might receive error messages in your
database client stating that constraints do not exist. You can safely ignore these
messages.
When to use ManagerSchema_DropAll.sql
You might want to use ManagerSchema_DropAll.sql if you have uninstalled an
instance of Marketing Platform where the system tables are in a database that
contains other tables you want to continue using.
Additional requirements
To make the Marketing Platform operational after running this script, you must
perform the following steps.
v Run the appropriate SQL script to re-create the system tables.
v Run the populateDB utility. Running the populateDB utility restores the default
configuration properties, users, roles, and groups, but does not restore any users,
roles, and groups you have created or imported after initial installation.
v Use the configTool utility with the config_navigation.xml file to import menu
items.
v If you have performed any post-installation configuration, such as creating data
filters or integrating with an LDAP server or web access control platform, you
must perform these configurations again.
Chapter 9. Marketing Platform SQL scripts
63
64
IBM Marketing Platform Installation Guide
Chapter 10. Uninstalling Marketing Platform
Run the Marketing Platform uninstaller to uninstall Marketing Platform. When you
run the Marketing Platform uninstaller, the files that were created during the
installation process are removed. For example, files such as configuration files,
installer registry information, and user data are removed from the computer.
About this task
When you install IBM Marketing Software products, an uninstaller is included in
the Uninstall_Product directory, where Product is the name of your IBM product.
On Windows, an entry is also added to the Add or Remove Programs list in the
Control Panel.
If you manually remove the files in your installation directory instead of running
the uninstaller, the result might be an incomplete installation if you later reinstall
an IBM product in the same location. After uninstalling a product, its database is
not removed. The uninstaller only removes default files that are created during
installation. Any file that is created or generated after installation is not removed.
Note: On UNIX, the same user account that installed Marketing Platform must run
the uninstaller.
Procedure
1. If you have deployed the Marketing Platform web application, undeploy the
web application from WebSphere or WebLogic.
2. Shut down WebSphere or WebLogic.
3. Stop the processes that are related to Marketing Platform.
4. If the ddl directory exists in the product installation directory, run the scripts
that are provided in the ddl directory to drop tables from the system table
database.
5. Complete one of the following steps to uninstall Marketing Platform:
v Click the Marketing Platform uninstaller that exists in the Uninstall_Product
directory. The uninstaller runs in the mode in which you installed Marketing
Platform.
v In a command-line window, navigate to the directory where the uninstaller
exists, and run the following command to uninstall Marketing Platform by
using the console mode:
Uninstall_Product -i console
v In a command-line window, navigate to the directory where the uninstaller
exists, and run the following command to uninstall Marketing Platform by
using the silent mode:
Uninstall_Product -i silent
When you uninstall Marketing Platform by using the silent mode, the
uninstallation process does not present any dialogs for user interaction.
Note: If you do not specify an option for uninstalling Marketing Platform, the
Marketing Platform uninstaller runs in the mode in which Marketing Platform
is installed.
© Copyright IBM Corp. 1999, 2017
65
66
IBM Marketing Platform Installation Guide
Before you contact IBM technical support
If you encounter a problem that you cannot resolve by consulting the
documentation, your company's designated support contact can log a call with
IBM technical support. Use these guidelines to ensure that your problem is
resolved efficiently and successfully.
If you are not a designated support contact at your company, contact your IBM
administrator for information.
Note: Technical Support does not write or create API scripts. For assistance in
implementing our API offerings, contact IBM Professional Services.
Information to gather
Before you contact IBM technical support, gather the following information:
v A brief description of the nature of your issue.
v Detailed error messages that you see when the issue occurs.
v Detailed steps to reproduce the issue.
v Related log files, session files, configuration files, and data files.
v Information about your product and system environment, which you can obtain
as described in "System information."
System information
When you call IBM technical support, you might be asked to provide information
about your environment.
If your problem does not prevent you from logging in, much of this information is
available on the About page, which provides information about your installed IBM
applications.
You can access the About page by selecting Help > About. If the About page is not
accessible, check for a version.txt file that is located under the installation
directory for your application.
Contact information for IBM technical support
For ways to contact IBM technical support, see the IBM Product Technical Support
website: (http://www.ibm.com/support/entry/portal/open_service_request).
Note: To enter a support request, you must log in with an IBM account. This
account must be linked to your IBM customer number. To learn more about
associating your account with your IBM customer number, see Support Resources
> Entitled Software Support on the Support Portal.
© Copyright IBM Corp. 1999, 2017
67
68
IBM Marketing Platform Installation Guide
Notices
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
Intellectual Property Licensing
Legal and Intellectual Property Law
IBM Japan, Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law: INTERNATIONAL
BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE. Some states do not allow disclaimer of express or implied warranties in
certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors.
Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
© Copyright IBM Corp. 1999, 2017
69
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose
of enabling: (i) the exchange of information between independently created
programs and other programs (including this one) and (ii) the mutual use of the
information which has been exchanged, should contact:
IBM Corporation
B1WA LKG1
550 King Street
Littleton, MA 01460-1250
U.S.A.
Such information may be available, subject to appropriate terms and conditions,
including in some cases, payment of a fee.
The licensed program described in this document and all licensed material
available for it are provided by IBM under terms of the IBM Customer Agreement,
IBM International Program License Agreement or any equivalent agreement
between us.
Any performance data contained herein was determined in a controlled
environment. Therefore, the results obtained in other operating environments may
vary significantly. Some measurements may have been made on development-level
systems and there is no guarantee that these measurements will be the same on
generally available systems. Furthermore, some measurements may have been
estimated through extrapolation. Actual results may vary. Users of this document
should verify the applicable data for their specific environment.
Information concerning non-IBM products was obtained from the suppliers of
those products, their published announcements or other publicly available sources.
IBM has not tested those products and cannot confirm the accuracy of
performance, compatibility or any other claims related to non-IBM products.
Questions on the capabilities of non-IBM products should be addressed to the
suppliers of those products.
All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.
All IBM prices shown are IBM's suggested retail prices, are current and are subject
to change without notice. Dealer prices may vary.
This information contains examples of data and reports used in daily business
operations. To illustrate them as completely as possible, the examples include the
names of individuals, companies, brands, and products. All of these names are
fictitious and any similarity to the names and addresses used by an actual business
enterprise is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which
illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
70
IBM Marketing Platform Installation Guide
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs. The sample
programs are provided "AS IS", without warranty of any kind. IBM shall not be
liable for any damages arising out of your use of the sample programs.
If you are viewing this information softcopy, the photographs and color
illustrations may not appear.
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at "Copyright and
trademark information" at www.ibm.com/legal/copytrade.shtml.
Privacy Policy and Terms of Use Considerations
IBM Software products, including software as a service solutions, ("Software
Offerings") may use cookies or other technologies to collect product usage
information, to help improve the end user experience, to tailor interactions with
the end user or for other purposes. A cookie is a piece of data that a web site can
send to your browser, which may then be stored on your computer as a tag that
identifies your computer. In many cases, no personal information is collected by
these cookies. If a Software Offering you are using enables you to collect personal
information through cookies and similar technologies, we inform you about the
specifics below.
Depending upon the configurations deployed, this Software Offering may use
session and persistent cookies that collect each user's user name, and other
personal information for purposes of session management, enhanced user usability,
or other usage tracking or functional purposes. These cookies can be disabled, but
disabling them will also eliminate the functionality they enable.
Various jurisdictions regulate the collection of personal information through
cookies and similar technologies. If the configurations deployed for this Software
Offering provide you as customer the ability to collect personal information from
end users via cookies and other technologies, you should seek your own legal
advice about any laws applicable to such data collection, including any
requirements for providing notice and consent where appropriate.
IBM requires that Clients (1) provide a clear and conspicuous link to Customer's
website terms of use (e.g. privacy policy) which includes a link to IBM's and
Client's data collection and use practices, (2) notify that cookies and clear gifs/web
beacons are being placed on the visitor's computer by IBM on the Client's behalf
along with an explanation of the purpose of such technology, and (3) to the extent
required by law, obtain consent from website visitors prior to the placement of
cookies and clear gifs/web beacons placed by Client or IBM on Client's behalf on
website visitor's devices
For more information about the use of various technologies, including cookies, for
these purposes, See IBM's Online Privacy Statement at: http://www.ibm.com/
privacy/details/us/en section entitled "Cookies, Web Beacons and Other
Technologies."
Notices
71
72
IBM Marketing Platform Installation Guide
IBM®
Printed in USA
Download PDF
Similar pages