50
IBM Contact Optimization Version 9 Release 1.1 November 26, 2014 Installation Guide

IBM Contact Optimization: Installation Guide

  • Upload
    others

  • View
    12

  • Download
    0

Embed Size (px)

Citation preview

Page 1: IBM Contact Optimization: Installation Guide

IBM Contact OptimizationVersion 9 Release 1.1November 26, 2014

Installation Guide

���

Page 2: IBM Contact Optimization: Installation Guide

NoteBefore using this information and the product it supports, read the information in “Notices” on page 41.

This edition applies to version 9, release 1, modification 1 of IBM Contact Optimization and to all subsequentreleases and modifications until otherwise indicated in new editions.

© Copyright IBM Corporation 2003, 2014.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Page 3: IBM Contact Optimization: Installation Guide

Contents

Chapter 1. Installation overview . . . . 1Installation roadmap. . . . . . . . . . . . 1How the installers work . . . . . . . . . . 2Modes of installation . . . . . . . . . . . 3Contact Optimization documentation and help . . . 3

Chapter 2. Planning the ContactOptimization installation. . . . . . . . 5Prerequisites . . . . . . . . . . . . . . 5Contact Optimization installation worksheet . . . . 7Installation order for IBM EMM products. . . . . 9

Chapter 3. Installing ContactOptimization . . . . . . . . . . . . 11Installing Contact Optimization by using the GUImode . . . . . . . . . . . . . . . . 11

Contact Optimization and EAR and WAR files . 16Installing Contact Optimization using the consolemode . . . . . . . . . . . . . . . . 16Installing Contact Optimization silently . . . . . 17

Sample response files . . . . . . . . . . 18

Chapter 4. Configuring ContactOptimization . . . . . . . . . . . . 21Creating and populating the Contact Optimizationsystem tables manually . . . . . . . . . . 21Registering Contact Optimization manually . . . 21Setting the Contact Optimization configurationproperties manually . . . . . . . . . . . 22Configuring the ACOOptAdmin tool . . . . . . 22

Configuring Contact Optimization for Chinese,Japanese, or Korean users . . . . . . . . . 23Starting the Contact Optimization server . . . . 23Mapping tables for Contact Optimization . . . . 24

Contact Optimization system table mappingreference . . . . . . . . . . . . . . 24Contact Optimization contact history tablemapping reference . . . . . . . . . . . 25

Verifying the Contact Optimization installation . . 25

Chapter 5. Configuring multiplepartitions for Contact Optimization . . 27How multiple partitions work . . . . . . . . 27Setting up multiple partitions for ContactOptimization . . . . . . . . . . . . . . 28Configuring ACOServer for multiple partitions . . 28

Chapter 6. Uninstalling ContactOptimization . . . . . . . . . . . . 31

Chapter 7. configTool . . . . . . . . 33

Before you contact IBM technicalsupport . . . . . . . . . . . . . . 39

Notices . . . . . . . . . . . . . . 41Trademarks . . . . . . . . . . . . . . 43Privacy Policy and Terms of Use Considerations . . 43

© Copyright IBM Corp. 2003, 2014 iii

Page 4: IBM Contact Optimization: Installation Guide

iv IBM Contact Optimization: Installation Guide

Page 5: IBM Contact Optimization: Installation Guide

Chapter 1. Installation overview

An installation of Contact Optimization is complete when you install and configureContact Optimization. The Contact Optimization Installation Guide providesdetailed information about installing and configuring Contact Optimization.

Use the Installation Roadmap section to obtain a broad understanding about usingthe Contact Optimization Installation Guide.

Installation roadmapUse the installation roadmap to quickly find the information that you need forinstalling Contact Optimization.

You can use the following table to scan the tasks that must be completed forinstalling Contact Optimization:

Table 1. Contact Optimization installation roadmap

Topic Information

Chapter 1, “Installation overview” This chapter provides the followinginformation:

v “How the installers work” on page 2

v “Modes of installation” on page 3

v “Contact Optimization documentation andhelp” on page 3

Chapter 2, “Planning the ContactOptimization installation,” on page 5

This chapter provides the followinginformation:

v “Prerequisites” on page 5

v “Contact Optimization installationworksheet” on page 7

v “Installation order for IBM EMMproducts” on page 9

Chapter 3, “Installing Contact Optimization,”on page 11

This chapter provides the followinginformation:

v “Installing Contact Optimization by usingthe GUI mode” on page 11

v “Installing Contact Optimization using theconsole mode” on page 16

v “Installing Contact Optimization silently”on page 17

© Copyright IBM Corp. 2003, 2014 1

Page 6: IBM Contact Optimization: Installation Guide

Table 1. Contact Optimization installation roadmap (continued)

Topic Information

Chapter 4, “Configuring ContactOptimization,” on page 21

This chapter provides the followinginformation:

v “Creating and populating the ContactOptimization system tables manually” onpage 21

v “Registering Contact Optimizationmanually” on page 21

v “Setting the Contact Optimizationconfiguration properties manually” onpage 22

v “Configuring the ACOOptAdmin tool” onpage 22

v “Configuring Contact Optimization forChinese, Japanese, or Korean users” onpage 23

v “Starting the Contact Optimization server”on page 23

v “Mapping tables for ContactOptimization” on page 24

v “Verifying the Contact Optimizationinstallation” on page 25

Chapter 5, “Configuring multiple partitionsfor Contact Optimization,” on page 27

This chapter provides the followinginformation:

v “How multiple partitions work” on page27

v “Setting up multiple partitions for ContactOptimization” on page 28

v “Configuring ACOServer for multiplepartitions” on page 28

Chapter 6, “Uninstalling ContactOptimization,” on page 31

This chapter provides information abouthow to uninstall Contact Optimization.

Chapter 7, “configTool,” on page 33 This chapter provides information abouthow to use the configTool utility.

How the installers workYou must use the suite installer and the product installer when you install orupgrade any IBM® EMM product. For example, for installing ContactOptimization, you must use the IBM EMM suite installer and the IBM ContactOptimization installer.

Make sure that you use the following guidelines before you use the IBM EMMsuite 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 aproduct installer are present in the directory with the master installer, the masterinstaller always shows the latest version of the product on the IBM EMMProducts screen in the installation wizard.

2 IBM Contact Optimization: Installation Guide

Page 7: IBM Contact Optimization: Installation Guide

v If you are planning to install a patch immediately after you install an IBM EMMproduct, make sure that the patch installer is in the same directory as that of thesuite and product installers.

v The default top-level directory for IBM EMM installations is /IBM/EMM for UNIXor C:\IBM\EMM for Windows. However, you can change the directory duringinstallation.

Modes of installationThe IBM EMM suite installer can run in one of the following modes: GUI mode,console mode, or silent mode (also called the unattended mode). Select a modethat suits your requirements when you install Contact Optimization.

GUI mode

Use the GUI mode for Windows or the X Window System mode for UNIX toinstall Contact Optimization by using the graphical user interface.

Console mode

Use the console mode to install Contact Optimization by using the command-linewindow.

Note: To display the Installer screens correctly in console mode, configure yourterminal software to support UTF-8 character encoding. Other character encoding,such as ANSI, will not render the text correctly, and some information will not bereadable.

Silent mode

Use the silent or unattended mode to install Contact Optimization multiple times.The silent mode uses response files for installation, and does not require user inputduring the installation process.

Contact Optimization documentation and helpContact Optimization provides documentation and help for users, administrators,and developers.

Use the following table to get information about how to get started with ContactOptimization:

Table 2. Get up and running

Task Documentation

View a list of new features, known issues,and workarounds

IBM Contact Optimization Release Notes

Learn about the structure of the ContactOptimization database

Contact Optimization System Tables and DataDictionary

Install or upgrade Contact Optimization One of the following guides:

v IBM Contact Optimization Installation Guide

v IBM Contact Optimization Upgrade Guide

Use the following table to get information about how to configure and use ContactOptimization:

Chapter 1. Installation overview 3

Page 8: IBM Contact Optimization: Installation Guide

Table 3. Configure and use Contact Optimization

Task Documentation

v Create Contact Optimization sessions

v Configure the Contact Optimizationprocess

v Use optimized contacts in marketingcampaigns

IBM Contact Optimization User's Guide

Use the following table to get information about how to get help if you face issueswhen you use Contact Optimization:

Table 4. Get help

Task Instructions

v Troubleshoot Contact Optimizationinstallation errors

v Troubleshoot Contact Optimizationsession errors

v Improve Contact Optimizationperformance

IBM Contact Optimization TroubleshootingGuide

Open online help 1. Choose Help > Help for this page toopen a context-sensitive help topic.

2. Click the Show Navigation icon in thehelp window to display the full help.

Obtain PDFs Use either of the following methods:

v Choose Help > Product Documentationto access Contact Optimization PDFs.

v Choose Help > All IBM EMM SuiteDocumentation to access all availabledocumentation.

Get support Go to http://www.ibm.com/support toaccess the IBM Support Portal.

4 IBM Contact Optimization: Installation Guide

Page 9: IBM Contact Optimization: Installation Guide

Chapter 2. Planning the Contact Optimization installation

When you plan your Contact Optimization installation, you must ensure that youhave set up your system correctly, and that you have configured your environmentto deal with any failures.

PrerequisitesBefore you install or upgrade any IBM EMM product, you must ensure that yourcomputer complies with all the prerequisite software and hardware.

System requirements

For information about system requirements, see the Recommended SoftwareEnvironments and Minimum System Requirements guide.

Network domain requirements

The IBM EMM products that are installed as a suite must be installed on the samenetwork domain to comply with the browser restrictions that are designed to limitthe security risks that can occur with cross-site scripting.

Important: For best performance, install Contact Optimization on its own system,where no other IBM EMM products are installed. Contact Optimization requiressignificant computation and data processing resources. You have the greatestcontrol and flexibility for performance-tuning if you operate Contact Optimizationin a dedicated environment.

JVM requirements

IBM EMM applications within a suite must be deployed on a dedicated Java™™

virtual machine (JVM). IBM EMM products customize the JVM that is used by theweb application server. If you encounter errors that are related to the JVM, youmust create an Oracle WebLogic or WebSphere® domain that is dedicated to theIBM EMM products.

Knowledge requirements

To install IBM EMM products, you must have a thorough knowledge of theenvironment in which the products are installed. This knowledge includesknowledge about operating systems, databases, and web application servers.

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 theinstallation tasks:

© Copyright IBM Corp. 2003, 2014 5

Page 10: IBM Contact Optimization: Installation Guide

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 andIBM EMM components

v Write permission for all files that you must editv Write permission for all directories where you must save a file, such as the

installation directory and backup directory if you are upgradingv Appropriate read/write/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, forexample, rwxr-xr-x.

JAVA_HOME environment variable

If a JAVA_HOME environment variable is defined on the computer where you installan IBM EMM product, verify that the variable points to a supported version ofJRE. For information about system requirements, see the Recommended SoftwareEnvironments and Minimum System Requirements guide.

Make sure that the JAVA_HOME environment variable points to JRE 1.7. If theJAVA_HOME environment variable points to an incorrect JRE, you must clear theJAVA_HOME variable before you run the IBM EMM installers.

You can clear the JAVA_HOME environment variable by using one of the followingmethods: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.

export JAVA_HOME= (leave empty)

After the environment variable is cleared, the IBM EMM installers use the JRE thatis bundled with the installers. You can reset the environment variable after theinstallation is complete.

Marketing Platform requirement

You must install or upgrade Marketing Platform before you install or upgrade anyIBM EMM products. For each group of products that work together, you mustinstall or upgrade Marketing Platform only once. Each product installer checkswhether the required products are installed. If your product or version is notregistered with Marketing Platform, a message prompts you to install or upgradeMarketing Platform before you proceed with your installation. Marketing Platformmust be deployed and running before you can set any properties on the Settings >Configuration page.

Campaign requirement

You must install or upgrade and configure Campaign before you install or upgradeContact Optimization.

6 IBM Contact Optimization: Installation Guide

Page 11: IBM Contact Optimization: Installation Guide

Note: For installations on UNIX, you might need to set the Djava.awt.headlessproperty to true in your web application server. The setting is required only whenyou are unable to view Contact Optimization reports. See the IBM CampaignInstallation Guide for details.

You do not need to prepare any additional data sources for Contact Optimizationbecause Contact Optimization uses the Campaign system tables data source.

Contact Optimization installation worksheetUse the Contact Optimization installation worksheet to gather information aboutthe database that contains your Contact Optimization system tables and aboutother IBM EMM products that are required for the installation of ContactOptimization.

Campaign database information

The installation wizard for Contact Optimization needs to communicate with yourCampaign system table database to create the Contact Optimization tables. Youmust collect the following information about your Campaign installation to enablethe installer to set up the Contact Optimization database tables and configureContact Optimization:

Table 5. Campaign database information worksheet

Database information Notes

Check if Campaign database is configuredfor Unicode

Campaign database type

If the database type is DB2® and is installedon a UNIX system, note DB2 instance path.

If the database type is Oracle, note theOracle home directory path.

Campaign database host name

Campaign database port

Campaign database name

User name for the Campaign databaseaccount

Password for the Campaign databaseaccount

JDBC connection URL to the Campaigndatabase

The installer provides the connection URLbased on the values you provide. However,you must confirm that the URL is correct.

The name of the system on which theCampaign web application server isinstalled.

The port on which the Campaign applicationserver listens.

If you plan to implement SSL, obtain theSSL port.

Chapter 2. Planning the Contact Optimization installation 7

Page 12: IBM Contact Optimization: Installation Guide

Table 5. Campaign database information worksheet (continued)

Database information Notes

The network domain for your deploymentsystem.

Note: If you have Contact Optimization and Campaign on separate systems, youdo not need to mount the Campaign directory for your Campaign installation as anetwork drive on the system that hosts Contact Optimization. Make sure thatCAMPAIGN_HOME is pointing to OPTIMIZE_HOME in ACOServer.bat/.sh. This variable isretained for compatibility purposes and is set to OPTIMIZE_HOME. Do not alter thevalue of this variable.

Marketing Platform database information

The Contact Optimization installation wizard must be able to communicate withthe Marketing Platform system table database to register the product. Each timethat you run the installer, you must enter the following database connectioninformation for the Marketing Platform system table database:v Database typev Database host namev Database portv Database name or schema IDv User name and password for the database accountv JDBC connection URL to the Marketing Platform database. The installer provides

the connection URL based on the values you provide. However, you mustconfirm that the URL is correct.

If you want the installer to create the system tables, you must provide informationthat enables the installer to connect to the product database. If you want to createthe system tables manually, you must use your database client to run the SQLscripts that are provided with your product installation.

Information about the web component

Obtain the following information for all IBM EMM products that have a webcomponent, 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 EMMenvironment 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, example.com.

IBM Site ID

If you are installing an IBM EMM product in one of the countries listed on theCountry for Install screen of your product installer, you must enter your IBM SiteID in the space provided. Your IBM Site ID can be found on one of the followingdocuments:v IBM Welcome letterv Tech Support Welcome letter

8 IBM Contact Optimization: Installation Guide

Page 13: IBM Contact Optimization: Installation Guide

v Proof of Entitlement letterv Other communications that are sent when you purchase your software

IBM might use the data that is provided by the software to better understand howcustomers use our products and to improve customer support. The data that isgathered does not include any information that identifies individuals. Completethe following actions if you do not want to have such information to be collected:1. After Marketing Platform is installed, log in 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 EMM productsWhen you install or upgrade multiple IBM EMM products, you must install orupgrade them in a specific order.

The following table provides information about the order that you must followwhen you install or upgrade multiple IBM EMM products:

Table 6. Installation or upgrade order for IBM EMM products

Product Installation or upgrade order

Campaign (with or withouteMessage)

1. Marketing Platform

2. Campaign

Note: eMessage is installed automatically when you install Campaign.However, eMessage is not configured or enabled during the Campaigninstallation 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 followingorder:

1. Marketing Platform

2. Campaign

3. Interact Design Time environment

If you want to install or upgrade the Interact runtime environment only, theninstall 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 theInteract Extreme Scale Server in the following order:

1. Marketing Platform

2. Interact Run Time environment

3. Interact Extreme Scale Server

Chapter 2. Planning the Contact Optimization installation 9

Page 14: IBM Contact Optimization: Installation Guide

Table 6. Installation or upgrade order for IBM EMM products (continued)

Product Installation or upgrade order

Marketing Operations 1. Marketing Platform

2. Marketing Operations

Note: If you are integrating Marketing Operations with Campaign, you mustalso install Campaign. The order of installation for those two products doesnot 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

If Opportunity Detect is integrated with Interact, install the products in thefollowing order:

1. Marketing Platform

2. Campaign

3. Interact

4. Opportunity Detect

IBM SPSS® Modeler AdvantageMarketing Edition

1. IBM SPSS Modeler Advantage Marketing Edition

10 IBM Contact Optimization: Installation Guide

Page 15: IBM Contact Optimization: Installation Guide

Chapter 3. Installing Contact Optimization

You must run the IBM EMM installer to start the installation of ContactOptimization. The IBM EMM installer starts the Contact Optimization installerduring the installation process. Make sure that the IBM EMM installer and theproduct installer are saved at the same location.

Each time that you run the IBM EMM Suite installer, you must first enter databaseconnection information for the Marketing Platform system tables. When theContact Optimization installer starts, you must enter the required information forContact Optimization.

Important: Before you install Contact Optimization, make sure that the availabletemporary space on the computer where you install Contact Optimization is morethan three times the size of the Contact Optimization installer.

Installation files

The installation files are named according to the version of the product and theoperating system on which they must be installed, except UNIX. For UNIX,different installation files exist for the X Window System mode and the consolemode.

The following table displays examples of the installation files that are namedaccording to the product version and the operating system:

Table 7. Installation files

Operating system Installation file

Windows: GUI and console mode Product_N.N.N.N_win64.exe, where Productis the name of your product, N.N.N.N is theversion number of your product, andWindows 64-bit is the operating system onwhich the file must be installed.

UNIX: X Window System mode Product_N.N.N.N_solaris64.bin, whereProduct is the name of your product, andN.N.N.N is the version number of yourproduct.

UNIX: Console mode Product_N.N.N.N.bin, where Product is thename of your product, and N.N.N.N is theversion number of your product. This filecan be used for installation on all UNIXoperating systems.

Installing Contact Optimization by using the GUI modeFor Windows, use the GUI mode to install Contact Optimization. For UNIX, usethe X Window System mode to install Contact Optimization.

© Copyright IBM Corp. 2003, 2014 11

Page 16: IBM Contact Optimization: Installation Guide

Before you begin

Important: Before you use the GUI mode to install Contact Optimization, makesure that the available temporary space on the computer where you install ContactOptimization is more than three times the size of the Contact Optimizationinstaller.

Important: If IBM EMM products are installed in a distributed environment, youmust use the machine name rather than an IP address in the navigation URL for allof the applications in the suite. Also, if you are on a clustered environment andchoose to have default ports that are different than 80 or 443 for your deployment,you must also make changes to the navigation URL by removing the default portnumber.

Make sure that the IBM EMM installer and the Contact Optimization installers arein the same directory on the computer where you want to install ContactOptimization.

Make sure that you install Marketing Platform and Campaign before installingContact Optimization. For more information about installing Marketing Platform,see the IBM Marketing Platform Installation Guide. For more information aboutinstalling Campaign, see the IBM Campaign Installation Guide.

About this task

Complete the following actions to install Contact Optimization by using the GUImode:

Procedure1. Go to the folder where you have saved the IBM EMM 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 IBMEMM installer:

Table 8. IBM EMM installer GUI

Window Description

Introduction This is the first window of the IBM EMMsuite installer. You can open the ContactOptimization installation and upgradeguides from this window. You can also see alink for the installation and upgrade guidesfor the products whose installers are savedin the installation directory.

Click Next to go to the next window.

12 IBM Contact Optimization: Installation Guide

Page 17: IBM Contact Optimization: Installation Guide

Table 8. IBM EMM installer GUI (continued)

Window Description

Response Files Destination Click the Generate Response File check boxif you want to generate response files foryour product. Response files store theinformation that is necessary for theinstallation of your product. You can useresponse files for an unattended installationof your product.

In the Response files destination field, clickChoose to browse for a destination whereyou want to save the response files.Alternatively, click Restore Default Folderto save the response files in the default C:\location.

Click Next to go to the next window.

IBM EMM Products In the Install Set list, select Custom to selectContact Optimization as the product thatyou want to install.

In the Install Set area, you can see all theproducts whose installation files are in thesame directory on your computer.

In the Description field, you can view thedescription of the product that you select inthe Install Set area.

Click Next to go to the next window.

Installation Directory In the Specify the installation directoryfield, click Choose to browse to the directorywhere you want to install your product.

If you want to install the product in thefolder where the installers are stored, clickRestore Default Folder.

Click Next to go to the next window.

Select Application Server Select one of the following applicationservers for the installation:

v IBM WebSphere

v Oracle WebLogic

Click Next to go to the next window.

Platform Database Type Select the appropriate Marketing Platformdatabase type.

Click Next to go to the next window.

Chapter 3. Installing Contact Optimization 13

Page 18: IBM Contact Optimization: Installation Guide

Table 8. IBM EMM installer GUI (continued)

Window Description

Platform Database Connection Enter the following information about yourdatabase:

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.

Click Next to go to the next window.

Preinstallation Summary Review and confirm the values that youadded during the installation process.

Click Install to start the installation process.

The IBM Contact Optimization installeropens.

4. Follow the instructions on the Contact Optimization installer to start installingContact Optimization. Use the information in the following table to navigatethrough the Contact Optimization installer and take appropriate actions oneach window in the IBM Contact Optimization installer:

Table 9. IBM Contact Optimization installer GUI

Window Description

Introduction This is the first window of the IBM ContactOptimization installer. You can open theinstallation guide, upgrade guide and allavailable documentation for ContactOptimization from this window.

Click Next to go to the next window.

Software License Agreement Carefully read the agreement. Use Print toprint the agreement. Click Next after youaccept the agreement.

Installation Directory Click Choose to browse to the directorywhere you want to install ContactOptimization.

Click Next to go to the next window.

Campaign Database Setup Select one of the following options forsetting up the Campaign database:

v Automatic database setup

v Manual database setup

If you select Automatic database setup,select Run Unicode SQL Script if yoursystem tables are configured for unicode.

Click Next to go to the next window.

14 IBM Contact Optimization: Installation Guide

Page 19: IBM Contact Optimization: Installation Guide

Table 9. IBM Contact Optimization installer GUI (continued)

Window Description

Campaign Database Setup (Windows) Select the appropriate database type.

Click Next to go to the next window.

Campaign Database Connection Enter the following details for the Campaigndatabase:

v Database host name

v Database port

v Database system ID (SID)

v Database user name

v Password

Important: If IBM EMM products areinstalled in a distributed environment, youmust use the machine name rather than anIP address in the navigation URL for all ofthe applications in the suite. Also, if you areon a clustered environment and choose tohave default ports that are different than 80or 443 for your deployment, you must alsomake changes to the navigation URL byremoving the default port number.

Click Next to go to the next window.

JDBC Connection Review and confirm the JDBC connection.

Click Next to go to the next window.

ContactOptimization Connection Settings Enter the following connection settings:

v Network domain name

v Host name

v Port number

Select the Use secure connection check boxif necessary.

Click Next to go to the next window.

ContactOptimization Utilities Settings In the JDBC driver classpath field, enter theJDBC driver classpath.

Click Next to go to the next window.

Preinstallation Summary Review and confirm the values that youadded during the installation process.

Click Install to start the ContactOptimization installation.

Installation Complete Use this window to view information aboutthe locations of log files that are createdduring installation.

Click Done to exit the IBM ContactOptimization installer and to go back to theIBM EMM suite installer.

Chapter 3. Installing Contact Optimization 15

Page 20: IBM Contact Optimization: Installation Guide

5. Follow the instructions on the IBM EMM installer to finish installing ContactOptimization. Use the information in the following table to take the appropriateactions on each window in the IBM EMM installer:

Table 10. IBM EMM installer GUI

Window Description

Deployment EAR file Click Do not create an EAR file fordeployment.Note: You do not create an EAR file forContact Optimization because ContactOptimization does not have a webapplication.

Click Next to go to the next window.

Installation Complete Use this window to view information aboutthe installation log, error log, and output logof your installation.

Click Done to exit the IBM EMM installer.

Contact Optimization and EAR and WAR filesContact Optimization does not have EAR and WAR files. Contact Optimizationdoes not have a stand-alone web application.

All the Contact Optimization GUI elements are included with the Campaign webapplication. During installation, Contact Optimization must register withMarketing Platform to enable all Contact Optimization features in Campaign.

Installing Contact Optimization using the console modeThe console mode allows you to install Contact Optimization using thecommand-line window. You can select various options in the command-linewindow to complete tasks such as selecting the products to install, or selecting thehome directory for the installation.

Before you begin

Before you install Contact Optimization, ensure that you have configured thefollowing.v An application server profilev A database schema

To display the installer screens correctly in console mode, configure your terminalsoftware to support UTF-8 character encoding. Other character encodings, such asANSI, do not render the text correctly, and some information is not readable withthese encodings.

Procedure1. Open a command-line prompt window and navigate to the directory where

you have saved the IBM EMM installer and the Contact Optimization installer.2. Complete one of the following actions to run the IBM EMM installer.

v For Windows, enter the following command:ibm_emm_installer_full_name -i console

16 IBM Contact Optimization: Installation Guide

Page 21: IBM Contact Optimization: Installation Guide

For example, IBM_EMM_Installer_9.1.1.0.exe -i console

v For Unix, invoke the ibm_emm_installer_full_name.sh file.For example: IBM_EMM_Installer_9.1.1.0.sh

3. Follow the directions that are displayed in the command-line prompt. Use thefollowing guidelines when you have to select an option in the command-lineprompt: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 the following list displays the components that you caninstall:

1 [X] Marketing Platform2 [X] Campaign3 Contact Optimization4 Distributed Marketing

If you want to install Distributed Marketing, and do not want to installCampaign, enter the following command: 2,4The following list would then display the options that you selected:

1 [X] Marketing Platform2 Campaign3 Contact Optimization4 [X] Distributed Marketing

Note: Do not clear the option for Marketing Platform unless you have alreadyinstalled it.

4. The IBM EMM installer launches the Contact Optimization installer during theinstallation process. Follow the instructions in the command-line promptwindow of the Contact Optimization installer.

5. After you enter quit in the Contact Optimization installer command-lineprompt window, the window shuts down. Follow the instructions in thecommand-line prompt window of the IBM EMM installer to complete theinstallation of Contact Optimization.

Note: If any error occurs during the installation, a log file is generated. Youmust exit the installer to view the log file.

Installing Contact Optimization silentlyUse the unattended or silent mode to install Contact Optimization multiple times.

Before you begin

Before you install Contact Optimization, make sure that you have configured thefollowing elements:v An application server profilev A database schema

Chapter 3. Installing Contact Optimization 17

Page 22: IBM Contact Optimization: Installation Guide

About this task

When you install Contact Optimization by using the silent mode, response files areused to obtain the information that is required during installation. You must createresponse files for a silent installation of your product. You can create response filesby 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 theResponseFiles compressed archive. For more information about sample responsefiles, 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 silentmode. One response file is created for the IBM EMM suite installer, and one ormore response files are created for your product installer. The files are created inthe directory that you specify.

Important: For security reasons, the installer does not save database passwordsin the response files. When you create response files, you must edit eachresponse file to enter database passwords. Open each response file and searchfor 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 thefollowing directories sequentially:v In the directory where the IBM EMM 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 pathwhere response files are read by adding arguments to the command line. Forexample: -DUNICA_REPLAY_READ_DIR="myDirPath" -f myDirPath/installer.properties

Procedure

Use the following command for Windows:v IBM_EMM_installer_full_name -i silent

For example:IBM_EMM_Installer_9.1.1.0_win.exe -i silent

Use the following command for Linux:v IBM_EMM_installer_full_name_opertating_system.bin -i silent

For example:IBM_EMM_Installer_9.1.1_linux.bin -i silent

Sample response filesYou must create response files to set up a silent installation of ContactOptimization. You can use sample response files to create your response files. Thesample response files are included with the installers in the ResponseFilescompressed archive.

The following table provides information about sample response files:

18 IBM Contact Optimization: Installation Guide

Page 23: IBM Contact Optimization: Installation Guide

Table 11. Description of sample response files

Sample response file Description

installer.properties The sample response file for the IBM EMMmaster installer.

installer_product intials and productversion number.properties

The sample response file for the ContactOptimization installer.

For example,installer_ucn.n.n.n.properties is theresponse file of the Campaign installer,where n.n.n.n is the version number.

installer_report pack initials, productinitials, and version number.properties

The sample response file for the reportspack installer.

For example, installer_urpc.properties isthe response file of the Campaign reportspack installer.

Chapter 3. Installing Contact Optimization 19

Page 24: IBM Contact Optimization: Installation Guide

20 IBM Contact Optimization: Installation Guide

Page 25: IBM Contact Optimization: Installation Guide

Chapter 4. Configuring Contact Optimization

Contact Optimization does not have a stand-alone web application. ConfigureContact Optimization after you install, configure, deploy, and verify yourinstallation of Campaign.

Creating and populating the Contact Optimization system tablesmanually

During installation, the Contact Optimization installer accesses the Campaignsystem tables to create the Contact Optimization system tables automatically. If thesystem tables are not created automatically, you must run the Contact OptimizationSQL scripts against the appropriate database to create and populate the ContactOptimization system tables manually.

About this task

Complete the following steps to create and populate the Contact Optimizationsystem tables manually:

Procedure1. To create and populate the Contact Optimization system tables, run the SQL

scripts against the database or schema that holds the Campaign system tables.The SQL scripts are in the ddl directory under the Contact Optimizationinstallation.

2. If your Campaign system tables are configured for unicode, use the appropriatescript in the ddl/unicode directory under the Contact Optimization installation.Use the information in the following table to run the appropriate script againstthe database to create the Contact Optimization system tables manually:

Table 12. Scripts for creating Contact Optimization system tables.

Data source type Script name

IBM DB2 aco_systab_db2.sql

Microsoft SQLServer

aco_systab_sqlsvr.sql

Oracle aco_systab_ora.sql

There is only one script to populate the Contact Optimization tables,aco_populate_tables.sql. There is no unicode equivalent script for theaco_populate_tables.sql script that is used to populate the tables.

Registering Contact Optimization manuallyRegister Contact Optimization with Marketing Platform to import menu items andset configuration properties. If the Contact Optimization installer cannot access theMarketing Platform system tables during the installation process, you must run theconfigTool utility to register Contact Optimization manually.

© Copyright IBM Corp. 2003, 2014 21

Page 26: IBM Contact Optimization: Installation Guide

About this task

You must run the configTool utility as many times as there are files. TheconfigTool utility is in the tools/bin directory under the Marketing Platforminstallation.

Use the following example commands as guidelines to register ContactOptimization manually:v configTool -i -p "Affinium|suite|uiNavigation|mainMenu|Campaign" -f

"full_path_to_Optimize_installation_directory\conf\optimize_navigation.xml"

v configTool -v -i -o -p "Affinium|Campaign|about|components" -f"full_path_to_Optimize_installation_directory\conf\optimize_subcomponent_version.xml"

All the Contact Optimization configuration properties are included with Campaign,so you do not have to register any configuration properties.

Setting the Contact Optimization configuration properties manuallySet configuration properties for the Contact Optimization listener. You can set thehost server name and port for the Contact Optimization installation. You canconfigure Contact Optimization to connect to the Marketing Platform server byusing SSL.

About this task

If the Contact Optimization installer cannot access the Marketing Platform systemtables during the installation process, the installer displays an error message. Theinstallation process proceeds, but go to Settings > Configuration to set the ContactOptimization configuration properties manually.

If required, set the following Contact Optimization configuration properties underthe Campaign > unicaACOListener category manually:v serverHost

v serverPort

v useSSL

Configuring the ACOOptAdmin toolConfigure the ACOOptAdmin tool to run Contact Optimization sessions from thecommand line.

About this task

Complete the following steps to configure the ACOOptAdmin tool:

Procedure1. Open the ACOOptAdmin.sh (UNIX) or ACOOptAdmin (Windows) file. The file is in

the bin directory under the Contact Optimization installation directory.2. Edit JAVA_HOME to replace [Change Me] with the path to the Java directory used

by your web application server.3. Save and close the file.

22 IBM Contact Optimization: Installation Guide

Page 27: IBM Contact Optimization: Installation Guide

4. Add or edit the JAVA_OPTIONS variable in your web application server startupscript. Add the following options to configure the ACOOptAdmin tool in the SSLenvironment for Windows and UNIX:v -Djavax.net.ssl.keyStoreType=keyStoreTypeValue

v -Djavax.net.ssl.keyStore=<keyStoreValue>

v -Djavax.net.ssl.keyStorePassword=<keyStorePasswordValue>

v -Djavax.net.ssl.trustStore=<trustStoreValue>

v -Djavax.net.ssl.trustStorePassword=<trustStorePasswordValue>

Configuring Contact Optimization for Chinese, Japanese, or Koreanusers

Modify the Contact Optimization ACOserver file to use Contact Optimization withuser names that contain Chinese, Japanese, or Korean characters.

About this task

Complete the following steps to configure Contact Optimization for Chinese,Japanese, or Korean users:

Procedure1. Open the Contact Optimization server file. The ACOserver file is in the bin

directory under the Contact Optimization installation directory.2. Remove the comment to set the UNICA_ACSYSENCODING environment variable

equal to UTF-8.For Windows: Remove @rem before the following line in ACOserver.bat:@rem set UNICA_ACSYSENCODING=UTF-8

For UNIX: Remove # before the following lines in ACOserver.sh:#UNICA_ACSYSENCODING=UTF-8#export UNICA_ACSYSENCODING

3. Save and close the file.4. Restart the Contact Optimization server in a new console window if the

Contact Optimization server is already running.

Starting the Contact Optimization serverTo use Contact Optimization, you must start the Contact Optimization server. Runthe ACOserver script to start the Contact Optimization server.

About this task

Complete the following steps to start the Contact Optimization server:

Procedure1. To start the Contact Optimization server, run the ACOserver script. The

ACOserver script is in the bin directory under the Contact Optimizationinstallation. Use the following commands to run the ACOserver script:v On Windows: ACOServer.bat start

v On UNIX: ./ACOServer.sh start

2. To verify that the ACOserver process is running, use the Windows TaskManager or the command ps -ef | grep unica_aolsnr on UNIX systems.

Chapter 4. Configuring Contact Optimization 23

Page 28: IBM Contact Optimization: Installation Guide

Mapping tables for Contact OptimizationYou can exchange data between Contact Optimization and Campaign by mappingthe Contact Optimization system tables, contact history tables, and segmentmembership tables to the Campaign tables.

About this task

Note: Mapping the segment membership system tables in Campaign for use withstrategic segments is optional. Map the segment membership system table for anaudience only if you use the audience with flowcharts or Contact Optimizationsessions that use strategic segments.

For more information about mapping system tables in Campaign, see the IBMCampaign Administrator's Guide.

Complete the following steps to map tables for Contact Optimization:

Procedure1. Map all system tables.2. Map all contact history tables.

Confirm each audience level in your Campaign configuration has a contacthistory table. You must map each contact history table. For more informationabout additional contact history tables, see the IBM Campaign Administrator'sGuide.

3. Optional: For each audience used in Contact Optimization sessions that usestrategic segments, map the segment membership system table for the audienceto the database table that defines the segment members.Requirements when you use strategic segments:If you plan to use strategic segments, ensure that there is a segmentmembership table for each audience level in your Campaign configuration. Youmust map each segment membership table.Create two indexes on the audience segment membership tables. Create thefirst index on SegmentID and create the second on the audience level columns.The UA_SegMembership table ships with an index on CustomerID and onSegmentID.For more information about system tables and strategic segments, see the IBMCampaign Administrator's Guide.

Contact Optimization system table mapping referenceTo integrate Contact Optimization with Campaign, map all the ContactOptimization system tables to the Campaign tables.

You can exchange data between Contact Optimization and Campaign by mappingthe Contact Optimization tables in Campaign. Map all the Contact Optimizationsystem tables, contact history tables, and segment membership tables to theCampaign tables.

Use the following table to get information about the Contact Optimization systemtables and the corresponding database tables:

24 IBM Contact Optimization: Installation Guide

Page 29: IBM Contact Optimization: Installation Guide

Table 13. Contact Optimization system table mapping

Contact Optimization System Table Database Table

Optimize Session Table UACO_OptSession

Optimize Process Table UACO_OptimizeProcess

Optimize Run History Table UACO_SesnRunHist

Optimize Session Segment Table UACO_SesnSegment

Optimize Offer Segment Table UACO_OfferSeg

Optimize Session Offer Table UACO_SesnOffer

Optimize Rule Table UACO_Rule

Optimize Exception Rule Table UACO_RException

Optimize Exception Rules Constraint Table UACO_RExConstraint

Optimize Rules Constraint Table UACO_RConstraint

Optimize Rule OfferList Table UACO_ROfferList

Optimize Rule Offer Table UACO_ROffer

Optimize Rule Segment Table UACO_RSegment

Optimize Proposed Contact Base Table UACO_PCTBase

Optimize Proposed Attribute Base Table UACO_POABase

Optimize Optimized Contact Base Table UACO_OCTBase

Contact Optimization contact history table mapping referenceTo integrate Contact Optimization with Campaign, map all the ContactOptimization contact history tables to the Campaign tables.

Use the following table to get information about the Contact Optimization contacthistory tables and the corresponding database tables:

Table 14. Contact Optimization contact history table mapping

Contact History Table Database Table

Customer Contact History Table UA_ContactHistory

Customer Detailed Contact History Table UA_DtlContactHist

The names of additional audience level tables are unique according to yourconfiguration of Contact Optimization.

Verifying the Contact Optimization installationIf Contact Optimization is installed correctly, you must be able to use the Optimizeprocess in Campaign when you build the Campaign batch flowcharts. To verify,log in to IBM EMM and confirm that you can access Campaign > ContactOptimizations.

Before you begin

Note: Before you verify that Contact Optimization is installed or upgradedcorrectly, make sure that the Affinium|Campaign|acoInstalled property is set totrue. If the Affinium|Campaign|acoInstalled is set to false, you get an errormessage that indicates Contact Optimization is not installed.

Chapter 4. Configuring Contact Optimization 25

Page 30: IBM Contact Optimization: Installation Guide

About this task

After you map the Contact Optimization tables to the Campaign tables, you mighthave to log out and log in to the IBM EMM console to show Campaign > ContactOptimizations.

Complete the following steps to verify the Contact Optimization installation:

Procedure1. Log in to the IBM EMM console.2. Select Contact Optimizations from the menu. The All Contact Optimization

Sessions page is displayed. Verify that you can view and manage your ContactOptimization sessions.

26 IBM Contact Optimization: Installation Guide

Page 31: IBM Contact Optimization: Installation Guide

Chapter 5. Configuring multiple partitions for ContactOptimization

In the Campaign family of products, partitions provide a way to secure the datathat is associated with different groups of users. When you configure Campaign ora related IBM EMM application to operate with multiple partitions, users can seeeach partition as a separate instance of the application. There is no indication thatother partitions exist on the same computer.

How multiple partitions workFor the IBM EMM applications that operate with Campaign, you can configure theapplication within the partitions where you have configured an instance ofCampaign. Application users within each partition can access the ContactOptimization functions, data, and customer tables that are configured for ContactOptimization in the same partition.

Partition benefits

Multiple partitions are useful for setting up strong security between groups ofusers, because each partition has its own set of Contact Optimization system tables.Multiple partitions cannot be used when groups of users must share data.

Each partition has its own set of configuration settings, and Contact Optimizationcan be customized for each group of users. However, all partitions share the sameinstallation binaries. With the same binaries for all partitions, you can minimize theinstallation and upgrade efforts for multiple partitions.

Partition user assignment

Access to partitions is managed through membership in Marketing Platformgroups.

With the exception of the partition superuser (platform_admin), each IBM user canbelong to one partition. A user who requires access to multiple partitions musthave a separate IBM user account for each partition.

If there is only one Contact Optimization partition, users do not have to beexplicitly assigned to that partition to have access to Contact Optimization.

Partition data access

In a multi-partition configuration, partitions have the following securitycharacteristics:v A user cannot access a partition if the user is not a member of a group that is

assigned to a partition.v A user of one partition cannot view or change data in another partition.v Users cannot navigate the Contact Optimization file system above the root

directory of their partition from the browse dialog boxes in ContactOptimization. For example, if two partitions, named partition1 and partition2exist, and you belong to the group that is associated with partition1, you cannotnavigate the directory structure for partition2 from a dialog box.

© Copyright IBM Corp. 2003, 2014 27

Page 32: IBM Contact Optimization: Installation Guide

Setting up multiple partitions for Contact OptimizationUse multiple partitions in Contact Optimization so that different groups of usershave access to different sets of Contact Optimization and Campaign data.

About this task

Installing Contact Optimization creates a default partition, partition1, under theContactOptimization/partitions directory of the Contact Optimizationinstallation. You can create additional partitions in the same directory.

Note: Save a clean copy of the original partition1 directory to serve as a backup.

If you configure Contact Optimization to use multiple partitions, you must alsoconfigure Campaign to use multiple partitions. The names of the partitions thatyou create for Contact Optimization must exactly match the names of thecorresponding partitions that are created for Campaign.

Complete the following steps to set up multiple partitions for ContactOptimization:

Procedure1. Create your Campaign partitions.2. Create a directory for each partition you created in Campaign in the partitions

directory of your Contact Optimization installation.For example, if you created partition2 in Campaign, you must create theContactOptimization/partitions/partition2 directory.

3. Copy the contents of the ContactOptimization/partitions/partition1directory, along with all of its (empty) subdirectories, into the directory youcreated for the new partition.For example, copy the contents of the partition1 directory into theContactOptimization/partitions/partition2 directory.

4. If any subdirectories of the newly created directory are not empty, delete allfiles in the subdirectories.

5. Run the SQL scripts to create and populate the Contact Optimization systemtables in the database that is configured for the new partition.For more information about running the SQL scripts, see “Creating andpopulating the Contact Optimization system tables manually” on page 21.

6. Repeat Steps 2 through 5 for each partition you must create. Use the mostrecently created directory as your starting point.

Results

Note: By default, partitions are installed under the ContactOptimization/partitions directory. You can modify the default directory for ContactOptimization, or you can modify the directory that specifies the partitions.

Configuring ACOServer for multiple partitionsIf you want, you can modify the default location of the partitions by using theACOServer script. For multiple partitions, you must make sure that ContactOptimization points to the correct partitions directory.

28 IBM Contact Optimization: Installation Guide

Page 33: IBM Contact Optimization: Installation Guide

About this task

When you install Contact Optimization, a default partitions directory is createdunder the directory that is specified by OPTIMIZE_HOME. This default directoryfor partitions contains one partition, partition1. Even if you create other partitionsfor your Contact Optimization configuration, you can modify the default locationfor all partitions.

To modify the home directory for partitions, you can optionally set theOPTIMIZE_PARTITION_HOME environment variable in the Contact Optimization serverfile. The OPTIMIZE_PARTITION_HOME variable defines the root location for thepartitions. If you set the OPTIMIZE_PARTITION_HOME variable, it overrides the defaultvalue.

Set the OPTIMIZE_PARTITION_HOME environment variable in the Contact Optimizationserver file by using one of the following methods:

Procedure1. For Windows: Set the OPTIMIZE_PARTITION_HOME environment variable by

adding the following lines to the ACOServer.bat file:set OPTIMIZE_PARTITION_HOME=C:\partitionsecho Using OPTIMIZE_PARTITION_HOME: %OPTIMIZE_PARTITION_HOME%

2. For UNIX: Set the OPTIMIZE_PARTITION_HOME environment variable by addingthe following lines to the ACOServer.sh file:OPTIMIZE_PARTITION_HOME = /root_dir/work/partitionsexport OPTIMIZE_PARTITION_HOMEecho "Using OPTIMIZE_PARTITION_HOME:"$OPTIMIZE_PARTITION_HOME

Chapter 5. Configuring multiple partitions for Contact Optimization 29

Page 34: IBM Contact Optimization: Installation Guide

30 IBM Contact Optimization: Installation Guide

Page 35: IBM Contact Optimization: Installation Guide

Chapter 6. Uninstalling Contact Optimization

Run the Contact Optimization uninstaller to uninstall Contact Optimization. Whenyou run the Contact Optimization uninstaller, the files that were created during theinstallation 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 EMM products, an uninstaller is included in theUninstall_Product directory, where Product is the name of your IBM product. OnWindows, an entry is also added to the Add or Remove Programs list in theControl Panel.

If you manually remove the files in your installation directory instead of runningthe uninstaller, the result might be an incomplete installation if you later reinstallan IBM product in the same location. After uninstalling a product, its database isnot removed. The uninstaller only removes default files that are created duringinstallation. Any file that is created or generated after installation is not removed.

Note: On UNIX, the same user account that installed Contact Optimization mustrun the uninstaller.

Procedure1. Stop the Contact Optimization listener.2. To drop the Contact Optimization tables from the system table database, run

the aco_systab_drop.sql script in the ddl directory under your ContactOptimization installation. If the ddl directory exists in the product installationdirectory, run the scripts that are provided in the ddl directory to drop tablesfrom the system table database.

3. Complete one of the following steps to uninstall Contact Optimization:v Double-click the Contact Optimization uninstaller that exists in the

Uninstall_Product directory. The uninstaller runs in the mode in which youinstalled Contact Optimization.

v In a command-line window, navigate to the directory where the uninstallerexists, and run the following command to uninstall Contact Optimization byusing the console mode:Uninstall_Product -i console

v In a command-line window, navigate to the directory where the uninstallerexists, and run the following command to uninstall Contact Optimization byusing the silent mode:Uninstall_Product -i silent

When you uninstall Contact Optimization by using the silent mode, theuninstallation process does not present any dialogs for user interaction.

Note: If you do not specify an option for uninstalling Contact Optimization,the Contact Optimization uninstaller runs in the mode in which ContactOptimization is installed.

© Copyright IBM Corp. 2003, 2014 31

Page 36: IBM Contact Optimization: Installation Guide

32 IBM Contact Optimization: Installation Guide

Page 37: IBM Contact Optimization: Installation Guide

Chapter 7. configTool

The properties and values on the Configuration page are stored in the systemtables. You can use the configTool utility to import and export configurationsettings 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 EMM 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 EMM.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 XMLthat creates the category, and by using configTool to import the edited XML.

Important: This utility modifies the usm_configuration andusm_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 configurationsby using configTool and back up the resulting file so you have a way to restoreyour 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 -uproductName

Commands

-d -p "elementPath" [o]

Delete configuration properties and their settings, specifying a path in theconfiguration property hierarchy.

The element path must use the internal names of categories and properties. Youcan obtain them by going to the Configuration page, selecting the wanted categoryor property, and looking at the path that is displayed in parentheses in the rightpane. Delimit a path in the configuration property hierarchy by using the |character, and surround the path with double quotation marks.

© Copyright IBM Corp. 2003, 2014 33

Page 38: IBM Contact Optimization: Installation Guide

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 awhole application.

v To delete categories that do not have the Delete Category link on theConfiguration page, use the -o option.

When you use -d with the -vp command, the configTool deletes any child nodes inthe 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 toimport your categories. The configTool utility imports properties under thecategory you specify in the path.

You can add categories at any level below the top level, but you cannot add acategory 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 requiredcategory or property, and looking at the path that is displayed in parentheses inthe 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 youcan 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 usethe -o option to force an overwrite.

-x -p "elementPath" -f exportFile

Export configuration properties and their settings to an XML file with a specifiedname.

You can export all configuration properties or limit the export to a specific categoryby specifying a path in the configuration property hierarchy.

The element path must use the internal names of categories and properties, whichyou can obtain by going to the Configuration page, selecting the wanted categoryor property, and looking at the path that is displayed in parentheses in the rightpane. 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 canspecify 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/bindirectory under your Marketing Platform installation. If you do not provide thexml extension, configTool adds it.

-vp -p "elementPath" -f importFile [-d]

34 IBM Contact Optimization: Installation Guide

Page 39: IBM Contact Optimization: Installation Guide

This command is used mainly in manual upgrades, to import configurationproperties. 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 upgradeprocess can override values that were set when the fix pack was applied. The -vpcommand ensures that the import does not override previously set configurationvalues.

Important: After you use the configTool utility with the -vp option, you mustrestart the web application server on which Marketing Platform is deployed so thechanges are applied.

When you use -d with the -vp command, the configTool deletes any child nodes inthe 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 thetools/bin directory or can be a full path. By default, this command does notoverwrite an existing configuration, but you can use the -o option to force anoverwrite. The productName parameter must be one of those names that are listedabove.

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 insertconfiguration properties into the Marketing Platform database. For these files,use the -i command. Only the file that has the <application> tag as the first tagcan 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 thepopulateDb utility, or rerun the Marketing Platform installer as described in theIBM Marketing Platform Installation Guide.

v After the initial installation, to re-register products other than the MarketingPlatform, use configTool with the -r command and -o to overwrite the existingproperties.

The configTool utility uses product names as parameters with the commands thatregister and unregister products. With the 8.5.0 release of IBM EMM, manyproduct names changed. However, the names that are recognized by configTooldid not change. The valid product names for use with configTool are listed below,along with the current names of the products.

Table 15. 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

Chapter 7. configTool 35

Page 40: IBM Contact Optimization: Installation Guide

Table 15. Product names for configTool registration and unregistration (continued)

Product name Name used in configTool

CustomerInsight Insight

Digital Analytics for On Premises NetInsight

Opportunity Detect Detect

Leads Leads

IBM SPSS Modeler Advantage EnterpriseMarketing Management Edition

SPSS

Digital Analytics Coremetrics

-u productName

Unregister an application that is specified by productName. You do not have toinclude a path to the product category; the product name is sufficient, and it isrequired. The process removes all properties and configuration settings for theproduct.

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 theDelete Category link on the Configuration page.

Examplesv 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 defaultCampaign partition, partition1. The example assumes that you placed the Oracledata source template, OracleTemplate.xml, in the tools/bin directory under theMarketing Platform installation.configTool -i -p "Affinium|Campaign|partitions|partition1|dataSources" -fOracleTemplate.xml

v Export all configuration settings to a file named myConfig.xml in the D:\backupsdirectory.configTool -x -f D:\backups\myConfig.xml

v Export an existing Campaign partition (complete with data source entries), saveit to a file named partitionTemplate.xml, and store it in the default tools/bindirectory under the Marketing Platform installation.configTool -x -p "Affinium|Campaign|partitions|partition1" -fpartitionTemplate.xml

v Manually register an application named productName, by using a file namedapp_config.xml in the default tools/bin directory under the Marketing Platforminstallation, 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.

36 IBM Contact Optimization: Installation Guide

Page 41: IBM Contact Optimization: Installation Guide

configTool -u productName

Chapter 7. configTool 37

Page 42: IBM Contact Optimization: Installation Guide

38 IBM Contact Optimization: Installation Guide

Page 43: IBM Contact Optimization: Installation Guide

Before you contact IBM technical support

If you encounter a problem that you cannot resolve by consulting thedocumentation, your company's designated support contact can log a call withIBM technical support. Use these guidelines to ensure that your problem isresolved efficiently and successfully.

If you are not a designated support contact at your company, contact your IBMadministrator for information.

Note: Technical Support does not write or create API scripts. For assistance inimplementing 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 informationabout your environment.

If your problem does not prevent you from logging in, much of this information isavailable on the About page, which provides information about your installed IBMapplications.

You can access the About page by selecting Help > About. If the About page is notaccessible, check for a version.txt file that is located under the installationdirectory for your application.

Contact information for IBM technical support

For ways to contact IBM technical support, see the IBM Product Technical Supportwebsite: (http://www.ibm.com/support/entry/portal/open_service_request).

Note: To enter a support request, you must log in with an IBM account. Thisaccount must be linked to your IBM customer number. To learn more aboutassociating your account with your IBM customer number, see Support Resources> Entitled Software Support on the Support Portal.

© Copyright IBM Corp. 2003, 2014 39

Page 44: IBM Contact Optimization: Installation Guide

40 IBM Contact Optimization: Installation Guide

Page 45: IBM Contact Optimization: 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 inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan, Ltd.19-21, Nihonbashi-Hakozakicho, Chuo-kuTokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law: INTERNATIONALBUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFNON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULARPURPOSE. Some states do not allow disclaimer of express or implied warranties incertain 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 beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

© Copyright IBM Corp. 2003, 2014 41

Page 46: IBM Contact Optimization: Installation Guide

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM Corporation170 Tracer LaneWaltham, MA 02451U.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 materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

All IBM prices shown are IBM's suggested retail prices, are current and are subjectto change without notice. Dealer prices may vary.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have not

42 IBM Contact Optimization: Installation Guide

Page 47: IBM Contact Optimization: Installation Guide

been thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs. The sampleprograms are provided "AS IS", without warranty of any kind. IBM shall not beliable for any damages arising out of your use of the sample programs.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.

TrademarksIBM, the IBM logo, and ibm.com are trademarks or registered trademarks ofInternational 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 andtrademark information" at www.ibm.com/legal/copytrade.shtml.

Privacy Policy and Terms of Use ConsiderationsIBM Software products, including software as a service solutions, ("SoftwareOfferings") may use cookies or other technologies to collect product usageinformation, to help improve the end user experience, to tailor interactions withthe end user or for other purposes. A cookie is a piece of data that a web site cansend to your browser, which may then be stored on your computer as a tag thatidentifies your computer. In many cases, no personal information is collected bythese cookies. If a Software Offering you are using enables you to collect personalinformation through cookies and similar technologies, we inform you about thespecifics below.

Depending upon the configurations deployed, this Software Offering may usesession and persistent cookies that collect each user's user name, and otherpersonal information for purposes of session management, enhanced user usability,or other usage tracking or functional purposes. These cookies can be disabled, butdisabling them will also eliminate the functionality they enable.

Various jurisdictions regulate the collection of personal information throughcookies and similar technologies. If the configurations deployed for this SoftwareOffering provide you as customer the ability to collect personal information fromend users via cookies and other technologies, you should seek your own legaladvice about any laws applicable to such data collection, including anyrequirements for providing notice and consent where appropriate.

IBM requires that Clients (1) provide a clear and conspicuous link to Customer'swebsite terms of use (e.g. privacy policy) which includes a link to IBM's andClient's data collection and use practices, (2) notify that cookies and clear gifs/webbeacons are being placed on the visitor's computer by IBM on the Client's behalfalong with an explanation of the purpose of such technology, and (3) to the extentrequired by law, obtain consent from website visitors prior to the placement ofcookies and clear gifs/web beacons placed by Client or IBM on Client's behalf onwebsite visitor's devices

For more information about the use of various technologies, including cookies, forthese purposes, See IBM's Online Privacy Statement at: http://www.ibm.com/privacy/details/us/en section entitled "Cookies, Web Beacons and OtherTechnologies."

Notices 43

Page 48: IBM Contact Optimization: Installation Guide

44 IBM Contact Optimization: Installation Guide

Page 49: IBM Contact Optimization: Installation Guide
Page 50: IBM Contact Optimization: Installation Guide

����

Printed in USA