ibm leads: upgrade guide€¦ · v “upgrading leads” on page 9 v “configuring the leads...

IBM LeadsVersion 9 Release 1October 25, 2013

Upgrade Guide

��

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

This edition applies to version 9, release 1, modification 0 of IBM Leads and to all subsequent releases andmodifications until otherwise indicated in new editions.

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

Contents

Chapter 1. Upgrade overview . . . . . 1Upgrade Roadmap . . . . . . . . . . . . 1How the installers work . . . . . . . . . . 2Modes of installation . . . . . . . . . . . 2

Sample response files . . . . . . . . . . 3Leads documentation and help . . . . . . . . 3

Chapter 2. Planning Leads upgrade . . . 5Prerequisites . . . . . . . . . . . . . . 5IBM Leads Installation database informationworksheet . . . . . . . . . . . . . . . 7

Chapter 3. Upgrading IBM Leads . . . . 9Upgrading Leads in a clustered environment . . . 9Customizations and upgrading . . . . . . . . 9Custom validation and upgrading . . . . . . . 9Upgrading Leads . . . . . . . . . . . . . 9

Configuring the Leads Sub-Status feature . . . 11Merge customized language properties files . . . 11

Chapter 4. Deploying IBM Leads webapplication . . . . . . . . . . . . . 13Guidelines for deploying Leads on WebSphere . . 13WebLogic guidelines . . . . . . . . . . . 14Configuring the IBM IHS web server for SSL . . . 15

Enabling HTTP compression and SSL encryption 15Enabling HTTP compression. . . . . . . . 16Adding SSL encryption . . . . . . . . . 16

Chapter 5. Uninstalling Leads . . . . . 19

Before you contact IBM technicalsupport . . . . . . . . . . . . . . 21

Notices . . . . . . . . . . . . . . 23Trademarks . . . . . . . . . . . . . . 25Privacy Policy and Terms of Use Considerations . . 25

© Copyright IBM Corp. 2004, 2013 iii

iv IBM Leads: Upgrade Guide

Chapter 1. Upgrade overview

An upgrade of Leads is complete when you upgrade, configure, and deploy Leads.The Leads Upgrade Guide provides detailed information about upgrading,configuring, and deploying Leads.

Use the Upgrade Roadmap section to obtain a broad understanding about usingthe Leads Upgrade Guide.

Upgrade RoadmapUse the upgrade roadmap to quickly find the information that you need forupgrading Leads.

You can use the Table 1 to scan the tasks that must be completed for upgradingLeads:

Table 1. Leads upgrade roadmap

Topic Information

Chapter 1, “Upgrade overview” This topic provides the followinginformation:

v “How the installers work” on page 2

v “Modes of installation” on page 2

v “Leads documentation and help” on page3

Chapter 2, “Planning Leads upgrade,” onpage 5

This topic provides the followinginformation:

v “Prerequisites” on page 5

v “IBM Leads Installation databaseinformation worksheet” on page 7

Chapter 3, “Upgrading IBM Leads,” on page9


v “Upgrading Leads in a clusteredenvironment” on page 9

v “Customizations and upgrading” on page9

v “Custom validation and upgrading” onpage 9

v “Upgrading Leads” on page 9

v “Configuring the Leads Sub-Statusfeature” on page 11

v “Merge customized language propertiesfiles” on page 11

Chapter 4, “Deploying IBM Leads webapplication,” on page 13


v “Guidelines for deploying Leads onWebSphere” on page 13

v “WebLogic guidelines” on page 14

v “Enabling HTTP compression” on page 16

© Copyright IBM Corp. 2004, 2013 1

Table 1. Leads upgrade roadmap (continued)

Topic Information

Chapter 5, “Uninstalling Leads,” on page 19 This topic provides the information abouthow to uninstall Leads.

How the installers workYou must use the suite installer and the product installer when you install anyIBM® EMM product. For example, for installing Leads, you must use the IBMEMM suite installer and the IBM Leads 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.

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 Leads.

GUI mode

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

Console mode

Use the console mode to install Leads by using the command-line window.

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 Leads multiple times. The silent modeuses response files for installation, and does not require user input during theinstallation process.

2 IBM Leads: Upgrade Guide

Sample response filesYou must create response files to set up a silent installation of Leads. You can usesample response files to create your response files. The sample response files areincluded with the installers in the ResponseFiles compressed archive.

The following table provides information about sample response files:

Table 2. 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 Leadsinstaller.

For example,installer_uln.n.n.n.properties is theresponse file of the Leads installer, wheren.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_urpl.properties isthe response file of the Leads reports packinstaller.

Leads documentation and helpIBM provides Leads documentation and help for users, administrators, anddevelopers.

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

Table 3. Get up and running

Task Documentation

View a list of new features, known issues, andworkarounds

IBM Leads Release Notes

Install or upgrade Leads and deploy the Leads webapplication

One of the following guides:

v IBM Leads Installation Guide

v IBM Leads Upgrade Guide

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

Table 4. Configure and use Leads

Task Documentation

v Set up and configure the system for users

v Adjust security settings

v Map tables, define offer templates and customattributes

v Run utilities and perform maintenance

IBM Leads Administrator's Guide

v Create and deploy marketing campaigns

v Analyze campaign results

IBM Leads User's Guide

Chapter 1. Upgrade overview 3

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

Table 5. Get help

Task Instructions

Open online help 1. Choose Help > Help for this page to open acontext-sensitive help topic.

2. Click the Show Navigation icon in the help windowto display the full help.

Obtain PDFs Use either of the following methods:

v Choose Help > Product Documentation to accessLeads PDFs.

v Choose Help > All IBM EMM Suite Documentationto access all available documentation.

Get support Go to http://www.ibm.com/support and click Support& downloads to access the IBM Support Portal.


http://www.ibm.com/support

Chapter 2. Planning Leads upgrade

For upgrading Leads to 9.1 version, you must check from which version you areupgrading. Upgrade scenarios are based on the current version of the Leadsproduct.

Use the following guidelines for upgrading Leads:

Important: If you are using the Leads reporting features, you must also upgradereports. See IBM EMM Reports Installation and Configuration Guide.

Table 6. Leads source version and upgrade path

Source version Upgrade path

Leads versions 7.1.0.x You must upgrade to Leads version 7.1.1, then to version 8.1.0,9.0.0 and finally to version 9.1. The interim upgrades aredescribed in the installation guides for those versions.

Leads versions 7.1.1.x and7.2.x

You must upgrade to Leads version 8.1.0, then to the version9.0 and then finally to 9.1. The interim upgrades are describedin the installation guide for that versions.

Leads versions 8.1.0 and8.5.0

Upgrade your installation to version 9.0 and then to 9.1 asdescribed in guide.

Leads versions 8.6.0 and9.0

Upgrade your installation to version 9.1 as described in guide.

Note: If you install a product over an existing version from which the upgrade isnot supported, you receive an informational message. With the help of thatmessage, you can cancel the installation or continue with the new installation.

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.

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:v Administration access for all necessary databasesv 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.6. 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 Marketing Platform before you install any IBM EMM products.For each group of products that work together, you must install MarketingPlatform only once. Each product installer checks whether the required productsare installed. If your product or version is not registered with Marketing Platform,a message prompts you to install or upgrade Marketing Platform before youproceed with your installation. Marketing Platform must be deployed and runningbefore you can set any properties on the Settings > Configuration page.

IBM Leads Installation database information worksheetUse the Leads installation worksheet to gather information about the Leadsdatabase and about other IBM EMM products that are required for the installationof Leads.

Use the IBM Leads database information worksheet to gather information aboutthe database that contains your Leads system tables.

Table 7. Leads database information worksheet

Field Notes®

Database type

Database name

Database account user name

Database account password

JNDI name

ODBC name

Checklist for IBM Marketing Platform

The installation wizards for each IBM EMM product must be able to communicatewith the Marketing Platform system table database to register the product. Eachtime that you run the installer, you must enter the following database connectioninformation for the Marketing Platform system table database:v Database typev JNDI namev JDBC driver classv JDBC connection URLv JDBC driver class path on your computerv Database host namev Database portv Database name or schema IDv User name and password for the database account

Information about 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 protocol that is HTTP or HTTPS, if SSL is implemented in the web

application server.

Chapter 2. Planning Leads upgrade 7

v The name of the systems on which the web application servers are installed. Youcan have one or several web application servers, depending on the IBM EMMenvironment 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 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 letterv Proof of Entitlement letterv Other communications that are sent when you purchase your software

IBM might use the data that is provided by the installed software to betterunderstand how customers use our products and to improve customer support.The data that is gathered does not include any information that identifiesindividuals. Complete the following actions if you do not want to have suchinformation 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.


Chapter 3. Upgrading IBM Leads

Before you upgrade from any version of Leads, be sure to read all of the topicsabout upgrading for a successful upgrade process.

Upgrading Leads in a clustered environmentUpgrading Leads in a clustered environment with more than one node can be acomplex process. If you upgrade Leads with only one node running, note downthe changes that occur in ms.config of the running node and update other nodesaccordingly.

Use the following guidelines for upgrading Leads in a clustered environment:v If you upgrade Leads in clustered environment with more than one node,

configuration changes that are made through the Leads Admin console can goto any of your load-balanced servers. So for example, attachmentHome=/attachments can be committed to Server A's ms.config file, whilecreateManagerUserDefaultPassword=password can be committed to Server B'sms.config file.

v Leave only one node that is running during upgrade so that all changes areconsolidated to the ms.config file of the server that is running. Then, when theupgrade is completed, you must update the rest of the servers' ms.config files,and restart all the nodes.

Customizations and upgradingCustomizations are not maintained during an upgrade. After you upgrade, youmust re-create the required customizations in your current version of Leads.

Custom validation and upgradingIn custom validation, take a back up of the validator (class file) which is under theWEB_INF directory before upgrade. Reinsert the class file to same location afterupgrade is complete.

Alternately, before upgrade, you can move the class file to the<IBM_EMM_Home>\Leads\conf\ directory and update the classpath variable inms.config accordingly.

Upgrading LeadsYou can upgrade Leads by selecting Upgrade Installation mode. In the UpgradeInstallation mode, your existing version of Leads is detected automatically andupgraded to the newer version.

Before you start to run the installer, obtain the following information:v If your Leads system tables are on Oracle: obtain the DSSDATA and DSSINDX

tablespace namesv If your Leads system tables are on DB2®: obtain the Online Transaction

Processing (OLTP) and DSS tablespace names


Make sure that you complete following tasks before upgrade::v Undeploy the current version of Leads from your machine.v Back up all files and folders in your existing installation folder.v Back up your system table database. This is required so you can restore your

system tables if errors occur. Also, even if the upgrade is completely successful,upgrade steps overwrite the etl_parm and src_tbl_import_stat tables, and youmust restore data to these tables using your backup.

Complete the following steps to install Leads in upgrade mode:1. Run the IBM master installer and specify your existing installation directory as

the installation directory to use.The installer detects that you have an earlier version installed and runs inupgrade mode.

2. Copy the ms.config file from the conf directory under your backed-up Leadsdirectory to your upgraded installation's conf directory, overwriting the filethat the installer laid down and restoring your original file.

3. Deploy Leads in your web application server as described in Chapter 4,“Deploying IBM Leads web application,” on page 13.

4. Start Leads and log in to the Admin Console.The Schema Upgrade page loads automatically.v If your Leads system tables are on Oracle, the OLTPDATA and OLTPINDX

tablespace names will be prepopulated. Enter or verify the DSSDATA andDSSINDX tablespace names

v If your Leads system tables are on DB2, enter or verify the OLTP and DSStablespace information.

5. Do one of the following.v If your company policy requires that only a database administrator can

make changes to the database, click Preview SQL to display the SQL codefor this schema on the page. Then click Download SQL to save the SQL ina file you can then give to your database administrator to apply. After theschema have been updated, click Next to proceed to the next page.

v If your company policy allows automatic changes to the database, clickUpgrade Schema.

The Initialize Stored Procedures page opens.6. Do one of the following.

v If your company policy requires that only a database administrator canmake changes to the database, click Preview SQL to display the SQL codefor this schema on the page. Then click Download SQL to save the SQL ina file you can then give to your database administrator to apply. After thestored procedures have been installed, click Next to proceed to the nextpage.

v If your company policy allows automatic changes to the database, clickInstall Stored Procedures.

The Application Upgrade Tasks page opens.7. Click Perform Upgrade Tasks.

The Initialize Data page opens.8. Click Next to upgrade the Leads data.

The Finalize Application Upgrade page opens.9. Click Perform Final Upgrade Tasks. The previous upgrade steps have

restored default values in the etl_parm and src_tbl_import_stat tables.


Restore the data from your old version, using data from the backup you madein an earlier step. The upgrade enables the Change Request and Referralfeatures. You can disable these features by changing theChangeRequests.enabled and Referral.enabled parameters in the ms.configfile, located in the conf directory under your upgraded Leads installation.

10. Restart the application server and then login to Leads to verify that it isrunning properly.

Configuring the Leads Sub-Status featureUse the following guidelines to use the Sub-Status feature in Leads after upgrade.

If you upgrade from a version of Leads earlier than 7.5.0, and you want tocontinue to use the Sub-Status feature, you must complete the following steps:1. Replace the existing sub-status control with the new sub-status editor so that

changes in substatus are recorded in the sub-status history.2. Add sub-status history to the Leads Details page.

For instructions, see the IBM Leads Administrator's Guide.

Merge customized language properties filesIf you customize the Leads user interface, ensure that your customization ispreserved when you upgrade previous versions of Leads to 9.1.

The Leads user interface

The Leads user interface is made up of:v Attributes, which represent information about the referrals, leads, companies,

contacts, products, and other objects that are stored in Leads. An example of anattribute might be Contact’s First Name.

v Non-attribute text. For instance, labels or titles might be displayed on the screento help group attributes and help the user understand required information. Anexample of non-attribute text might be the Find Leads page title.

The attributes and non-attribute text that make up the user interface are stored inproperties files. If you are using multiple locales, the Attribute Editor automaticallycreates a separate property file for each locale.

Leads customizations

You might want to modify the user interface for a number of reasons. You mightcustomize the interface to support multiple locales, or to incorporate specificbusiness terminology.

You can make the following customizations to attributes:v Global customizations to attributes: The Attribute Editor sets the display of

attributes globally throughout the user interface.v Page-level customizations to attributes: The Detail Page Editor sets or changes

the display of an attribute at the page level. Changes you make here apply onlyto the page you are editing.

If, however, you want to customize non-attribute text that is displayed in the userinterface, you must do so by manually modifying the property files.

Chapter 3. Upgrading IBM Leads 11

How customizations are handled during the upgrade

During the upgrade process, be aware that modifications you make to anyattributes by using the Attribute Editor or the Detail Page Editor are automaticallypreserved; take no particular action beyond running the upgrade to preserve thesechanges.

The following table summarizes the action that you must take to preserve Leadsuser interface customizations during an upgrade.

Table 8. Customizations and actions to preserve customizations

To preserve... ... Action

Global customizations made to attributesthrough the Attribute Editor

No action required; the upgrade processautomatically preserves thesecustomizations.

Page-level customizations made to attributesthrough the Detail Page Editor.

No action required; the upgrade processautomatically preserves these customizations


Chapter 4. Deploying IBM Leads web application

When you run the IBM installer, you create WAR files for Leads and the AdminConsole. You must now deploy the Leads web application on your web applicationserver.

We assume that you know how to work with your web application server. Consultyour web application server documentation for details.

Guidelines for deploying Leads on WebSphereYou must follow a set of guidelines when you deploy Leads on Websphere.

Make sure that the version of WebSphere meets the requirements that aredescribed in the IBM Enterprise Products Recommended Software Environments andMinimum System Requirements document, including any necessary fix packs. Usethe following guidelines when you deploy Leads on WebSphere:v When you deploy the WAR/EAR file, ensure that the JDK source level of the

JSP compiler is set to Java™ 16 or 17v Deploy the leads.war and admin.war file or leads.ear file as an enterprise

application. When you deploy the EAR file or the WAR file, ensure that the JDKsource level of the JSP compiler is set to Java™ 16 or 17, and that JSP pages areprecompiled 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 Optionswizard runs.

– In step 1 of the Select Installation Options wizard, select PrecompileJavaServer Pages files.

– In step 3 of the Select Installation Options wizard, ensure that the JDKSource Level is set to 16 or 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 LeadsData as thematching Target Resource.

The context root is created by default.v In the Web Container Settings > Web Container > Session Management section

of the server, enable cookies. Specify a different session cookie name for eachapplication that is deployed. Use one of the following procedures to specify acookie name:– Select the Override session management check box under Session

Management.If you deployed separate WAR files for your IBM EMM products, in theWebSphere console, in the Applications > Enterprise Applications >[deployed_application] > Session Management > Enable Cookies > CookieName section of the server, specify a unique session cookie name.If you deployed EAR files for your IBM EMM products, in the WebSphereconsole, in the Applications > Enterprise Applications >[deployed_application] > Module Management > [deployed_module] >Session Management > Enable Cookies > Cookie Name section of theserver, specify a unique session cookie name.


– If your installation must support non-ASCII characters, for example forPortuguese or for locales that require multi-byte characters, add the followingarguments to Generic JVM Arguments at the server level:-Dfile.encoding=UTF-8

-Dclient.encoding.override=UTF-8

Navigation tip: Select Servers > Application Servers > Java and ProcessManagement > Process Definition > Java Virtual Machine > Generic JVMArguments. See the WebSphere documentation for additional details.

v In the Applications > Enterprise Applications section of the server, select theEAR file or WAR file that you deployed, then select Class loading and updatedetection 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 inapplication.

v The following additional setting is required for WAS 8.5:In Websphere Enterprise Applications, select Your Application > ManageModules > Your Application > Class Loader Order > Classes loaded with localclass loader first (parent last).

v The recommended minimum heap size for the basic functioning of theapplication 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 ProcessManagement > 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.

WebLogic guidelinesDeploy Leads on Weblogic by using the Leads WAR files.

Use the following guidelines when you deploy Leads on WebLogic:v On WebLogic, you must extract the two Leads WAR files (leads.war and

admin.war) and then deploy the extracted WAR files. If you mistakenly create anEAR file containing these two WAR files, you must extract the EAR file to obtainthe two WAR files, and then extract the WAR files.You can use a zip utility or the Java jar command to extract the files. If you usethe Java command, you can use the JDK packaged with your web server. Seehttp://download.oracle.com/javase/1.4.2/docs/tooldocs/windows/jar.html forinformation on using this command.

v Deploy the extracted leads.war and admin.war as web applications.v Add the following JAVA_OPTIONS in the setDomainEnv script, located in the bin

directory under your WebLogic domain directory.


http://download.oracle.com/javase/1.4.2/docs/tooldocs/windows/jar.html

-Dconf.path=/path_to_Leads_install_directory/conf

-Dleads.path=/path_to_WebLogic_deployed_applications_ directory/leads.ear/leads.war

-DAFFINIUM_HOME=/path_to_IBM_EMM_Home_root_install_directory

The server has to be restarted for changes to take effect.

Configuring the IBM IHS web server for SSLConfigure the IBM HTTP Server (IHS) web server so that it can communicate withthe web application server. After you configure IBM IHS web server, you canconfigure Secure Sockets Layer (SSL).

Before configuring the IBM IHS web server for SSL, ensure that the followingconditions are fulfilled:v Working installations of your web server and the web application server exist.v Leads installation is complete.

Enabling HTTP compression and SSL encryptionConfigure the IHS with a WebSphere application server if you want to usecompression and SSL encryption of the HTML transmission or both between theweb server and the browser client.

Leads supports standard HTML compression, as defined in the W3C HTTPspecification (RFC 2616), for the Leads application pages (HTML/JSP, JavaScript,and style sheets) between the web server and the browser client. Leads supportscompression by using the IHS mod_deflate module and encryption through theSSL capabilities that are built into the IBM HTTP Server (IHS).

Note: To start the Leads application when SSL is enabled, you must connect tothe web server by entering https://host/ in a browser window, where host is thename of the computer where Leads is installed, for example: https://LeadsServer1. If necessary, shut down the IHS web server: Complete the following steps to

shut down the IHS server:a. Change directories to the IHS bin directory. By default this directory is

/opt/IBMIHS/bin. For example, at the command prompt type:cd/opt/IBMIHS/bin

b. Stop IHS by typing: ./apachectl stop

2. Change directories to the IHS configuration directory. By default this directoryis: /opt/IBMIHS/conf. For example, type at the command prompt:cd/opt/IBMIHS/conf

3. Edit the configuration file httpd.conf. Complete the following steps to edithttpd.conf file:a. In a text editor, open httpd.conf configuration file.b. Copy the following lines at the bottom of the httpd.conf file:

LoadModule was_ap20_module /opt/[WebSphere-root]/AppServer/bin/mod_was_ap20_http.soWebSpherePluginConfig /opt/[WebSphereroot]/AppServer/config/cells/plugin-cfg.xml#AddModule mod_was_ap20_http.cLoadModule was_ap20_module /opt/IBMIHS/modules/mod_was_ap20_http.soWebSpherePluginConfig /opt/IBMIHS/modules/conf/plugin-cfg.xml#AddModule mod_was_ap20_http.c

c. Continue to the next section.

Chapter 4. Deploying IBM Leads web application 15

Enabling HTTP compressionEnable an HTTP compression between the web server and the browser client byusing the mod_deflate module that is built into IBM HTTP server (IHS).

Complete the following steps to enable HTTP compression.

Note: If you do not want to enable compression, skip to step 2.1. Continue from step b in Enable HTTP compression and SSL encryption.

a. Search for the following line:#LoadModule deflate_module modules/mod_deflate.so

This line loads the module to support compression in the web server.b. Remove the comment character, #, from the line that you found in Step b.c. The following lines set specific configuration settings for compression. Copy

the following lines to the bottom of the httpd.conf file:# Turn on compression for everything except images#<Location /># Insert filterSetOutputFilter DEFLATE# Netscape 4.x has some problems...BrowserMatch ^Mozilla/4 gzip-only-text/html# Netscape 4.06-4.08 have some more problemsBrowserMatch ^Mozilla/4\.0[678] no-gzip# MSIE masquerades as Netscape, but it is fineBrowserMatch MSIE !no-gzip !gzip-only-text/html# Don’t compress imagesSetEnvIfNoCase Request_URI "\.(?:gif|jpe?g|png)$" no-gzip dont-vary# Don’t compress .js & .css files as IE cannot handle thatSetEnvIfNoCase Request_URI "\.(?:js|css)$" no-gzip dont-vary# Make sure proxies don’t deliver the wrong content#Header append Vary User-Agent env=!dont-vary</Location>#DeflateFilterNote ratioLogFormat ’%t "%r" %b (%{ratio}n)’ deflateCustomLog logs/deflate_log deflate

2. Optionally, enable SSL encryption. If you want to enable SSL encryption, enterthe encryption information into the configuration file as described in "Add SSLencryption." Otherwise, skip to Step 3.

3. Save and close the httpd.conf file.4. Restart the server.5. Change directories to the IHS bin directory. By default this directory is

/opt/IBMIHS/bin. For example, at the command prompt type: cd/opt/IBMIHS/bin

6. Type the following command to start IHS: ./apachectl start

Adding SSL encryptionWhen you add an SSL encryption, ensure that the properties in the ms.config filesare correctly specified.

Before you enable SSL encryption, confirm that the following settings exist:v In the ms.config file, confirm that the transmitter.nonSSLServerHostAndPort

property is set to the internal Application Server HTTP port of the WebSphere.By default, the port can be 9080 or 9081. Leads cannot create and distribute usernotifications over an encrypted port. During installation, the application should


set the transmitter.nonSSLServerHostAndPort property to a non-encrypted port.After installation, confirm that the the transmitter.nonSSLServerHostAndPortproperty is set correctly to a port that is pure HTTP (no SSL).

v In the plugin-cfg.xml file, ensure that the VirtualHostGroup includes an entryfor this same internal Application Server HTTP port in addition to your SSLport. For more information about the port numbers, see step 2 in "ConfigureWebSphere Administration." For more information about editing plugin-cfg.xml,refer to "Edit the server configuration file."

1. If not already opened, open the file httpd.conf in a text editor. By default thisfile is in the /opt/IBMIHS/conf.

2. Search for the following line:# Dynamic Shared Object (DSO) Support

3. Go to the end of the list of modules in the httpd.conf. Add the following lineto the end of the list of modules:LoadModule ibm_ssl_module modules/mod_ibm_ssl.so

This line loads the module to support SSL encryption in the web server.4. To enable SSL support, add lines similar to the following lines below to the end

of the httpd.conf file. The details of the lines depend on your environment.The lines below are only an example.LISTEN 443SSLEnableKeyfile /opt/IBMIHS/bin/key.kdbSSLServerCert TestCertificateSSLStashfile /opt/IBMIHS/bin/key.sth

Modify the following lines to correspond to your environment:a. LISTEN 443 specifies the port used for SSL access. Port 443 is commonly

used. The port you specify must match the port that you specified whenyou created the VirtualHost Name in the plugin-cfg.xml file on theapplication server. See "Edit the server configuration file."

b. SSLEnable is included exactly as is.c. The remaining lines provide information to support the use of a certificate

with your SSL deployment:Keyfile /opt/IBMIHS/bin/key.kdbSSLServerCert <certificate_name>SSLStashfile /opt/IBMIHS/bin/key.sth

The /opt/IBMIHS/bin directory is the default location for the Key file andthe SSLStash file. Confirm that the location of these files in yourenvironment.Following the SSLServerCert property, replace <certificate_name> with thename of the certificate that you use to access your site. For moreinformation about using certificates, see the documentation for IHS 2.0.

Note: To disable SSL encryption, open the configuration file and comment out theline shown in Step 3 and the lines that you added to the end of the file in step 4.Save the file, then restart the server.

Chapter 4. Deploying IBM Leads web application 17

Chapter 5. Uninstalling Leads

Run the Leads uninstaller to uninstall Leads. When you run the Leads uninstaller,the files that were created during the installation process are removed. Forexample, files such as configuration files, installer registry information, and userdata are removed from the computer.

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 Leads must run theuninstaller.

Complete the following tasks to uninstall Leads:1. If you have deployed the Leads web application, undeploy the web application

from WebSphere or WebLogic.2. Shut down WebSphere or WebLogic.3. Stop the processes that are related to Leads.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 tabledatabase.

5. Complete one of the following steps to uninstall Leads:v Double-click the Leads uninstaller that exists in the Uninstall_Product

directory. The uninstaller runs in the mode in which you installed Leads.v In a command-line window, navigate to the directory where the uninstaller

exists, and run the following command to uninstall Leads by using theconsole 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 Leads by using the silentmode:Uninstall_Product -i silent

When you uninstall Leads by using the silent mode, the uninstallationprocess does not present any dialogs for user interaction.

Note: If you do not specify an option for uninstalling Leads, the Leadsuninstaller runs in the mode in which Leads is installed.


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.

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.


http://www.ibm.com/support/entry/portal/open_service_request

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 about 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 websites are provided forconvenience only and do not in any manner serve as an endorsement of thosewebsites. The materials at those websites are not part of the materials for this IBMproduct and use of those websites is at your own risk.


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


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 25

http://www.ibm.com/legal/copytrade.shtml

http://www.ibm.com/legal/copytrade.shtml

��

Printed in USA

ibm leads: upgrade guide€¦ · v “upgrading leads” on page 9 v “configuring the leads...

Documents