Siperian Hub Installation Guide (Windows and

Transcription

Siperian Hub Installation Guide (Windows and
XU SP2
Siperian Hub XU SP2
Installation Guide (Windows and Oracle)
© 2009 Siperian, Inc.
Copyright 2009 Siperian, Inc. [Unpublished - rights reserved under the Copyright Laws of the United
States]
THIS DOCUMENTATION CONTAINS CONFIDENTIAL INFORMATION AND TRADE
SECRETS OF SIPERIAN, INC. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED
WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SIPERIAN, INC.
Siperian and the Siperian logo are trademarks or registered trademarks of Siperian, Inc. in the US and
other countries. All other products or services mentioned are the trademarks or service marks of their
respective companies or organizations.
Contents
Preface
Intended Audience ...........................................................................................................................................ix
Contents..............................................................................................................................................................x
Learning About Siperian Hub .........................................................................................................................x
Contacting Siperian ........................................................................................................................................xiii
Chapter 1: Introducing Siperian Hub Installation
About the Installation Process ........................................................................................................................1
Chapter 2: Installing the Hub Store
About Hub Store ...............................................................................................................................................4
About Installing the Hub Store .......................................................................................................................5
Setting the Oracle PLSQL Compiler Flags..........................................................................................5
Creating the Tablespaces ..................................................................................................................................6
Creating the Master Database and One ORS Database ..............................................................................8
Creating an Additional ORS Database.........................................................................................................11
Testing the Database Connection.......................................................................................................14
Creating a proxy user ............................................................................................................................14
Chapter 3: Installing the Hub Server
About the Hub Server.....................................................................................................................................18
About the Application Server and Connection Pooling..................................................................18
Configuring the Services Integration Framework for Asynchronous Requests ..........................18
About the Post-Installation Process ...................................................................................................19
Before Installing the Hub Server ..................................................................................................................20
About the Hub Server and WebLogic................................................................................................21
About Installing a Newer Version of the Hub Server .....................................................................21
iii
About Configuring JBoss..................................................................................................................... 22
Using an Oracle Data Source with Application Servers ................................................................. 22
Configuring JBoss to Run Both the Hub Server and Cleanse Match Server............................... 23
Installing the Hub Server ............................................................................................................................... 24
Checking the Log Files......................................................................................................................... 28
Configuring the Hub Server .......................................................................................................................... 28
Checking the Version and Build Number......................................................................................... 29
Configuring the Logging Settings ....................................................................................................... 29
Setting the Configuration Properties.................................................................................................. 29
Changing Your WebLogic Settings .................................................................................................... 30
Changing Your WebSphere Settings.................................................................................................. 30
Changing Your JBoss Settings ............................................................................................................ 31
Changing the Password for the CMX_SYSTEM User ................................................................... 31
Changing the Password for the CMX_ORS User ........................................................................... 32
Running the Post-Install Steps...................................................................................................................... 32
Running the Post-Install Process Manually ...................................................................................... 32
Manually Redeploying the Hub Server Application ........................................................................ 33
Manually Restarting WebLogic ........................................................................................................... 34
Chapter 4: Installing the Cleanse Match Server
About Cleanse Match Server......................................................................................................................... 36
About the Supported Cleanse Engines.............................................................................................. 36
About the Installation Process............................................................................................................ 36
About the Post-Installation Process................................................................................................... 37
Before Installing Cleanse Match Server....................................................................................................... 38
About Installing a Newer Version of Cleanse Match Server ......................................................... 38
Using the Correct Siperian License File for Your Cleanse Match Server .................................... 39
About Cleanse Match Server and WebLogic.................................................................................... 39
About Cleanse Match Server and WebSphere.................................................................................. 44
About Cleanse Match Server and JBoss ............................................................................................ 49
Configuring JBoss for Both Cleanse Match Server and Hub Server ............................................ 51
Installing Cleanse Match Server.................................................................................................................... 52
Configuring Cleanse Match Server for your Application Server ................................................... 53
iv
Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Configuring Cleanse Match Server for Your Cleanse Engine ........................................................54
Continuing Your Cleanse Match Server Installation........................................................................55
Checking the Log Files .........................................................................................................................56
Configuring the Cleanse Match Server.........................................................................................................56
Configuring Cleanse Match Server with Various Cleanse Engines ...............................................57
Checking the Version and Build Number .........................................................................................57
Deleting Temporary Files.....................................................................................................................57
Configuring Logging Settings ..............................................................................................................58
Setting Configuration Properties.........................................................................................................58
Adding the Oracle TNS Name to the ORS Database .....................................................................58
Running the Post-Install Process Manually.................................................................................................59
Configuring Cleanse Match Server for Multi-Threading...........................................................................60
Configuring Dual Cleanse Servers ................................................................................................................61
Configuring Multiple Instances of Your Application Server..........................................................62
Deploying Cleanse Match Server on the Second Application Server Instance ...........................63
Using Multiple Cleanse Servers ...........................................................................................................64
Distributed Cleanse Match Servers...............................................................................................................65
Installing the Siperian Hub Server into a WebLogic Server Cluster........................................................65
Creating a WebLogic Cluster ...............................................................................................................66
Deploying the Cleanse Server Once the Cluster is Running ..........................................................68
Chapter 5: Launching Siperian Hub Console
About the Hub Console .................................................................................................................................69
Starting the Hub Console...............................................................................................................................70
Chapter 6: Clustering
Installing the Siperian Hub Server into a WebLogic Server Cluster........................................................72
Creating a WebLogic Cluster ...............................................................................................................72
Configure Services and Deploy the Hub Server...............................................................................73
Deploying the Cleanse Server..............................................................................................................74
Installing the Siperian Hub Server into a WebSphere Server Cluster .....................................................75
Installing Siperian Hub .........................................................................................................................75
Contents
v
Instructions to Create a WebSphere Cluster..................................................................................... 76
Load Balancing ...................................................................................................................................... 77
Configure Services and Deploy Hub Server ..................................................................................... 77
Deploy the Cleanse Match Server ...................................................................................................... 79
Chapter 7: Upgrading Siperian Hub
Before You Upgrade....................................................................................................................................... 82
About the Upgrade Process................................................................................................................. 83
About the Supported Platforms.......................................................................................................... 84
Checking the Version and Build Number......................................................................................... 84
Patch Installs for AddressDoctor and Platon Licenses................................................................... 85
Upgrading the Hub Server............................................................................................................................. 86
Patch Install for the Hub Server......................................................................................................... 86
Checking the Log Files......................................................................................................................... 87
Running the patchInstallSetup Script .......................................................................................................... 88
About Upgrade Failures ....................................................................................................................... 89
Upgrading Cleanse Match Server ................................................................................................................. 89
Patch Install for the Cleanse Match Server ....................................................................................... 90
Check the log files................................................................................................................................. 91
About Patch Install Failures ................................................................................................................ 91
About Non-default Server Names and SOAP Ports on WebSphere ........................................... 92
Upgrading the Hub Store............................................................................................................................... 94
Proxy User Questions........................................................................................................................... 96
Processing Data in the Staging Tables After Migration from XR................................................. 96
Updating the Database ................................................................................................................................... 97
General Recommendations ................................................................................................................. 97
In case of failure .................................................................................................................................... 99
Updating Hierarchy Manager ........................................................................................................................ 99
Chapter 8: Uninstalling Siperian Hub
About Uninstalling Siperian Hub ............................................................................................................... 103
Uninstalling Cleanse Match Server............................................................................................................. 104
vi
Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Undeploy Cleanse Server....................................................................................................................104
Uninstalling Hub Server ...............................................................................................................................105
Undeploy the Hub Server.............................................................................................................................105
Uninstalling the Hub Store From Oracle ..................................................................................................106
Chapter 9: Troubleshooting
Updating Hub Server Parameters After Installation................................................................................110
Changing the Hub Server Parameters for WebLogic ....................................................................110
Changing the Hub Server Parameters for the Database................................................................113
Changing the Hub Server Parameters for WebSphere ..................................................................114
Changing the Hub Server Parameters for JBoss.............................................................................115
Updating Cleanse Match Server Parameters After Installation ..............................................................116
Changing the Cleanse Match Server Parameters for WebLogic ..................................................117
Configuring the JVM Settings......................................................................................................................120
Setting the JVM Size for WebSphere ...............................................................................................120
Setting the JVM Size for WebLogic Server .....................................................................................120
Setting the JVM Size for JBoss..........................................................................................................121
Manually Redeploying Hub Server .............................................................................................................121
About the Siperian Hub Log Files ..............................................................................................................122
About the Siperian Hub Log Files ....................................................................................................122
console.log ............................................................................................................................................122
cmxserver.log (for Master Reference Manager)..............................................................................123
cmxserver.log (for Cleanse Match Server) .......................................................................................123
cmxdebug.log .......................................................................................................................................123
Enabling Debug Logging ...................................................................................................................124
Setting the Location of the Files .......................................................................................................125
Checking the Hub and Cleanse Server Silent Install................................................................................125
Checking the Hub Server Silent Install ............................................................................................126
Checking the Cleanse Server Silent Install.......................................................................................128
Match Process Error: VerifyNeedToStrip.................................................................................................129
Inaccurate Start/Stop Timestamp for ORS ..............................................................................................130
Compatibility Errors During Full Install ...................................................................................................130
Contents
vii
Appendix A: Manually Configuring Siperian System Message Queues
JBoss Configuration...................................................................................................................................... 132
Configuring Additional Queues........................................................................................................ 133
WebLogic Configuration ............................................................................................................................. 134
Configuring Additional Queues........................................................................................................ 135
BEA WebLogic 9.x Configuration ............................................................................................................. 135
Configuring Additional Queues........................................................................................................ 137
IBM WebSphere 6.1 Configuration ........................................................................................................... 138
Configuring Additional Queues........................................................................................................ 139
Index....................................................................................................................................................................... 141
viii
Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Preface
Welcome to the Siperian Hub™ XU SP2 Installation Guide (Windows and Oracle). This
guide explains how to perform a first-time installation of Siperian Hub Server and the
Cleanse Match Server. It also covers upgrades from earlier versions to Siperian Hub
XU SP2.
Chapter Contents
•
Intended Audience
•
Contents
•
Learning About Siperian Hub
•
Contacting Siperian
Intended Audience
This guide has been written for database administrators, system administrators, and
other implementers who are responsible for installation and setup tasks required for
Siperian Hub. System administrators must be familiar with your Windows platform.
Database administrators must be familiar with the database environment on which they
are installing Siperian Hub. Knowledge of Oracle administration is particularly
important.
Other administration and configuration tasks are described in the Siperian Hub
Administrator Guide.
ix
Contents
Contents
This guide contains the following sections:
Chapter 1, “Introducing Siperian Orients you to the installation process
Hub Installation”
Chapter 2, “Installing the Hub
Store”
Explains how to install Hub Store
Chapter 3, “Installing the Hub
Server”
Explains how to install and configure Hub Server
Chapter 4, “Installing the
Cleanse Match Server”
Explains how to install and configure Cleanse Match Server
Chapter 5, “Launching Siperian
Hub Console”
Explains how to launch the Hub Console
Chapter 6, “Clustering”
Explains how to set up Siperian Hub in a cluster
Chapter 7, “Upgrading Siperian Explains how to upgrade Siperian Hub from earlier versions
Hub”
Chapter 8, “Uninstalling Siperian Explains how to uninstall Hub Server components
Hub”
Chapter 9, “Troubleshooting”
Explains how to troubleshoot Siperian Hub after installation
Appendix A, “Manually
Configuring Siperian System
Message Queues”
Explains how to configure message queues for use with
Siperian Hub
Learning About Siperian Hub
What’s New in Siperian Hub
What’s New in Siperian Hub describes the new features in this Siperian Hub release.
Siperian Hub Release Notes
The Siperian Hub Release Notes contain important information about this release of
Siperian Hub. Read the Siperian Hub Release Notes before installing Siperian Hub.
x
Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Learning About Siperian Hub
Siperian Hub Overview
The Siperian Hub Overview introduces Siperian Hub, describes the product architecture,
and explains core concepts that all users need to understand before using the product.
Siperian Hub Installation Guide
The Siperian Hub Installation Guide for your platform explains how to install Siperian
Hub and Cleanse Match Server. There is a Siperian Hub Installation Guide for each
supported platform.
Siperian Hub Cleanse Adapter Guide
The Siperian Hub Cleanse Adapter Guide explains to installers how to configure Siperian
Hub to use the supported adapters and cleanse engines.
Siperian Hub Data Steward Guide
The Siperian Hub Data Steward Guide explains how to use Siperian Hub. It provides a
description of the Siperian Hub platform through a discussion of Siperian Hub
concepts and tasks. Data stewards and users who are new to Siperian Hub should read
the Siperian Hub Data Steward Guide first.
Siperian Hub Administrator Guide
The Siperian Hub Administrator Guide explains how to configure, administer, and manage
a Siperian Hub implementation. It provides a description of the Siperian Hub platform
through a discussion of Siperian Hub concepts, services, tools, and databases.
Administrators should read the Siperian Hub Administrator Guide first.
Siperian Hub Services Integration Framework Guide
The Siperian Hub Services Integration Framework Guide explains how to developers how to
use the Siperian Hub Services Integration Framework (SIF) to integrate Siperian Hub
functionality with your applications, and how to create applications using the data
provided by Siperian Hub. SIF allows you to integrate Siperian Hub smoothly with
xi
Learning About Siperian Hub
your organization's applications. After reading the Siperian Hub Overview, developers
should read the Siperian Hub Services Integration Framework Guide.
Siperian Hub Metadata Manager Guide
The Siperian Hub Metadata Manager Guide explains how to use the Siperian Hub
Metadata Manager tool to validate their organizations metadata, promote changes
between repositories, import objects into repositories, export repositories, and related
tasks.
Siperian Hub Resource Kit Guide
The Siperian Hub Resource Kit Guide explains how to install and use the Siperian Hub
Resource Kit, which is a set of utilities, examples, and libraries that assist developers
with integrating the Siperian Hub into their applications and workflow. This document
provides a description of the various sample applications that are included with the
Resource Kit.
Siperian Hub Insight Manager Guide
The Siperian Hub Insight Manager Guide explains how to install, configure, and use the
Siperian Hub Insight Manager to generate reporting metadata for the data managed in
the Hub Store. It provides a description of how to use this reporting metadata with
third-party reporting tools to create reports and metrics for this data.
Siperian Training and Materials
Siperian provides live, instructor-based training to help you become a proficient user as
quickly as possible. From initial installation onward, a dedicated team of qualified
trainers ensure that your staff is equipped to take advantage of this powerful platform.
To inquire about training classes or to find out where and when the next training
session is offered, please visit our website or contact Siperian directly.
xii
Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Contacting Siperian
Contacting Siperian
Technical support is available to answer your questions and to help you with any
problems encountered using Siperian products. Please contact your local Siperian
representative or distributor as specified in your support agreement. If you have a
current Siperian Support Agreement, you can contact Siperian Technical Support:
Method
Contact Information
World Wide Web
http://www.siperian.com/support
E-Mail
[email protected]
Voice
U.S.: 1-866-SIPERIAN (747-3742)
We are interested in hearing your comments about this book. Send your comments to:
by E-Mail:
[email protected]
by Postal Service:
Documentation Manager
Siperian, Inc.
100 Foster City Blvd.
2nd Floor
Foster City, CA 94404 USA
xiii
Contacting Siperian
xiv
Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
1
Introducing Siperian Hub Installation
This chapter describes the overall Siperian Hub installation process. Subsequent
chapters describe each step in the process. For a review of the Siperian Hub
architecture, see the Overview Guide.
Chapter Contents
•
About the Installation Process
Note: Siperian Hub supports a variety of cleanse engines. This Installation Guide
(Windows and Oracle) assumes that your site’s cleanse engine is already installed and
configured according to the vendor’s instructions.
About the Installation Process
The installation process for Siperian Hub consists of installing the various components
and then launching the Hub Console.
To install Siperian Hub, go through the following steps in the exact order specified
here:
1. Hub Store, as explained in Chapter 2, “Installing the Hub Store.”
2.
Hub Server, as explained in Chapter 3, “Installing the Hub Server.”
3.
Cleanse Match Server and configure your cleanse engine, as explained in
Appendix 4, “Installing the Cleanse Match Server.”
1
About the Installation Process
4.
If you are using an adapter for your cleanse engine, configure your adapter.
To learn more, see “Configuring the Cleanse Match Server” on page 56, and the
Siperian Hub Cleanse Adapter Guide.
5.
Start Hub Console, as explained in Chapter 5, “Launching Siperian Hub Console.”
If you are upgrading from an earlier version of Siperian Hub, see Chapter 7,
“Upgrading Siperian Hub” for upgrade and configuration details.
Note: Siperian System message queues are now automatically configured for use with
the Siperian Hub. If you need to manually configure the system message queues for
troubleshooting purposes, see Appendix A, “Manually Configuring Siperian System
Message Queues”.
Note: Installing Siperian products on Windows using the command line interface is
not supported.
2 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
2
Installing the Hub Store
This chapter explains how to install the Hub Store on Oracle.
Important: Different versions of the Siperian Hub cannot operate together in the
same environment—all components of your installation must be the same version. If
you want to have multiple versions of Siperian Hub at your site, you must install each
version in a separate environment.
Chapter Contents
•
About Hub Store
•
About Installing the Hub Store
•
Creating the Tablespaces
•
Creating the Master Database and One ORS Database
•
Creating an Additional ORS Database
3
About Hub Store
About Hub Store
The Hub Store is the database that contains all your Siperian Hub objects.
Siperian Hub works with one Master Database and one or more ORS databases.
The Master Database contains all the Siperian Hub metadata, including configuration
information and other information Siperian Hub requires to run properly. An ORS
database contains all the data you load or create within the Siperian Hub system.
There are two scripts you can use to create databases for the Hub Store.
Script
Description
setup.sql
Creates the Master Database and one ORS database. To learn more, see
“Creating the Master Database and One ORS Database” on page 8.
setup_ors.sql Creates one ORS database. To learn more, see “Creating an Additional
ORS Database” on page 11.
Note: When running the scripts, the default Master Database name is CMX_SYSTEM
and the default ORS database name is CMX_ORS. If you must use a different name
for the Master Database or usernames that own these databases, contact Siperian
support.
The most commonly used of these scripts is setup.sql. The setup.sql script sets up
the Master Database and one ORS database.
Note: Multiple Master Databases cannot share the same ORS. A single ORS cannot be
associated with multiple Master Databases.
If you want to set up additional ORS databases on a single DBMS, you can use
setup.sql to set up the Master Database and one ORS database, and then use setup_
ors.sql to set up additional ORS databases. This configuration allows you to have a
single Master Database and ORS databases on other servers, all controlled through that
Master Database. This avoids installing Master Databases on the servers with the ORS
databases.
4 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
About Installing the Hub Store
Important: When you are installing a major platform release on top of an older
version of Siperian Hub, the major platform release overwrites the master data source
CMX_SYSTEM. Minor releases, such as those with SP followed by a numeral after the
name do not overwrite the master data source.
About Installing the Hub Store
To install Hub Store:
1. Ensure that you have Oracle installed and configured.
2.
If you are using Oracle version 10g R2, set the Oracle compiler flags as explained
in “Setting the Oracle PLSQL Compiler Flags” on page 5.
3.
Create an Oracle database for your Hub Store.
4.
Create the Oracle tablespaces required for Hub Store. To learn more, see “Creating
the Tablespaces” on page 6.
5.
Create the schemas required for Hub Store. You have two options:
If you do not yet have a Master Database, choose the option to create one Master
Database and one ORS database. To learn more, see “Creating the Master
Database and One ORS Database” on page 8.
If you already have a Master Database and an ORS, and want to create an
additional ORS, choose “Create An Additional ORS Database.” To learn more, see
“Creating an Additional ORS Database” on page 11.
Setting the Oracle PLSQL Compiler Flags
If you are using Oracle 10gR2, you must set the PLSQL compiler flags. If you are using
any other version, you can skip this step. In 10gR2, the default value for PLSQL_
COMPILER_FLAGS is NATIVE. This causes Siperian Hub packages to fail to compile.
You must set this value to be INTERPRETED.
Installing the Hub Store 5
Creating the Tablespaces
To set the Oracle PLSQL compiler flags:
1. Connect to Oracle and get a SQL command prompt.
2.
Issue the following commands:
SHOW PARAMETER plsql_compiler_flags;
ALTER SYSTEM SET plsql_compiler_flags=INTERPRETED;
3.
Close the connection to Oracle.
Creating the Tablespaces
This section describes how to create the three tablespaces required by Hub Store:
CMX_DATA, CMX_INDX, and CMX_TEMP.
Note: The sizes described in this section are examples. Adjust the default sizes and
number of data files based on your analysis of data volumes to be loaded into Siperian
Hub.
Creating CMX_DATA
The CMX_DATA tablespace is the default tablespace for the Siperian Hub ORS
schema. Create this tablespace as a locally managed or manually configured tablespace.
Use a command similar to the following:
CREATE TABLESPACE CMX_DATA
NOLOGGING
DATAFILE '<Oracle_Install_dir>\CMX_DATA1.dbf' SIZE 2048M REUSE
EXTENT MANAGEMENT LOCAL;
COMMIT;
where <Oracle_Install_dir> is your Oracle installation directory.
Creating CMX_INDX
The CMX_INDX tablespace is used for indexes created and used by Siperian Hub.
Create this tablespace as a locally managed or manually configured tablespace.
6 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Creating the Tablespaces
Use a command similar to the following:
CREATE TABLESPACE CMX_INDX
NOLOGGING
DATAFILE '<Oracle_Install_dir>\CMX_INDX1.dbf' SIZE 2048M REUSE
EXTENT MANAGEMENT LOCAL;
COMMIT;
where <Oracle_Install_dir> is your Oracle installation directory.
Creating CMX_TEMP
The CMX_TEMP tablespace is used for temporary tables created and used by Siperian
Hub, and for stored procedures. Create this tablespace as a locally managed or
manually configured tablespace.
Important: Despite its name, do not create the CMX_TEMP tablespace as an Oracle
TEMPORARY tablespace.
Use a command similar to the following:
CREATE TABLESPACE CMX_TEMP
NOLOGGING
DATAFILE '<Oracle_Install_dir>\CMX_TEMP1.dbf' SIZE 2048M REUSE
EXTENT MANAGEMENT LOCAL;
COMMIT;
where <Oracle_Install_dir> is your Oracle installation directory.
Installing the Hub Store 7
Creating the Master Database and One ORS Database
Creating the Master Database and One ORS
Database
The Siperian Hub distribution includes a script named setup.sql, located in your
distribution’s database\oracle directory. This script:
• Creates the Master Database (default name: CMX_SYSTEM)
•
Creates one ORS database (default name CMX_ORS)
•
Imports the base repository data
Run this script if this is the first time you are installing Hub Store for your Siperian
Hub implementation. If you already have a Master Database for your Hub Store and
want to set up an additional ORS database, see “Creating an Additional ORS
Database” on page 11.
• Setup scripts (setup.sql or setup_ors.sql) create PROXY_ROLE when cmx_
ors is created. cmx_ors user owns this role.
•
Setup scripts (setup.sql or setup_ors.sql) grant required privileges on all
REPOS tables, views, sequences, procedures, packages, functions to PROXY_
ROLE.
To set up schemas with one Master Database and one ORS database:
1. Create a temporary directory on the Oracle database server or on a client
workstation that has Oracle client installed with Oracle utilities.
Copy all of the files from the Siperian Hub distribution (<Siperian_Install_
to the temporary directory you
just created.
Dir>\server\resources\database\oracle)
2.
Open a command window.
Go to the Windows Start menu. choose Run and enter cmd.
3.
Go to the temporary directory you just created.
4.
To start SQL*PLUS, enter:
sqlplus
Press Enter.
8 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Creating the Master Database and One ORS Database
5.
Connect to the server as SYSTEM or as a user with DBA privileges.
6.
To execute the setup.sql script by typing the following command:
@setup.sql
7.
Answer the following prompts:
•
Enter Oracle Server TNS Name:
This is the name by which the database is known on your network. The TNS
Name, which is set at Oracle installation, has the format:
mydatabase.mycompany.com
To learn more about TNS Names, see your Oracle documentation.
•
Enter Oracle Instance Name:
This is the name of the Oracle instance.
•
Enter Oracle Listener Port number [1521]:
This is the port used by the Oracle listener.
Note: The text in brackets is the default information for each prompt. “1521” for
the Listener Port number in this case. Press Enter to use the default information
and go to the next prompt.
•
Enter Oracle database server name:
This is the name of the host running the Oracle database server.
•
Enter Oracle system user name: [SYSTEM]
•
Enter Oracle system password
This is the password for the Oracle SYSTEM account.
•
Enter name of new CMX System (Master) user [CMX_SYSTEM]
This is an Oracle username that the script creates. This user owns all the
Master Database objects in the Hub Store. Do not change this username. This
user is created with the password !!cmx!!
•
Enter name of Data tablespace [CMX_DATA]
This is the tablespace that will contain the data components for the Master
Database.
Installing the Hub Store 9
Creating the Master Database and One ORS Database
•
Enter name of Temporary tablespace [TEMP]
This is the name of the Oracle temporary tablespace. Do not confuse this with
the CMX_TEMP tablespace.
•
Create a proxy user [PROXY_ROLE]:
This step will create a proxy user with access to the database. See “Creating a
proxy user” on page 14 for more detail.
•
Enter name of user [CMX_ORS]
This is an Oracle user name the script creates. This user owns all the ORS
database objects in the Hub Store. This user is created with the password
!!cmx!!
•
Enter password for ORS user [!!cmx!!]
•
Enter name of MRM data tablespace[CMX_DATA]
This is the name of the tablespace that will contain the data components for
the ORS database.
•
Enter name of MRM index tablespace [CMX_INDX]
This is the tablespace that will contain the indexes.
•
Enter name of MRM temporary tablespace <not an Oracle temp
tablespace>[CMX_TEMP]:
•
Enter name of temporary tablespace:[TEMP]
This is the name of the Oracle temporary tablespace. Do not confuse this with
the CMX_TEMP tablespace.
•
Import into CMX_SYSTEM [cmx_system.dmp]
This is the name of the Oracle export file containing the Master Database.
This is included as part of the Siperian Hub install. Do not change this name,
choose the default. The script will look for the default dump file. If it doesn’t
find it, it generates a warning and proceeds.
•
Import into CMX_SYSTEM: Enter the source schema name (fromuser) for
the export file [CMX_SYSTEM]
This is the username under which the dump file was exported. Accept the
default. Do not change this username.
10 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Creating an Additional ORS Database
•
Import into CMX_ORS: Enter the Oracle export file [cmx_ors.dmp]
This is the name of the Oracle export file containing the ORS database. This is
part of the Siperian Hub install. Do not change this name, choose the default.
The script will look for the default dump file. If it doesn’t find it, it generates a
warning and proceeds.
•
Import into CMX_ORS: Enter the source schema name (fromuser) for the
export file [CMX_ORS]
This is the username under which the dump file was exported. Accept the
default. Do not change this username.
•
After the setup script is complete, setup.log and cmx_system.dmpimp.log files
are created in the temporary directory from which you ran the script. Review
this file to ensure no errors occurred. You may see some warnings, which you
can ignore. Errors must be addressed.
If you see database error in the logs, resolve these first with your DBA and/or
RDBMS vendor, and then re-run the setup.sql script.
Creating an Additional ORS Database
The Siperian Hub distribution also includes a script named setup_ors.sql in the
database\oracle directory. This script is used to create an additional ORS database
and import the base repository data. The default ORS database name is CMX_ORS.
You can change the default name of the ORS database name from CMX_ORS to
something else using this script. Run this script if you already have a Master Database
in your Hub Store and you want to create an additional ORS. You must have a Master
Database for Hub Store to function. This script does not create that Master Database.
Note: If you prefer to set up the Master Database as well as the ORS database, see
Creating the Master Database and One ORS Database “Creating the Master Database
and One ORS Database” on page 8.
To set up the Siperian Hub schemas with an additional ORS database:
1. Create a temporary directory on the Oracle database server or on a client
workstation that has Oracle client installed with Oracle utilities.
Installing the Hub Store 11
Creating an Additional ORS Database
Copy all of the files from the Siperian Hub distribution (from <Siperian_Hub_
Install_Dir>\server\resources\database\oracle) to the temporary directory you
just created.
2.
Open a command window.
Go to the Windows Start menu. choose Run and enter cmd.
3.
Go to the temporary directory you just created.
4.
To start SQL*PLUS, enter:
sqlplus
Press Enter.
5.
Connect to the server as SYSTEM or as a user with DBA privileges.
6.
Execute the setup_ors.sql script by typing the following command:
@setup_ors.sql
7.
Answer the following prompts:
•
Enter name of User [CMX_ORS]:
This is the name of the Siperian Hub user that owns this ORS.
If the user name you select already exists, the user will be dropped and
recreated. To learn about changing this name, see “Changing the Password for
the CMX_ORS User” on page 32.
Note: The text in brackets is the default information for each prompt. “CMX_
ORS” for the name of the User in this case. Press Enter to use the default
information and go to the next prompt.
•
Enter password for ORS User [!!cmx!!]
•
Enter name of MRM data tablespace [CMX_DATA]:
This is the tablespace in which this ORS will be created.
•
Enter name of MRM index tablespace [CMX_INDX]
This is the tablespace that will contain the indexes.
•
Enter name of MRM temporary tablespace <not an Oracle temp
tablespace>[CMX_TEMP]:
12 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Creating an Additional ORS Database
•
Create a proxy user [PROXY_ROLE]:
This step will create a proxy user with access to the database. See “Creating a
proxy user” on page 14 for more detail.
•
Enter name of Oracle temporary tablespace [TEMP]:
This is the name of the Oracle temporary tablespace.
•
Enter ORACLE server TNS name:
This is the name by which the database is known on your network. For
example:
mydatabase.mycompany.com
This value is set when you install Oracle. See your Oracle documentation to
learn more about this name.
•
Enter name of DBA User [SYSTEM]
This is the Oracle username with DBA privileges.
•
Enter password of DBA User:
This is the password for the Oracle username with DBA privileges.
•
Enter file to import [cmx_ors.dmp]:
This is the name of the Oracle export file containing the ORS database. This is
part of the Siperian Hub install. Do not change this name, choose the default.
The script will look for the default dump file. If it doesn’t find it, it generates a
warning and proceeds.
•
Enter import from user name [cmx_ors]:
This is the user name under which the dump file was exported.
Note: When creating the CMX_ORS schema, you are prompted for the
TEMPORARY tablespace name. Do not confuse this with the CMX_TEMP
tablespace. When prompted, enter the Oracle temporary tablespace name (usually
TEMP).
Installing the Hub Store
13
Creating an Additional ORS Database
8.
After the setup scripts are complete, there are log files in the temporary directory
from which you ran the scripts:
•
setup_ors.log
•
cmx_ors.dmpimp.log
Review these files to ensure no errors occurred. You may see warnings, which can
be ignored. Errors must be addressed.
If you see database error in the logs, resolve these first with your DBA and your
RDBMS vendor, and then re-run the setup_ors.sql script.
Testing the Database Connection
Before proceeding, test the database connections from all the machines on which you
will run either Hub Server or Cleanse Match Server. To test these connections, create
the TNS names entries for the database on each of those machines. Then, verify that
the database connections work properly from all the machines.
Note: Each machine must have the same TNS names.
Creating a proxy user
You may want to limit privileges to the database to only run batch jobs. This is typically
done in production environments where security is more strict and database access and
stored procedure batch jobs goes through a proxy user. In this case, you can create a
proxy user for running stored procedure batch jobs and accessing the production
database. For instance, the proxy user would not have permissions to create or alter
tables, so the proxy user cannot be used for making schema changes.
The proxy user is generally limited to running stored procedure batch jobs from job
scheduling scripts.
The proxy role is created as part of the initial database.
Stored Procedure Batch jobs only request a user name and password and do not
require an ORS ID (data source name). In this way, administrators can grant privileges
14 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Creating an Additional ORS Database
to some users to run stored procedures from SQL Plus without granting them full
access to the actual DB Owner.
Proxy users should not be used in the configuration of the Siperian Hub Data Source.
Doing so limits the ability of users to do Hub-related activities, such as creating base
objects. This level of security should be accomplished by using SAM. The data source
should not be modified when a proxy user is created/configured.
The original ORS owner account should only be locked in Oracle when the grant_
priv_to_proxy_role.sql script is being run. The only reason to lock the original owners
to prevent new objects from being created while the grant_priv_to_proxy_
role.sqlscript is being run. This account needs to remain unlocked at all other times in
order for day-to-day activity to be successful (including upgrades).
You can create a proxy user by executing the following steps.
To create a proxy user
It is assumed the user ORS has been created and registered in hub console.
1. Run mk_proxy_ors_user.sql to create a proxy user.
2.
Lock the original ORS
Enter sqlplus as system user. Run this SQLstatement:
alter user <origianl_ors> account lock;
3.
Run grant_priv_to_proxy_role.sql
4.
Unlock the original ORS with:
alter user <origianl_ors> account unlock
5.
Run stored procedure batch jobs and tests using the proxy user.
Note: To add new objects to the schema, repeat the steps 2 - 4
For information about creating a proxy user during an upgrade, see “Proxy User
Questions” on page 96.
Installing the Hub Store
15
Creating an Additional ORS Database
16 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
3
Installing the Hub Server
This chapter explains how to install the Hub Server and create both the Master and
ORS data sources. The Siperian installer can also be used to upgrade existing
installations. If you have a previously installed version of Siperian software, see Chapter
7, “Upgrading Siperian Hub” for details on upgrading. This chapter covers new
installations.
Important: Different versions of Siperian Hub cannot operate together in the same
environment. All components of your installation must be the same version. If you
want to have multiple versions of Siperian Hub, you must install each version in a
separate environment.
Chapter Contents
•
About the Hub Server
•
Before Installing the Hub Server
•
Installing the Hub Server
•
Configuring the Hub Server
•
Running the Post-Install Steps
17
About the Hub Server
About the Hub Server
Siperian Hub Server is the J2EE EAR application within the Siperian Hub system that
lets you orchestrate the data processing within the Hub Store. The GUI tool for
controlling the processing is called Hub Console and it is packaged inside the Hub
Server application as a J2EE WAR module.
Once the Hub Server is fully installed and running, you can launch the Hub Console
on any client machine from an URL through Sun’s Java Web Start. Java Web Start
downloads the Hub Console within the running Hub Server application from the
server machine to the client machine and then launches it. Therefore, the client
machine requires only Java Web Start to launch and run the Hub Console.
About the Application Server and Connection Pooling
Siperian Hub uses connection pooling from data source facilities provided by the J2EE
application servers. Hub Server requires one data source for the Master Database and a
data source for each ORS database that is accessed through the server. The master data
source setup affects the installation process since the Hub Server application will not
start up successfully without it.
The creation of this master data source is automated during the Hub Server installation
process, as is the creation of the ORS data source.
Configuring the Services Integration Framework for
Asynchronous Requests
The Services Integration Framework (SIF) uses a message-driven bean (MDB) on the
JMS queue (named siperian.sif.jms.queue) to process incoming asynchronous
SIF requests. This message queue and the connection factory (named
siperian.mrm.jms.xaconnectionfactory) need to be configured for the specific
application server you are using for your Siperian Hub implementation. Correctly
configured message queues are essential to a fully-functioning Siperian Hub
installation.
18 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
About the Hub Server
The Siperian installer automatically sets up message queues and connection factory
configuration. If you need to manually configure your message queues or connection
factories for testing or troubleshooting purposes, see Appendix A, “Manually
Configuring Siperian System Message Queues”.
About the Post-Installation Process
Once the installer copies the files to the Siperian root installation directory, installation
is complete. The next step is to deploy and configure the Hub Server on the
application server. This is done by the post-installation process. You can choose to
have the installation program perform the post-installation process for you, or end the
program before post-installation begins and do it manually. To learn more about
running the post-install process manually, see “Running the Post-Install Process
Manually” on page 32.
Separating the installation and post-installation (deployment) functions has a few
advantages.
• It enables you to make sure the application starts up successfully before you deploy
the application server. (For further information, see “Before Installing the Hub
Server” on page 20.)
•
It simplifies troubleshooting.
•
It enables you to deploy the application using the application server’s administrator
console.
To deploy and configure the Hub Server:
• Run the postinstallsetup script
By default, the script is located in the following location:
<Siperian_Install_Dir>\hub\server\postinstallsetup.bat
The postinstallsetup script deploys the application and creates a datasource. See
“Running the Post-Install Process Manually” on page 32 for more details.
Installing the Hub Server
19
Before Installing the Hub Server
Before Installing the Hub Server
Before installing Hub Server:
• Make sure that you fulfill the hardware and software requirements for the Hub
Server. To learn more about these requirements, see the Siperian Hub Release Notes.
In particular, make sure you have the correct version of the Oracle drivers.
•
Make sure you have a license file from Siperian. You cannot install Siperian Hub if
you do not have a license.
•
Make e sure that you have your application server installed and configured. To
learn more, see your application server documentation.
•
If you are upgrading your current installation of the Siperian Hub server, see
Chapter 7, “Upgrading Siperian Hub”for upgrade details and requirements.
•
- Make sure that there is sufficient physical memory available to satisfy the runtime
needs of all the Siperian software you intend to install.
Use the following formula to determine if your physical memory is adequate:
total Siperian runtime memory footprint = JDK JVM max heap size
of the application server + Window’s native heap size
By default, Windows has a 2GB limit to the amount of memory it will allow to be
used by a single process. This 2GB limit is the limit within which the total Siperian
runtime memory footprint must fit.
•
Make sure that there is enough physical RAM available to satisfy the runtime needs
of all the Siperian software you intend to install.
With all your non-Siperian applications turned on, use the following formula to
determine if your physical RAM is adequate:
min physical RAM available >= Window’s native process memory
limit >=(application server JVM maximum heap size + <cleanse_
engine> memory size)
To learn more about RAM and physical memory, consult your Windows
documentation.
Note: Message queues are now automatically configured for use with the Siperian Hub
by the Siperian installer. If you need to manually configure your message queues for
20 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Before Installing the Hub Server
troubleshooting purposes, see Appendix A, “Manually Configuring Siperian System
Message Queues”.
About the Hub Server and WebLogic
Before you install Hub Server, use the WebLogic Administration Wizard to create a
WebLogic domain for the Hub Server. To learn more, see your WebLogic
documentation. You must also configure a data source. To learn more, see “Using an
Oracle Data Source with WebLogic” on page 23.
Note: To use a WebLogic clustered environment, contact Siperian support.
About Installing a Newer Version of the Hub Server
Different versions of Siperian Hub cannot operate together in the same environment;
all components of your installation must be the same version. If you want to have
multiple versions of Siperian Hub at your site, you must install each version in a
separate environment.
This also applies to the components of Siperian Hub, including the Hub Server. If you
have an earlier version of the Hub Server installed and deployed on your application
server, you can upgrade the version using the Siperian installer.
If you have a previously installed version of Siperian software, see Chapter 7,
“Upgrading Siperian Hub” for details on upgrading. This chapter covers new
installations.
If you choose to undeploy and uninstall the older version of the Hub Server before you
install the new version, see “Uninstalling Hub Server” on page 105 for details. After
you undeploy the old Hub Server application, if you are using either the WebLogic or
WebSphere application servers, you must re-start the application server.
Installing the Hub Server
21
Before Installing the Hub Server
About Configuring JBoss
For JBoss, you must complete these steps before starting up the server:
1. When you install JBoss, do not extract the zip file in the normal way. Instead, issue
the following command to unzip the JBoss file:
java -jar jboss-4.0.3SP1-installer.jar
2.
Make sure the JBoss data source works correctly with Oracle. To learn more, see
“Using an Oracle Data Source with JBoss” on page 22.
3.
If you want to run both Hub Server and Cleanse Match Server on the same JBoss
server, you must perform some additional configuration of the JBoss application
server. To learn more, see “Configuring JBoss to Run Both the Hub Server and
Cleanse Match Server” on page 23.
Using an Oracle Data Source with Application Servers
This section describes using an Oracle data source with various application servers.
Using an Oracle Data Source with JBoss
To configure JBoss to use an Oracle data source:
1. Edit the jboss-service.xml file, making sure the XidFactory padding is set to
true. This file is in <JBOSS_Install_Dir>\server\default\conf. Here is the
fragment of the XML to set that value:
<mbean code="org.jboss.tm.XidFactory"
name="jboss:service=XidFactory">
<attribute name="Pad">true</attribute>
</mbean>
This information is already in the file, but commented out:
<--attribute name="Pad">true</attribute-->
Simply remove the “--” to un-comment the statement to match the example
above.
2.
Copy the following new Oracle JDBC driver files to your
<JBOSS_Install_Dir>\server\default\lib directory:
•
ojdbc14.jar
•
orai18n.jar
22 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Before Installing the Hub Server
Contact Oracle to obtain these files.
Using an Oracle Data Source with WebLogic
To use an Oracle data source with WebLogic:
• Copy the following new Oracle JDBC driver files to your
<WEBLOGIC_Install_Dir>\weblogicxx\server\lib directory:
where weblogicxx is the WebLogic directory for your version of WebLogic.
•
ojdbc14.jar
•
orai18n.jar
Contact Oracle to obtain this driver.
Using an Oracle Data Source with WebSphere
To configure WebSphere to use an Oracle data source:
• Copy the following new Oracle JDBC driver files to your
<WEBSPHERE_Install_Dir>\lib directory:
•
ojdbc14.jar
•
orai18n.jar
Contact Oracle to obtain these drivers.
Configuring JBoss to Run Both the Hub Server and
Cleanse Match Server
To configure JBoss to run both the Hub Server and Cleanse Match Server on the same
server:
1. Set the Isolated attribute of the JBoss’s EAR deployer to true in the
<JBOSS_Install_Dir>\server\default\deploy\ear-deployer.xml. This
configures all your EARs to be in isolated class loader spaces using call by value for
remote interfaces.
For example:
<mbean code="org.jboss.deployment.EARDeployer"
name="jboss.j2ee:service=EARDeployer">
Installing the Hub Server
23
Installing the Hub Server
<!-- Isolate all ears in their own classloader space -->
<attribute name="Isolated">true</attribute>
</mbean>
2.
Set the UseJBoss Web Loader to false in the following file:
<JBOSS_Install_
Dir>\server\default\deploy\jbossweb-tomcatxx.sar\META-INF\jboss-s
ervice.xml
where jbossweb-tomcatxx is the SAR file for your Tomcat installation. This
disables JBoss from using unified class loader as the Web application class loader.
For example:
<attribute name="UseJBossWebLoader">false</attribute>
Installing the Hub Server
Important: You must use the same username to install both Hub Server and Cleanse
Match Server.
Note: The screen shots, file names, and directories in this guide may vary slightly
depending on what type of installation you are performing.
To install Hub Server:
1. Run the Siperian Hub installer. The installer is located on the distribution in the
\mrmserver\windows directory. Run hub_install.exe to begin the installation
process. This file is part of your Siperian Hub distribution.
The Siperian Hub installer displays the Introduction screen.
2.
Click Next to continue.
The License Agreement screen is displayed.
3.
Select the “I accept the terms of the License Agreement” button and then click
Next.
The Choose Install Folder screen is displayed.
Important: Do not use a path that has spaces in the directory or folder names.
24 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Installing the Hub Server
Note: If you enter a location that has a previously installed version of Siperian
software, the install will ask you if you want to patch your existing installation. For
details on the upgrade process, see Chapter 7, “Upgrading Siperian Hub.”
4.
Click Next to install Siperian Hub in C:\siperian\hub\server, or click the
Choose... button to choose another location to install Siperian Hub and then click
Next.
The Choose Shortcut Folder screen is displayed.
5.
Click Next to continue.
The Enter Location of License File screen is displayed.
6.
Click Choose to select a license file. Siperian provides you with a license file. If you
do not have the license file, you cannot continue with the install. Contact Siperian
Support to obtain the license file.
Click Next to continue.
The Application Server screen is displayed.
7.
Choose the application server you are running and then click Next.
The next steps depend on which application server you choose.
•
For any supported version of WebLogic, see “Configuring the Hub Server
With WebLogic” on page 25.
•
For WebSphere, see “Configuring the Hub Server With WebSphere” on page
26.
•
For JBoss, see “Configuring the Hub Server With JBoss” on page 26.
Configuring the Hub Server With WebLogic
If you chose WebLogic for your application server, the WebLogic Application Server
Home screen is displayed.
a.
Choose a path to the WebLogic domain installation directory for the domain
you want to use for Siperian Hub. This is the domain you created in “About
the Hub Server and WebLogic” on page 21. Click Next.
The reminder screen is displayed.
b.
Make sure you have fulfilled the prerequisites and click OK.
Installing the Hub Server
25
Installing the Hub Server
The Application Server Login screen is displayed.
c.
Enter the login and port information for your WebLogic domain.
Enter the host name, server name, user name, password, and port number on
which your WebLogic server is listening. Click Next.
WebLogic collects information for the administrative login that the installation
process uses to create the JDBC data source to the Master Database.
If you type in incorrect login information, the installer fails when running the
postInstallSetup script. You can correct this after running the installer. To
learn more, see “Changing Your WebLogic Settings” on page 30.
d.
For the rest of the Hub Server installation, skip to “Continuing Your Hub
Server Configuration” on page 27.
Configuring the Hub Server With WebSphere
If you chose WebSphere for your application server, the WebSphere Application Server
Home screen is displayed.
a. Choose a path to the WebSphere application server. Click Next.
The reminder screen is displayed.
b.
Make sure you have fulfilled the prerequisites and click OK.
The WebSphere Application Port screen is displayed.
c.
Set the server name, RMI, and SOAP ports for your WebSphere application
server. Click Next.
d.
For the rest of the Hub Server installation, skip to “Continuing Your Hub
Server Configuration” on page 27.
Configuring the Hub Server With JBoss
If you chose JBoss for your application server, the JBoss Application Server Home
screen is displayed.
a. Specify the application server installation directory. Click Next.
The reminder screen is displayed.
26 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Installing the Hub Server
b.
Make sure you have fulfilled the prerequisites and click OK.
The JBoss Server Port screen is displayed.
c.
Specify your RMI port. Click Next.
Important: If you change the default port number, you also need to change it
in the following directory:
<JB_Install_
Dir>\server\default\deploy\jbossweb-tomcatxx.sar\server.xml
where jbossweb-tomcatxx.sar is the SAR file for your Tomcat installation.
xx represents the version number.
The JBoss port can conflict with the default Oracle port. If that is the case for
your installation, you must change one of the ports to resolve the conflict.
•
To change the port number in that file, open jbossweb-tomcatxx.sar
for editing and search for the word port.
Change the value for port to match the value you have set on the JBoss
Application Server Port screen.
d.
For the rest of the Hub Server installation, go to “Continuing Your Hub
Server Configuration” on page 27.
Continuing Your Hub Server Configuration
1.
Select the Oracle database.
2.
Click Next. The Oracle Database Information screen displays.
3.
Enter the Oracle server name, Oracle port number, Oracle SID, Siperian Hub
system schema name (default is cmx_system), CMX Username (default is cmx),
and password for that username.
Note: A common password for CMX is: !!cmx!!
4.
Click Next.
The PostInstallSetup script (Deploy) screen is displayed.
5.
Click Yes to run the script during the installation, or click No to manually run it
later. To learn more about the post-installation process, see “About the
Post-Installation Process” on page 19.
Installing the Hub Server
27
Configuring the Hub Server
Click Next.
6.
If you want to change any options, click the Previous button to navigate to the
appropriate screens. Once the summary reflects the options you want, click Install
to start the installation process.
7.
Click Done to exit the installer.
Checking the Log Files
The following files are useful for troubleshooting your Hub Server installation. Save
these files right after a failure and provide them when you call Siperian support:
• <Siperian_Install_Dir>\hub\server\Siperian_Hub_Server_
InstallLog.xml – contains the messages for the installation
•
<Siperian_Install_Dir>\hub\server\siperian_installer_debug.txt –
contains debug messages. This contains all the options that you selected when you
ran the installation.
•
<Siperian_Install_Dir>\hub\server\logs\postInstallSetup.log–
contains the messages for the postInstallSetup script
•
<Siperian_Install_Dir>\hub\server\logs\cmxserver.log–
this is the for
the server. When the server started, it created this file.
•
Application server log files.
To learn more, see “About the Siperian Hub Log Files” on page 122.
Configuring the Hub Server
During runtime, the Hub Server application must locate the installation it was deployed
from. Therefore, it is not recommended to carry the EAR file to deploy onto another
machine. For example, if you installed Hub Server on a Marketing machine and then
deployed the EAR on the Sales machine, the application would not be able to locate
the installation for configuration information such as logging.
28 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Configuring the Hub Server
Checking the Version and Build Number
You can find out the version and build number of Hub Server by viewing the
manifest.mf jar entry inside the <Siperian_Install_
Dir>\server\siperian-mrm.ear file.Siperian Hub. You can also check this from the
Help menu in the Hub Console.
Configuring the Logging Settings
You can configure the C:\siperian\hub\server\conf\log4j.xml for logging. The
default value is INFO for log4j.xml. You can turn on DEBUG for mrmserver by
replacing INFO with DEBUG in log4j.xml. After you update this file, you must restart
the Hub Server application.
For JBoss, the log4j.xml file is located in the conf directory under the JBoss default
server directory.
Setting the Configuration Properties
You can configure the cmxserver.properties file located in <Siperian_Install_
Dir>\hub\server\resources directory. After you update this file, you must restart
the Hub Server application to reload the settings in the file. The values in this file
reflect your installation. For example, the application.server.type may not be the
same as the one in the example. Your values should reflect the application server you
are using.
Your file looks similar to this:
cmx.home=C:\siperian\hub\server
cmx.server.masterdatabase.type=oracle
cmx.application.server.type=websphere
cmx.appserver.web.port=9080
cmx.appserver.rmi.port=2809
cmx.appserver.naming.protocol=iiop
cmx.appserver.soap.connector.port=8880
cmx.server.connectionpool.minsize=5
cmx.server.connectionpool.maxsize=100
cmx.server.connectionpool.maxlifetime=1800000
Installing the Hub Server
29
Configuring the Hub Server
jnlp.initial-heap-size=128m
jnlp.max-heap-size=192m
cmx.server.datalayer.cleanse.execution=SERVER
cmx.server.datalayer.cleanse.working_
files.location=C:\siperian\hub\server\logs
cmx.server.datalayer.cleanse.working_files=LOCAL
Note: If you are using JBoss and need to change ports because of port conflicts, you
must ensure that the cmx.appserver.rmi.port value is the same as the JNP port
number, not the RMI port number. The value of the JNP port number is in the
<JBoss_Install_Dir>\server\default\conf\jboss-service.xml file, in the
following attribute: <attribute name="Port">1099</attribute>.
Changing Your WebLogic Settings
If you keyed in the incorrect WebLogic settings during the installation process,
complete the following:
1. Open the following file for editing:
<Siperian_Install_Dir>\server\bin\build.properties
2.
Modify your WebLogic configuration settings under the #Server Settings
section of build.properties.
3.
Save and close build.properties file.
4.
Run the postInstallSetup.bat script.
postinstallsetup -Dweblogic.password=weblogic
-Ddatabase.password=!!cmx!!
5.
Restart the application server.
Changing Your WebSphere Settings
If you keyed in the incorrect WebSphere settings during the installation process,
complete the following:
1. Open the following file for editing:
<Siperian_Install_Dir>\server\bin\build.properties
30 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Configuring the Hub Server
2.
Modify your WebSphere configuration settings under the #Server Settings
section of build.properties.
3.
Save and close build.properties file.
4.
Run the postInstallSetup script.
5.
Restart the application server.
Changing Your JBoss Settings
If you keyed in the incorrect JBoss settings during the installation process, complete
the following:
1. Open the following file for editing:
<Siperian_Install_Dir>\server\bin\build.properties
2.
Modify your JBoss configuration settings under the Server Settings section of
build.properties.
3.
Save and close build.properties file.
4.
Run the postInstallSetup script.
5.
Restart the application server.
Changing the Password for the CMX_SYSTEM User
After you have installed Hub Server, you can change the password for the CMX_
SYSTEM user. If you do so, you must also:
• Change the password for the CMX user in Oracle.
•
Set the same password in the data source in the application server.
To learn more about changing passwords in Siperian Hub, see the Siperian Hub
Administrator’s Guide.
Installing the Hub Server
31
Running the Post-Install Steps
Changing the Password for the CMX_ORS User
After you have installed Hub Server, you can change the username and password for
the CMX_ORS user. If you do so, you must also:
• Change the password for the CMX_ORS user in Oracle.
•
Set the same password in the data source in the application server.
•
Register the schema with the same username and password as you configured in
the database and the application server. All these usernames and passwords must
be the same.
Running the Post-Install Steps
This section describes the post-installation steps that you might have to perform,
depending on your configuration.
Running the Post-Install Process Manually
If you chose to have the Siperian Hub installation program skip the post-install
process, you must run this script manually.
By default, this script is located in the following directory:
<Siperian_Install_Dir>\hub\server
To run the post-install script manually:
• For the WebLogic application server, run the following command from a
command prompt:
postinstallsetup.bat -Dweblogic.password=your_password
-Ddatabase.password=!!cmx!!
where your_password is the password for your WebLogic application server.
•
For the WebSphere application server, run the following command from a
command prompt:
postinstallsetup.bat -Ddatabase.password=!!cmx!!
32 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Running the Post-Install Steps
•
For the JBoss application server, run the following command from a command
prompt:
postinstallsetup.bat
Manually Redeploying the Hub Server Application
In the process of installing Hub Server, you can choose whether to run the
postInstallSetup script to deploy Hub Server. If you choose not to run this script
automatically as part of the installation process, you must run it yourself. You can also
use this script if you need to redeploy the application to the application server.
Alternatively, you can also use the application server’s tool to do the deployment
yourself, as long as the Hub Server EAR file is deployed from the Siperian Hub Server
installation directory. The table below lists basic guidelines for redeployment. To learn
more, see your application server documentation.
Redeploying on WebLogic
To redeploy the Hub Server on WebLogic:
• Use the WebLogic Server Administration Console to undeploy and deploy the
siperian-mrm.ear file from the Hub Server installation directory. Deploy the
application in stage mode.
Redeploying on WebSphere
To redeploy the Hub Server on WebSphere, use the WebSphere Application Server
Administrative Console to uninstall and install the siperian-mrm.ear from the Hub
Server installation directory. Be sure to allow the deployment to generate default
bindings by checking the option in the Preparing for the application installation
panel.
Redeploying on JBoss
To redeploy the Hub Server on JBoss:
1. Stop the server.
Installing the Hub Server
33
Running the Post-Install Steps
2.
Undeploy the Hub Server.
3.
Remove the siperian-mrm.ear file from $<JBoss_Install_
Dir>\server\default\deploy to make sure the application is completely
removed.
4.
Copy the siperian-mrm.ear file from the Hub Server installation directory to the
deploy directory.
5.
Start the server.
6.
Redeploy the application.
Manually Restarting WebLogic
You must restart WebLogic after you install the Hub Server. The installation process
automatically enables the AnonymousAdminLookupEnabled method, causing the ORS
to fail, unless you restart WebLogic.
34 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
4
Installing the Cleanse Match Server
This chapter explains how to install the Siperian Cleanse Match Server. If you have a
previously installed version of the Cleanse Match Server, see Chapter 7, “Upgrading
Siperian Hub” for details on upgrading. This chapter covers new installations.
Important: Different versions of Siperian Hub cannot operate together in the same
environment—all components of your installation must be the same version. If you
want to have multiple versions of Siperian Hub at your site, you must install each
version in a separate environment.
Note: Make sure you have the latest patches for the cleanse engines you are using.
Chapter Contents
•
About Cleanse Match Server
•
Before Installing Cleanse Match Server
•
Installing Cleanse Match Server
•
Configuring the Cleanse Match Server
•
Running the Post-Install Process Manually
•
Configuring Cleanse Match Server for Multi-Threading
•
Configuring Dual Cleanse Servers
•
Distributed Cleanse Match Servers
•
Installing the Siperian Hub Server into a WebLogic Server Cluster
35
About Cleanse Match Server
About Cleanse Match Server
The Siperian Cleanse Match Server allows you to standardize your data before you start
the matching process. Cleansed data will result in more matches, and those matches will
be more reliable matches than matches on uncleansed data.
The Cleanse Match Server, like the Hub Server is an application which is run on an
application server. The Cleanse Match Server application uses a cleanse engine to
perform the data cleansing.
About the Supported Cleanse Engines
Siperian assumes that you are familiar with your cleanse engine and have already
installed and configured it prior to installing Siperian Hub. See the Siperian Hub Release
Notes for the cleanse engines and the versions that are supported by Siperian Hub.
About the Installation Process
After the successful installation of the Hub Server, you can start installing Cleanse
Match Server.
The installation process consists of the following steps:
1. “Installing Cleanse Match Server” on page 52.
2.
“Configuring the Cleanse Match Server” on page 56.
3.
Restarting your application server.
Important: You must use the same username to install both Hub Server and Cleanse
Match Server.
36 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
About Cleanse Match Server
About the Post-Installation Process
The installer, by default, runs the post-installation process to deploy the application on
your application server. However, while running the install you can choose to not run
this post-installation process.
If you choose to not run the post-installation process, the installer only installs files to
the installation directory. Once that process is done, you must deploy the Cleanse
Match Server application on the application server and perform some application
server configuration.
At the end of the automated installation, you can choose to run a script called
postInstallSetup to perform these tasks. Alternatively, you can choose to do these
tasks manually. To learn more, see “Running the Post-Install Process Manually” on
page 59.
Separating the installation and deployment functions allows you to:
• Avoid deploying the application as part of the installation process. You can
manually run the script later when you are sure the application starts up
successfully. To learn more about this, see “Before Installing Cleanse Match
Server” on page 38.
•
Deploy the application using the application server’s administrator console.
•
Run the script to redeploy the application instead of reinstalling the entire Cleanse
Match Server.
•
Troubleshoot deployment problems outside the installation process.
Installing the Cleanse Match Server
37
Before Installing Cleanse Match Server
Before Installing Cleanse Match Server
Make sure that you have fulfilled the hardware and software requirements for Cleanse
Match Server as outlined in the Siperian Hub Release Notes.
Before installing Cleanse Match Server:
• Install and configure your application server
•
Install and configure your cleanse engine
•
Get any required unlock codes for that software
•
Verify that your cleanse server functions properly
•
Get a license file from Siperian. You cannot install Cleanse Match Server without a
license file.
About Installing a Newer Version of Cleanse Match Server
Different versions of Siperian Hub cannot operate together in the same environment;
all components of your installation must be the same version. If you want to have
multiple versions of Siperian Hub, you must install each version in a separate
environment.
This also applies to the components of Siperian Hub, including Cleanse Match Server.
If you have an earlier version of Cleanse Match Server installed and deployed on your
application server, you must uninstall and undeploy the older version of Cleanse Match
Server before you install the new version.
If you are using the WebSphere or JBoss application servers, you must restart the
application server after you undeploy the old Cleanse Match Server application.
38 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Before Installing Cleanse Match Server
Using the Correct Siperian License File for Your Cleanse
Match Server
Your Siperian license has the information you need to install the Cleanse Server with
the Cleanse Match Engine you are using. During the Cleanse Server installation, the
installer asks you for information on the Cleanse Match Engine, checks the license file
for corresponding Cleanse Match Engine information, then stores that information in
the cmxcleanse.properties file.
If you have installed a Cleanse Match Engine that does not have corresponding
information in the Siperian license file, the installer does not store any information in
the properties file. Therefore, the properties file displays either blank or default values
for that Cleanse Match Engine.
To make sure that the cmxcleanse.properties file is updated you must obtain the
correct Siperian license file and reinstall the Cleanse Server.
About Cleanse Match Server and WebLogic
Before installing Cleanse Match Server on the WebLogic application server, you must
create a WebLogic domain for the Cleanse Match Server application using the
WebLogic Administration Wizard. To learn more, see your WebLogic documentation.
Creating Data Sources for Each ORS
If you install Cleanse Match Server on a different machine from the one running Hub
Server, you must create data sources for each ORS. You must do this on the
application server on the Cleanse Match Server machine. You must configure the
location of the JDBC driver as well as create a datasource for each ORS.
Setting the Location of the JDBC Driver
To set the location of the JDBC driver:
• Add the Oracle JDBC Driver JAR file to the
<WEBLOGIC_Install_Dir>\weblogicxx\server\lib
directory.
Installing the Cleanse Match Server
39
Before Installing Cleanse Match Server
where weblogicxx is the directory for your version of WebLogic.
See the Siperian Hub Release Notes for the supported versions of these drivers.
Contact Oracle for these files.
Configuring WebLogic to Use an Oracle Data Source
If you are running the Hub Server on the same host that is running the Cleanse Match
Server, you can skip this section.
To configure WebLogic to use an Oracle data source:
Launch the WebLogic administrator console.
1.
2.
Create a connection pool called “MRM Connection Pool”.
a.
Under Services > JDBC > Connection Pools > Configure a new JDBC
connection pool.
•
Select “Oracle” as the Database Type and “Oracle’s driver (Thin XA)” as
the Database Driver.
b.
Add the following properties:
Property
Value
TestConnectionsOnRelease
false
TestTableName
C_REPOS_DATABASE
TestConnectionsOnReserve
false
c.
Test the driver connections, create, and deploy.
d.
Go to the Connections tab, choose Advanced Options > Show.
Enable “Supports Local Transaction” and click Apply.
3.
Create a connection pool called “ORS Connection Pool”.
a.
Choose Services > JDBC > Connection Pools > Configure a new JDBC
Connection Pool.
•
Select Oracle as the database type and Other as the database driver.
40 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Before Installing Cleanse Match Server
•
Set Name = ORS Connection Pool
•
Set Database Name = YourDatabaseName
•
Set Host Name = YourHostname
•
Set Port = YourPortNumber
•
Set Database User Name = NameOfYourORS
For example CMX_ORS.
•
Set the Password to “!!cmx!!”
b.
Set the following properties:
Property
Value
TestConnectionsOnRelease
false
TestTableName
C_REPOS_DB_RELEASE
TestConnectionsOnReserve
false
c.
Test the driver connections, create, and deploy.
d.
Go to the Connections tab, choose Advanced Options > Show.
Enable “Supports Local Transaction” and click Apply.
4.
Create a Data Source called “MRM Data Source”
Under Services > JDBC > Data Sources > Configure a new JDBC data
source named “MRM Data source”.
5.
•
Use “jdbc/siperian-cmx_system-ds” for the JNDI name.
•
Set the pool name to “MRM Connection Pool”.
•
Select myserver and click Create.
Create a Data Source called “ORS Data Source”.
Use “jdbc/siperian-hostname-oracleinstance-ors-ds” for the JNDI name,
where hostname is the name of your host, oracleinstance is the name of your
Oracle instance and ors is the name of your ORS.
•
Set the pool name to “ORS Connection Pool”
Installing the Cleanse Match Server
41
Before Installing Cleanse Match Server
•
Select myserver and click Create.
Note: Use all lower case when creating the JNDI names.
You must create data sources and connection pools for every ORS you plan to
register.
Configuring WebLogic 9.x to Use an Oracle Datasource
If you are running Oracle on the same host that is running Cleanse Match Server, you
can skip this section.
To configure WebLogic 9.x to use an Oracle data source:
1. Launch the WebLogic 9.x Administrator Console.
2.
Create a data source called “MRM Data Source”.
a.
Acquire a lock by clicking the Lock & Edit button.
Under Services > JDBC > Data Sources configure a new master data
source.
Click New.
•
Set the name to “MRM Data Source”.
•
Set the JNDI Name to “jdbc/siperian-cmx_system-ds”.
•
Select “Oracle” as the Database Type and “Oracle's driver (Thin XA)
Versions 9.0.1, 9.2.0, 10” as the Database Driver.
•
Click Next.
b.
On the Transaction Options page, click Next.
•
Set Database Name = YourDatabaseName
•
Set Host Name = YourDatabaseHostname
•
Set Port = YourPortNumber
•
Set Database User Name = cmx
•
Set Password = !!cmx!!
•
Set Confirm Password = !!cmx!!
42 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Before Installing Cleanse Match Server
•
Click Next.
c.
Test the driver connections by clicking Test Configuration.
If the test is unsuccessful, you must update values in this page then retry the
connection until successful. If the test is successful, click Next.
d.
On Select Targets page, select “AdminServer”.
Click Finish.
e.
3.
Click Activate Changes.
Create a Data Source called “ORS Data Source”.
a.
Acquire lock by clicking the Lock & Edit button.
Under Services > JDBC > Data Sources configure a new ORS data source.
Click New.
•
Set the name to “ORS Data Source”.
•
Use “jdbc/siperian-hostname-oracleinstance-ors-ds” for the JNDI
name; where hostname is the name of your host, oracleinstance is the
name of your oracle instance and ors is the name of your ORS.
•
Select “Oracle” as the Database Type and “Oracle's driver (Thin XA)
Versions 9.0.1, 9.2.0, 10” as the Database Driver.
•
Click Next.
b.
On Transaction Options page, click Next.
•
Set Database Name = YourDatabaseName
•
Set Host Name = YourDatabaseHostname
•
Set Port = YourPortNumber
•
Set Database User Name = NameOfYourORS
For example CMX_ORS.
•
Set Password = !!cmx!!
•
Set Confirm Password = !!cmx!!
•
Click Next.
Installing the Cleanse Match Server
43
Before Installing Cleanse Match Server
c.
Test the driver connections, click Test Configuration.
If the test is unsuccessful, you need to update values in this page then retry the
connection until successful. If the test is successful, then click Next.
d.
On Select Targets page, select “AdminServer”.
Click Finish.
Click Activate Changes.
Note: Use all lower case when creating the JNDI names.
About Cleanse Match Server and WebSphere
If you install Cleanse Match Server on a different machine from the one running Hub
Server, on the Cleanse Match Server machine, you must create data sources for each
ORS.
To configure WebSphere to use an Oracle data source:
• Add the Oracle JDBC Driver JAR file to the
<WEBSPHERE_Install_Dir>\lib directory.
Contact Oracle for these files.
Creating Master Data Sources in WebSphere
To create your WebSphere master data sources:
1. Start the application server. Choose Start > Programs > IBM WebSphere >
Application Server v6 > Profiles > default > Start the Server.
2.
Start the WebSphere Application Server Admin Console. Choose Start >
Programs > IBM WebSphere > Application Server v6 > Profiles > default >
Administrative Console.
3.
Login with any user name.
4.
Specify the location of the driver libraries:
a.
Expand Environment in the console navigation tree.
b.
Click the WebSphere Variables link.
44 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Before Installing Cleanse Match Server
c.
5.
Update the ORACLE_JDBC_DRIVER_PATH variable to point to the JDBC
driver location. (E.g.: C:/WAS6023/AppServer/lib).
Create the security account to be used by the Siperian Master Data Source:
a.
Expand Security in the console navigation tree.
Click Global security link.
b.
Expand JAAS Configuration under Authentication in right side of the
console window.
Click J2C Authentication Data.
c.
Click New to create a new security account.
d.
Set the following:
•
Alias = CMX_SYSTEM
•
User ID = cmx_system
Do not change this username.
•
Password = !!cmx!!
To learn about changing this password, see “Changing the Password for
the CMX_SYSTEM User” on page 46.
e.
6.
Click OK to save.
Create the JDBC Provider:
a.
b.
c.
Expand Resources in the console navigation tree.
•
Click the JDBC Providers link.
•
Make sure that the scope is set to Node. (Change and apply if this needs
adjustment).
Click New to create a new JDBC Provider.
•
Select Oracle from database type list.
•
Select Oracle JDBC Driver from provider type list.
•
Select XA data source from implementation type list.
Click Next.
Installing the Cleanse Match Server
45
Before Installing Cleanse Match Server
7.
•
Change the name to “Siperian Oracle JDBC Provider (XA)”.
•
Click OK to save.
Create the Siperian Master Data Source:
a.
Click the created provider.
b.
Click the Data Sources link (under Additional Properties in right side of the
console window).
c.
Click New to create the new data source.
d.
Fill in the form with the following values:
e.
•
Name = Siperian Master Data Source
•
JNDI Name = jdbc/siperian-cmx_system-ds
•
Component-managed Authentication Alias = <hostname>/cmx_
system
•
URL = jdbc:oracle:thin:@<oracle_hostname>:<oracle_port_
number>:<oracle_sid>
Click OK.
Note: The JNDI name must be in lower case.
Changing the Password for the CMX_SYSTEM User
After you have installed Siperian Hub, you can change the password for
CMX_SYSTEM. If you do so, you must also:
• Change the password for the CMX user in Oracle
•
Set the same password in the datasource on the application server
Creating ORS Data Sources in WebSphere
To create your WebSphere ORS data sources:
1. Start the application server. Choose Start > Programs > IBM WebSphere >
Application Server v6 > Profiles > default > Start the Server.
46 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Before Installing Cleanse Match Server
2.
Start the WebSphere application server admin console. Choose Start > Programs
> IBM WebSphere > Application Server v6 > Profiles > default >
Administrative Console.
3.
Login with any user name.
4.
Specify the location of the driver libraries:
5.
a.
Expand Environment in the console navigation tree.
b.
Click the WebSphere Variables link.
c.
Update the ORACLE_JDBC_DRIVER_PATH variable to point to the JDBC
driver location. (for example, C:\WAS6023\AppServer\lib).
Create the security account to be used by the Siperian ORS Data Source:
a.
Expand Security in the console navigation tree.
Click Global security link.
b.
Expand JAAS Configuration under Authentication in right side of the
console window.
Click J2C Authentication Data.
Click New to create a new security account.
c.
Set the following:
•
Alias = cmx_ors
•
User ID = cmx_ors
•
Password = !!cmx!!
To learn about changing this username and password, see “Changing the
Username and Password for the CMX_ORS User” on page 49.
d.
6.
Click OK to save.
Create the JDBC Provider:
a.
Expand Resources in the console navigation tree.
Click JDBC Providers link.
Make sure that the scope is set to Node. (Change and apply if this needs
adjustment).
Installing the Cleanse Match Server
47
Before Installing Cleanse Match Server
b.
c.
Click New to create a new JDBC Provider.
•
Select Oracle from database type list.
•
Select Oracle JDBC Driver from provider type list.
•
Select XA data source from implementation type list.
Click Next.
Change the name to “Siperian Oracle JDBC Provider (XA)”.
Click OK to save.
7.
Create the Siperian ORS Data Source:
a.
Click the created provider.
b.
Click the Data Sources link (under Additional Properties in right side of the
console window).
c.
Click New to create the new data source.
Fill in the form with the following values:
•
d.
Name = Siperian ORS Data Source
•
JNDI Name = jdbc/siperian-<oracle_hostname>-<oracle_
SID>-cmx_ors-ds
•
Component-managed Authentication Alias = <hostname>/cmx_
ors
•
URL= jdbc:oracle:thin:@<oracle_hostname>:<oracle-port_
number>:<oracle_sid>
Click OK.
Note: The JNDI name must be in lower case.
48 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Before Installing Cleanse Match Server
Changing the Username and Password for the CMX_ORS User
After you have installed the Siperian Hub, you can change the username and password
for CMX_ORS.
If you do so, you must also:
• Change the password for the CMX user in Oracle.
•
Set the same password in the datasource on the application server.
•
Register the schema with the same username and password.
About Cleanse Match Server and JBoss
Before you install the Cleanse Match Server, delete any instances of old Oracle drivers
from your JBoss directory structure. The most likely place for them is
JBoss\server\default\lib.
The files are:
•
ojdbc14.jar
•
orai18n.jar.
You may also require nls_charset12.jar.
Creating Data Sources for Each ORS
If you install Cleanse Match Server on a different machine from the one running Hub
Server, on the Cleanse Match Server machine, you must create data sources for each
ORS. You must do some Oracle configuration as well as some JBoss configuration.
Setting the location of the JDBC Driver
To configure JBoss to use an Oracle data source:
• Copy the following Oracle files to your JBoss\server\default\lib directory:
•
ojdbc14.jar
•
orai18n.jar
Installing the Cleanse Match Server
49
Before Installing Cleanse Match Server
To obtain the drivers, contact Oracle.
Configuring JBoss to Use an Oracle Data Source
If you are running Oracle on the same host that is running Cleanse Match Server, you
can skip this section.
To configure JBoss to use an Oracle data source:
1. Copy a sample datasource file into your JBoss deploy directory.
By default, the JBoss deploy directory is:
jboss_Install_Dir\server\default\deploy
You can find the samples in:
jboss_Install_Dir\docs\examples\jca
You can change the name of the sample datasource file, but the file must end with
-ds.xml to be recognized as a datasource descriptor.
2.
Edit the datasource definition to match your database connection parameters. Edit
these parameters:
•
jndi-name:
Set jndi-name to the following value for a Hub Server datasource:
jdbc/siperian-cmx_system-ds
Set jndi-name to the following value for cleanse server datasource:
jdbc/siperian-hostname-oracleinstance-ors-ds
where hostname is the name of your host, oracleinstance is the name of
your oracle instance and ors is the name of your ORS.
•
connection-url: The JDBC driver connection URL string for your driver. Make
sure that the database name, host, and port are correct for the database to
which you are connecting.
•
(for example, jdbc:oracle:thin:@mvwks01:1521:orcl in oracle username: This
default username used when creating a new connection. the default user in
Oracle for hub server is cmx and cmx_ors for cleanse server.
•
password: The default password used when creating a new connection.
50 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Before Installing Cleanse Match Server
Configuring JBoss for Both Cleanse Match Server and Hub
Server
For JBoss, if you must run both Hub Server and Cleanse Match Server on the same
JBoss server, you must manually configure JBoss before starting the server.
To configure JBoss before installing both Hub Server and Cleanse Match Server:
1. Set the Isolated attribute of the JBoss’s EAR deployer to true in the
%JBOSS_Install_Dir%\server\default\deploy\ear-deployer.xml. This
configures all your EARs to be in isolated class loader spaces using call by value for
remote interfaces.
For example:
<mbean code="org.jboss.deployment.EARDeployer"
name="jboss.j2ee:service=EARDeployer">
<!-- Isolate all ears in their own classloader space -->
<attribute name="Isolated">true</attribute>
</mbean>
2.
Set the UseJBossWebLoader to false in the following file:
%JBOSS_Install_
Dir%\server\default\deploy\jbossweb-tomcatxx.sar\META-INF\jboss-s
ervice.xml
where jbossweb-tomcatxx.sar is the sar file for your Tomcat installation.
This disables JBoss from using a unified class loader as the web application class
loader. For example:
<attribute name="UseJBossWebLoader">false</attribute>
3.
When there is the potential for conflict between the JBoss port and the Oracle
port, change the port name used by one of the applications. The port name for
Hub Server can be changed in the following file:
%JBOSS_Install_
Dir%\server\default\deploy\jbossweb-tomcatxx.sar\server.xml
where jbossweb-tomcatxx.sar is the sar file for your Tomcat installation.
The default port is 8080. Change this to any unused port that does not conflict.
Installing the Cleanse Match Server
51
Installing Cleanse Match Server
Installing Cleanse Match Server
Your Siperian Hub distribution includes an installation wizard for Cleanse Match
Server.
Note: The screen shots, file names, and directories in this guide may vary slightly
depending on what type of installation you are performing.
To install Cleanse Match Server:
1. Run the Siperian Cleanse Match Server installer. The installer is on the distribution
in the \mrmcleanse\windows directory. Run hub_cleanse_install.exe to
begin the installation process. This file is part of your Siperian Hub distribution.
The Siperian installer displays the Introduction screen.
2.
Click Next.
The License Agreement screen is displayed.
3.
Click the I accept the terms of the License Agreement button and then click
Next.
The Choose Install Folder screen is displayed.
4.
Click Next to install Cleanse Match Server in C:\siperian\hub\cleanse, or
click the Choose button to choose another location to install Cleanse Match
Server and then click Next.
Important: Do not use a path that has spaces in the directory or folder names.
Note: Cleanse Match Server will fail to load if the total length of this path exceeds
256 characters.
The Choose Shortcut Folder is displayed.
5.
Select a location for the product icons. Click Next.
The Enter Location of License File screen is displayed.
6.
Click Choose to select a license file. Siperian provides you with a license file. If you
do not have the license file, you cannot continue with the install. Contact Siperian
Support to obtain the license file.
7.
Click Next to continue.
The Application Server screen is displayed.
52 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Installing Cleanse Match Server
8.
Choose an application server and click Next.
Proceed to the directions in the appropriate section under “Configuring Cleanse
Match Server for your Application Server” on page 53.
Configuring Cleanse Match Server for your Application
Server
The next steps depend on which application server you chose.
• WebLogic—see “Configuring Cleanse Match Server With WebLogic” on page 53.
•
WebSphere—see “Configuring Cleanse Match Server With WebSphere” on page
54.
•
JBoss—see “Configuring Cleanse Match Server With JBoss” on page 54.
Configuring Cleanse Match Server With WebLogic
If you chose WebLogic for your application server, the WebLogic Application Server
Home screen is displayed.
a. Choose a path to the WebLogic domain installation directory for the domain
you want to use for Siperian Hub. This is the domain you created in “About
Cleanse Match Server and WebLogic” on page 39. Click Next.
The Application Server Login screen is displayed.
b.
Enter the login information for your WebLogic application and click Next.
WebLogic collects information for the administrative login that the installation
process needs to create the JDBC data source to the Master Database.
Enter the host name, server name, user name, and password. If you type in
incorrect login information, the installer fails when running the
postInstallSetup script. You can correct this after the installation process is
complete. To learn more, see “Changing the Username for WebLogic” on page
112.
c.
Click Next. Skip to “Configuring Cleanse Match Server for Your Cleanse
Engine” on page 54.
Installing the Cleanse Match Server
53
Installing Cleanse Match Server
Configuring Cleanse Match Server With WebSphere
If you chose WebSphere for your application server, the WebSphere Application Server
Home screen is displayed.
a. Choose a path to the WebSphere application server.
The server name and SOAP port screen is displayed.
b.
Change the SOAP port number if necessary. Click Next.
Skip to “Configuring Cleanse Match Server for Your Cleanse Engine” on page
54.
Configuring Cleanse Match Server With JBoss
If you chose JBoss for your application server, the JBoss Application Server Home
screen is displayed.
a. Specify the application server installation directory and click Next.
b.
Specify your RMI port. Click Next.
Important: If you change the default port number, you also need to change it
in the following directory:
<JB_Install_
Dir>\server\default\deploy\jbossweb-tomcatxx.sar\server.xml
where jbossweb-tomcatxx.sar is the SAR file for your Tomcat installation.
xx represents the version number.
The JBoss port can conflict with the default Oracle port. If that is the case for
your installation, you must change one of the ports to resolve the conflict.
•
To change the port number in that file, open jbossweb-tomcatxx.sar
for editing and search for the word port.
Change the value for port to match the value you have set on the JBoss
Application Server Port screen.
c.
Click Next. Go to “Configuring Cleanse Match Server for Your Cleanse
Engine” on page 54.
Configuring Cleanse Match Server for Your Cleanse
54 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Installing Cleanse Match Server
Engine
The next steps in configuration depend on which cleanse engine you use.
Note: After installation you will need to do additional configuration for your cleanse
engine. This information is located in the Cleanse Adapter Guide.
Configuring Cleanse Match Server With AddressDoctor
The Configure AddressDoctor screen is displayed.
a. Specify the Unlock Code, Optimization, Memory, and Connection Type
parameters.
If the unlock code contains the backslash character (\), you must quote it by
using a double backslash (\\), otherwise the unlock code is not properly
recognized.
Click Next. The Configure AddressDoctor Preload screen is displayed.
b.
Specify the AddressDoctor preload parameters. Click Next.
The Choose AddressDoctor Database Path screen is displayed.
c.
Choose the AddressDoctor database path. Click Next.
d.
Skip to “Continuing Your Cleanse Match Server Installation” on page 55.
Configuring Cleanse Match Server With Business Objects DQ XI
If you are using Business Objects DQ XI, you need to configure Business Objects DQ
XI. The Configure Business Objects DQ XI directory screen is displayed.
a.
Specify the Host, Port, and Sub File parameters. Click Next.
b.
Go to “Continuing Your Cleanse Match Server Installation” on page 55.
Continuing Your Cleanse Match Server Installation
1.
In the Deploy screen, click Yes to run the script during the installation, or click No
to manually run it later.
Installing the Cleanse Match Server
55
Configuring the Cleanse Match Server
2.
In the Pre-Installation Summary screen, if you want to change any options, click
the Previous button to navigate to the appropriate screens. Once the summary
reflects the options you want, click Next to start the installation process.
Once you have set up your application server, the Pre-Installation Summary screen
is displayed.
3.
Click Install to start the installation process.
When the installation completes, the Install Complete screen is displayed. This
screen shows messages relevant to your specific installation, such as upgrading
shared libraries.
4.
Choose Yes to restart your system, or choose No to restart it later and click Done.
Checking the Log Files
The following log files are useful for troubleshooting the Cleanse Match Server
installation process. Save these files immediately after a failure and provide them when
you report it to Siperian support.
Check the following files:
• <Siperian_Install_Dir>\hub\cleanse\siperian_installer_debug.txt –
shows what was chosen during the installation
•
•
<Siperian_Install_Dir>\hub\cleanse\Siperian_Hub_Cleanse_Match_
Server_InstallLog.xml – shows the cleanse install errors and status
<Siperian_Install_Dir>\hub\cleanse\logs\postInstallSetup.log
–
shows the postInstallSetup script results
•
<Siperian_Install_Dir>\hub\cleanse\logs\cmxserver.log
– cleanse
server logs
•
Application server files, located in the tree under the install directory for your
application server.
Configuring the Cleanse Match Server
After you have installed the Cleanse Match Server, you must configure it.
56 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Configuring the Cleanse Match Server
Important: During runtime, Cleanse Match Server must locate the installation from
which it was deployed. Therefore, do not move the EAR file to deploy onto another
machine. For example, if you installed Cleanse Match Server on a Marketing machine
and then deployed the EAR on the Sales machine, the application would not be able to
locate the installation for configuration information such as logging.
Note: The cmxcleanse.properties file must be repackaged when a change is made
to CMX_Install_Dir. Any other parameter simply requires a restart of the Cleanse
Match Server application.
Configuring Cleanse Match Server with Various Cleanse
Engines
For more information regarding cleanse engine configuration, see the Cleanse Adapter
Guide.
Checking the Version and Build Number
You can find out the version and build number of Cleanse Match Server by viewing the
manifest.mf jar entry inside the following file:
<Siperian_Install_Dir>\hub\cleanse\siperian-mrm-cleanse.ear
Deleting Temporary Files
The temporary files generated by the cleanse service are left on disk. You can configure
the cleanse server to clean these up by setting a flag in the cleanse server properties file.
This file is cmxcleanse.properties and by default it is in this directory:
<Siperian_Install_Dir>\hub\cleanse\resources\
The entry appears as follows:
cmx.server.datalayer.cleanse.working_files=KEEP
You can change the value to FALSE to delete the file after cleanse/strip is completed.
cmx.server.datalayer.cleanse.working_files=FALSE
Installing the Cleanse Match Server
57
Configuring the Cleanse Match Server
Configuring Logging Settings
You can configure the cleanse application for logging. The settings are listed in the
log4j.xml file, located in the <Siperian_Install_Dir>\hub\cleanse\conf
directory.
The default value is INFO in the log4j.xml file. You can turn on DEBUG for
Cleanse Match Server by replacing INFO with DEBUG in the log4j.xml file.
After you update this file, you must restart the Cleanse Match Server application and
rerun postInstallSetup.bat. For JBoss, the log4j.xml file is located in the JBoss
\server\conf directory.
Setting Configuration Properties
You can further configure your Cleanse Match Server installation by customizing the
values in the cmxcleanse.properties file located in the directory specified in the
license file, such as: C:\Siperian\hub\cleanse\resources.
After you update cmxcleanse.properties, you must restart the Cleanse Match
Server application to reload the settings in the file. Your file reflects your installation,
but it looks similar to the following example:
cmx.server.datalayer.cleanse.working_
files.location=C:\siperian\hub\cleanse\tmp
cmx.server.datalayer.cleanse.working_files=KEEP
cmx.server.datalayer.cleanse.execution=LOCAL
cmx.home=C:\siperian\hub\cleanse
cmx.appserver.type=websphere
Adding the Oracle TNS Name to the ORS Database
Cleanse Match Server processes cleanse jobs either online or in batches. In the case of
an online operation, the application sends back the result as an XML response via
HTTP protocol. In the case of a batch job, the batch commands that Cleanse Match
Server application launches use Oracle SQL loader to write the data back.
58 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Running the Post-Install Process Manually
When the loader is invoked, it uses the parameters in tnsnames.ora to connect to the
Oracle database. The Cleanse Match Server installer does not add the TNS name into
the Oracle installation. Therefore, on the cleanse server machine, you must add the
TNS entry to the tnsnames.ora file. The following is an example of an entry:
<TNS NAME> =
(DESCRIPTION =
(ADDRESS_LIST =
(ADDRESS = (PROTOCOL = TCP)(HOST = <ORACLE_SERVER_HOSTNAME>)(PORT =
<ORACLE_SERVER_PORT>))
)
(CONNECT_DATA = (SERVICE_NAME = <ORACLE_SID>))
)
Enter this TNS name when you register the ORS database through the Hub Console.
Please see the Siperian Hub Administrator’s Guide for more information.
Note: The TNS names on the Hub Server machine and the Cleanse Match Server
machine must be the same.
Running the Post-Install Process Manually
If you chose to have the installer skip the post-install process, you must run this
manually.
By default, this script is located in the following directory:
<Siperian_Install_Dir>\hub\cleanse
To run the post-install process manually:
• For the WebLogic application server, run the following command from a
command prompt:
postInstallSetup.bat -Dweblogic.password=your_password
-Ddatabase.password=!!cmx!!
where your_password is the password
•
for your WebLogic application server.
For the WebSphere application server, run the following command from a
command prompt:
Installing the Cleanse Match Server
59
Configuring Cleanse Match Server for Multi-Threading
postinstallsetup.sh -Ddatabase.password=!!cmx!!
•
For the JBoss application server, run the following command from a command
prompt:
postinstallsetup.sh
Configuring Cleanse Match Server for
Multi-Threading
By default, Cleanse Match Server runs in single-threaded mode. If you have a Cleanse
Match Server server with more than one CPU, then you may get performance benefits
by configuring Cleanse Match Server for multi-threaded operation.
To configure Cleanse Match Server for multi-threading:
1. Go to the following directory:
<Siperian_Install_Dir>\hub\cleanse\resources
and open the cmxcleanse.properties file for editing.
2.
Find the following entry in the cmxcleanse.properties file:
# Cleanse Properties
# control the number thread to use while cleaning
Cmx_server.cleanse.num_of_thread=1
3.
Set the cmx_server.cleanse.num_of_thread parameter to the number of
threads appropriate for your system.
The default, recommended value is 1 thread. Thread counts can be changed
without needing to restart the server.
There are several factors you should consider:
•
Number of processor cores available on your machine
You might consider setting the number of threads to the number of processor
cores available on your machine. For example, set the number of threads for a
dual-core machine to two threads, and set the number of threads for a single
quad-core to four threads.
•
Remote database connection
60 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Configuring Dual Cleanse Servers
If you are working with a remote database, you might consider setting the
threads to a number that is slightly higher than the number of processor cores,
so that the wait of one thread can be used by another thread. Setting the
number of threads slightly higher also enables you to account for the possible
latency that might occur with a remote database.
•
Process memory requirements
If you are running a memory-intensive process, you must restrict the total
memory allocated to all threads that are run under the JVM to 1 Gigabyte.
Because Siperian Hub runs in a 32-sit JVM environment, each thread requires
memory from the same JVM, and therefore the total amount of memory is
restricted.
If you set the num_of_thread property to any illegal values, such as a negative
number, 0, a character or a string, then the property value will be automatically
reset to the default value (1).
Note: You must change this value after migration from an earlier hub version or
all the values will default to one (1) thread.
Configuring Dual Cleanse Servers
You can configure multiple instances of Cleanse Match Server to run on a single
machine. The effectiveness of this approach depends on the hardware you are using as
well as your particular data cleansing requirements.
Multiple instances of Cleanse Match Server must run on separate application server
instances. That is, they must be in separate physical processes.
The process of configuring dual cleanse servers is primarily an exercise in application
server configuration.
Note: This procedure requires that you be expert in the administration and
troubleshooting of your application server implementation.
These are the steps to configuring dual cleanse servers:
Installing the Cleanse Match Server
61
Configuring Dual Cleanse Servers
1.
Install and configure the first instance of Cleanse Match Server as explained in
“Installing Cleanse Match Server” on page 52 and “Configuring the Cleanse Match
Server” on page 56.
2.
Configure your system to run multiple instances of your application server. To
learn more, see “Configuring Multiple Instances of Your Application Server” on
page 62.
3.
Deploy Cleanse Match Server to the second instance of your application server.
Configuring Multiple Instances of Your Application Server
To configure your application server:
1. Ensure that the machine you are configuring has sufficient memory to host
multiple instances of the application server.
2.
3.
Configure each Cleanse Match Server instance in a separate application server
instance:
•
On WebLogic, create a separate domain for each cleanse instance. To learn
more, see your WebLogic documentation.
•
On JBoss, copy the JBoss files to a new directory. Change the port settings to
allow multiple instances to coexist without conflicting ports. To learn more,
see your JBoss documentation.
•
On WebSphere, you must either have the Network Deployment edition of
WebSphere, which allows you to create and manage multiple instances, or use
the instance script and adjust the settings. In either case, change the default_
host port settings using the WAS Admin Console so the values for the
separate instances don’t conflict. If you are using the wsinstance script, install
the Admin console on the new instance manually and change admin_host port
assignment. To learn more, see your WebSphere documentation.
Test the second instance you just created.
Now you can deploy Cleanse Match Server. To learn more, see “Deploying Cleanse
Match Server on the Second Application Server Instance” on page 63.
62 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Configuring Dual Cleanse Servers
Deploying Cleanse Match Server on the Second
Application Server Instance
There are two alternatives for deploying Cleanse Match Server on the second instance
of your application server:
• You can install an additional copy of Cleanse Match Server into a different
directory using the installer.
Installing an additional copy using the installer gives you full independence of the
two Cleanse Match Server instances. There are no extra steps required to support
this configuration. You can run the postInstallSetup script to deploy Cleanse
Match Server to your second instance.
•
You can deploy your existing Cleanse Match Server EAR into the new application
server instance.
The second approach is lighter and allows multiple instances to share the Siperian
Hub configuration settings. The disadvantage is that both servers share the
temporary directories and write to the same file. This complicates diagnostics when
both instances run Cleanse Match Server at the same time.
Using this approach, you cannot use the postInstallSetup script to deploy the
additional cleanse instance, but you can deploy them manually on the application
server.
Deploying the EAR File Manually
To deploy the EAR file manually:
• If you are using JBoss, copy the file the \deploy directory.
If you are using WebLogic or WebSphere, use the Administrative Console for
deployment. Accept all defaults.
Installing the Cleanse Match Server
63
Configuring Dual Cleanse Servers
Using Multiple Cleanse Servers
Siperian Hub supports running multiple Cleanse Match Server servers per ORS
database. This allows you to parallelize the work of cleansing the data. However, only
one Cleanse Match Server application is supported on a single system.
When Cleanse Match Server is not installed on the same application server as Hub
Server, then you must manually configure the application server to create the
datasources for Cleanse Match Server to take advantage of connection pooling and
improved performance.
Note: If the datasource does not exist, the Cleanse Match Server uses the JDBC
connection.
To configure multiple cleanse servers
1. After you have installed and configured the Hub Server and Cleanse Match Server,
install your cleanse engine and Cleanse Match Server on another machine. To learn
more about installing Cleanse Match Server, see “Installing Cleanse Match Server”
on page 52 and “Configuring the Cleanse Match Server” on page 56.
2.
For each Cleanse Match Server server, on the application server create the
datasource for each cmx_system. This has to have exactly the same name and
JNDI name as the Hub Server configuration. To learn more about creating
datasources, see Appendix A, “Manually Configuring Siperian System Message
Queues.”
3.
Using Hub Console, connect to the data store.
4.
Choose the Cleansing workbench.
Add the new cleanse server.
Siperian Hub uses round-robin load-balancing to spread cleansing tasks between all the
cleanse servers that are online. You can see all the cleanse servers in the Cleansing
workbench.
64 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Installing the Siperian Hub Server into a WebLogic Server Cluster
Distributed Cleanse Match Servers
When running a stage/match job, if more than one cleanse match server is registered,
and if the total number of records to be staged/matched is more than 500, then the job
will get distributed in parallel between the different cleanse/match servers.
Below are the parameters that need to be set to utilize the cleanse servers based on the
server configuration.
• Thread Count - This setting reflects the number of threads that a server will be
asked to handle. We recommend that you set the thread count higher than the
number of CPUs available if the servers are widely distributed and/or latency is
high, so that servers can be doing more work during wait time.
•
CPU Rating - This setting rates the relative “strength” of the CPUs across the
machines; the “lowest power” machine would have a rating of 1.0. Other CPUs on
different machines would have a number relative number to the lowest powered
machine.
Note: To configure distributed cleanse and distributed match, you must set Thread
Count and CPU Rating values when you register the Cleanse Match Server in the
Siperian console.
Installing the Siperian Hub Server into a WebLogic
Server Cluster
The following instructions apply to installing the Siperian Hub Server into a WebLogic
Server cluster.
See the documentation on the BEA/WebLogic website for detailed instructions on
setting up the WebLogic Server cluster.
Install Siperian Hub Server on the Admin Server and all nodes of the cluster that MRM
server will be deployed to by running following command:
hub_install.exe
-DSIPERIAN_INSTALL_PREREQ_VALIDATION=false
Installing the Cleanse Match Server
65
Installing the Siperian Hub Server into a WebLogic Server Cluster
The path for the Siperian Hub install should be the same on nodes of the cluster.
Choose between the following two methods for installing the Siperian Hub on all of
the nodes in the cluster:
1. Run the Siperian Hub installer on all nodes and click No when prompted to run
the postInstallSetup script to deploy the application.
2.
Run the Siperian Hub installer on the first node of the cluster. Click No when
prompted to run the postInstallSetup script to deploy the application. Copy the
Siperian Hub Server root installation directory to all nodes in the cluster.
Creating a WebLogic Cluster
1.
Create a clustered domain. For details on setting up a clustered domain see Cluster
Implementation procedures.
a.
2.
Create an Admin server (for example, on port 7001) and two managed servers
(for example, on port 8001, 8002) and one cluster that includes the managed
servers.
Start the node manager at this location:
%BEA_Install_Dir%/weblogic91/server/bin/startNodeManager.cmd
3.
Start the Admin server using the startWeblogic.cmd command.
4.
Start the managed servers either through the WebLogic Server console or using
startManagedWebLogic.cmd. See the file startManagedWebLogic_readme.txt
for instructions on using the script. Here is an example command line to start one
of the nodes:
startManagedWebLogic.cmd "managedServer_1" http://DKWKS01:7001
5.
Open the WebLogic Console connected to the Admin server.
6.
Configure the Cluster IP Address. See the Cluster Address section of the
BEA/WebLogic setup documentation located on the BEA/WebLogic website for
details. Follow the instructions for creating the cluster address Development and
Test Environments, for example: 192.168.1.113:8001, 192.168.1.113:8002.
7.
Restart all the managed servers.You can either use the console or stop all of the
servers and start them again by repeating Step 4.
66 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Installing the Siperian Hub Server into a WebLogic Server Cluster
To configure the services and deploy hub server once the
cluster is running:
1.
Start hub server install with following command:
hub_install.exe
2.
-DSIPERIAN_INSTALL_PREREQ_VALIDATION=false
When asked by the installer for the WebLogic listener port, enter the managed
server ports for any node in the cluster, if the cluster is set up with the
development Cluster IP address.
Use the DNS name and the cluster port when using the production cluster IP
address configuration.
3.
Run following command to repackage the EAR file:
cd <install_Install_Dir>\bin
sip_ant.bat repackage
4.
Open the WebLogic Server console and manually create the JMS queue. For more
information on how to create JMS queues, see Appendix A, “Manually Configuring
Siperian System Message Queues.”
In WebLogic 9.x, while creating JMS Server for Siperian, make sure to select a
Migratable Server as target. For more information on why the JMS Server target
should be a migratable server, see “Configuring Migratable Targets for JMS
Servers” in the BEA/WebLogic documentation.
When configuring the JMS Module, make the target “All servers in the cluster”.
5.
Open the WebLogic Server console and manually create the connection pools and
data sources for CMX_SYSTEM and ORSs. Deploy them to the cluster.
6.
Manually deploy the MRM Server EAR through the WebLogic Server console.
7.
If production Cluster IP address is used to update the cmx.appserver.hostname
setting in the cmxserver.properties file on all nodes in the cluster and set it to
the cluster IP address.
The MRM Server is now ready to use. The MRM Server can be accessed using either
of the nodes in the cluster if the development cluster IP is used or with the cluster
name in the production clusters. Once the application is started, the EJB clustering will
distribute the requests between the managed servers and manage any failover.
Installing the Cleanse Match Server
67
Installing the Siperian Hub Server into a WebLogic Server Cluster
Note: When registering new ORSs in Siperian Hub console, the data sources and
connection pools for these ORSs have to be created manually.
Deploying the Cleanse Server Once the Cluster is Running
1.
Start Siperian Cleanse Server install with following command:
Hub_cleanse_install.exe -DSIPERIAN_INSTALL_PREREQ_VALIDATION=false
2.
When the installer prompts you for the WebLogic listener port, enter the managed
server ports for any node in the cluster if the cluster is setup with the development
Cluster IP address.
Use the DNS name and the cluster port when using the production cluster IP
address configuration.
3.
Run following command to repackage the EAR file:
cd <install_Install_Dir>\bin
sip_ant.bat repackage
4.
Manually deploy the MRM Server EAR file through the WebLogic Server console.
5.
If production Cluster IP is used update the cmx.appserver.hostname setting in
the cmxserver.properties file on all nodes in the cluster and set it to the cluster
IP address.
6.
When registering new ORSs in Siperian Hub console, the data sources and
connection pools for these ORSs have to be created manually in the Siperian Hub
server environment.
68 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
5
Launching Siperian Hub Console
This chapter explains how to start the Hub Console.
Chapter Contents
•
About the Hub Console
•
Starting the Hub Console
About the Hub Console
You do not need to install the Hub Console because the console is launched from the
Hub Server installation using Java Web Start. You can launch the console from the
Windows Start menu, or type the following URL into your browser:
http://<hostname>:<port>/cmx/siperian-console.jnlp
Make sure that Java Web Start has been installed. The following URL is a page that has
a link to the Web Start installer:
http://<hostname>:<port>/cmx
Note: If you have just upgraded your installation from a previous version of Siperian
Hub, your site now has an updated Siperian certificate. Before you start the Console
for the first time, be sure to clear Java Web Start. To do this, open the Java Web Start
application. Select File > Preferences > Advanced and click Clear Folder.
69
Starting the Hub Console
Starting the Hub Console
To start Hub Console:
Click Start > Programs > Siperian > Hub-XU SP2 > server >Launch Hub
Console, or open a browser window and enter the following URL:
http://<hostname>:<port>/cmx/
If you entered the URL above, the Welcome page is displayed.
7.
Click the Launch MRM Console link.
The Hub Console login screen is displayed.
8.
Enter a user name and password.
If you do not have a user name and password set up, contact Siperian Support.
The console is now launched and you are logged in.
70 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
6
Clustering
This chapter explains how to set up clustering when you install Siperian Hub with
WebLogic or WebSphere.
Note: Currently, clustering using the Siperian Hub is only supported with WebLogic
and WebSphere.
Chapter Contents
•
Installing the Siperian Hub Server into a WebLogic Server Cluster
•
Installing the Siperian Hub Server into a WebSphere Server Cluster
71
Installing the Siperian Hub Server into a WebLogic Server Cluster
Installing the Siperian Hub Server into a WebLogic
Server Cluster
The following instructions apply to installing the Siperian Hub Server into a WebLogic
Server cluster.
See the documentation on the BEA/WebLogic website for detailed instructions on
setting up the WebLogic Server cluster.
Install Siperian Hub Server on the Admin Server and all nodes of the cluster that MRM
server will be deployed to by running following command:
hub_install.exe -DSIPERIAN_INSTALL_PREREQ_VALIDATION=false
The path for the Siperian Hub install should be the same on all nodes of the cluster.
Choose between the following methods for installing the Siperian Hub on all of the
nodes in the cluster:
1. Run the Siperian Hub installer on all nodes and click No when prompted to run
the postInstallSetup script to deploy the application.
2.
Run the Siperian Hub installer on the first node of the cluster. Click No when
prompted to run the postInstallSetup script to deploy the application. Copy the
Siperian Hub Server root installation directory to all nodes in the cluster.
Creating a WebLogic Cluster
The steps below provide a high-level overview of the process of setting up your
WebLogic cluster. You should refer to your BEA WebLogic documentation for details.
1. Create a clustered domain. For details on setting up a clustered domain see Cluster
Implementation procedures.
Create an Admin server (for example, on port 7001) and two managed servers (for
example, on port 8001, 8002) and one cluster that includes the managed servers.
2.
Start the node manager.
3.
Start the Admin server using the startWeblogic.cmd command.
72 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Installing the Siperian Hub Server into a WebLogic Server Cluster
4.
Start the managed servers either through the WebLogic Server console or using
startManagedWebLogic.cmd. See the file startManagedWebLogic_readme.txt
for instructions on using the script.
5.
Open the WebLogic Console connected to the Admin server.
6.
Configure the Cluster IP Address. See the Cluster Address section of the
BEA/WebLogic setup documentation located on the BEA/WebLogic website for
details. Follow the instructions for creating the cluster address Development and
Test Environments, for example: 192.168.1.113:8001, 192.168.1.113:8002.
7.
Restart all the managed servers.You can either use the console or stop all of the
servers and start them again by repeating Step 4.
For details and to learn more, see your WebLogic documentation.
Configure Services and Deploy the Hub Server
To configure the services and deploy the hub server once the cluster is running:
1. Start hub server install with following command:
hub_install.exe -DSIPERIAN_INSTALL_PREREQ_VALIDATION=false
2.
When asked by the installer for the WebLogic listener port, enter the managed
server ports for any node in the cluster, if the cluster is set up with the
development Cluster IP address.
Use the DNS name and the cluster port when using the production cluster IP
address configuration.
3.
Run following command to repackage the EAR file:
cd <install_Install_Dir>\bin
sip_ant.bat repackage
4.
Open the WebLogic Server console and manually create the JMS queue. For more
information on how to create JMS queues, see Appendix A, “Manually Configuring
Siperian System Message Queues.”
In WebLogic 9.x, while creating JMS Server for Siperian, make sure to select a
Migratable Server as target. For more information on why the JMS Server target
should be a migratable server, see “Configuring Migratable Targets for JMS
Servers” in the BEA/WebLogic documentation.
Clustering 73
Installing the Siperian Hub Server into a WebLogic Server Cluster
When configuring the JMS Module, make the target “All servers in the cluster”.
5.
Open the WebLogic Server console and manually create the connection pools and
data sources for CMX_SYSTEM and ORSs. Deploy them to the cluster.
See Chapter 2, “Creating the Master Database and One ORS Database” in this
guide for information about creating these data sources.
6.
Manually deploy the MRM Server EAR through the WebLogic Server console.
7.
If production Cluster IP address is used, update the cmx.appserver.hostname
setting in the cmxserver.properties file on all nodes in the cluster and set it to
the cluster IP address.
The MRM Server is now ready to use. The MRM Server can be accessed using either
of the nodes in the cluster if the development cluster IP is used or with the cluster
name in the production clusters. Once the application is started, the EJB clustering will
distribute the requests between the managed servers and manage any failover.
Note: When registering new ORSs in Siperian Hub console, the data sources and
connection pools for these ORSs have to be created manually.
Deploying the Cleanse Server
To deploy the Cleanse Server once the cluster is running:
1. Start Siperian Cleanse Server install with following command:
Hub_cleanse_install.exe -DSIPERIAN_INSTALL_PREREQ_VALIDATION=false
2.
When the installer prompts you for the WebLogic listener port, enter the managed
server ports for any node in the cluster if the cluster is setup with the development
Cluster IP address.
Use the DNS name and the cluster port when using the production cluster IP
address configuration.
3.
Run following command to repackage the EAR file:
cd <install_Install_Dir>\bin
sip_ant.bat repackage
4.
Manually deploy the MRM Server EAR file through the WebLogic Server console.
74 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Installing the Siperian Hub Server into a WebSphere Server Cluster
5.
If production Cluster IP is used update the cmx.appserver.hostname setting in
the cmxserver.properties file on all nodes in the cluster and set it to the cluster
IP address.
6.
When registering new ORSs in Siperian Hub console, the data sources and
connection pools for these ORSs have to be created manually in the Siperian Hub
server environment.
Installing the Siperian Hub Server into a WebSphere
Server Cluster
Follow the steps in this section to set up and configure WebSphere with Siperian Hub
applications. The following instructions apply to installing the Siperian Hub Server and
Cleanse Match Server into a WebSphere Server (WAS) cluster.
See the WebSphere Network Install Guide for detailed instructions on installing
WebSphere and setting up the WAS cluster.
Installing Siperian Hub
Install Siperian Hub Server and Cleanse Match Server on each of the nodes of the
cluster servers to which the MRM server will be deployed.
1. While installing Hub Server and Cleanse Match Server, the path for the Siperian
Hub install should be the same on all nodes of the cluster.
2.
When WebSphere server name, SOAP port, and RMI port are requested during
installation, provide one of the cluster server's names and its corresponding SOAP
and RMI port information.
3.
Choose between the following two methods for installing the Siperian Hub on all
of the nodes in the cluster:
Clustering 75
Installing the Siperian Hub Server into a WebSphere Server Cluster
a.
Run the Siperian Hub installers on all nodes and click No when prompted to
run the postInstallSetup script to deploy the application.
b.
Run the Siperian Hub installers on the first node of the cluster. Click No when
prompted to run the postInstallSetup script to deploy the application. Copy
the Siperian Hub root installation directory to all nodes in the cluster if all
nodes use the same operating system.
Instructions to Create a WebSphere Cluster
This section describes how to create a WebSphere cluster.
1. Start the WebSphere nodes and the WebSphere manager.
2.
Create WebSphere cluster and cluster servers.
Creating a Cluster
This section describes how to create a cluster and cluster members.
1. In the WebSphere admin console, select create Cluster > add Cluster members.
2.
Add all the default ports in the virtual host that are associated with cluster
members.
3.
In the admin console, select Environment > Virtual Hosts > default_host >
Host Aliased > new (*:9081, *:9082 and so on)
4.
Start the cluster (wait until you see a solid green icon in the console).
For more information on creating clusters, go to the following:
http://publib.boulder.ibm.com/infocenter/wsphelp/index.jsp?topic=
/com.ibm.websphere.nd.doc/info/ae/ae/trun_wlm_member.html
For more information on creating cluster members, go to the following:
http://publib.boulder.ibm.com/infocenter/wsphelp/index.jsp?topic=
/com.ibm.websphere.nd.doc/info/ae/ae/trun_wlm_member.html
5.
Make sure the cluster and all cluster servers are running.
76 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Installing the Siperian Hub Server into a WebSphere Server Cluster
Load Balancing
To enable application load balancing, you must install the IBM HTTP Server (or
another supported web server) and the web server plug-in. You must also propagate
the web server plug-in XML configuration file. Once you perform these two steps, you
can access the application through one port (for instance, port number 80) and the
plug-in will arrange to forward to individual cluster ports (say 9082, 9083 etc.) in
round-robin fashion.
For more detailed information on load balancing, from your WebSphere administrator’s
console site choose:
http://localhost:<admin_port>/ibm/console > Guided Activities >
From this location, you can choose any of the following:
• Routing request through a Web server to an application server
•
Configuring a cluster
•
Making applications highly available
Without load-balancing (which generally is not the goal), you need to add all the ports
in the default virtual host and access each server through its own port.
Select the following to add ports:
Environment > Virtual Hosts > default_host > Host Aliases > new
(*:9082, *:9083, *:9084, ...)
Configure Services and Deploy Hub Server
This section describes the steps to configure the services and deploy Hub Server once
the cluster is running.
1. Copy the Oracle 10.2.0.4 JDBC driver (ojdbc5.jar) to:
<WAS61ND_Home>\AppServer\
2.
In the admin console, add the JDBC driver path (it should be <WAS61ND_
HOME>\AppServer\lib) into the ORACLE_JDBC_DRIVER_PATH:
Clustering 77
Installing the Siperian Hub Server into a WebSphere Server Cluster
Environment > WebSphere Variables > ORACLE_JDBC_DRIVER_PATH
3.
Start the Hub Server installation with following command:
hub_install.exe
4.
When prompted for the WebSphere server name, SOAP, and RMI ports, enter one
of the cluster server names and its corresponding SOAP and RMI port
information.
5.
Click No when prompted to run the postInstallSetup script to deploy the
application.
6.
After the installation, open <install_Install_Dir>\resources\cmxserver.properties
and add all of the cluster server's machine names in cmx.appserver.hostname and
RMI ports in cmx.appserver.rmi.port, with the property information separated by
commas.
For example, if the cluster has four servers which are running in host1, host2,
host3, host4 using RMI ports 2812, 2813, 2814 and 2815 respectively, then the
cmx.appserver.hostname and cmx.appserver.rmi.port property in
<Hub_Install_Dir>/resources/cmxserver.properties would look like this:
cmx.appserver.rmi.port=2812,2813,2814,2815
cmx.appserver.hostname=host1,host2,host3,host4
Make sure there is no space or tab between port numbers. These port numbers
should be separated only by a comma, and host name and port numbers should be
in the same order. For example, first server's host name and port number should
be host1 and 2812; second server's host name and port number should be host2
and 2813 and so on.
7.
Run the following command to repackage the EAR file:
cd <Hub_Install_Dir>/bin
sip_ant.bat repackage
8.
Open the WebSphere console and manually create a JMS Queue.
For more information on how to create JMS Queue, please see the Siperian Hub
Install Guide for your platform. Designate the cluster member as the target for
JMS Bus, Queue, and Activation. This step needs to be done for every
member/server in the cluster.
9.
Open WebSphere console and manually create the connection pools and data
sources for CMX_SYSTEM and ORSs and deploy them to the cluster.
78 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Installing the Siperian Hub Server into a WebSphere Server Cluster
10.
Manually deploy the MRM Hub Server EAR to the cluster through the WebSphere
console.
a.
In the WebSphere admin console, select Applications > Enterprise
Applications, and click Install.
b.
Enter the local path for the siperian-mrm.ear and click Next.
c.
Use the default settings and click Next.
d.
Map modules to servers, select the cluster name you want to deploy, check
both JARs, click Apply, and then click Next.
e.
Choose the default method and the authentication data = cmx_system, and
check siperian-server.jar. Click Apply.
Map resource references to resources, browse target resource JNDI name for
siperian-server.jar, and select and apply
siperian.mrm.jms.xaconnectionfactory from the list. Click Next.
11.
Verify the information in the summary and click Next.
12.
Save the change.
13.
Stop the following: cluster, manager, and node. Restart them in the following
order: node, manager, cluster.
The MRM Server is ready to use. MRM Server can be accessed using any of the nodes
in the cluster if host aliases are set. MRM Server can also be accessed through IBM
HTTP Server if cluster is set for load balancing.
Note: When registering new ORSs in the Siperian Hub console, the data sources and
connection pools for these ORSs have to be created manually.
Deploy the Cleanse Match Server
Here are the steps to deploy the Cleanse Match Server once the cluster is running:
1. Start the Cleanse Match Server install with following command:
hub_cleanse_install.exe
2.
When asked by the installer for the WebSphere server name and SOAP port, enter
one of the cluster server's names and its corresponding SOAP port information.
Clustering 79
Installing the Siperian Hub Server into a WebSphere Server Cluster
3.
Run following command to repackage the EAR file:
cd <Cleanse_Install_Dir>\bin
sip_ant.bat repackage
4.
Manually deploy the Cleanse Match Server's EAR to the cluster through the
WebSphere Admin console.
80 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
7
Upgrading Siperian Hub
If you have a Siperian Hub version XT or higher, you can use the Siperian installer to
upgrade your current installation. This is done by patching your current installation;
none of the current configuration information will be changed.
If you are upgrading from a version of the Siperian Hub prior to XT, you will need to
do a full install of the XU SP2 Hub Server and Cleanse Server. See Chapter 3,
“Installing the Hub Server” for details. You can upgrade your system and Master and
ORS database from Siperian Hub XR and above. See “Updating the Database” on
page 97.
Note: The duration of the upgrade process will be determined by the number and size
of the base objects.
Chapter Contents
•
Before You Upgrade
•
Upgrading the Hub Server
•
Running the patchInstallSetup Script
•
Upgrading Cleanse Match Server
•
Upgrading the Hub Store
•
Updating the Database
•
Updating Hierarchy Manager
81
Before You Upgrade
Before You Upgrade
The Siperian installer can be used to automatically upgrade Siperian Hub XT
installations of the Siperian Hub and Cleanse Match servers to Siperian Hub
XU SP2. This section contains upgrade and configuration information. See the Siperian
Hub Release Notes for a synopsis of the new features of Siperian Hub XU SP2, as well as
a list of known issues, and details on patching and upgrading various application
servers.
To use the installer to upgrade your current software, you must have one of these
versions already installed and configured for your environment:
• Siperian Hub XT
•
Siperian Hub XT SP1
•
Siperian Hub XT SP2
•
Siperian Hub XU
•
Siperian Hub XU Patch A
•
Siperian Hub XU Patch B
•
Siperian Hub XU SP1
Check the Siperian Hub Release Notes for details on patching and upgrading various
application servers. Not all application servers will support the upgrade.
Important: Different versions of Siperian Hub cannot co-exist in the same
environment. All the components of an installation must be the same version. If you
wish to have multiple versions installed, you must install each version in a separate
environment.
Before you upgrade, make sure that you have:
• Fulfilled the Siperian Hub XU SP2 hardware and software requirements for your
platform. These software requirements include any unlock codes required for your
cleanse engine. To learn more about the requirements, see the Siperian Hub Release
Notes.
•
Turned on the Siperian Hub database debug log.
82 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Before You Upgrade
•
Validated your metadata. Upgrades performed on Hub Stores with any invalid
metadata may not perform as expected. Contact Siperian Support for information
about validating metadata.
•
Backed up your schema. Contact Siperian Support if you need assistance with this.
It is essential to back up your schema before upgrading. If the upgrade fails, you
must restore from this backup before proceeding.
•
WebSphere: Made the configuration changes explained in About Non-default
Server Names and SOAP Ports on WebSphere. If you do not make these
configuration changes and you run patchInstallSetup manually, the process will
fail.
•
If you have used non-default tablespaces, make sure that these tablespaces are
available before starting with the upgrade.
•
Backed up your user exit stored procedures if they have been customized. The
installer overwrites any customized database code when you upgrade the database.
You must manually reapply the customizations after you perform the upgrade.
•
Make sure that you have enough space for your data. This sizing will depend on
your data volumes. Check with your database administrator.
•
Some of the conversion scripts create backups of the CTL, HCTL, HFKM,
HMXR, HXRF, VXR and the XREF tables, which will require space. please
contact Siperian Support if you need more assistance with the upgrade process.
•
Remove your relationship tables before you upgrade, or you will receive an error.
About the Upgrade Process
The steps of the upgrade process are:
1. Make sure that you have fulfilled the requirements in Before You Upgrade.
2.
Upgrade the Hub Server, as explained in “Upgrading the Hub Server” on page 86.
3.
Upgrade the Cleanse Match server, as explained in “Upgrading Cleanse Match
Server” on page 89.
4.
If you are using WebSphere, update the properties as explained in “Updating the
Properties” on page 93.
Upgrading Siperian Hub
83
Before You Upgrade
5.
If you are using the AddressDoctor cleanse engine, check the Jade library version,
as explained in the Cleanse Adapter Guide.
6.
Upgrade the databases (all master and ORS databases,) as explained in “Upgrading
the Hub Store” on page 94.
7.
If you are using the AddressDoctor cleanse engine, set the JVM settings, as
explained in Cleanse Adapter Guide.
8.
Shut down the application servers that run the Hub Server and Cleanse Match
server. Clear Java Web Start. You must do this because you now have an updated
Siperian certificate.
9.
Start the application servers that run the Hub Server and the Cleanse Match server.
10.
Send the Siperian database debug log to Siperian Support at the following address:
[email protected]
This allows support to confirm that the upgrade was successful.
About the Supported Platforms
Upgrading the Siperian Hub and Cleanse Match server is supported on all the
platforms on which the Siperian Hub is supported. For the supported versions of these
operating systems and supporting software, see the Siperian Hub Release Notes.
The Siperian Hub and Cleanse Match Server can be upgraded only from Siperian Hub
XT and above. The ORS and CMX_SYSTEM can be upgraded only from Siperian
Hub XR, a one-step migration.
You will need do a clean install of the Siperian Hub and Cleanse Server if you have a
pre-XT version of Siperian. See Chapter 2, “Installing the Hub Store” and Chapter 3,
“Installing the Hub Server” for details on a full installation.
Checking the Version and Build Number
You can find out the version and build number of Hub Server by viewing the
manifest.mf inside the <Siperian_Install_Dir>\server\siperian-mrm.ear
file.
84 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Before You Upgrade
You can also check by running <Siperian_Install_
Dir>\hub\server\bin\versionInfo.bat file and check the
version and build
number for your installation from the Help menu in the Hub Console.
Patch Installs for AddressDoctor and Platon Licenses
The following table shows what happens to files during different patch installs on
machines that use AddressDoctor or Platon licenses:
Patch
What Happens to libJADE.dll file
Platon
XU PatchB or earlier
versions to XU SP1
Updated and copied to:
XU SP1-XU SP2
Updated and copied to:
<cleanse_install_
home>\lib\upgrade\AddressDoctor
<cleanse_install_
home>\lib\upgrade\AddressDoctor
AddressDoctor
XU PatchB or earlier
versions to XU SP1
Updated and copied to:
XU SP1-XU SP2
Updated and copied to:
<cleanse_install_
home>\lib\upgrade\AddressDoctor
<cleanse_install_
home>\lib\upgrade\AddressDoctor
Note: You will have to stop appserver, copy JADE.dll from <cleanse_install_
home>\lib\upgrade\AddressDoctor to <cleanse_install_home>\lib and restart the
appserver.
Upgrading Siperian Hub
85
Upgrading the Hub Server
Upgrading the Hub Server
To upgrade the Hub Server:
1. Back up your existing Hub Server directories, as described in “Before You
Upgrade” on page 82.
2.
Make sure that your application server is up and running. For WebLogic and
WebSphere, you must have the application server running in order to perform the
upgrade. For JBoss, having the application server running is optional. You can
manually deploy the upgrade if the JBoss server is off; however to do an
auto-deploy, the JBoss server must be turned on.
3.
Log in under the username that was used to install the Hub Server.
4.
Run the Siperian installer. See “Patch Install for the Hub Server” on page 86 for
details.
If the install fails to complete successfully, the last screen of the installer will state
that the patch failed and include a pointer to the appropriate log file with the error
or failure messages. To learn more about what to do if the install/upgrade fails, see
“About Upgrade Failures” on page 89.
5.
Upgrade the database, as explained in “Upgrading the Hub Store” on page 94.
6.
If you chose to run the patchInstallSetup script manually, make sure that the
application server is up and running. Then run the patchInstallSetup script, as
explained in the “Running the patchInstallSetup Script” on page 88.
Patch Install for the Hub Server
Note: The screen shots, file names, and directories in this guide may vary slightly
depending on what type of installation you are performing.
To perform a patch install for the Siperian Hub Server:
1. Run the Siperian Hub installer. The installer is located on the distribution in the
\mrmserver\windows directory. Run hub_install.exe to begin the installation
process. This file is part of your Siperian Hub distribution.
The Siperian installer displays the Introduction screen.
2.
Click Next to continue
86 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Upgrading the Hub Server
3.
Select the “I accept the terms of the License Agreement” button and then click
Next.
4.
Click the Choose... button to locate your previous Siperian Hub installation and
then click Next.
A Version Warning message screen is displayed. To upgrade the version you have,
choose OK. Otherwise, choose Cancel and pick another location for your
installation.
5.
If you want to overwrite this installation, click OK.
The WebLogic login screen displays. You are prompted for the WebLogic
Administrative password if this patch upgrade is being done while using the
WebLogic application server.
6.
Enter the WebLogic Administrative domain password, the Deploy screen displays.
7.
If you click No, you have the option of running PatchInstallSetup manually.
See “Running the patchInstallSetup Script” on page 88 for details.
8.
If you want to change any options, click the Previous button to navigate to the
appropriate screens. Once the summary reflects the options you want, click Install
to start the installation process.
The Please Wait screen displays while Siperian configures your system. During this
operation, the installer is backing up files (except what is in the tmp folder) and
putting them into a JAR file with a name similar to Siperian Hub
Server-2007-07-26_14.34.jar.
When the installation completes, the Install Complete screen is displayed.
9.
Click Done to exit the installer.
Checking the Log Files
The following files are useful for troubleshooting your Hub Server installation. Save
these files right after a failure and provide them when you call Siperian support:
• For the upgrade installation, check this file for the patch version after both the
Hub Server and Cleanse Match Server upgrade:
<Siperian_Install_Dir>\server\bin\versionInfo.bat
Upgrading Siperian Hub
87
Running the patchInstallSetup Script
Run the versionInfo.bat file to display information about the component name,
release name, date and time stamps for the start of the install and end of the install,
and the current install status.
•
<Siperian_Install_Dir>\hub\server\Siperian_Hub_Server_
InstallLog.xml – contains the messages for the installation
•
<Siperian_Install_Dir>\hub\server\siperian_installer_debug.txt –
contains debug messages. This contains all the options that you selected when you
ran the installation.
•
<Siperian_Install_Dir>\hub\server\logs\patchInstallSetup.log–
contains the messages for the patchInstallSetup script
•
<Siperian_Install_Dir>\hub\server\logs\cmxserver.log–
this is the log
for the server. When the server started, it created this file.
•
Application server log files.
To learn more, see “About the Siperian Hub Log Files” on page 122.
Running the patchInstallSetup Script
If you chose to manually deploy the patch install for the application, you must run the
patchInstallSetup script yourself. This script deploys the application and performs
some application server configuration. You must run patchInstallSetup (either
manually or automatically) for both Cleanse Match and Hub Server.
To run the patchInstallSetup script manually:
1. Make sure your application server is up and running.
2.
Go to the installation directory.
3.
Run the patchInstallSetup.bat script for your application server:
For the WebLogic application server:
patchInstallSetup.bat -Dweblogic.password=weblogic
-Ddatabase.password=!!cmx!!
For the WebSphere application server:
patchInstallSetup.bat -Ddatabase.password=!!cmx!!
For the JBoss application server:
88 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Upgrading Cleanse Match Server
patchInstallsetup.bat
If you need to create a new datasource, you can run the postInstallSetup script instead,
which will create a new datasource in addition to configuring and deploying the
application. See “Running the Post-Install Process Manually” on page 32 for details.
About Upgrade Failures
If you run the installer and the auto patch install fails, you can run the
patchInstallSetup.bat file after the failure. You can find this file in the
<Siperian_Install_Dir>\hub\server directory. See “Updating the Database” on
page 97 for more information on upgrade failures.
Upgrading Cleanse Match Server
To upgrade the Cleanse Match Server:
1. Back up your existing Cleanse Match directories, as described in Before You
Upgrade.
2.
Log in under the username that was used to install Cleanse Match.
3.
Run the Siperian installer for the Cleanse Match server as explained in “Patch
Install for the Cleanse Match Server” on page 90.
If the install/upgrade fails to complete successfully, the last screen of the installer
will state that the patch failed and include a pointer to the appropriate log file with
the error or failure messages. To learn more about what to do if the upgrade fails,
see About Upgrade Failures.
PATCH ONLY:Address these issues and reapply the patch with the force option:
java -jar patch1_hub_cleanse_<version_number>.jar apply -D force.apply=true
Depending on where the patch failed, you may be asked to confirm the
reapplication of the patch. Answer Yes to proceed.
4.
If you chose to run the patchInstallsetup script manually, make sure that the
application server is up and running. Then run the patchInstallsetup script
now, as explained in “Running the patchInstallSetup Script” on page 88.
Upgrading Siperian Hub
89
Upgrading Cleanse Match Server
5.
Update your cleanse engine as explained in the appendix for your cleanse engine in
this guide. If you are using the AddressDoctor cleanse engine, put the JADE.dll
(full size: 54,685,696 bytes) into the <Siperian_Install_Dir>\cleanse\lib
folder and replace the current JADE.dll. See the Cleanse Adapter Guide for details
on upgrading the Address Doctor Cleanse Engine.
Patch Install for the Cleanse Match Server
Your Siperian Hub distribution includes an installation wizard for Cleanse Match
Server.
To install Cleanse Match Server:
1. Run the Siperian Cleanse Match Server installer. The installer is on the distribution
in the \mrmcleanse\windows directory. Run hub_cleanse_install.exe to
begin the installation process. This file is part of your Siperian Hub distribution.
The Siperian installer displays the Introduction screen.
2.
Click Next.
The License Agreement screen is displayed.
3.
Click the I accept the terms of the License Agreement button and then click
Next.
The Choose Install Folder screen is displayed.
4.
Click the Choose... button to locate your previous Siperian Hub installation and
then click Next.
Important: Do not use a path that has spaces in the directory or folder names.
The Deploy screen is displayed.
5.
Click Yes to run the script during the installation, or click No to manually run it
later.
The Pre-Installation Summary screen is displayed.
6.
If you want to change any options, click the Previous button to navigate to the
appropriate screens. Once the summary reflects the options you want, click Next
to start the installation process.
Once the process is complete, the Install Complete screen is displayed.
90 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Upgrading Cleanse Match Server
7.
Click Done to finish the process and exit the installer.
Check the log files
The following files are also useful for troubleshooting your Hub Server installation.
Save these files right after a failure and provide them when you call Siperian support:
• For the upgrade installation, check this file for the patch version after both the
Hub Server and Cleanse Match Server upgrade:
<Siperian_Install_Dir>\server\bin\versionInfo.bat
Run the versionInfo.bat file to display information about the component name,
release name, date and time stamps for the start of the install and end of the install,
and the current install status.
•
<Siperian_Install_Dir>\hub\cleanse\siperian_installer_debug.txt
–
shows what was chosen during the upgrade installation
•
•
<Siperian_Install_Dir>\hub\cleanse\Siperian_Hub_Cleanse_Match_
Server_InstallLog.xml – shows the cleanse install errors and status
<Siperian_Install_Dir>\hub\cleanse\logs\postInstallSetup.log
–
shows the postInstallSetup script results
•
<Siperian_Install_Dir>\hub\cleanse\logs\cmxserver.log
– cleanse
server logs
•
Application server files, located in the tree under the install directory for your
application server.
About Patch Install Failures
Important: If the install/upgrade for the database process fails, stop. Contact Siperian
Support.
Do not
• Attempt to fix your metadata to resolve or by-pass errors.
•
Re-run the upgrade process using the installer. The upgrade process must not be
applied to schemas that have already been completely or partially upgraded.
Upgrading Siperian Hub
91
Upgrading Cleanse Match Server
Do
• Send Siperian support the debug log from the ORS. These files are located in the
following directory:
<Siperian_Install_Dir>\hub\server\resources\database\db_
changes\oracle\ORS
To learn more about the logs, see Chapter 9, “About the Siperian Hub Log Files”.
About Non-default Server Names and SOAP Ports on
WebSphere
If you are using the WebSphere application server and you want to use a server name
other than server1 for your Hub Server or Cleanse Match hosts, you must edit the
Siperian environment properties before upgrading either your Hub Server or Cleanse
Match Server. Likewise, if you want to use a non-default SOAP port for either Hub
Server or Cleanse Match server, you must edit the same properties file.
Using a Non-default Server Name
To use non-default values for the server name:
1. On the Hub Server machine, open the following file for editing:
<Siperian_Install_Dir>\hub\server\setSiperianEnv.bat
2.
To set the server name, update the value of the variable named WAS_SERVER.
3.
Save and close the file.
Using a Non-default SOAP Port
To use non-default values for the SOAP port:
1. On the Hub Server machine, open the following file for editing:
<Siperian_Install_Dir>\hub\server\resources\cmxserver.properties
2.
Add the following line to the properties file:
cmx.appserver.soap.connector.port=YourPortNumber
where YourPortNumber is the port you want to use.
92 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Upgrading Cleanse Match Server
3.
Save and close the file.
4.
On the Cleanse Match machine, open the following file for editing:
<Siperian_Install_
Dir>\hub\cleanse\resources\cmxcleanse.properties
5.
Add the following line to the properties file:
cmx.appserver.soap.connector.port=YourPortNumber
where YourPortNumber is the port you want to use.
6.
Save and close the file.
Updating the Properties
If you are using the WebSphere application server or the WebLogic application server
and are upgrading from Siperian Hub XU or Siperian Hub XU SP1, you must update
the properties.
To update the properties:
1. On the machine running Hub Server, open the following file for editing:
<Siperian_Install_Dir>\hub\server\bin\build.properties
Check to be sure the following lines have been added in the properties file
correctly. Correct the entries if necessary. Here is what the entries will look like for
WebSphere: # Master database settings
# In Oracle, masterdatabase.dbname is the Oracle SID
masterdatabase.type=ORACLE
masterdatabase.server=YourDatabaseHostName
masterdatabase.port=YourDatabasePortNumber
masterdatabase.dbname=YourOracleSID
masterdatabase.schemaname=YourMasterDatabaseSchemaName
masterdatabase.user=YourMasterDatabaseUserName
where YourDatabaseHostName is the name of the host running Oracle,
YourDatabasePortNumber is the number of the port on which Oracle is listening,
YourOracleSID is the your Oracle SID, YourMasterDatabaseSchemaName is the
name of the master database schema, usually CMX_SYSTEM, and
YourMasterDatabaseUserName is the username for the master database, usually
cmx.
Upgrading Siperian Hub
93
Upgrading the Hub Store
For the WebLogic server, these are the entries to check in the build.properites
file:
# Master database settings
masterdatabase.type=ORACLE
masterdatabase.server=YourDatabaseHostName
masterdatabase.instance=
masterdatabase.databasename=YourOracleSID
masterdatabase.jdbc.driverclassname=oracle.jdbc.xa.client.OracleX
ADataSource
masterdatabase.jdbc.jndiname=jdbc/siperian-cmx_system-ds
masterdatabase.jdbc.url=jdbc:oracle:thin:@YourDatabaseHostName:Yo
urDatabasePortNumber:YourDatabaseHostName
masterdatabase.user=YourMasterDatabaseUserName
where YourDatabaseHostName is the name of the host running Oracle,
YourDatabasePortNumber is the number of the port on which Oracle is listening,
YourOracleSID is the your Oracle SID, YourMasterDatabaseSchemaName is the
name of the master database schema, usually CMX_SYSTEM, and
YourMasterDatabaseUserName is the username for the master database, usually
cmx.
Note: The JBoss application server will not have these entries in the properties
file.
2.
Open the following file for editing:
<Siperian_Install_Dir>\hub\server\resources\cmxserver.properties
3.
Confirm that this property has been updated by the upgrade:
cmx.server.masterdatabase.type=ORACLE
Upgrading the Hub Store
You must perform this Hub Store upgrade for each database you wish to use with your
upgraded Hub Server. That means you must upgrade the master database as well as all
ORS databases you have. Upgrade of the ORS and Master database requires DBA
username and password.
Note: Before you upgrade your Hub Store, see “Updating the Database” on page 97
for recommendations and information to consider before you upgrade.
94 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Upgrading the Hub Store
To upgrade your database:
1. Go to the bin directory under the Hub Server installation directory.
2.
Update your master database with the following command:
sip_ant.bat updatemasterdatabase
3.
4.
Provide the following information for your master database:
•
TNS name—the name by which your database is known on the network
•
Master DB hostname—the name of the host running your master database
•
Master DB port number—the port number on which Oracle is listening
•
Master DB SID— the database system identifier
•
Master DB user name—the upgrade process expects the user name
CMX_SYSTEM
•
Master DB user password—the upgrade process expects the password for the
user name CMX_SYSTEM
•
CMX DB user name—the upgrade process expects the user name CMX
•
CMX DB user password—the upgrade process expects the password for the
user name CMX
Answer the following prompt:
This upgrade must be performed by a database administrator (DBA) to grant
‘create sequence’ privileges for the master database. The master database does not
have ‘create sequence’ privileges, you can either grant it now (manually) and then
move forward or re-start the upgrade, or direct this process to do so for you now,
and continue the current upgrade.
Do you want the process to create this privilege? Yes/No
A No answer means that the upgrade process checks again to make sure the user
really granted the privilege, and returns to the prompts, starting at the TNS name
prompt. A Yes answer means that you must answer some additional prompts:
•
Enter DBA username:
•
Enter DBA password:
After you have given the DBA username and password, the process automatically
grants the privilege and continues the upgrade process.
Upgrading Siperian Hub
95
Upgrading the Hub Store
5.
Update your ORS databases with the following command:
sip_ant.bat updateorsdatabase
You will be asked to provide the following information for your ORS Database:
•
TNS name—the database name
•
Host name—the name of the machine on which the database is running
•
Port number—the port on which the database is listening
•
SID—schema ID
•
Schema name—the name of your ORS
•
user password—the upgrade process expects the password for the user name
CMX_USER
You must run this script for each of your ORS databases.
Proxy User Questions
During the ORS upgrade process, you may need to answer the following questions if
your ORS does not have a PROXY_ROLE defined, or PROXY_ROLE is not granted
to the ORS database.
Here are the proxy user questions:
question.grant.create.proxy_role:
This upgrade should be performed by a DBA to create proxy_role
for the ors database. The ors database does not have proxy_role set,
you can either create it now (manually) and then move forward or
re-start the upgrade, or direct this process to do so for you now,
and continue the current upgrade.
[propertyprompt] Do you want the process to create proxy_role?
(Yes/No) [Yes]: do.grant.create.proxy_role.yes:
[propertyprompt] Enter DBA username [null]:
[propertyprompt] Enter DBA password [null]:
Processing Data in the Staging Tables After Migration from
96 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Updating the Database
XR
Note: The information in this section is only valid if you are migrating your schema
from XR to Siperian XU SP2.
If you migrated from Siperian XR to Siperian XU SP2 with data in the staging tables,
you must re-execute the staging job. This repopulates the staging tables with the data,
including a new field that is used internally by Siperian Hub, SRC_ROWID. This field
is strictly for use by Siperian Hub. Do not use this value in your processing or
calculations.
Updating the Database
You can only update the database after you have successfully installed and patched the
Hub Server. The Hub Server will work only after both the Master database and ORS
are updated.
You can create the data sources on the application server for the databases that are
already registered in the Master database by editing the registration and saving it with
“Update DataSource” checked. This creates the data source if it does not exist on the
application server. For example, a new application server may be brought online which
is missing all or some of the data sources for the ORSs that are already registered.
Another way to create a datasource is to run the postInstallSetup.bat file.
Warning: Back up your user exit stored procedures if they have been customized. The
patch installer overwrites any customized database code you have created when you
upgrade the database. If you do not backup your customized stored procedures, the
customizations must be manually re-applied after the upgrade.
General Recommendations
1.
Run the Metadata Validation tool. Generate the metadata report and resolve any
metadata issues before proceeding with the XU SP2 upgrade. See the Metadata
Manager Guide for more information.
Upgrading Siperian Hub
97
Updating the Database
•
The upgrade can fail if the metadata is not valid. In case of upgrade failures
due to metadata errors, you must restore the original schema, validate the
metadata, and repeat the upgrade again. Correct the inconsistencies with
assistance from Support
•
As part of the metadata validation and review, you must make sure that all the
stored procedures and views compile successfully in the schema.
2.
Run the metadata validation tool for XU SP2 once the upgrade is complete. This
tool is available in the Hub Console in XU SP2.
3.
You must sync up the views in the Hub Store after the upgrade to XU SP2. You
can do this by updating the query and re-saving it. If you don’t do this, the
Metadata validation tool will show inconsistencies in the packages. Please contact
support for assistance with the metadata validation.
4.
Send the generated metadata report to Siperian Support for review; also send the
empty repositories, database log, and tables for the schema. Invalid packages in the
schema may cause the upgrade process to fail.
This is to ensure that there are no metadata inconsistencies in the schema.
Inconsistencies in metadata can cause issues later on when using the Hub Server or
when running the Environment staging scripts.
5.
If the debug_file_path in the c_repos_db_release file is not set correctly before
migration, you might see a series of errors in the log file. Your upgrade might
experience buffer overflow errors and could quit.
Some Additional Pointers on Migration
1.
If you have Hierarchy Manager enabled in your Siperian Hub Store you must go
into the HM Configuration Tool in the Siperian Hub Console to allow the required
XU SP2 Hierarchy Manager changes to be made on your Hub Store. When
prompted to create the HM-specific columns in the HM Configuration Tool,
answer Yes.
See “Updating Hierarchy Manager” on page 99 for more information on updating
the Hierarchy Manager.
2.
The security settings translated from older releases to XU SP2 can only include
privileges that existed in the old release. (For example, READ, CREATE, UPDATE,
MERGE will be translated from XT and XU schemas when migrated to XU SP2.)
You can modify settings to take advantage of new features.
98 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Updating Hierarchy Manager
3.
Upgrade will fail in the 2005081801_mig_crt_ldg_stg_system_cols.sql script
if tables that were registered in the Hub Store are missing from the physical
schema. Make sure all metadata inconsistencies are resolved prior to migrating to
XU SP2.
4.
It is safe to drop unused tables from upgraded XR (to XU SP2) schemas - follow
up with Siperian Support to get a list of unused tables that can be dropped after
the upgrade.
5.
Relationship Tables will be dropped as part of the upgrade.
6.
The Match Validate (pre-merge rematch) flag is no longer used in XU SP2 and will
get dropped as part of the upgrade.
In case of failure
Re-running the upgrade on a partially upgraded schema will not work. You will have to
go back to a clean version of the schema if the upgrade fails.
• Review the debug log for database errors
•
Check metadata consistency. Run the metadata tool after the upgrade and send it
to Siperian Support along with the empty repositories and tables.
Updating Hierarchy Manager
After you upgrade a pre-XU SP2 schema to XU SP2, you will be prompted to upgrade
the XU SP2-specific Hierarchy Manager (HM) metadata when you open the HM
Configuration Tool in the Hub Console.
To upgrade the HM metadata:
1. Start the Hub Console. To learn more, see the Siperian Hub Administrator’s Guide for
details.
2.
Acquire a write lock. To learn more, see Siperian Hub Administrator’s Guide for
details.
3.
Launch the HM Configuration tool in the Hub Console.
4.
When you are prompted to add additional columns for HM, such as columns for
the RBO tables, click Yes.
Upgrading Siperian Hub
99
Updating Hierarchy Manager
After you upgrade a pre-XU SP2 schema to XU SP2, you will be prompted to remove
obsolete HM metadata when you get into the HM Configuration Tool.
To remove obsolete HM metadata:
1. In the Hub Console, acquire a write lock. See the Siperian Hub Administrator’s Guide
for details.
2.
Launch the HM Configuration Tool in the Hub Console.
3.
When you are prompted to delete obsolete base objects, click Yes.
Note: If the Rbo Rel Type Usage base object is being used by some other non-HM
base object, you will be told to manually delete the table by going to the schema
manager. This prompt will be shown only once - not every time the you launch the
HM Configuration tool.
The new HM Configuration Tool displays the entity types and relationship types
differently in Siperian Hub XU SP2. It shows types under the base object with which
they are associated. If a type is not associated with a base object, for example it does
not have HM packages configured, it cannot be shown on the GUI. These orphan
types remain in the database but cannot be shown in the new HM Configuration tool.
Older versions of HM Configuration tool allowed you to create Relationship and
Entity types without associating them with the base objects. The association between
types and base objects was made when you configured HM packages. In Siperian Hub
XU SP2, you must associate a type with a base object when a type is created.
During the ORS upgrade process, the migration script will skip over the orphan entity
and relationship types. It will show a warning message but instead of stopping at that
point, it will continue with the rest of the script.
After the ORS upgrade, when you click on the HM Configuration Tool, you are be
prompted to either delete these orphan types or associate an entity object or
relationship object with them. You can choose cancel and the regular
HM Configuration screen will be shown that will not include these orphan types. You
will get a database error when you try to create a type with the same name.
100 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Updating Hierarchy Manager
If you do not want to delete the types and if you have not yet created a base object for
these orphan types, click Cancel and you will see the regular HM Configuration screen
without these orphan types. You can create new base objects, press refresh, and you
will be prompted again to associate the orphan types.
The orphan types panel that is displayed resembles the following graphic.
Validate the Hierarchy Manager configuration after the upgrade completes successfully.
Upgrading Siperian Hub 101
Updating Hierarchy Manager
102 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
8
Uninstalling Siperian Hub
This chapter explains how to uninstall your Siperian Hub system.
Chapter Contents
•
About Uninstalling Siperian Hub
•
Uninstalling Cleanse Match Server
•
Uninstalling Hub Server
•
Undeploy the Hub Server
•
Uninstalling the Hub Store From Oracle
About Uninstalling Siperian Hub
To uninstall Siperian Hub:
1. Uninstall the Cleanse Match Server and Hub Server applications. To learn more,
see “Uninstalling Cleanse Match Server” on page 104 and “Uninstalling Hub
Server” on page 105.
2.
Undeploy the Cleanse Match Server and Hub Server applications from the
application server.
3.
Shut down the application server.
4.
Drop the schemas from Oracle. To learn more, see “Uninstalling the Hub Store
From Oracle” on page 106.
103
Uninstalling Cleanse Match Server
Uninstalling Cleanse Match Server
Note: The screen shots, file names, and directories in this guide may vary slightly
depending on what type of installation you are performing.
To uninstall Cleanse Match Server:
1. Click the Start button and select Programs > Siperian > Hub > Cleanse >
Uninstall Siperian Hub Cleanse
Or navigate to the siperian\hub\cleanse\UninstallerData directory and
double-click Uninstall_Siperian_Hub_Cleanse_Match_Server.exe.
The Uninstall introduction screen is displayed.
2.
Click Uninstall to begin the uninstallation.
The Uninstall Complete screen is displayed.
3.
Click Done.
Undeploy Cleanse Server
The installer undeploys the Cleanse Match Server automatically before reinstalling a
new version. If that process fails, you must undeploy manually
If you are using JBoss, delete the siperian-mrm-cleanse.ear file from the
directory.
Note: Restart the server if the auto-deploy process of JBoss does not remove the
applications. See your JBoss Administration documentation for more information.
server\default\deploy
If you are using WebLogic, uninstall the siperian-mrm-cleanse.ear application
using the WebLogic Server Administration Console. Make sure that the process
finishes completely. See your WebLogic documentation for more information.
If you are using WebSphere, uninstall the siperian-mrm-cleanse.ear application
from the WebSphere Application Server Administrative Console. Make sure that the
process finishes completely. See your WebSphere documentation for more information.
104 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Undeploy the Hub Server
Uninstalling Hub Server
To uninstall the Hub Server:
1. Click the Start button and select Programs > Siperian > Hub > Server >
Uninstall Siperian Hub Server
Or navigate to the siperian\hub\server\UninstallerData directory and
double-click Uninstall_Siperian_Hub_Server.exe.
The Uninstall introduction screen is displayed.
2.
Click Uninstall to begin the uninstallation.
The Uninstall Complete screen is displayed.
3.
Click Done.
You must restart the Hub Server after you uninstall.
Note: You must undeploy Hub Server before reinstalling a new version.
Undeploy the Hub Server
JBoss Application Server
If you are using the JBoss application server, delete siperian-mrm.ear and
siperian-mrm-ds.xml from the <JBoss_Install_Dir>/server/default/deploy
directory.
Also remove the following files from server/default/deploy/jms if they
exist.These files contain the JMS configuration queue.
• siperian-jms-ds.xml
•
siperian-jmsmq-service.xml
Note: Restart the server if the auto-deploy process of JBoss doesn’t remove the
applications. To learn more, see your JBoss documentation.
Uninstalling Siperian Hub 105
Uninstalling the Hub Store From Oracle
WebLogic Application Server
If you are using WebLogic, uninstall the siperian-mrm.ear application using the
WebLogic Server Administration Console. Make sure that the process finishes
completely. To learn more, see your WebLogic documentation.
WebSphere Application Server
If you are using WebSphere, uninstall the siperian-mrm.ear application from the
WebSphere Application Server Administrative Console. Make sure that the process
finishes completely. To learn more, see your WebSphere documentation.
Uninstalling the Hub Store From Oracle
When uninstalling the Hub Store, you must drop all Oracle database schemas that you
created from the setup.sql and setup_ors.sql scripts. You must also remove all
user logins for those database schemas. For example, if you created CMX_SYSTEM
(Master Database) and CMX_ORS (ORS database) using setup.sql, and CMX_
ORS2 (ORS database) using setup_ors.sql, you must drop the following:
Oracle Object Type
To Be Dropped
Database schema
CMX_SYSTEM, CMX_ORS and CMX_ORS2
User
CMX, CMX_SYSTEM, CMX_ORS, CMX_ORS2, and any users
you created that access those schemas
To drop schemas that setup.sql creates:
Be sure you have Oracle DBA privileges.
4.
Log into the Hub Console.
106 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Uninstalling the Hub Store From Oracle
5.
In the Hub Console, expand the Siperian Configuration workbench and then click
Databases
6.
In the list of databases, select the database that you want to drop, and then click
button.
the
Note: If you are running WebLogic, enter the WebLogic user name and password
when prompted.
The Databases tool prompts you to confirm unregistering the ORS.
7.
Click Yes.
8.
Connect to the Oracle instance using SQL*PLUS, using a login with DBA
privileges.
9.
For each of the schemas listed in “Uninstalling the Hub Store From Oracle” on
page 106, issue the following command:
drop user <username> cascade;
Uninstalling Siperian Hub 107
Uninstalling the Hub Store From Oracle
Note for JBoss Users: When uninstalling the Hub Server, check for the presence of
the following files and delete them if they were not deleted from the <JBoss_
Install_Dir>\server\default\deploy folder. These files must be removed before
you can upgrade to the current version of Siperian Hub.:
siperian-mrm.ear
siperian-mrm-cleanse.ear
siperian-mrm-ds.xml
108 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
9
Troubleshooting
This chapter explains how to troubleshoot your installation and make changes to your
application and database servers after running the installation process.
Chapter Contents
•
Updating Hub Server Parameters After Installation
•
Updating Cleanse Match Server Parameters After Installation
•
Configuring the JVM Settings
•
Manually Redeploying Hub Server
•
About the Siperian Hub Log Files
•
Checking the Hub and Cleanse Server Silent Install
•
Match Process Error: VerifyNeedToStrip
109
Updating Hub Server Parameters After Installation
Updating Hub Server Parameters After Installation
If the environment changes or parameters were entered incorrectly during the
installation process, you can manually correct the information after you run the
installation.
There are two scripts that you can use to manually repackage the application and
redeploy it on your application server: postInstallSetup and patchInstallSetup.
The postInstallSetup script undeploys your current application (if there is one),
repackages your application with the new information, configures your message
queues, installs or recreates your datasource and deploys the newly packaged
application to your application server.
The patchInstallSetup script does all of these things, except installing your
datasource. The only difference between these two scripts is step of installing a
datasource. patchInstallSetup doesn’t recreate datasources. Therefore, if you really just
want to copy an EAR file and deploy it, run patchInstallSetup. You don’t really
need to run postInstallSetup.
Note: For more information on running postInstallSetup, see “About the
Post-Installation Process” on page 19.
Changing the Hub Server Parameters for WebLogic
You can change the following parameters:
• WebLogic domain name
•
WebLogic application server and RMI port number
•
WebLogic username and password
•
WebLogic host or server name
110 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Updating Hub Server Parameters After Installation
Changing the Domain for WebLogic
To change the WebLogic domain:
1. Open the following file in a text editor:
<install_directory>\setSiperianEnv.bat
2.
Change the following values with the new domain path:
For WebLogic 9.x:
SET WLS_HOME=D:<\bea_install_directory>\user_
projects\domains\<domain_name>
SET WLS_DEPLOY_DIR=D:\<bea_install_directory>\user_
projects\domains\<domain_name>\autodeploy
3.
Go to <install_directory> and run the following command:
postInstallSetup.bat -Dweblogic.password=<weblogicPassword>
-Ddatabase.password=<yourDBPassword>
where weblogicPassword is the WebLogic password and yourDBPassword is the
password for your database.
You must keep the application server running while you run the script, or the
script will fail.
4.
Restart the application server.
Changing the RMI Port Number for WebLogic
To change the application server and RMI port number:
1. Open the following file in a text editor:
<install_directory>\bin\build.properties
2.
Change the following value:
weblogic.rmi.port=7001
3.
Open the following file in a text editor:
<install_directory>\resources\cmxserver.properties
4.
Change the following value:
cmx.appserver.rmi.port=7001
Troubleshooting 111
Updating Hub Server Parameters After Installation
5.
Go to <install_directory> and run the following command:
postInstallSetup.bat -Dweblogic.password=<weblogicPassword>
-Ddatabase.password=<yourDBPassword>
where weblogicPassword is the WebLogic password and yourDBPassword is the
password for your database.
You must keep the application server running while you run the script, or the
script will fail.
6.
Restart the application server.
Changing the Username for WebLogic
To change the username for the WebLogic domain:
1. Open the following file in a text editor:
<install_directory>\bin\build.properties
2.
Change the following value:
weblogic.username=<username>
3.
Go to <install_directory> and run the following command:
postInstallSetup.bat -Dweblogic.password=<weblogicPassword>
-Ddatabase.password=<yourDBPassword>
where weblogicPassword is the WebLogic password and is yourDBPassword
the password for your database.
You must keep the application server running while you run the script, or the
script will fail.
4.
Restart the application server.
112 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Updating Hub Server Parameters After Installation
Changing the Host or Server Name for WebLogic
To change the WebLogic host or server:
1. Open the following file in a text editor:
<install_directory>\bin\build.properties
2.
Change the following values:
weblogic.host=<host_name>
weblogic.server=<server_name>
3.
Go to <install_directory> and run the following command:
postInstallSetup.bat -Dweblogic.password=<weblogicPassword>
-Ddatabase.password=<yourDBPassword>
where weblogicPassword is the WebLogic password and is yourDBPassword
the password for your database.
You must keep the application server running while you run the script, or the
script will fail.
4.
Restart the application server.
Changing the Hub Server Parameters for the Database
You can change the following database parameters for WebLogic:
• Database server name
•
Database instance name
Changing Server Name for the Database
To change the database server name:
1. Open the following file in a text editor:
<install_directory>\bin\build.properties
2.
Change the following values:
masterdatabase.server=<database_host_name>
masterdatabase.jdbc.url=jdbc:oracle:thin:@<database_host_
name>:<port>:<instance_name>
Troubleshooting
113
Updating Hub Server Parameters After Installation
3.
Go to <install_directory> and run the following command:
postInstallSetup.bat -Dweblogic.password=<weblogicPassword>
-Ddatabase.password=<yourDBPassword>
where weblogicPassword is the WebLogic password and is yourDBPassword
the password for your database.
You must keep the application server running while you run the script, or the
script will fail.
4.
Restart the application server.
Changing Instance Name for the Database
To change the instance name:
1. Open the following file in a text editor:
<install_directory>\bin\build.properties
2.
Change the following values:
masterdatabase.jdbc.url=jdbc:oracle:thin:@<database_host_
name>:<port>:<instance_name>
3.
Go to <install_directory> and run the following command:
postInstallSetup.bat -Dweblogic.password=<weblogicPassword>
-Ddatabase.password=<yourDBPassword>
where weblogicPassword is the WebLogic password and is yourDBPassword
the password for your database.
You must keep the application server running while you run the script, or the
script will fail.
4.
Restart the application server.
Changing the Hub Server Parameters for WebSphere
You can change the following parameters:
• WebSphere application server
•
RMI port number
114 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Updating Hub Server Parameters After Installation
To change the application server and RMI port number:
1. Open the following file in a text editor:
<install_directory>\resources\cmxserver.properties
2.
Change the following values:
cmx.appserver.rmi.port=2809
3.
Go to <install_directory> and run the following command:
postInstallSetup.bat
-Ddatabase.password=<yourDBPassword>
where yourDBPassword the password for your database.
You must keep the application server running while you run the script, or the
script will fail.
4.
Restart the application server.
Changing the Hub Server Parameters for JBoss
You can change the following parameters:
• JBoss application server and RMI port number
•
Database server and instance name
Changing the Application Server and RMI Port Number for
JBoss
To change the application server and RMI port number:
1. Open the following file in a text editor:
<install_directory>\resources\cmxserver.properties
2.
Change the following value:
cmx.appserver.rmi.port=1099
3.
Go to <install_directory> and run postInstallSetup.bat.
4.
Restart the application server.
Troubleshooting
115
Updating Cleanse Match Server Parameters After Installation
Changing the Database Server and Instance Name for JBoss
To change the database server and instance name:
1. Open the following file in a text editor:
<jboss_install_
directory>\server\default\deploy\siperian-mrm-ds.xml
2.
Change the following values:
<xa-datasource-property
name="URL">jdbc:oracle:thin:@hostname:1521:orcl</xa-datasource-pr
operty>
where hostname is the name of the host.
Note: Do not run postinstall for JBoss.
3.
Restart the application server.
Updating Cleanse Match Server Parameters After
Installation
If the environment changes or parameters were entered incorrectly during the
installation process, you can manually correct the information after you run the
installation.
There are two scripts that you can use to manually repackage the application and
redeploy it on your application server: postInstallSetup and patchInstallSetup.
The postInstallSetup script undeploys your current application (if there is one),
repackages your application with the new information, configures your message
queues, installs or recreates your datasource and deploys the newly packaged
application to your application server.
The patchInstallSetup script does all of these things, except installing your
datasource. The only difference between these two scripts is step of installing a
datasource. patchInstallSetup doesn’t recreate datasources. Therefore, if you really just
want to copy an EAR file and deploy it, run patchInstallSetup. You don’t really
need to run postInstallSetup. The patchInstallSetup script will only appear in
116 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Updating Cleanse Match Server Parameters After Installation
your <Siperian_Install_Dir> directory after you have done a patch or upgrade
installation.
Note: For more information on running postInstallSetup, see “About the
Post-Installation Process” on page 19.
Changing the Cleanse Match Server Parameters for
WebLogic
You can change the following parameters:
• WebLogic domain name
•
WebLogic application server and RMI port number
•
WebLogic username and password
•
WebLogic host and server name
Changing the Domain for WebLogic
To change the WebLogic domain:
1. Open the following file in a text editor:
<install_directory>\setSiperianEnv.bat
2.
Change the following values with the new domain path:
For WebLogic 9.x:
SET WLS_HOME=D:\<bea_install_directory>\user_
projects\domains\<domain_name>
SET WLS_DEPLOY_DIR=D:\<bea_install_directory>\user_
projects\domains\<domain_name>\autodeploy
3.
Go to <install_directory> and run the following command:
postInstallSetup.bat -Dweblogic.password=<weblogicPassword>
-Ddatabase.password=<yourDBPassword>
where weblogicPassword is the WebLogic password and is yourDBPassword
the password for your database.
You must keep the application server running while you run the script, or the
script will fail.
4.
Restart the application server.
Troubleshooting
117
Updating Cleanse Match Server Parameters After Installation
Changing the Application Server and RMI Port Number for
WebLogic
To change the application server and RMI port number:
1. Open the following file in a text editor:
<install_directory>\bin\build.properties
2.
Change the following values:
weblogic.app.port=7001
weblogic.rmi.port=7001
3.
Go to <install_directory> and run the following command:
postInstallSetup.bat -Dweblogic.password=<weblogicPassword>
-Ddatabase.password=<yourDBPassword>
where weblogicPassword is the WebLogic password and is yourDBPassword
the password for your database.
You must keep the application server running while you run the script, or the
script will fail.
4.
Restart the application server.
Changing the Username and Password for WebLogic
To change the username and password for the WebLogic domain:
1. Open the following file in a text editor:
<install_directory>\bin\build.properties
2.
Change the following values:
weblogic.username=<user_name>
weblogic.password=<password>
3.
Go to your install directory and run the following script:
postInstallSetup.bat -Dweblogic.password=YourPassword
-Ddatabasec.password=YourDBPassword
where YourPassword is your password and where YourDBPassword is your
database password.
118 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Updating Cleanse Match Server Parameters After Installation
You must keep the application server running while you run the script, or the
script will fail.
4.
Restart the application server.
Changing the Host or Server Name for WebLogic
To change the WebLogic host or server:
1. Open the following file in a text editor:
<install_directory>\bin\build.properties
2.
Change the following values:
weblogic.host=<host_name>
weblogic.server=<server_name>
3.
Go to your install directory and run the following script:
postInstallSetup.bat -Dweblogic.password=YourPassword
-Ddatabasec.password=YourDBPassword
where YourPassword is your password and where YourDBPassword is your
database password.
You must keep the application server running while you run the script, or the
script will fail.
4.
Restart the application server.
Troubleshooting
119
Configuring the JVM Settings
Configuring the JVM Settings
If you are using AddressDoctor as your cleanse engine to run any batch process, you
must make sure that the stack size for the JVM is sufficient. If you do not set this
properly for your application server, AddressDoctor will throw an exception during
certification.
Setting the JVM Size for WebSphere
To set the JVM size for WebSphere:
1. Open the WebSphere Console.
2.
Go to Servers > Application Server > <Your_Server> > Process Definition
> Java Virtual Machine
3.
Add the following to the Generic JVM Arguments
-Xss1000k
4.
Save the configuration.
5.
Re-start the server.
Setting the JVM Size for WebLogic Server
To set the JVM size for WebLogic Server:
1. Go to your WebLogic installation directory.
2.
Open the startWeblogic.cmd file in a text editor.
3.
Set the MEM_ARGS variable as follows:
set MEM_ARGS=%MEM_ARGS% -Xss1000k
4.
Save and close the startWeblogic.cmd file.
120 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Manually Redeploying Hub Server
Setting the JVM Size for JBoss
To set the JVM size for JBoss:
1. Go to your JBoss installation directory.
2.
Navigate to the bin directory.
Open run.bat in a text editor.
3.
Set the JAVA_OPTS variable as follows:
JAVA_OPTS="%JAVA_OPTS% -Xss1000k"
4.
Save and close the run.bat file.
Manually Redeploying Hub Server
Siperian provides the postInstallSetup script that both the Hub Server installer and
user can use to deploy or redeploy the Hub Server application to the application server.
However, you can also use the default application server’s tool to do the deployment
yourself, as long as it is deployed from the Hub Server installation directory. Refer to
your application server documentation for more information.
Application Server General Steps to Redeploy the Hub Server Application
JBoss
1- Stop the server.
2- Remove the <JBoss_Install_Dir>/server/default/deploy/siperian-*
files and <JBoss_Install_Dir>/server/default/deploy/jms/siperian-* to
make sure all siperian related files and application are totally removed.
3- Copy the siperian-mrm.ear from hub server installation directory to
<JBoss_Install_Dir>/server/default/deploy.
4- Copy siperian-mrm-ds.xml from <hub_server_install_dir>/conf to
<JBoss_Install_Dir>/server/default/deploy.
5- Copy siperian-jms-ds.xml and siperian-jmsmq-service.xml from
<hub_server_install_dir>/conf to <JBoss_Install_
Dir>/server/default/deploy/jms.
6- Start the server.
WebLogic
Use the WebLogic Server Administration Console to undeploy and
deploy the siperian-mrm.ear from the Hub Server installation
directory. Deploy the application in stage mode.
Troubleshooting
121
About the Siperian Hub Log Files
Application Server General Steps to Redeploy the Hub Server Application
WebSphere
Use the WebSphere Application Server Administrative Console to
uninstall and install the siperian-mrm.ear from the Hub Server
installation directory. Be sure to allow the deployment to generate
default bindings by checking for the option in the “Preparing for the
application installation” panel.
About the Siperian Hub Log Files
This section describes the Siperian Hub log files that you can use for troubleshooting
your installation.
About the Siperian Hub Log Files
Siperian Hub creates the following log files:
• console.log
•
cmxserver.log (for Master Reference Manager)
•
cmxserver.log (for Cleanse Match Server)
•
cmxserver.log (for Cleanse Match Server)
Note: Some files include password information.
console.log
This file is created in
C:\Documents and Settings\<user_Install_Dir>\siperian\console.log
It contains the messages from the Hub Console. Any errors that occur when
communicating with the application server or error messages from the application
server or console error messages are logged to this file.
By default cmxconsole.log is ON and created. It is a good idea to periodically delete
the old files, or transfer them to some other storage.
122 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
About the Siperian Hub Log Files
cmxserver.log (for Master Reference Manager)
This is the log file for the application server. During installation, if you choose the
default location, cmxserver.log appears in C:\siperian\hub\server\logs. In
general, the file location is <INSTALL_DIR>\hub\server\logs.
This file contains all of the logging and debugging information from the application
server. By default cmxserver.log is ON and created. This file is a rolling file and once
it reaches 5MB, it is copied to cmxserver.log.1 and resumes. Hub Server does this
indefinitely, potentially creating very many files. It is a good idea to periodically delete
the old files, or transfer them to some other storage.
Note: If you are using JBoss for Siperian Hub, the cmxserver.log is in
<INSTALL_DIR>\logs\cmxserver.log by default. Also, for JBoss, the
cmxserver.log contains the information for both the Hub Server and Cleanse Match
Server.
cmxserver.log (for Cleanse Match Server)
This file is for the CLEANSE\TOKENIZATION\SIMULATION. It is located in the
install directory <Siperian_Install_Dir>\hub\cleanse\logs. This file contains all
of the debugging and error messages for the Cleanse process (Landing > Staging). By
default cmxserver.log is ON. This file is a rolling file and once it reaches 5MB, it is
copied to cmxserver.log.1 and resumes.
cmxdebug.log
This file is for the database stored procedures. It contains all of the logging
information for the PUT, GET, GETLIST, MATCH, LOAD, MERGE, and
AUTOMERGE stored procedures. By default cmx_debug.log is OFF. To set debug
logging on, see “cmxdebug.log” on page 123.
Troubleshooting
123
About the Siperian Hub Log Files
Enabling Debug Logging
By default, debug logging is off, as there is some performance overhead associated with
logging.
To turn the debug logging on
1. On the database server machine, add the utl_file_dir to your Oracle SPFile.
There are two ways to set value for utl_file_dir:
a.
Go to <ORACLE_HOME>/dbs, open the file SPFILE<oracle_sid>, add utl_
file_dir='d:\cmx_log'. Save the file and restart Oracle.
b.
Open the Oracle Enterprise Manager URL for your database instance:
http://<database_machine>:1158/em. Log into the system as sysdba.
Go to Database Configuration > All Initialization Parameters > Select
the SPFile tab > enter the value for utl_file_dir. Save the values and
restart Oracle.
This is the debug log location. The directory must be accessible and writable by
Oracle.
2.
Restart Oracle.
3.
In your ORS schema, go to the table C_REPOS_DB_RELEASE and turn on
debug by setting the following columns.
DEBUG_IND = 1
DEBUG_FILE_PATH = d:\cmx_log\
See Log Configuration in the Enterprise Manager section of the Siperian Hub
Administrator Guide for more information.
Note: The file path must match the one set above in utl_file_dir
4.
Test debug by running the following code in SQL*PLUS:
exec cmxut.debug_print ('Testing debug - should appear in file');
Go to the directory d:\cmx_log\ and open a file named cmx_debug.
If your configuration change succeeded, this file contains the test message:
Testing debug - should appear in file
Debug logging is now enabled.
124 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Checking the Hub and Cleanse Server Silent Install
Setting the Location of the Files
Important: DO NOT edit the cmxserver.properties file to change the location of
the logs.
Component
Configuration file to edit to set the location of the logs
JBoss
<JBoss_Install_Dir>\server\default\conf\log4j.xml
Hub Server
SIPERIAN_SERVER_INSTALL_DIR\conf\log4j.xml
Cleanse Match Server
SIPERIAN_CLEANSE_INSTALL_DIR\conf\log4j.xml
where SIPERIAN_SERVER_INSTALL_DIR is the directory into which you installed Hub
Server and SIPERIAN_CLEANSE_INSTALL_DIR is the directory into which you installed
Cleanse Match Server.
Checking the Hub and Cleanse Server Silent Install
This section describes how to confirm that your silent install was successful. A failed
silent install could be due to many factors, including incorrect information in the silent
property file (such as the incorrect application-server installation paths, or the fact that
the file contains too many port numbers).
To verify that your silent install succeeded, you can check files for entries related to the
silent install, and folders for files related to the silent install.
Troubleshooting
125
Checking the Hub and Cleanse Server Silent Install
Checking the Hub Server Silent Install
Check these files or folders when you perform a silent Hub Server install.
Location
Check For
<Hub_Server_Install_Dir>\logs
postInstallSetup.log: Check for any ERROR in the log.
<Hub_Server_Install_
database credentials:
Dir>\bin\build.properties where
Look for following properties and make sure their values are correct. Example
the appserver is WebLogic
values:
masterdatabase.type=ORACLE
masterdatabase.server=centos01
masterdatabase.databasename=cmx_system
masterdatabase.jdbc.driverclassname=oracle.jdbc.xa.client.OracleXADataSource
masterdatabase.jdbc.jndiname=jdbc\siperian-cmx_system-ds
masterdatabase.jdbc.url=jdbc:oracle:thin:@centos01:1521:orcl
masterdatabase.user=cmx
<Hub_Server_Install_
database credentials:
Dir>\bin\build.properties where Look for following properties and make sure their values are correct. Example
the appserver is WebSphere
values:
masterdatabase.type=ORACLE
masterdatabase.server=centos01
masterdatabase.port=1521
masterdatabase.dbname=orcl
masterdatabase.schemaname=cmx_system
masterdatabase.user=cmx
<Hub_Server_Install_
Dir>\conf\siperian-mrm-ds.xml
where the appserver is JBoss.
database credentials
Look for following properties and make sure their values are correct. Example
values:
<xa-datasource-property
name="URL">jdbc:oracle:thin:@centos01:1521:orcl<\xa-datasource-propert
y>
<xa-datasource-property name="User">cmx<\xa-datasource-property>
<xa-datasource-property
name="Password">!!cmx!!<\xa-datasource-property>
126 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Checking the Hub and Cleanse Server Silent Install
Location
Check For
<Hub_Server_Install_
WebLogic credentials
Dir>\bin\build.properties where
Look for following properties and make sure their values are correct. Example
the appserver is WebLogic
value:
weblogic.host=localhost
weblogic.server=AdminServer
weblogic.username=weblogic
weblogic.rmi.port=7001
weblogic.naming.protocol=t3
weblogic.version=9.x
<Hub_Server_Install_
cmx.server.masterdatabase.type, cmx.appserver.type, cmx.appserver.rmi.port
Dir>\resources\cmxserver.prope and cmx.appserver.soap.connector.port
rties
<sip_Install_
Dir>\setSiperian.bat where the
appserver is JBoss
Check for following variables and make sure their values are correct in your
environment.
SET SIP_HOME=C:\siperian\hub\server
SET JBS_HOME=C:\jboss-4.0.3SP1
SET JBS_DEPLOY_DIR=C:\jboss-4.0.3SP1\server\default\deploy
<sip_Install_
Dir>\setSiperian.bat where
appserver is WebLogic
Check for following variables and make sure their values are correct in your
environment.
SET SIP_HOME=C:\siperian\hub\server
SET WLS_HOME=C:\bea\user_projects\domains\base_domain
SET WLS_DEPLOY_DIR=C:\bea\user_projects\domains\base_
domain\autodeploy
<sip_Install_
Dir>\setSiperian.bat where
appserver is WebSphere
Check for following variables and make sure their values are correct in your
environment.
SET SIP_HOME=C:\siperian\hub\server
SET WAS_HOME=C:\Program Files\IBM\WebSphere\AppServer
SET WAS_SERVER=server1
If any of the items are incorrect, enter the correct contents or properties manually into
the silent-install property file, then restart the installation. You can also make
corrections to the individual files, such as the cmxserver.properties file, and rerun
the postInstallSetup command manually from the same <hub_server_Install_Dir>.
Troubleshooting
127
Checking the Hub and Cleanse Server Silent Install
Checking the Cleanse Server Silent Install
Check these files or folders when you perform a silent cleanse server install.
Location
Check For
<cleanse_server_install_
dir>\logs
postInstallSetup.log: Check for any ERROR in the file
# Address Doctor Properties
cleanse.library.addressDoctor.property.AddressDoctor.UnlockCode=
cleanse.library.addressDoctor.property.AddressDoctor.DatabasePath=C:/addressdo
ctor
and cmx.appserver.type files
cleanse.library.addressDoctor.property.AddressDoctor.Optimization=ADDRESSES
_SORTED_BY_COUNTRIES
cleanse.library.addressDoctor.property.AddressDoctor.MemoryMB=600
cleanse.library.addressDoctor.property.AddressDoctor.CorrectionType=CORRECT
_ONLY
cleanse.library.addressDoctor.property.AddressDoctor.PreLoad.CERTIFIED.PREL
OAD_PART=US
cleanse.library.addressDoctor.property.AddressDoctor.PreLoad.CERTIFIED.PREL
OAD_FULL=
cleanse.library.addressDoctor.property.AddressDoctor.PreLoad.CORRECTION_
ONLY.PRELOAD_PART=CA, US
cleanse.library.addressDoctor.property.AddressDoctor.PreLoad.CORRECTION_
ONLY.PRELOAD_FULL=
# Trillium Director Properties
cleanse.library.trilliumDir.property.config.file.1=C:\siperian\hub\cleanse\resources
\Trillium\samples\director\td_default_config_Global.txt
cleanse.library.trilliumDir.property.config.file.2=C:\siperian\hub\cleanse\resources
\Trillium\samples\director\td_default_config_US_detail.txt
cleanse.library.trilliumDir.property.config.file.3=C:\siperian\hub\cleanse\resources
\Trillium\samples\director\td_default_config_US_summary.txt
# Group1Software Enterprise Server Properties
cleanse.library.group1EntServer.property.config.file=
<Cleanse_Server_Install_
Directory>
\resources\cmxcleanse.pr
operties
# Group1Software CDQ Server Properties
cleanse.library.group1CDQ.property.config.file=C:\siperian\hub\cleanse\r
esources\Group1CDQ\samples\G1EServerConfig.properties
#FirstLogicDirect Properties
cleanse.library.firstLogicDirect.property.config.file=C:\siperian/hub\cleans
e\resources\firstLogicDirect\fld_default_config.txt
128 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Match Process Error: VerifyNeedToStrip
Location
Check For
<cleanse_server_Install_
Dir>
\resources\cmxserver.pro
perties
cmx.home=$USER_INSTALL_DIR$
# Application server type: jboss, tomcat, websphere or weblogic
cmx.appserver.type=$SIP.APPSERVER.TYPE$
# default setting: 8880 for websphere only (this is not being used in jboss
and weblogic
cmx.appserver.soap.connector.port=$SIP.WEBSPHERE.SOAP.PORT$
<cleanse_server_install_
dir>\setSiperianEnv.bat where
the appserver is JBoss
All the settings in setSiperianEnv.bat for cleanse server are same as for the
Hub Server.
<cleanse_server_install_
dir>\setSiperianEnv.bat where
appserver is WebLogic
All the settings in setSiperianEnv.bat for cleanse server are same as for the
Hub Server.
<cleanse_server_install_
dir>\setSiperianEnv.bat where
appserver is WebSphere
All the settings in setSiperianEnv.bat for cleanse server are same as for the
Hub Server.
If any of the contents of the files or the properties listed in the table above are
incorrect, you must enter the correct contents or properties manually into the
silent-install property file, then restart the installation. Alternatively, you can make
corrections to the individual files, such as the cmxserver.properties file, and rerun
the postInstallSetup command manually from the same <cleanse_server_Install_
Dir>.
Match Process Error: VerifyNeedToStrip
If you receive VerifyNeedToStrip error SIP-16062 while you run a Match process,
check the following library and environment variable settings:
• The LD_LIBRARY_PATH environment variable should contain the following path
for the Siperian profile: <Hub_Install_Directory>\cleanse\lib is in the
LD_LIBRARY_PATH for the Siperian profile.
For example: LD_LIBRARY_PATH=C:\siperian\hub\cleanse\lib
•
The SSAPR environment variable should include the following path for all users
(such as the WebLogic user and the Siperian user):
<Hub_Install_Directory>\cleanse\resources.
Troubleshooting
129
Inaccurate Start/Stop Timestamp for ORS
For example: SSAPR=C:\siperian\hub\cleanse\resources
Inaccurate Start/Stop Timestamp for ORS
If you create an ORS, then export it, and subsequently reuse the .dmp file of this
previously installed ORS to create a second ORS, the start date and end date columns
in the C_REPOS_DB_VERSION table of this ORS will have a different value from
the actual start date and end date.
This difference in date does not affect any functionality.
Compatibility Errors During Full Install
If you want to force a patch install, you must pass -DSIPERIAN_FORCED_PATCH_
INSTALL=true in the command line while running hub_install or hub_cleanse_install.
Note: The situation may can arise where you have the install of this release and you
want to force a patch install for the same release. In this case, -DSIPERIAN_
FORCED_PATCH_INSTALL=true can be passed as command line argument.
For example, you might see the following error:
Compatibility Error Message:
SIP-01509: the Siperian Hub Server version XU-xx is already
installed successfully, therefore, a new install will not be allowed
in this location.
To perform a full install at that location, change the value of the parameter from true
to false:
SIPERIAN_FORCED_PATCH_INSTALL=false
130 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
A
Manually Configuring Siperian System
Message Queues
The Services Integration Framework (SIF) uses a message-driven bean (MDB) on the
JMS queue (named siperian.sif.jms.queue) to process incoming asynchronous
SIF requests. This message queue and the connection factory (named
siperian.mrm.jms.xaconnectionfactory) need to be configured for the specific
application server you are using for your Siperian Hub implementation. Correctly
configured Siperian System message queues are essential to a fully-functioning Siperian
Hub installation. The Siperian Hub installer automatically configures your Siperian
System message queues during installation.
This section covers the steps for manually configuring Siperian System message queues
and connection factories. These instructions are for trouble shooting purposes, if for
example the automated queue creation process fails or if the queues were dropped
accidentally after the install.
Chapter Contents
•
JBoss Configuration
•
WebLogic Configuration
•
BEA WebLogic 9.x Configuration
•
IBM WebSphere 6.1 Configuration
131
JBoss Configuration
JBoss Configuration
Note: The Siperian System message queues are automatically configured by the
Siperian installer. To verify that the Siperian System messages queues have been
configured correctly., check the JMS configuration under <jboss_Install_
Dir>\server\default\deploy\jms. In the file siperian-jms-ds.xml you should
find siperian.mrm.jms.xaconnectionfactory (the XA connection factory) and in
jbossmq-destinations-service.xml you should find the file
siperian.sif.jms.queue.
The JBoss application server is manually configured for Siperian by editing the
file to add the Siperian System message
queues and connection factories.
jbossmq-destinations-service.xml
To configure the Siperian System message queues and connection
factories
1. Open the
jboss\server\default\deploy\jms\jbossmq-destinations-service.xml
file in an editor.
Add the following queue declaration:
<mbean code="org.jboss.mq.server.jmx.Queue"
name="jboss.mq.destination:service=Queue,name=siperian.sif.jms.qu
eue">
<depends optional-attribute-name="DestinationManager">
jboss.mq:service=DestinationManager
</depends>
</mbean>
132 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
JBoss Configuration
2.
Open the jboss\server\default\deploy\jms\jms-ds.xml file in an editor.
Add the following declaration for a JMS connection factory (XA enabled).
<tx-connection-factory>
<jndi-name>siperian.mrm.jms.xaconnectionfactory</jndi-name>
<xa-transaction/>
<rar-name>jms-ra.rar</rar-name>
<connection-definition>
org.jboss.resource.adapter.jms.JmsConnectionFactory
</connection-definition>
<config-property name="SessionDefaultType"
type="java.lang.String">
javax.jms.Topic
</config-property>
<config-property name="JmsProviderAdapterJNDI"
type="java.lang.String">
java:/DefaultJMSProvider
</config-property>
<max-pool-size>20</max-pool-size>
<security-domain-and-application>JmsXARealm</security-domain-andapplication>
</tx-connection-factory>
The JBoss Siperian System message queues and connection factory are now
configured.
Configuring Additional Queues
The following steps enable you to set up Siperian System message queues for testing.
This is also an example of how to step additional queues. These steps are optional.
To configure a test message queue
• Open the file
jboss\server\default\deploy\jms\jbossmq-destinations-service.xml
in an editor.
Manually Configuring Siperian System Message Queues
133
WebLogic Configuration
Add the following queue declaration:
<mbean code="org.jboss.mq.server.jmx.Queue"
name="jboss.mq.destination:service=Queue,name=siperian.sif.test.j
ms.queue">
<depends optional-attribute-name="DestinationManager">
jboss.mq:service=DestinationManager
</depends>
</mbean>
<mbean code="org.jboss.mq.server.jmx.Topic"
name="jboss.mq.destination:service=Topic,name=siperian.sif.test.j
ms.topic">
<depends optional-attribute-name="DestinationManager">
jboss.mq:service=DestinationManager
</depends>
</mbean>
Note: This configuration is only needed for testing purposes.
WebLogic Configuration
Manually configure the WebLogic application server by creating a new connection
factory and message queues.
To create the connection factory and message queue
1. Start the WebLogic Console.
2.
Go to Services > JMS > Connection Factories.
Create a new JMSConnectionFactory using
“siperian.mrm.jms.xaconnectionfactory” for both the name and JNDI
name.
3.
Set the server target by selecting the tab Target and Deploy.
Check the server target and click Apply.
134 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
BEA WebLogic 9.x Configuration
4.
Configure this as XA Connection Factory Enabled under Configuration >
Transactions.
5.
Go to Services > JMS > Servers.
Select an existing JMS server and configure a new destination JMS Queue using
“siperian.sif.jms.queue” for both the name and JNDI name.
6.
Go to your <DomainName> and view your domain-wide security settings by
clicking the Security tab.
Select “Anonymous Admin Lookup Enabled” by clicking the checkbox next to
it. Click Save.
The WebLogic message queues and connection factory are now configured.
Configuring Additional Queues
The following steps enable you to set up message queues for testing. This is also an
example of how to step additional queues. These steps are optional.
To configure additional test message queues
1. In the WebLogic Console, go to Services > JMS > Servers.
2.
Select an existing JMS server and configure a new destination JMS Queue using
“siperian.sif.test.jms.queue” for both the name and the JNDI name.
Note: This configuration is only needed for testing purposes.
BEA WebLogic 9.x Configuration
Manually configure the WebLogic 9.x application server by creating a new connection
factory and message queues.
To create a new JMS server and module
1. Start the WebLogic Console.
Click Lock&Edit.
2.
Go to Services > Messaging > JMS Servers.
Manually Configuring Siperian System Message Queues
135
BEA WebLogic 9.x Configuration
Create a new JMS Server using the name “SiperianJMSServer”. Click Next.
3.
Select the server name in the Target drop-down list.
Click Finish.
4.
Go to Services > Messaging > JMS Modules.
Create a new JMS Module using the name “SiperianModule”. Click Next.
5.
Choose the Target server by selecting the check box.
Click Next and then click Finish.
To create a connection factory for the new module
Go to the “SiperianModule” that you just created.
1.
Click New under Summary of Resources.
Choose Connection Factory. Click Next.
2.
Specify “siperian.mrm.jms.xaconnectionfactory” for both the name and the
JNDI name.
Click Next.
3.
Choose Target Server.
Click Finish.
To configure the new connection factory
Go to the siperian.mrm.jms.xaconnectionfactory you just created, under
Configuration.
1.
Click Transactions.
2.
Select the XA Connection Factory Enabled check box.
Save the change.
To add some message queues to the module
1. Go to the “SiperianModule” again.
Click New under Summary of Resources.
Choose Queue. Click Next.
136 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
BEA WebLogic 9.x Configuration
2.
Specify “siperian.sif.jms.queue” for both the name and the JNDI name.
Click Next.
3.
Choose the JMS Server you just created.
Click Finish. Click Activate Changes.
To create a new subdeployment queue
1. Go to the “SiperianModule” once more.
Click New under Summary of Resources.
Choose Queue. Click Next.
2.
Click on the “Create a new Subdeployment” button.
Make sure the Subdeployment Name is “siperian.sif.jms.queue”, and click
OK.
3.
Use “siperian.sif.jms.queue” for both the name and the JNDI name.
Click Next.
4.
Choose the JMS Server you just created and click Finished.
Click Activate Changes.
The WebLogic 9.x message queues and connection factory are now configured.
Configuring Additional Queues
The following steps enable you to set up message queues for testing. This is also an
example of how to step additional queues. These steps are optional.
To configure additional test message queues
1. In the WebLogic Console, click Lock&Edit.
2.
Go to Services > Messaging > JMS Modules.
Choose the “SiperianModule”. Click New under Summary of Resources.
3.
Choose Queue and click Next.
Manually Configuring Siperian System Message Queues
137
IBM WebSphere 6.1 Configuration
Specify “siperian.sif.test.jms.queue” for both the name and the JNDI
name. Click Next.
4.
Choose the JMS Server you just created.
Click Finish.
5.
Click Activate Changes.
Note: This configuration is only needed for testing purposes.
IBM WebSphere 6.1 Configuration
Manually configure the WebSphere 6.1 application server by creating a new connection
factory and message queues.
To create and configure a new bus in the WebSphere server
1. In the WebSphere Console, go to Service integration > Buses.
Create a new bus with name “SiperianBus” and save the change.
2.
Go to the SiperianBus you just created and click Bus Members.
Add a new member in the Server drop-down list.
3.
Choose the server your application is running.
Click Next and select Data Store.
Click Next under this and make sure the Create default data source with
generated JNDI name is checked.
4.
Click Next, then click Finish. Save the change.
5.
Go to the SiperianBus you just created and click Destination.
Click New and choose the Queue as destination type. Click Next.
6.
Use the name “SiperianQueue” as the Identifier and click Next.
Choose the Bus member you just created and click Next.
7.
Click Finish. Save the change.
Configure a new connection factory
1. In the WebSphere Console go to Resources > JMS > JMS Providers.
138 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
IBM WebSphere 6.1 Configuration
Select “Node=<servername>Node01” from the drop-down list.
Choose Default messaging provider.
2.
Click JMS queue connection factory. Configure a new JMS connection factory
using “siperian.mrm.jms.xaconnectionfactory” for both the name and the
JNDI name.
3.
Choose the “SiperianBus” as the Bus name for the JMS connection factory.
Save the change.
4.
Click on Queues.
Select the scope “Node=<servername>Node01” from the drop-down list.
Configure a new JMS queue
Click on the New button.
1.
Select Default messaging provider and click OK.
Use “siperian.sif.jms.queue”for both the name and the JNDI name.
Choose the “SiperianBus” as Bus name, choose the “SiperianQueue” you
created as Queue name. Save the change.
2.
Click on JMS activation specification. Select the scope
“Node=<servername>Node01” from drop-down list.
3.
Configure a new Siperian Activation.
Click New. Use “SiperianActivation” for both the name and the JNDI name.
Choose Queue as the Destination type and “siperian.sif.jms.queue” as the
Destination JNDI name. Choose “SiperianBus” as Bus name. Save the change.
Configuring Additional Queues
The following steps set up message queues for testing. This is also an example of how
to step additional queues. These steps are optional.
Create the test message queue
1. In the WebSphere Console, go to Service integration > Buses.
Select the SiperianBus and click Destination.
Manually Configuring Siperian System Message Queues
139
IBM WebSphere 6.1 Configuration
2.
Click New and choose the Queue as destination type then click Next.
3.
Use the name “SiperianTestQueue” as the Identifier and click Next.
4.
Choose the Bus member and click Next.
Click Finish and save the change.
To configure the test message queue
In the WebSphere Console, go to Resources > JMS Providers > Default
Messaging.
1.
Click on Queue and configure a new JMS queue using
“siperian.sif.test.jms.queue” for the both name and the JNDI name.
2.
Choose “SiperianBus” as Bus name. Choose the “SiperianTestQueue” you just
created as the Queue name.
Note: This configuration is only needed for testing purposes.
140 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
Index
A
application server 18
and connection pooling 18
audience ix
B
base objects, influence on upgrade process 81
before you upgrade 82
Business Objects DQ XI cleanse engine 55
C
changing
application server and RMI port number
JBoss 115
WebLogic 118
Cleanse Match Server parameters
WebLogic 117
Cleanse Match Server
about 36
application server instances, configuring
multiple 62
Business Objects DQ XI cleanse engine
55
cmxcleanse.properties file 57
cmxserver.log 123
configuration settings 58
configuring 56
deploying 63
manually 63
dual cleanse servers 61
installation 52
overview 36
prerequisites 38
JBoss 49, 54
log files 56
logging settings 58
multi-threading, configuring 60
newer versions 38
Oracle TNS server name 58
parameters, updating 116
post-installation 37
prerequisites for installing 38
temporary files, deleting 57
uninstalling 104
using correct license with 39
version and build number 57
WebLogic 39, 53
WebSphere 44, 54
Cleanse Server
silent install, troubleshooting 128
supported cleanse engines 36
CMX_DATA
creating 6
CMX_DATA tablespace 6
cmx_debug.log file 123
141
CMX_INDX
creating 6
CMX_INDX tablespace 6
CMX_ORS database 11
CMX_ORS User
changing username and password 49
cmx_ors.dmpimp.log file 14
CMX_TEMP
creating 7
CMX_TEMP tablespace 7
cmxcleanse.properties file 57
cmxdebug.log 123
cmxserver.log file 28, 56
command-line interface installation 2
configuring cleanse engines 57
configuring dual cleanse servers 61
connection factory
configuring new 138
connection pooling 18
console.log file 122
contacting Siperian xiii
D
data cleansing engines 1
data sources
JBoss 22
WebLogic 23
WebSphere 23
database
changing
server name 113
changing Hub Server parameters 113
changing instance name 114
connection testing 14
server and instance name, JBoss 116
debug log file, enabling 124
documentation
audience ix
contents x
other documentation x
H
Hub Console
about the Hub Console 69
starting 70
Hub Server
about Hub Server 18
application server 18
configuration properties 29
configuring
JBoss 26
WebLogic 25
WebSphere 26
configuring Hub Server 28
connection pooling 18
database parameters, updating 113
deploying manually 33, 121
installatiion prerequisites 20
installing 24
log files 28, 87
logging settings 29
parameters, updating 110
post-install process 19
prerequisites for installing 20
previous versions of 21
silent install, troubleshooting 126
uninstalling 105
version and build number 29, 84
142 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
WebLogic settings 30
Hub Server and WebLogic 21
Hub Store 4
about the Hub Store 4
database configuration options 4
installing 5
ORS database, creating 11
tablespaces, creating 6
I
installation
troubleshooting 109
Installation Process 1, 36
installing
Cleanse Match Server 52
Hub Server 24
Hub Store 5
newer version of Cleanse Match Server
38
newer version of the Hub Server 21
overview of 1
J
JBoss
changing database server and instance
name 116
changing settings 31
Cleanse Match Server 49, 54
Cleanse Match Server, configuring 51
configuring 22
Hub Server
changing parameters 115
configuring 26
parameters, updating 115
Hub Server and Cleanse Match Server,
configuring 23
Oracle data sources and 22
port conflicts 30
settings 31
JBoss Hub Server, configuring 51
JBoss, extracting file with special command
22
L
license file 20
log files
application server log files 28, 56, 88, 91
checking 28, 56
Cleanse Match Server 56
cmx_ors.dmpimp.log file 14
cmxserver.log file 28, 56
postInstallSetup.log file 28, 56
setup_ors.log file 14
Siperian_Hub_Cleanse_Match_Server_
InstallLog.xml file 56
Siperian_Hub_Server_InstallLog.xml
file 28
siperian_installer_debug.txt file 28, 56
M
master database, creating 8
Master Reference Manager
cmxserver.log 123
match process error
VerifyNeedToStrip 129
message queues
143
configuring additional
JBoss 133
WebLogic 9.x 137
WebSphere 6.1 139
using 131
WebLogic
9.x configuration 135
R
relationship tables, removing before upgrade
83
S
Oracle
data sources
JBoss 22
WebLogic 23
WebSphere 23
PLSQL compiler flags
setting 5
TNS name
adding to the ORS database 58
ORS database
creating 8
creating additional 11
setup_ors.log file 14
silent install
Cleanse Server, troubleshooting 128
confirming installation success 125
Hub Server, troubleshooting 126
troubleshooting 125
Siperian Hub
documentation x
log files 122
master database, creating 8
ORS database, creating 8
uninstalling 103
Siperian Services Integration Framework
Guide (SIF) xi
siperian_installer_debug.txt file 28
P
T
O
password
changing for CMX_ORS user 32
changing for CMX_SYSTEM user 31, 46
port conflicts 30
postInstallSetup.log file 28, 56
product support xiii
proxy role 13
proxy user
create 13, 14
creating during upgrade 10
tablespaces
CMX_DATA 6
CMX_INDX 6
CMX_TEMP 7
creating 6
temporary tablespace 13
technical support xiii
troubleshooting
changing domain, WebLogic 111
cmxserver.log file 123
144 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)
installation 109
log files
cmx_debug.log file 123
cmxserver.log file 123
console.log file 122
location of 125
log4j.xml file 125
overview of 122
log4j.xml file 125
silent install 125
silent install, Cleanse Server 128
silent install, Hub Server 126
WebLogic
changing domain 117
changing host or server name 113
changing Hub Server parameters 110
changing RMI Port Number 111
changing username 112
changing username and password 118
Cleanse Match Server parameters,
updating 117
U
uninstalling
Cleanse Match Server 104
Hub Server 103, 105
Hub Store 106
upgrade
cmxserver.log file 88, 91
failure 99
log files
checking 87, 91
cmxserver.log file 88, 91
postInstallSetup.log file 88, 91
Siperian_Hub_Cleanse_Match_
Server_InstallLog.xml file 91
Siperian_Hub_Server_InstallLog.xml file 88
siperian_installer_debug.txt file 88,
91
postInstallSetup.log file 88, 91
proxy user
questions 96
supported platforms 84
upgrade process, and base objects 81
upgrading
removing relationship tables 83
V
VerifyNeedToStrip error message 129
version and build number
checking 29, 57
checking, during upgrade 84
W
WebLogic
changing
host or server name, troubleshooting
119
changing domain, troubleshooting 111
changing settings 30
Cleanse Match Server
about 39
configuring 53
Hub Server
configuring 25
parameters, updating 110
Oracle data sources and 23
145
restarting after installation 34
settings 30
WebSphere
changing Hub Server parameters 114
changing settings 30
Cleanse Match Server
about 44
configuring 54
Hub Server
configuring 26
parameters, updating 114
Oracle data sources and 23
settings 30
uninstalling 106
WebSphere 6.1
configure a new JMS queue 139
WebSphere Server cluster 75
workbenches
Configuration workbench 107
146 Siperian Hub XU SP2 Installation Guide (Windows and Oracle)