Siperian Hub Upgrade Guide

Siperian Hub XU SP2
Upgrade Guide
Copyright 2009 Siperian, Inc. Copyright 2009 Siperian Inc. [Unpublished - rights reserved under the Copyright Laws of the United States] 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. 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.
Contents
Preface
Intended Audience ..........................................................................................................................................vii Organization.....................................................................................................................................................vii Learning About Siperian Hub ......................................................................................................................viii Contacting Siperian ...........................................................................................................................................x
Chapter 1: Introduction
About Upgrading to Siperian Hub XU SP2 Patch B...................................................................................2 Siperian Hub XU SP2 Versions ............................................................................................................2 Upgrading from Prior Versions of Siperian Hub ...............................................................................2 Overview of Upgrading ....................................................................................................................................3 Upgrading Siperian Hub Environments ..............................................................................................3 Upgrading a Single Siperian Hub Environment .................................................................................4 Updates in this Release .....................................................................................................................................5 Summary of Changes ..............................................................................................................................5 Functional Changes .................................................................................................................................7 Product Documentation.........................................................................................................................9 Deprecation Notices ...............................................................................................................................9 Supported Platform Changes...............................................................................................................10 Before You Begin ............................................................................................................................................11 Assumptions About Upgrading...........................................................................................................11 Duration of Upgrade.............................................................................................................................11 Documenting Your Upgrade ...............................................................................................................12
Chapter 2: Before You Upgrade

Preparation Overview .....................................................................................................................................14 Create an Upgrade Documentation Directory............................................................................................15
iii
Validate Your Metadata.................................................................................................................................. 15 Verify Your Siperian Hub Environment ..................................................................................................... 15 Validate Content Metadata ............................................................................................................................ 16 Back Up Your Current Implementation...................................................................................................... 17 Back Up Your Schema ......................................................................................................................... 17 Back Up User Exits .............................................................................................................................. 17 Back Up Customizations ..................................................................................................................... 17 Back Up Trillium Director Configuration Files ............................................................................... 17 Verify Available Space.................................................................................................................................... 18 Enable the Siperian Hub Database Debug Log ......................................................................................... 18
Chapter 3: Upgrade Siperian Hub

Upgrade Overview .......................................................................................................................................... 20 Upgrading the Hub Server............................................................................................................................. 21 About the Hub Server Upgrade.......................................................................................................... 21 Steps to Upgrade the Hub Server....................................................................................................... 21 Copy Hub Server Log Files to the Upgrade Doc Directory .......................................................... 25 Upgrading Cleanse Match Servers................................................................................................................ 26 About Cleanse Match Server Upgrades............................................................................................. 26 Steps to Upgrade the Cleanse Match Server..................................................................................... 26 Copy Cleanse Match Server Log Files to the Upgrade Doc Directory ........................................ 30 Upgrading the Hub Store............................................................................................................................... 31 About Hub Store Upgrades................................................................................................................. 31 Upgrading the Master Database.......................................................................................................... 31 Upgrading ORS Databases .................................................................................................................. 33 Restarting Your Environment....................................................................................................................... 35 Updating Business Data Director................................................................................................................. 36 Enabling Query Results De-duplication (Optional) ........................................................................ 36 Update BDD Queries........................................................................................................................... 37 Refresh Business Data Director Help................................................................................................ 39
iv
Siperian Hub XU SP2 Upgrade Guide
Chapter 4: After You Upgrade

Verification Overview.....................................................................................................................................42 Validate the Upgraded Metadata ...................................................................................................................43 Verify Your Upgraded Siperian Hub Environment...................................................................................43 Validate the Upgraded Content Metadata ...................................................................................................43 Test the Upgraded Environment ..................................................................................................................44 Testing with Business Data Director..................................................................................................44 Testing with Hub Console Tools........................................................................................................45 Testing Custom Code ...........................................................................................................................45 Archive the Upgrade Documentation Directory........................................................................................46
Appendix A: Troubleshooting
Troubleshooting Hub Server Upgrades .......................................................................................................48 Running patchInstallSetup Manually ..................................................................................................48 Forcing a Patch Install ..........................................................................................................................49 Troubleshooting Cleanse Match Server Upgrades .....................................................................................49 Running patchInstallSetup Manually ..................................................................................................49 Forcing a Patch Install ..........................................................................................................................50 Troubleshooting Hub Store Upgrades.........................................................................................................51 Restoring from a Full Backup..............................................................................................................51 Check Metadata Consistency ...............................................................................................................51 Check the Database Debug Log .........................................................................................................51 Check C_REPOS_DB_CHANGE ....................................................................................................52 ORA-20005 Error When Upgrading an ORS...................................................................................52
Contents
vi
Preface
Welcome to the Siperian HubXU SP2 Upgrade Guide. This guide explains how to upgrade your Siperian Hub implementation to the most recent version.
Intended Audience
This guide is intended for technical specialists who are responsible for upgrading their Siperian Hub implementation.
Organization
This guide contains the following chapters:
Chapter 1, Introduction Chapter 2, Before You Upgrade Chapter 4, After You Upgrade Appendix A, Troubleshooting Overview and key concepts for upgrading your Siperian Hub implementation. Tasks to perform before you upgrade. Tasks to perform after you upgrade. Tips for troubleshooting upgrade issues.
Chapter 3, Upgrade Siperian Hub Upgrade steps.
vii
Learning About Siperian Hub

Whats New in Siperian Hub
Whats 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 Siperian Hub release. Installers should read the Siperian Hub Release Notes before installing 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 explains to installers how to set up Siperian Hub, the Hub Store, Cleanse Match Servers, and other components. There is a Siperian Hub Installation Guide for each supported platform.
Siperian Hub Upgrade Guide

The Siperian Hub Upgrade Guide explains to installers how to upgrade a previous Siperian Hub version to the most recent version.
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.
viii
Siperian Hub Data Steward Guide

The Siperian Hub Data Steward Guide explains to data stewards how to use Siperian Hub tools to consolidate and manage their organization's data. After reading the Siperian Hub Overview, data stewards should read the Siperian Hub Data Steward Guide.
Siperian Hub Administrator Guide

The Siperian Hub Administrator Guide explains to administrators how to use Siperian Hub tools to build their organizations data model, configure and execute Siperian Hub data management processes, set up security, provide for external application access to Siperian Hub services, and other customization tasks. After reading the Siperian Hub Overview, administrators should read the Siperian Hub Administrator Guide.
Siperian Hub Services Integration Framework Guide

The Siperian Hub Services Integration Framework Guide explains to developers how to use the Siperian Hub Services Integration Framework (SIF) to integrate Siperian Hub functionality with their applications, and how to create applications using the data provided by Siperian Hub. SIF allows developers to integrate Siperian Hub smoothly with their 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 workflows. This
ix
Contacting Siperian
document provides a description of the various sample applications that are included with the Resource Kit.
Siperian Training and Materials

Siperian provides live, instructor-based training to help professionals become proficient users as quickly as possible. From initial installation onward, a dedicated team of qualified trainers ensure that an organizations 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 Siperians web site or contact Siperian directly.
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 World Wide Web Email Voice Contact Information http://www.siperian.com support@siperian.com U.S.: 1-866-SIPERIAN (747-3742)
We are interested in hearing your comments about this book. Send your comments to:
by Email: by Postal Service: docs@siperian.com Documentation Manager Siperian, Inc. 100 Foster City Blvd. 2nd Floor Foster City, California 94404 USA
1
Introduction
This chapter introduces the process of upgrading your Siperian Hub XU SP2 GA or XU SP2 Patch A implementation to Siperian Hub XU SP2 Patch B. Important: If you are upgrading from a version of the Siperian Hub prior to Siperian Hub XU SP2 GA, do not use this document. Instead, contact Siperian Support (support@siperian.com) for assistance.
Chapter Contents
About Upgrading to Siperian Hub XU SP2 Patch B Overview of Upgrading Updates in this Release Before You Begin
About Upgrading to Siperian Hub XU SP2 Patch B
About Upgrading to Siperian Hub XU SP2 Patch B

This document provides the information and instructions necessary to upgrade to Siperian Hub XU SP2 Patch B from prior versions of Siperian Hub XU SP2.
Siperian Hub XU SP2 Versions

This document provides the information and instructions necessary to upgrade to Siperian Hub XU SP2 Patch B from the following Siperian Hub XU SP2 releases: Siperian Hub XU SP2 GA Siperian Hub XU SP2 Patch A Siperian Hub XU SP2 Patch A Rollup 1 Siperian Hub XU SP2 hotfixes
Note: In all cases, the steps to upgrade are the same.
Upgrading from Prior Versions of Siperian Hub

Important: If you are upgrading from a version of the Siperian Hub prior to Siperian Hub XU SP2 GA, do not use this document. Instead, contact Siperian Support (support@siperian.com) for assistance.
2 Siperian Hub XU SP2 Upgrade Guide
Overview of Upgrading
This section provides an overview of upgrading your Siperian Hub implementation.
Upgrading Siperian Hub Environments

Siperian Hub implementations comprise multiple environments, such as development, test, and production. When you upgrade your Siperian Hub implementation, you must do so in each environment. Organizations typically upgrade environments in the following sequence.
Note: In the midst of upgrading, the schemas for environments that have not been upgraded are temporarily out of sync with those that have been. When upgrading the production environment, organizations often run a test upgrade on a copy ofor representative sample ofproduction data. This allows the organization to identify, document, and remedy possible issues before performing the actual production upgrade on the live environment.In addition, rather than upgrade (or patch install) the production environment, some organizations choose to perform a full install with a new Hub Store, and then use the Metadata Manager to migrate the data to the new deployment. For instructions on performing a full Siperian Hub installation, see the Siperian Hub Installation Guide for you platform. A typical upgrade involves several steps, including planning, preparation, implementation, and testing. While each upgrade is different, a reasonable estimate of the time required to complete an upgrade is two-to-four months. The planning and preparation tasks typically require one-to-three months of effort, depending on the
Introduction 3
complexity of your implementation and the level of customization that you have applied to Siperian Hub. The implementation and test of the upgrade in each Siperian Hub environment usually takes one-to-two weeks.
Upgrading a Single Siperian Hub Environment

Within each Siperian Hub environment, upgrading to Siperian Hub XU SP2 Patch B occurs in three distinct phases, each with its own set of tasks.
Phase Preparation
Description Tasks to perform before you run the upgrade process. This phase includes validating and fixing any metadata and data issues in your Hub Store, backing up your system, making sure you have sufficient free space to perform the upgrade, taking a snapshot of your system configuration before you upgrade, and enabling the database debug log so that you have a detailed trace of changes made to your Hub Store during upgrade. See Chapter 2, Before You Upgrade. Tasks to upgrade your Siperian Hub implementationthe Hub Server, Cleanse Match Servers, Master Database, Operational Record Stores (ORS databases), and Business Data Director. See Chapter 3, Upgrade Siperian Hub. Tasks to perform after you run the upgrade to verify that the upgrade process completed successfully. See Chapter 4, After You Upgrade.
Upgrade
Verification
Important: The instructions in this document assume that you are not making any major changes to your environment (such as database upgrades) while you are in the midst of upgrading your Siperian Hub implementation.
Updates in this Release

This section describes key changes from prior releases of Siperian Hub XU SP2.
Summary of Changes
This section summarizes the key changes in Siperian Hub XU SP2 Patch A and Siperian Hub XU SP2 Patch B. For more information about new features and enhancements for specific releases, see the associated Whats New in Siperian Hub document available on the FTP site or on Siperian SHARE. Note: Unless explicitly noted, no changes were made in Hot Fixes or XU SP2 Patch A Rollup 1.
XU SP2 Patch A Release

Siperian Hub XU SP2 Patch A provided the following key changes: Business Data Director (BDD) Enhanced BDD Configuration Tool Extended Subject Area Data View Capabilities Enhanced Extensibility Dashboard Visualization and Personalization Enhanced Hierarchy Management Capabilities Additional Flexibility in Configuring Lookups Updated Implementation Guide Enhanced BDD Generic Online Help Null Value Enhancements Resource Kit Enhancements
MRM Hub
Introduction 5
XU SP2 Patch B Release

Siperian Hub XU SP2 Patch B provides the following key changes. Enhanced BDD Usability & Extensibility Ability to search by related data not in the Subject Area Enhanced drop-down list support, including dependent lookups and typeahead Ability to view, navigate and maintain grandchild data within a Subject Area Ability to incorporated federated queries as a child tab within a Subject Areas (requires Activity Manager) Hierarchy point-in-time view Support for code based user, providing the ability to call custom functions while maintaining and saving data within a subject area. A new Cleanse Adapter for Informatica Data Quality (Web Services) Support for Trillium 12
MRM Hub
Functional Changes
This section summarizes the functional changes since Siperian Hub XU SP2 GA.
Metadata Changes
The following metadata changes were made in Siperian Hub XU SP2 Patches A and B.
Version Introduced Action Add Column Add Column Add Column Add Column Add Column Add Column Affected Table C_REPOS_DB_RELEASE.EXPLICIT_MERGE_CONSOL_1_IND C_REPOS_CL_FUNCTION_LIB.WSDL_PORT C_REPOS_CL_FUNCTION_LIB.WSDL_SERVICE C_REPOS_CL_FUNCTION_LIB.WSDL_URI C_REPOS_SUBJECT_AREA.LABEL_FORMAT_STR C_REPOS_SUBJECT_AREA.LABEL_ROWID_COLUMN_LIST
XU SP2 Patch A (XU SP2 GA -> XU SP2 Patch A) XU SP2 Patch B (XU SP2 Patch A -> XU SP2 Patch B)
Database User Exits

There are no signature or behavior changes for database user exits since XU SP2 GA.
BDD User Exits

BDD User Exits are new in XU SP2 Patch B. These did not exist in XU SP2 GA or Patch A. These are specific to the BDD and have no impact on any database User Exits. For more information, see the Siperian Hub Business Data Director Implementation Guide.
Introduction 7
Database Stored Procedures

For the REVALIDATE_BO stored procedure, in XU SP2 Patch B, a new parameter (IN_RECALC_BVT_IND INT DEFAULT, which defaults to zero) was added to recalculate BVT on the base object. This change does not require any changes to job execution and ETL scripts unless you want to refresh BVT on the base object after the revalidate.
SIF API Changes

The following SIF API changes were made in Siperian Hub XU SP2 Patches A and B.
Version Introduced API Call GetOneHopRequest Change(s) getOneHop did not return the total number of relationships. The recordCount field has been added to the response. Changes to the searchQuery API to support grandchildren. There can be up to three match path components specified as joinUids to allow including additional columns in the search query result.
XU SP2 Patch A (XU SP2 GA -> XU SP2 Patch A)
XU SP2 Patch B (XU SP2 Patch A -> XU SP2 Patch B) SearchQueryRequest
AuthenticateResponse Return username as part of authenticate response. If username was not part of the request, take username from user profile if it has been set. This can be used in cases where a custom SAM provider is used that takes no username parameter.
Note: No signature changes have been made to the SIF API since XU SP2 GA. For more information about these SIF calls, refer to the Siperian Hub Javadoc. Services implemented on top of Siperian Hub do not need to be repackaged with the latest version of the SIF client libraries.
Match Changes
There are no match changes or SSA updates since XU SP2 GA.
Cleanse and Cleanse Adapter Changes

In XU SP2 Patch A, no cleanse changes were made. In XU SP2 Patch B, support was added for: Trillium 12 Informatica Data Quality (IDQ)
No other cleanse-related changes have been made in XU SP2 Patch B.
Product Documentation
These new guides or significant documentation updates are included in this release: Siperian Hub Upgrade Guide for XU SP2 (this guide) (new for Patch B) Online help for the BDD Configuration Manager (new for Patch B) Updated generic BDD online Help and templates (part of the BDD client)
Deprecation Notices
This section describes Siperian Hub features that have been deprecated. Note: No new deprecation notices have been issued in XU SP2 Patch A or XU SP2 Patch B.
About Deprecation
The term deprecation is applied to software features that are superseded and should be avoided. Although deprecated features remain in the current version, it should be anticipated that the feature will be removed in a future release.
Introduction 9
Previously-deprecated Functionality
Data Groups tool have been deprecated. Environment Staging has been deprecated post XU-SP1 and replaced by functionality that is embedded in the new Metadata Manager tools. The Match Validate process has been deprecated. Match for Duplicates / Rule Based Match for Duplicates has been deprecated post XU-SP1 and replaced by functionality that is embedded in the Exact Match process. Remote schemas are deprecated as of XU-SP1 and are not supported by MET migration. Relationship tables have been deprecated. Use relationship base objects for this functionality instead. Dependant objects have been deprecated post XU-SP1. Use base objects for this functionality. The XML API has been deprecated and is no longer available for use with new Hub implementations. This functionality is superseded by the Services Integration Framework (SIF). More information about SIF can be found in the Siperian_Hub_ SIF_Guide.pdf available on SHARE.
Supported Platform Changes

Upgrading the Siperian Hub and Cleanse Match Servers is supported on all the platforms on which the Siperian Hub is supported. The supported platforms described in the Siperian Hub Release Notes remains the same as it was for the XU SP2 GA release. For more information, see the Siperian Hub Release Notes.
Before You Begin
Before You Begin

Read this section before you begin the process of upgrading your Siperian Hub environment.
Assumptions About Upgrading

The instructions in this document assume the following: Your Siperian Hub implementation is version XU SP2 GA or later. All the components of your Siperian Hub implementation are the same version. If you have multiple versions of Siperian Hub installed, each version must be installed in a separate environment. Different versions of Siperian Hub cannot co-exist in the same environment. Your environment complies with 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. You are not making any major changes to your environment (such as database upgrades) while you are in the midst of upgrading your Siperian Hub implementation.
Duration of Upgrade
The duration of the upgrade process is determined by the number and size of your base objects. XU SP2 Patch B is a low-impact upgrade that, for a basic configuration, can usually be completed in a few hours.
Introduction 11
Before You Begin
Documenting Your Upgrade

You need to capture the details of your Siperian Hub environment before, during, and after you upgrade in case you encounter issues during the upgrade process. This information can prove extremely useful with verification and troubleshooting. If necessary, you can provide copies of this information to Siperian Support. Sources of upgrade information include:
Information About ORS metadata Source of Information Validation Results report from the Metadata Manager tool in the Hub Console. Used to document ORS metadata before and the upgrade. For instructions, see Siperian Hub Metadata Manager Guide. Environment Report from the Enterprise Manager tool in the Hub Console. Used to document Hub Server, Cleanse Match Server, Master Database, and ORS database information before and after the upgrade. For instructions, see Appendix D, Viewing Configuration Details, in the Siperian Hub Administrator Guide. ZIP archive file containing the results of running the DVT (data validation) scripts that validate your content metadata. Database debug log. Used to log database events for your Hub Store. Enabled according to the instructions in the Siperian Hub Installation Guide for your platform. Siperian Hub Installer log files. Used to log upgrade events for your Hub Server and Cleanse Match Server upgrades. Hub Server and Cleanse Match Server log files Hub Console log files
configuration settings
content metadata database changes
upgrade process Hub Server and Cleanse Match Server Hub Console
Important: The instructions in this document remind you to capture and save this information if needed for future reference. In Create an Upgrade Documentation Directory on page 15, you will create a folder (such as upgradedoc) where you will centrally store copies of all your upgrade documentation.
2
Before You Upgrade
This chapter describes what you need to do before upgrading your Siperian Hub XU SP2 implementation to Siperian Hub XU SP2 Patch B.
Chapter Contents
Preparation Overview Create an Upgrade Documentation Directory Validate Your Metadata Verify Your Siperian Hub Environment Validate Content Metadata Back Up Your Current Implementation Verify Available Space Enable the Siperian Hub Database Debug Log
13
Preparation Overview
Preparation Overview
Before you upgrade, you need to complete the following tasks.

Step 1 2 Task Create a documentation folder Instructions Create an Upgrade Documentation Directory on page 15
Run Metadata Manager to validate and Validate Your Metadata on page 15 document your ORS to ensure that there are no errors Run Enterprise Manager to review and document your current Siperian Hub environment Run data validation scripts to validate your content metadata Back up key Siperian Hub components Review space requirements Enable the database debug log Verify Your Siperian Hub Environment on page 15 Validate Content Metadata on page 16 Back Up Your Current Implementation on page 17 Verify Available Space on page 18 Enable the Siperian Hub Database Debug Log on page 18
4 5 6 7
Verify Your Siperian Hub Environment
Create an Upgrade Documentation Directory

Create a folder (such as upgradedoc) where you will centrally store copies of all your upgrade artifactssuch as the Validation Results and Environment reports, database debug log, log files, and other items described in Documenting Your Upgrade on page 12. Important: In the event that problems arise with your upgrade, you will need to create an archive file of this directory and send it to Siperian Support for analysis.
Validate Your Metadata

Prior to upgrading, your schema needs to be clean. An upgrade performed on a Hub Store with any invalid metadata may not perform as expected. To validate your metadata, run the validation process using the Metadata Manager in the Hub Console according to the instructions in the Siperian Hub Metadata Manager Guide. Resolve any validation issues encountered and re-run validation. Contact Siperian Support if you need assistance. Important: When finished, save a copy of the final validation results in your upgrade documentation folder that you created in Create an Upgrade Documentation Directory on page 15.
Verify Your Siperian Hub Environment

Use the Enterprise Manager tool in the Hub Console to review your current Siperian Hub configuration for Hub Servers, Cleanse Match Servers, the Master Database, and ORS databases. Review the version history as well. For instructions, see Appendix D, Viewing Configuration Details, in the Siperian Hub Administrator Guide. Important: Generate an Environment Report and save a copy in your upgrade documentation folder that you created in Create an Upgrade Documentation Directory on page 15.
Before You Upgrade 15
Validate Content Metadata
Validate Content Metadata

Your content metadata is information that describes the data that has been loaded into the Hub Store. Siperian provides DVT (data validation) scripts that that you can run to validate your content metadata. 1. Contact Siperian Support to obtain the DVT scripts that apply to your Siperian Hub implementation.
2.
Run the DVT scripts according to the instructions in the readme that accompanies the DVT distribution. At the end of the execution process, the scripts package the result files into a ZIP archive. Based on the input parameters, the archive file can include: generated dataset and slice subfolders DVT result count file configuration file TEMPLATE.CSV Result.info a summary file containing the total number of queries, how many of them have been executed, and what time it took to complete them
3.
Send the ZIP archive to Siperian Support (support@siperian.com) for analysis.
Important: Save a copy of the ZIP results in the upgrade documentation folder that you created in Create an Upgrade Documentation Directory on page 15.
Back Up Your Current Implementation
Back Up Your Current Implementation

This section describes backup tasks that you need to perform before you upgrade.
Back Up Your Schema

Before you upgrade, it is essential that you perform a full back up of your schema. If issues arise during the upgrade, you may need to restore your entire schema from this backup (there is no automatic rollback of the upgrade changes). Contact your database administrator and Siperian Support if you need assistance with this.
Back Up User Exits

Back up your user exit stored procedures if they have been customized. The Hub Store installer scripts overwrite the User Exit (UE) packages when you upgrade the database. If you do not back up your user exit customized stored procedures, you must manually reapply the customizations after you perform the upgrade. You may need to update the user exits based on the XU SP2 Patch B stored procedure definitions.
Back Up Customizations
Any customizations that are registered in the Hub Console (such as custom queries, custom functions, registered custom indexes, and so on) are automatically included in the upgrade process. Be sure to register any unregistered custom indexes. Any customizations that are not registered in the Hub Console (such as user exits, custom client Java code, custom stored procedures, custom buttons, unregistered custom queries, and so on) require special attention. Before you start to upgrade, take an inventory of all customizations in your Siperian Hub implementation and ensure that you have backed up the latest source code for each customization.
Back Up Trillium Director Configuration Files

If you are using Trillium Director, back up the configuration files for Trillium Director if you have modified them in any way.
Before You Upgrade 17
Verify Available Space
Verify Available Space

Space requirements are minimal for upgrading to XU SP2 Patch B. To ensure sufficient storage space to complete the upgrade, a good rule of thumb is to use the following formula:
(2 x Hub Store Size) x 20%
Enable the Siperian Hub Database Debug Log

Make sure that you have turned on the Siperian Hub database debug log (cmx_debug.log) according to the instructions in Enabling Debug Logging in the Siperian Hub Installation Guide for your platform (Windows or UNIX). The database debug log contains run-time logging information for stored procedures that have been executed. The Environment Report generated using the Enterprise Manager tool provides the full path to your database debug log. Note: If you have any difficulties enabling the CMX database debug log, contact Siperian Support. It is essential to have this debug log enabled before starting the upgrade.
3
Upgrade Siperian Hub
This chapter describes the tasks that you need to perform to your Siperian Hub XU SP2 implementation to Siperian Hub XU SP2 Patch B. Important: The instructions in this chapter assume that you have already completed the preparation tasks described in Chapter 2, Before You Upgrade.
Chapter Contents
Upgrade Overview Upgrading the Hub Server Upgrading Cleanse Match Servers Upgrading the Hub Store Restarting Your Environment Updating Business Data Director
19
Upgrade Overview
Upgrade Overview
Note: If you need help obtaining the Siperian Hub XU SP2 Patch B distribution, contact Siperian Support (support@siperian.com). To upgrade your Siperian Hub implementation, complete the following general steps:
Step 1 Task Upgrade the Hub Server by running the Hub Server installer provided in the distribution. Upgrade any Cleanse Match Servers in your Siperian Hub implementation by running the Cleanse Match Server installer provided in the distribution. Upgrade the Master Database (CMX_ SYSTEM) by running the updatemasterdatabase script. Upgrade ORS databases by running the updateorsdatabase script. Restart your application servers, clear Java Web Start, and other Update Business Data Director Instructions Upgrading the Hub Server on page 21
Upgrading Cleanse Match Servers on page 26
Upgrading the Master Database on page 31 Upgrading ORS Databases on page 33 Restarting Your Environment on page 35 Updating Business Data Director on page 36
4 5 6
Once you have completed these steps, proceed to Chapter 4, After You Upgrade.
Upgrading the Hub Server

This section describes how to upgrade the Hub Server in your Siperian Hub implementation. If you encounter any problems, refer to Troubleshooting Hub Server Upgrades on page 48.
About the Hub Server Upgrade

The Hub Server is the Siperian Hub software that runs in the application server environment and provides core and common services, including access, security, and session management. To upgrade the Hub Server, you run the Hub Server Installer provided in the distribution. The Hub Server Installer recognizes that this is an upgrade (patch installation instead of a full installation) when, during installation, you point to your existing Siperian Hub installation as the target. Before overwriting your existing software, the Siperian Hub Installer creates a backup of critical files.
Steps to Upgrade the Hub Server

The Hub Server can deployed as a standalone component (one instance), or multiple Hub Servers can be deployed in a cluster. Follow the instructions that are appropriate for your Siperian Hub implementation.
Steps to Upgrade a Standalone Deployment

To upgrade a standalone Hub Server, complete the following steps. 1. Make sure that the application server on which your Hub Server is deployed is up and running.
2. 3.
Log in under the username that was used to install the Hub Server (see the Siperian Hub Installation Guide for details). Run the Hub Server Installer to start the upgrade. Windows: The Hub Server installer (hub_install.exe) is located on the distribution in the \mrmserver\windows directory.
21
UNIX: The Hub Server installer (hub_install.bin) is located on the distribution in the /mrmserver/<your_OS> directory. Note: For UNIX or Linux environments, if you are using character console mode (when X-Windows is not available) to upgrade, then use the following command:
./hub_install.bin -console
4. 5. 6. 7. 8. 9. 10. 11.
In the Introduction screen, click Next to continue In the License Agreement screen, accept the terms and click Next. In the Choose Install Folder screen, click the Choose... button, then locate and select your previous Siperian Hub installation. Click Next. In the Version Warning message, click OK to confirm that you want to proceed. If your previous installation uses WebLogic as its application server, the Hub Server Installer prompts you to provide the WebLogic Admin password. In the Deploy screen, click Yes to deploy automatically, and click Next. In the Pre-Installation Summary screen, if you want to change any options, click the Previous button to navigate back to previous screens and change your selections. Once the summary reflects the options you want, click Install to start the installation process. The Hub Server Installer displays the Please Wait screen while it configures your system. During this process, the Hub Server Installer will back up critical files (except what is in the tmp folder), compressing them into an archive that is stored in a backup folder in your Siperian Hub installation directory: The filename of the archive uses a pattern similar to the following example:
Siperian Hub Server-2009-10-06_18-09.jar
When installation completes, the Install Complete screen is displayed.

12.
Click Done to exit the Hub Server installer. Note: If the install fails to complete successfully, the last screen of the Hub Server 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 Troubleshooting Hub Server Upgrades on page 48.
13.
Save a copy of the Hub Server log files in your upgrade documentation directory according to the instructions in Copy Hub Server Log Files to the Upgrade Doc Directory on page 25.
Steps to Upgrade a Clustered Deployment

To upgrade Hub Servers deployed in a cluster, complete the following steps. 1. Make sure that the application server on which your Hub Server is deployed is up and running.
2. 3.
Log in under the username that was used to install the Hub Server (see the Siperian Hub Installation Guide for details). Run the Hub Server Installer to start the upgrade. Windows: The Hub Server installer (hub_install.exe) is located on the distribution in the \mrmserver\windows directory. UNIX: The Hub Server installer (hub_install.bin) is located on the distribution in the /mrmserver/<your_OS> directory. Note: For UNIX or Linux environments, if you are using character console mode (when X-Windows is not available) to upgrade, then use the following command:
./hub_install.bin -console
4. 5. 6. 7. 8. 9. 10.
In the Introduction screen, click Next to continue In the License Agreement screen, accept the terms and click Next. In the Choose Install Folder screen, click the Choose... button, then locate and select your previous Siperian Hub installation. Click Next. In the Version Warning message, click OK to confirm that you want to proceed. If your previous installation uses WebLogic as its application server, the Hub Server Installer prompts you to provide the WebLogic Admin password. In the Deploy screen, choose No because you will deploy the EAR file manually.
23
11.
In the Pre-Installation Summary screen, if you want to change any options, click the Previous button to navigate back to previous screens and change your selections. Once the summary reflects the options you want, click Install to start the installation process, and click Next. The Hub Server Installer displays the Please Wait screen while it configures your system. During this process, the Hub Server Installer will back up critical files (except what is in the tmp folder), compressing them into an archive that is stored in a backup folder in your Siperian Hub installation directory: The filename of the archive uses a pattern similar to the following example:
Siperian Hub Server-2009-10-06_18-09.jar

12.
Click Done to exit the Hub Server Installer. Note: If the upgrade fails to complete successfully, the last screen of the Hub Server 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 Troubleshooting Hub Server Upgrades on page 48.
13.
Run following command to repackage the EAR file: Windows

cd <Siperian_Install_Directory>\bin sip_ant.bat repackage
UNIX
cd <Siperian_Install_Directory>/bin ./sip_ant.sh repackage 14.
Open the application server administration console (WebLogic Server or WebSphere) and manually deploy the MRM Server EAR. For instructions, refer to your application server documentation. Save a copy of the Hub Server log files in your upgrade documentation directory according to the instructions in Copy Hub Server Log Files to the Upgrade Doc Directory on page 25.
15.
Copy Hub Server Log Files to the Upgrade Doc Directory

Once you have completed the Hub Server upgrade, copy the following log files to the upgrade documentation folder you created in Create an Upgrade Documentation Directory on page 15. You may need these log files to assist with troubleshooting. For more information, see About the Siperian Hub Log Files in the Siperian Hub Installation Guide.
File
<Siperian_Install_Directory>/hub/server/Siperian_Hub_ Server_InstallLog.xml <Siperian_Install_Directory>/hub/server/siperian_ installer_debug.txt <Siperian_Install_ Directory>/hub/server/logs/patchInstallSetup.log <Siperian_Install_ Directory>/hub/server/logs/cmxserver.log
Description Contains log messages for the Hub Server installation. Contains debug messages and all the options that you selected when you ran the installation. Contains the
patchInstallSetup messages
for the script.
Hub Server log. When the server started, it created this file. Located in the tree under the install directory for your application server.
Application server log files.
upgrade).
Important: You should save these files in a separate folder (such as hub_server_ If you upgraded multiple Hub Servers in a cluster, copy the files for each Hub Server instance into its own folder. When finished, proceed to the next section, Upgrading Cleanse Match Servers on page 26.
25
Upgrading Cleanse Match Servers

This section describes how to upgrade Cleanse Match Servers in your Siperian Hub implementation.
About Cleanse Match Server Upgrades

The Cleanse Match Server is a servlet that contains a cleanse server (to handle data cleansing operations) and a match server (to handle match operations). To upgrade the Cleanse Match Server, you run the Cleanse Match Server Installer provided in the distribution. The Cleanse Match Server Installer recognizes that this is an upgrade (patch installation instead of a full installation) when, during installation, you point to your existing Siperian Hub installation as the target. Before overwriting your existing software, the Cleanse Match Server Installer creates a backup of critical files.
Steps to Upgrade the Cleanse Match Server

The Cleanse Match Server can deployed as a standalone component (one instance), or multiple Cleanse Match Servers can be deployed in a cluster. Follow the instructions that are appropriate for your Siperian Hub implementation. If you encounter any problems, refer to Troubleshooting Cleanse Match Server Upgrades on page 49.
Steps to Upgrade a Standalone Deployment

To upgrade a standalone Cleanse Match Server, complete the following steps. 1. Log in using the username that was used to install Cleanse Match Server.
2.
If you are using the AddressDoctor cleanse engine: Shut down the application server on which the Cleanse Match Server is running. Check the Jade library version according to the instructions in the Cleanse Adapter Guide.
3.
Start up the application server on which your Cleanse Match Server is deployed, and make sure that it is up and running.
4.
Run the Cleanse Match Server Installer to begin the installation process. Windows: The Cleanse Match Server installer (hub_cleanse_install.exe) is located on the distribution in the \mrmcleanse\windows directory. UNIX: The Cleanse Match Server installer (hub_cleanse_install.bin) is located in the /<your_OS>/mrmcleanse directory on the distribution. Note: For UNIX or Linux environments, if you are using character console mode (when X-Windows is not available) to upgrade, then use the following command:
./hub_cleanse_install.bin -console
5. 6. 7. 8. 9.
In the Introduction screen, click Next. In the License Agreement screen, accept the terms and click Next. In the Choose Install Folder screen, click the Choose... button to locate your previous Cleanse Match Server installation, and then click Next. In the Version Warning message, click OK to confirm that you want to proceed. If your previous installation uses WebLogic as its application server, the Cleanse Match Server Installer prompts you to provide the WebLogic Admin password. Enter the WebLogic password. In the Deploy screen, choose Yes to deploy the Cleanse Match Server automatically, and then choose Next. In the Pre-Installation Summary screen, if you want to change any options, click the Previous button to navigate back to previous screens and change your selections. Once the summary reflects the options you want, click Install to start the installation process. The Cleanse Match Server Installer displays the Please Wait screen while it configures your system. During this process, the Cleanse Match Server Installer will back up critical files (except what is in the tmp folder), compressing them into an archive that is stored in a backup folder in your Siperian Hub installation directory: The filename of the archive uses a pattern similar to the following example:
Siperian Hub Cleanse Match Server-2009-11-26_17-21.jar
10. 11.
27

12.
Click Done to exit the Cleanse Match Server installer. Note: If the upgrade fails to complete successfully, the last screen of the Cleanse Match Server 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 Troubleshooting Cleanse Match Server Upgrades on page 49.
13.
Save a copy of the Cleanse Match Server log files in your upgrade documentation directory according to the instructions in Copy Cleanse Match Server Log Files to the Upgrade Doc Directory on page 30.
Steps for Upgrading a Clustered Deployment

To upgrade Cleanse Match Servers deployed in a cluster, complete the following steps. 1. Log in using the username that was used to install Cleanse Match Server.
2.
If you are using the AddressDoctor cleanse engine: Shut down the application server on which the Cleanse Match Server is running. Check the Jade library version according to the instructions in the Cleanse Adapter Guide.
3. 4.
Start up the application server on which your Cleanse Match Server is deployed, and make sure that it is up and running. Run the Cleanse Match Server Installer to begin the installation process. Windows: The Cleanse Match Server installer (hub_cleanse_install.exe) is located on the distribution in the \mrmcleanse\windows directory. UNIX: The Cleanse Match Server installer (hub_cleanse_install.bin) is located in the /<your_OS>/mrmcleanse directory on the distribution. Note: For UNIX or Linux environments, if you are using character console mode (when X-Windows is not available) to upgrade, then use the following command:
./hub_cleanse_install.bin -console
5.
In the Introduction screen, click Next.
6. 7. 8. 9.
In the License Agreement screen, accept the terms and click Next. In the Choose Install Folder screen, click the Choose... button to locate your previous Cleanse Match Server installation, and then click Next. In the Version Warning message, click OK to confirm that you want to proceed. If your previous installation uses WebLogic as its application server, the Cleanse Match Server Installer prompts you to provide the WebLogic Admin password. Enter the WebLogic password. In the Deploy screen, choose No because you will deploy the Cleanse Match Server manually. In the Pre-Installation Summary screen, if you want to change any options, click the Previous button to navigate back to previous screens and change your selections. Once the summary reflects the options you want, click Install to start the installation process. The Cleanse Match Server Installer displays the Please Wait screen while it configures your system. During this process, the Cleanse Match Server Installer will back up critical files (except what is in the tmp folder), compressing them into an archive that is stored in a backup folder in your Siperian Hub installation directory: The filename of the archive uses a pattern similar to the following example:
Siperian Hub Cleanse Match Server-2009-11-26_17-21.jar
10. 11.

12.
Click Done to exit the Cleanse Match Server installer. Note: If the upgrade fails to complete successfully, the last screen of the Cleanse Match Server 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 Troubleshooting Cleanse Match Server Upgrades on page 49.
13.
Run following command to repackage the EAR file: Windows

cd <Siperian_Install_Directory>\bin sip_ant.bat repackage
29
UNIX
cd <Siperian_Install_Directory>/bin ./sip_ant.sh repackage 14.
Open the application server administration console (WebLogic Server or WebSphere) and manually deploy the Cleanse Match Server EAR file. For instructions, refer to your application server documentation. Save a copy of the Cleanse Match Server log files in your upgrade documentation directory according to the instructions in Copy Cleanse Match Server Log Files to the Upgrade Doc Directory on page 30.
15.
Copy Cleanse Match Server Log Files to the Upgrade Doc Directory
Once you have completed the Cleanse Match Server upgrade, copy the following log files to the upgrade documentation folder you created in Create an Upgrade Documentation Directory on page 15. You may need these log files to assist with troubleshooting. For more information, see About the Siperian Hub Log Files in the Siperian Hub Installation Guide.
File
<Cleanse_Install_Directory>/hub/cleanse/Siperian_ Hub_Cleanse_Match_Server_InstallLog.xml <Cleanse_Install_ Directory>/hub/cleanse/logs/patchInstallSetup.log <Cleanse_Install_ Directory>/hub/cleanse/logs/cmxserver.log <Cleanse_Install_Directory>/hub/cleanse/siperian_ installer_debug.txt
Description Shows the Cleanse Match Server install errors and status. Shows the patchInstallSetup script results. Cleanse server logs. Shows what was chosen during the upgrade installation. Located in the tree under the install directory for your application server.
Application server log files.
Important: You should save these files in a separate folder (such as cleanse_match_ server_upgrade). If you upgraded multiple Cleanse Match Servers in a cluster, copy the files for each Cleanse Match Server instance into its own folder.
Upgrading the Hub Store
When finished, proceed to the next section, Upgrading the Hub Store on page 31.

This section describes how to upgrade the Hub Store in your Siperian Hub implementation.
About Hub Store Upgrades

The Hub Store is the database that contains your Master Database and one or more Operational Record Store (ORS) databases. You must use scriptsprovided in the distribution to upgrade all of these databases according to the instructions in Upgrading the Master Database on page 31 and Upgrading ORS Databases on page 33. If you encounter problems during the upgrade, refer to the tips in Troubleshooting Hub Store Upgrades on page 51. Important: If you made changes to the metadata in any way other than through the Siperian Hub user interface, these database update scripts may fail. If a script fails, contact Siperian Support.
Upgrading the Master Database

Important: The instructions in this section assume that you have already completed the tasks described in Chapter 2, Before You Upgrade. You can update the database only after you have successfully installed and patched the Hub Server software according to the instructions in Upgrading the Hub Server on page 21. To upgrade the Master Database: 1. Go to the bin directory under the Hub Server installation directory.
2.
Run the Master Database upgrade script with the following command: Windows: sip_ant.bat updatemasterdatabase UNIX: ./sip_ant.sh updatemasterdatabase
31
3.
Provide the following information for your Master Database:

File TNS name Master DB hostname Master DB port number Master DB SID Master DB user name Master DB user password CMX DB user name CMX DB user password Description Name by which your database is known on the network. Name of the host running your Master Database. Port number on which Oracle is listening. Database system identifier. Upgrade process expects the user name CMX_SYSTEM. Upgrade process expects the password for the user name CMX_SYSTEM. Upgrade process expects the user name CMX. Upgrade process expects the password for the user name CMX.
4.
During the Master Database upgrade process, if you see the following prompt, respond accordingly.
This upgrade should be performed by a 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
Answer Yes or 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.
5. 6.
For JBoss, after you run updatemasterdatabase, you need to restart the JBoss AppServer. Otherwise, when you launch the Hub Console, you will get an error. Save a copy of the sip_ant log file in your upgrade documentation directory according to the instructions in Copy Hub Server Log Files to the Upgrade Doc Directory on page 25. The log file is stored in the following directory: Important: The sip_ant log file is overwritten every time you execute sip_ant from the command line. You must save a backup copy before you run sip_ant again.
<Siperian_Install_Directory>\server\resources\database\db_changes\oracle\ORS
Upgrading ORS Databases

Important: The instructions in this section assume that you have already completed the tasks described in Upgrading the Master Database on page 31. For each ORS database that you want to upgrade, complete the following steps: 1. Check stored procedures and views in the ORS database. All the stored procedures and views should compile successfully in the schema before you start the upgrade. You can check this using the TOAD schema viewer. Invalid stored procedures or views will cause the upgrade to fail.
2.
Go to the bin directory under the Hub Server installation directory. Windows: <Siperian_Install_Directory>\hub\server\bin UNIX: <Siperian_Install_Directory>/hub/server/bin Windows: sip_ant.bat updateorsdatabase UNIX: ./sip_ant.sh updateorsdatabase
3.
Update your ORS database with the following command:
33
4.
Provide the following information for your ORS database:

File TNS name Schema User password Description Name by which your ORS database is known on the network. Name of your ORS database. Upgrade process expects the password for the user name CMX_USER.
5.
During the ORS upgrade process, if you see the following questions, respond accordingly. You may need to answer the following questions if your ORS does not have a PROXY_ROLE defined, or if a PROXY_ROLE is not granted to the ORS database.
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]:
6.
After upgrading an ORS, save a copy of the sip_ant log file in your upgrade documentation directory according to the instructions in Copy Hub Server Log Files to the Upgrade Doc Directory on page 25. The log file is stored in the following directory: Important: The sip_ant log file is overwritten every time you execute sip_ant from the command line. You must save a backup copy before you run sip_ant again (for example, to upgrade next ORS).
<Siperian_Install_Directory>\server\resources\database\db_changes\oracle\ORS
Restarting Your Environment
7.
Save a copy of the database debug log the your upgrade documentation directory that you created previously in Create an Upgrade Documentation Directory on page 15. You enabled this database debug log in Enable the Siperian Hub Database Debug Log on page 18. To find the debug log, refer to the path referenced in the Environment Report, which you generated using the Enterprise Manager tool in the Hub Console according to the instructions in Verify Your Siperian Hub Environment on page 15. If you have backed up your customized user exit stored procedures as specified in Back Up User Exits on page 17, edit the cmxue package in the following location: Apply the cmxue package to the ORS.
8.
<Siperian_Installation_Directory>\server\resources\database\oracle
When finished, proceed to Restarting Your Environment on page 35.
Restarting Your Environment

After you have upgraded the Hub Servers, Cleanse Match Servers, Master Database, and any ORS databases, you need to restart your Siperian Hub environment. 1. Shut down any application servers that run the Hub Server and any Cleanse Match Servers.
2. 3. 4. 5.
Clear Java Web Start according to the instructions in the vendor documentation. You must do this because you now have an updated Siperian certificate. Clear the Java cache according to the instructions in the vendor documentation. Start the application servers that run the Hub Server and any Cleanse Match Servers. Proceed to the next section, Updating Business Data Director on page 36.
35
Updating Business Data Director

This section describes tasks to update Business Data Director in your upgraded Siperian Hub implementation.
Enabling Query Results De-duplication (Optional)

In XU SP2 Patch B, you can have duplicates removed from BDD search query results. This feature is not enabled by default. To use this feature, you must manually enable it by adding a SIF-related property to the cmxserver.properties file. To enable query results de-duplication: 1. Open the cmxserver.properties file:
2.
Windows: <Siperian_Install_
Directory>\server\resources\cmxserver.properties
UNIX: <Siperian_Install_
Directory>/server/resources/cmxserver.properties
Add the following code lines anywhere in the cmxserver.properties file:

# Sif property to remove duplicates from the search query results cmx.server.remove_duplicates_in_search_query_results=true
3. 4.
Save your changes. Restart the Hub Server application for your changes to take effect. WebSphere and WebLogic: Restart the application using the application server administration console application. JBoss: Restart the application server.
Update BDD Queries

When upgrading to XU SP2 Patch B, ifbefore the upgradeyou had child objects in a subject area that referred to the same base object as the primary object in the subject area, the child objects will be consolidated into a single instance of the base object in the query creation dialog. Therefore, any queries that refer to child subject areas on the same base object need to be updated to include the type code for the base object as a column of the query.
Example of a BDD Query that Requires Updating

In the following example, before the upgrade, the Person subject area had two child objectsBill Address and Ship Addressas shown in the Query Builder:
In the following example, after the upgrade to XU SP2 Patch B, the Bill Address and Ship Address were merged into one Address subject area, because they both referenced the same physical base object and had the same match path UID configured in BDDConfig.xml.
37
Note, however, that this new subject area node contains an additional attributeAddress Typewhich is based on the column that is used to classify records as either Bill or Ship sub-types.
The following screen shot shows how this additional search attribute can be used in search. If the type column is selected in a query, BDD renders it as a drop-down list populated by all the types of base objects that were used in the merged Address node.
In this example, the list contains Bill address and Ship address values. Because of this change, all affected saved queries need to be updated to use the new attributes. For example, to find persons with a billing address that matches Address Line 1, two attributes need to be specified: Address Type (Bill Address) and Address Line 1.
BDD Query Update Steps

To update affected BDD queries: 1. Log into the BDD application.
2. 3. 4.
Open the Query Builder. Click the Saved Queries tab. Mouse-over all saved queries to display the tool-tip showing the query definition. Determine whichif anysaved queries require updating because they use a newly-created composite object (in the previous example, Address is the composite object). For each query that uses a newly-created composite object, open the query, add the applicable type attribute (in our example, Address type), select the appropriate value (in our example, Bill Address or Ship Address), and then save the query.
5.
Refresh Business Data Director Help

For BDD upgrades, users will need to manually refresh the BDD Help for any existing applications: 1. Obtain the BDDHelp.zip file from the Docs folder included with the FTP package.
2. 3. 4.
Launch and login to the BDD Configuration Manager. Select the BDD application for which you want to update the Help. From the command menu, choose Import > Import to existing BDD Application.
a. b.
From the Configuration Type drop-down list, choose BDD Help and browse to the updated BDDHelp.zip file. Complete the import to replace the existing Help file with the updated release version.
39
4
After You Upgrade
This chapter describes the tasks that you need to perform after upgrading your Siperian Hub XU SP2 implementation to Siperian Hub XU SP2 Patch B.
Chapter Contents
Verification Overview Validate the Upgraded Metadata Validate the Upgraded Content Metadata Verify Your Upgraded Siperian Hub Environment Test the Upgraded Environment Archive the Upgrade Documentation Directory
41
Verification Overview
Verification Overview
After completing an upgrade, complete the following tasks:

Step 1 2 3 4 5 Task Run metadata validation on the ORS to ensure that there are no errors. Run Enterprise Manager and Review the Server / Cleanse and ORS configuration Run content metadata validation Test Batch, API and BDD operations Archive upgrade documentation Instructions Validate the Upgraded Metadata on page 43 Verify Your Upgraded Siperian Hub Environment on page 43 Validate the Upgraded Content Metadata on page 43 Test the Upgraded Environment on page 44 Archive the Upgrade Documentation Directory on page 46
Validate the Upgraded Content Metadata
Validate the Upgraded Metadata

After upgrading, validate your metadata again and compare the results with the previous results obtained in Validate Your Metadata on page 15. Run the validation process using the Metadata Manager in the Hub Console according to the instructions in the Siperian Hub Metadata Manager Guide. Resolve any validation issues encountered and re-run validation. Contact Siperian Support if you need assistance. Important: When finished, save a copy of the final validation results (under a different name) in your upgrade documentation folder that you created earlier (see Create an Upgrade Documentation Directory on page 15).
Verify Your Upgraded Siperian Hub Environment

Use the Enterprise Manager tool in the Hub Console to review your upgraded Siperian Hub configuration for Hub Servers, Cleanse Match Servers, the Master Database, and ORS databases. Review the version history as well. Compare this with the previous results obtained in Verify Your Siperian Hub Environment on page 15. For instructions, see Appendix D, Viewing Configuration Details, in the Siperian Hub Administrator Guide. Important: Generate an Environment Report and save a copy (under a different name) in your upgrade documentation folder that you created earlier (see Create an Upgrade Documentation Directory on page 15).
Validate the Upgraded Content Metadata

Run the DVT (data validation) scripts again to validate your content metadata. Compare the results with those obtained before the upgrade (see Validate Content Metadata on page 16). Contact Siperian Support (support@siperian.com) if you encounter any discrepancies. Important: Save a copy of the generated ZIP results archive (under a different name) in your upgrade documentation folder that you created earlier (see Create an Upgrade Documentation Directory on page 15).
After You Upgrade
43
Test the Upgraded Environment

This section provides some suggestions for testing your upgraded Siperian Hub implementation. Every Siperian Hub implementation is unique, and testing requirements vary across environments (DEV, QA/TEST, and PROD). Therefore, your test activities should be designed to meet the unique requirements of your implementation. Note: Not all suggestions are appropriate in all implementations or all environments. You may also design tests that are not mentioned in this section.
Testing with Business Data Director

Consider performing any or all of the following operations to test your Siperian Hub implementation within Business Data Director: If a BDD application is not currently deployed, launch the BDD Configuration Manager and deploy a BDD application instance. Log into the BDD application (if currently deployed). Run several searches. Run workflow operationscreate and execute several tasks. Insert a test record. Create a copy that test record. Find these test records. Merge and unmerge these test records.
Testing with Hub Console Tools

Consider performing any or all of the following operations to test your Siperian Hub implementation within the Hub Console: Launch the Hub Console (which verifies the CMX_SYSTEM datasource). Run the Users tool and view an existing user's properties (which verifies the REPOS layout) Connect to an ORS and run the Schema Viewer to look at the schema, and then run the Schema Manager to view match properties for a base object (verifies the CMX_ORS REPOS tables) Run the Batch Viewer (verifies the Table_Object_View). If possible, execute test batch jobs for Stage, Load, Match, and Merge jobs. In the Cleanse Match Server tool, test connections to any registered Cleanse/Match Servers. From the Cleanse Function Tool, execute a test function for each external cleanse engine (for example AddressDoctor, Trillium Director, and so on). In the Data Manager and Merge Manager tools, find some matches. Insert a test record, make a copy of the test record, find the test records, merge them, and then unmerge them.
Testing Custom Code

If you have custom code, such as client applications or custom stored procedures, run tests to verify that they work as expected.
After You Upgrade
45
Archive the Upgrade Documentation Directory
Archive the Upgrade Documentation Directory

Important: If you are upgrading a production environment, before you go live, you must submit a copy of your upgrade documentation (see Documenting Your Upgrade on page 12) in order to flag and address potential upgrade issues. This is also recommendedbut not mandatoryfor upgrades to non-production environments. Submit the following upgrade documentation to Siperian Support (support@siperian.com): pre-upgrade and post-upgrade validation results from the Metadata Manager pre-upgrade and post-upgrade Environment Report results from the Enterprise Manager pre-upgrade and post-upgrade DVT ZIP archive log filesSiperian database debug log, installer logs, Hub Server log, Cleanse Match Server logs, and Hub Console log (if you encountered a problem using one of the Hub Console tools) anticipated go-live date, environments, and upgrade version feedback on the use of this document, including suggestions on how to improve it
Important: Be sure to contact Siperian Support if you have any questions, concerns, or problems.
A
Troubleshooting
This appendix provides supplemental troubleshooting tips for Siperian Hub XU SP2 Patch B upgrades. For issues not covered in this appendix, or for additional help, contact Siperian Support.
Appendix Contents
Troubleshooting Hub Server Upgrades Troubleshooting Cleanse Match Server Upgrades Troubleshooting Hub Store Upgrades
47
Troubleshooting Hub Server Upgrades
Troubleshooting Hub Server Upgrades

This section provides troubleshooting instructions for Hub Server upgrades.
Running patchInstallSetup Manually

If you run the Hub Server installer and the automatic patch install failed, or if you accidentally answered No when asked whether to deploy to EAR file automatically, you can run the patchInstallSetup manually. 1. Go to the following directory (Siperian_Install_Directory):
2.
Windows: <Siperian_Install_Directory>\hub\server UNIX: /<Siperian_Install_Directory>/hub/server
Execute the patchInstallSetup script to deploy the Hub Server application and apply some changes to your application server configuration. Windows WebLogic
patchInstallSetup.bat -Dweblogic.password=weblogic -Ddatabase.password=!!cmx!!
WebSphere
patchInstallSetup.bat -Ddatabase.password=!!cmx!!
JBoss
patchInstallsetup.bat
UNIX WebLogic
patchInstallSetup.sh -Dweblogic.password=<weblogic_password> -Ddatabase.password=<yourDBPassword>
Note: If you include the ! character in your password, you must include a \ before the ! character. For example, if your password is !!cmx!!, you need to enter the following: \!\!cmx\!\! WebSphere
patchInstallSetup.sh -Ddatabase.password=<yourDBPassword>
Troubleshooting Cleanse Match Server Upgrades
Note: If you include the ! character in your password, you must include a \ before the ! character. For example, if your password is !!cmx!!, you need to enter the following: \!\!cmx\!\! JBoss
patchInstallsetup.sh
Forcing a Patch Install

Important: Consult Siperian Support before attempting this operation. Once a patch install has occurred, the Hub Server Installer prevents you from running it again over the updated files. However, you might need to run the Hub Server Installer and bypass this restriction (for example, installation was interrupted due to a hardware failure). In these circumstances, you can force a patch install by passing the following argument in the hub_install.bin or hub_install.exe command line:
-DSIPERIAN_FORCED_PATCH_INSTALL=true

This section provides troubleshooting instructions for Cleanse Match Server upgrades.
Running patchInstallSetup Manually

If you run the Cleanse Match Server installer and the automatic patch install failed, or if you accidentally answered No when asked whether to deploy to EAR file automatically, you can run the patchInstallSetup manually. 1. Go to the following directory (Siperian_Install_Directory):
2.
Windows: <Siperian_Install_Directory>\hub\cleanse UNIX: /<Siperian_Install_Directory>/hub/cleanse
Execute the patchInstallSetup script to deploy the Cleanse Match Server application and apply some changes to your application server configuration. Windows
Troubleshooting
49
WebLogic
patchInstallSetup.bat -Dweblogic.password=weblogic -Ddatabase.password=!!cmx!!
WebSphere
patchInstallSetup.bat -Ddatabase.password=!!cmx!!
JBoss
patchInstallsetup.bat
UNIX WebLogic
patchInstallSetup.sh -Dweblogic.password=<weblogic_password> -Ddatabase.password=<yourDBPassword>
Note: If you include the ! character in your password, you must include a \ before the ! character. For example, if your password is !!cmx!!, enter the password as follows: \!\!cmx\!\! WebSphere
patchInstallSetup.sh -Ddatabase.password=<yourDBPassword>
Note: If you include the ! character in your password, you must include a \ before the ! character. For example, if your password is !!cmx!!, enter the password as follows: \!\!cmx\!\! JBoss
patchInstallsetup.sh
Forcing a Patch Install

Important: Consult Siperian Support before attempting this operation. Once a patch install has occurred, the Cleanse Match Server Installer prevents you from running it again over the updated files. However, you might need to run the Cleanse Match Server Installer and bypass this restriction (for example, installation was interrupted due to a hardware failure). In these circumstances, you can force a patch install by passing the following argument in the hub_cleanse_install.bin or hub_ cleanse_install.exe command line:
-DSIPERIAN_FORCED_PATCH_INSTALL=true
Troubleshooting Hub Store Upgrades

This section provides troubleshooting instructions for Master Database and ORS database upgrades.
Restoring from a Full Backup

Re-running the upgrade on a partially upgraded schema will not work. Instead, if the upgrade failed, you need to go back to a clean version of the schema by restoring from a full database backup, which you created in Back Up Your Schema on page 17.
Check Metadata Consistency

After running the upgrade, launch the Metadata Manager in the Hub Console, run the validation process, generate a validation results report, and send the results to Siperian Support, along with the empty REPOS and tables.
Check the Database Debug Log

Save a copy of the database debug log the your upgrade documentation directory that you created previously in Create an Upgrade Documentation Directory on page 15. You enabled this database debug log in Enable the Siperian Hub Database Debug Log on page 18. Review the debug log for database errors. To find the debug log, refer to the path referenced in the Environment Report, which you generated using the Enterprise Manager tool in the Hub Console according to the instructions in Verify Your Siperian Hub Environment on page 15.
Troubleshooting
51
Check C_REPOS_DB_CHANGE
After upgrading the Master Database and all ORS databases, you can check C_REPOS_DB_CHANGE to see which scripts have been run. All of the scripts should have executed successfully. Make note of the script that was run last. The upgrade process will only apply scripts that have not been applied previously on the schema. If you encounter any failures, send the debug log and the schema to Siperian Support.
ORA-20005 Error When Upgrading an ORS

When you run sip_ant updateorsdatabase, if you encounter a ORA-20005 Error, refer to the following article:
http://siperian.custhelp.com/app/answers/detail/a_ id/518/kw/20005/r_id/100038
Index
A
audience vii
D
database debug log checking 51 enabling 18 deprecated functionality 10 documentation audience vii list of documents viii organization vii documentation changes 9 documenting the upgrade 15, 46
B
backup up 17 BDD user exits (new) 7 Business Data Director help, refreshing 39 testing with 44 upgrading 36
C
C_REPOS_DB_CHANGE 52 cleanse adapter changes 9 cleanse changes 9 Cleanse Match Server upgrades about 26 clustered deployment 28 log files 30 standalone deployment 26 steps 26 troubleshooting 49 cmxserver.log file 25, 30 custom code, testing 45 customer support x
F
forcing a patch install Cleanse Match Server 50 Hub Server 49
H
Hub Console, testing with 45 Hub Server upgrades about 21 clustered deployment 23 log files 25 standalone deployment 21 steps 21 troubleshooting 48
53
Hub Store upgrades about 31 Master Database 31 ORS databases 33 troubleshooting 51
L
log files application server log files 25, 30 Cleanse Match Server upgrades 30 cmxserver.log file 25, 30 database debug log 18 Hub Server upgrades 25 postInstallSetup.log file 25, 30 Siperian_Hub_Cleanse_Match_Server_ InstallLog.xml file 30 Siperian_Hub_Server_InstallLog.xml file 25 siperian_installer_debug.txt file 25, 30
Cleanse Match Server 49 Hub Server 48 platform changes 10 postInstallSetup.log file 25, 30 preface vii preparing available space 18 backup up 17 BDD queries 37 customizations 17 database debug log, enabling 18 validating content metadata 16 validating metadata 15
R
restoring from a full backup 51
S
server user exit changes 7 SIF API changes 8 siperian_installer_debug.txt file 25, 30 Siperian, contacting x stored procedures changes 8 support x
M
Master Database 31 match changes 8 metadata changes 7 Metadata Manager 15
O
ORS database 33
T
technical support x testing about testing 44 Business Data Director 44 custom code 45 Hub Console tools 45
P
patchInstallSetup
training x troubleshooting Cleanse Match Server upgrades 49 Hub Server upgrades 48 Hub Store upgrades 51
U
updates summary 5 XU SP2 Patch A 5 XU SP2 Patch B 6 upgrading about upgrading 2 Business Data Director 36 Cleanse Match Servers 26 documenting the process 15, 46 duration of 11 Hub Server 21 Hub Store 31 Master Database 31 multiple environments 3 ORS databases 33
overview of 3, 20 restarting environment 35 single environment 4 updates in this release 5 versions prior to XU SP2 2 XU SP2 versions 2 user exits, backing up 17 user exits, cmxue package 35
V
validating content metadata 16, 43 metadata 15, 43 verifying testing the upgraded environment 44 validating content metadata 43 validating metadata 43
X
XU SP2 Patch A changes 5 XU SP2 Patch B changes 6
55

Siperian Hub Upgrade Guide

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Siperian Hub Upgrade Guide

Uploaded by

Copyright:

Available Formats

Siperian Hub XU SP2

Chapter 2: Before You Upgrade

Chapter 3: Upgrade Siperian Hub

Siperian Hub XU SP2 Upgrade Guide

Chapter 4: After You Upgrade

Siperian Hub XU SP2 Upgrade Guide

Chapter 3, Upgrade Siperian Hub Upgrade steps.

Learning About Siperian Hub

Learning About Siperian Hub

Siperian Hub Release Notes

Siperian Hub Overview

Siperian Hub Installation Guide