siperian hub upgrade guide

8/6/2019 Siperian Hub Upgrade Guide

1/66

Siperian Hub XU SP2

Upgrade Guide


2/66

Copyright 2009 Siperian, Inc.

Copyright 2009 Siperian Inc. [Unpublished - rights reserved under the Copyright Laws of the UnitedStates]

Siperian and the Siperian logo are trademarks or registered trademarks of Siperian, Inc. in the US andother countries. All other products or services mentioned are the trademarks or service marks of theirrespective companies or organizations.

THIS DOCUMENTATION CONTAINS CONFIDENTIAL INFORMATION AND TRADESECRETS OF SIPERIAN, INC. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED

WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SIPERIAN, INC.


3/66

iii

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 ..............................................................................................................................5Functional 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


4/66

iv Siperian Hub XU SP2 Upgrade Guide

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............................................................................................................................. 21About 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................................................................................................................. 36Enabling Query Results De-duplication (Optional) ........................................................................ 36

Update BDD Queries........................................................................................................................... 37

Refresh Business Data Director Help................................................................................................ 39


5/66

Contents v

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..................................................................................................48Forcing 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..............................................................................................................51Check Metadata Consistency...............................................................................................................51

Check the Database Debug Log .........................................................................................................51

Check C_REPOS_DB_CHANGE....................................................................................................52

ORA-20005 Error When Upgrading an ORS...................................................................................52


6/66

vi Siperian Hub XU SP2 Upgrade Guide


7/66

vii

Preface

Welcome to the Siperian HubXU SP2 Upgrade Guide. This guide explains how toupgrade your Siperian Hub implementation to the most recent version.

Intended Audience

This guide is intended for technical specialists who are responsible for upgrading theirSiperian Hub implementation.

Organization

This guide contains the following chapters:

Chapter 1, Introduction Overview and key concepts for upgrading your SiperianHub implementation.

Chapter 2, Before You Upgrade Tasks to perform before you upgrade.

Chapter 3, Upgrade Siperian Hub Upgrade steps.

Chapter 4, After You Upgrade Tasks to perform after you upgrade.

Appendix A, Troubleshooting Tips for troubleshooting upgrade issues.


8/66

Learning About Siperian Hub

viii Siperian Hub XU SP2 Upgrade Guide


Whats New in Siperian Hub

Whats New in Siperian Hubdescribes the new features in this Siperian Hub release.

Siperian Hub Release Notes

The Siperian Hub Release Notescontain important information about this Siperian Hubrelease. Installers should read the Siperian Hub Release Notesbefore installing SiperianHub.

Siperian Hub Overview

The Siperian Hub Overviewintroduces 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 Guideexplains to installers how to set up Siperian Hub,the Hub Store, Cleanse Match Servers, and other components. There is a Siperian Hub

Installation Guidefor each supported platform.

Siperian Hub Upgrade Guide

The Siperian Hub Upgrade Guideexplains to installers how to upgrade a previousSiperian Hub version to the most recent version.

Siperian Hub Cleanse Adapter Guide

The Siperian Hub Cleanse Adapter Guideexplains to installers how to configure SiperianHub to use the supported adapters and cleanse engines.


9/66


ix

Siperian Hub Data Steward Guide

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

Siperian Hub Administrator Guide

The Siperian Hub Administrator Guideexplains to administrators how to use SiperianHub tools to build their organizations data model, configure and execute Siperian Hubdata management processes, set up security, provide for external application access toSiperian Hub services, and other customization tasks. After reading the Siperian HubOverview, administrators should read the Siperian Hub Administrator Guide.

Siperian Hub Services Integration Framework Guide

The Siperian Hub Services Integration Framework Guideexplains to developers how to usethe Siperian Hub Services Integration Framework (SIF) to integrate Siperian Hubfunctionality with their applications, and how to create applications using the dataprovided by Siperian Hub. SIF allows developers to integrate Siperian Hub smoothlywith 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 Guideexplains how to use the Siperian HubMetadata Manager tool to validate their organizations metadata, promote changesbetween repositories, import objects into repositories, export repositories, and relatedtasks.

Siperian Hub Resource Kit Guide

The Siperian Hub Resource Kit Guideexplains how to install and use the Siperian HubResource Kit, which is a set of utilities, examples, and libraries that assist developerswith integrating the Siperian Hub into their applications and workflows. This


10/66

Contacting Siperian

x Siperian Hub XU SP2 Upgrade Guide

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 proficientusers as quickly as possible. From initial installation onward, a dedicated team ofqualified 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 andwhen the next training session is offered, please visit Siperians web site or contactSiperian 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 Siperianrepresentative or distributor as specified in your support agreement. If you have acurrent Siperian Support Agreement, you can contact Siperian Technical Support:

We are interested in hearing your comments about this book. Send your comments to:

Method Contact Information

World Wide Web http://www.siperian.com

Email [email protected] U.S.: 1-866-SIPERIAN (747-3742)

by Email: [email protected]

by Postal Service: Documentation ManagerSiperian, Inc.100 Foster City Blvd.2nd FloorFoster City, California 94404 USA
https://gateway.wipro.com/,DanaInfo=www.siperian.com+https://gateway.wipro.com/,DanaInfo=www.siperian.com+


11/66

1

1Introduction

This chapter introduces the process of upgrading your Siperian Hub XU SP2 GA orXU 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([email protected]) for assistance.

Chapter Contents

About Upgrading to Siperian Hub XU SP2 Patch B

Overview of Upgrading

Updates in this Release

Before You Begin


12/66


2 Siperian Hub XU SP2 Upgrade Guide


This document provides the information and instructions necessary to upgrade toSiperian 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 toSiperian 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 SiperianHub XU SP2 GA, do not use this document. Instead, contact Siperian Support([email protected]) for assistance.


13/66


Introduction 3


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 mustdo so in each environment. Organizations typically upgrade environments in thefollowing 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 upgradeon a copy ofor representative sample ofproduction data. This allows theorganization to identify, document, and remedy possible issues before performing theactual production upgrade on the live environment.In addition, rather than upgrade (or

patch install) the production environment, some organizations choose to perform afullinstallwith a new Hub Store, and then use the Metadata Manager to migrate the data tothe new deployment. For instructions on performing a full Siperian Hub installation,see the Siperian Hub Installation Guidefor you platform.

A typical upgrade involves several steps, including planning, preparation,implementation, and testing. While each upgrade is different, a reasonable estimate ofthe time required to complete an upgrade is two-to-four months. The planning andpreparation tasks typically require one-to-three months of effort, depending on the


14/66



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 SiperianHub 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 Boccurs in three distinct phases, each with its own set of tasks.

Important: The instructions in this document assume that you are not making anymajor changes to your environment (such as database upgrades) while you are in themidst of upgrading your Siperian Hub implementation.

Phase Description

Preparation 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 toperform the upgrade, taking a snapshot of your system configurationbefore you upgrade, and enabling the database debug log so that you have adetailed trace of changes made to your Hub Store during upgrade. SeeChapter 2, Before You Upgrade.

Upgrade Tasks to upgrade your Siperian Hub implementationthe Hub Server,Cleanse Match Servers, Master Database, Operational Record Stores (ORSdatabases), and Business Data Director. See Chapter 3, Upgrade Siperian

Hub.

Verification Tasks to perform after you run the upgrade to verify that the upgradeprocess completed successfully. See Chapter 4, After You Upgrade.


15/66


Introduction 5


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 andenhancements for specific releases, see the associated Whats New in Siperian Hubdocument available on the FTP site or on Siperian SHARE.

Note: Unless explicitly noted, no changes were made in Hot Fixes or XU SP2 Patch ARollup 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

MRM Hub

Null Value Enhancements

Resource Kit Enhancements


16/66



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 andtypeahead

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 functionswhile maintaining and saving data within a subject area.

MRM Hub

A new Cleanse Adapter for Informatica Data Quality (Web Services)

Support for Trillium 12


17/66


Introduction 7

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.

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 orPatch A. These are specific to the BDD and have no impact on any database UserExits. For more information, see the Siperian Hub Business Data Director ImplementationGuide.

VersionIntroduced Action Affected Table

XU SP2 Patch A (XU SP2 GA -> XU SP2 Patch A)

Add Column C_REPOS_DB_RELEASE.EXPLICIT_MERGE_CONSOL_1_IND

XU SP2 Patch B (XU SP2 Patch A -> XU SP2 Patch B)

Add Column C_REPOS_CL_FUNCTION_LIB.WSDL_PORT

Add Column C_REPOS_CL_FUNCTION_LIB.WSDL_SERVICE

Add Column C_REPOS_CL_FUNCTION_LIB.WSDL_URI

Add Column C_REPOS_SUBJECT_AREA.LABEL_FORMAT_STR

Add Column C_REPOS_SUBJECT_AREA.LABEL_ROWID_COLUMN_LIST


18/66



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 torecalculate BVT on the base object. This change does not require any changes to jobexecution and ETL scripts unless you want to refresh BVT on the base object after therevalidate.

SIF API Changes

The following SIF API changes were made in Siperian Hub XU SP2 Patches A and B.

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

Services implemented on top of Siperian Hub do notneed to be repackaged with thelatest version of the SIF client libraries.

Match Changes

There are no match changes or SSA updates since XU SP2 GA.

Version Introduced API Call Change(s)

XU SP2 Patch A (XU SP2 GA -> XU SP2 Patch A)

GetOneHopRequest getOneHop did not return the total number of relationships.

The recordCount field has been added to the response.

XU SP2 Patch B (XU SP2 Patch A -> XU SP2 Patch B)

SearchQueryRequest Changes to the searchQuery API to support grandchildren.There can be up to three match path components specified asjoinUids to allow including additional columns in the searchquery result.

AuthenticateResponse Return username as part of authenticate response. If username

was not part of the request, take username from user profile if ithas been set. This can be used in cases where a custom SAMprovider is used that takes no username parameter.


19/66


Introduction 9

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 Guidefor 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 orXU SP2 Patch B.

About Deprecation

The term deprecationis applied to software features that are superseded and should beavoided. Although deprecated features remain in the current version, it should beanticipated that the feature will be removed in a future release.


20/66



Previously-deprecated Functionality

Data Groups tool have been deprecated.

Environment Staging has been deprecated post XU-SP1 and replaced byfunctionality 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 postXU-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 METmigration.

Relationship tables have been deprecated. Use relationship base objects for thisfunctionality 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 newHub implementations. This functionality is superseded by the Services IntegrationFramework (SIF). More information about SIF can be found in the Siperian_Hub_SIF_Guide.pdf available on SHARE.

Supported Platform ChangesUpgrading the Siperian Hub and Cleanse Match Servers is supported on all theplatforms on which the Siperian Hub is supported. The supported platforms describedin the Siperian Hub Release Notesremains the same as it was for the XU SP2 GA release.For more information, see the Siperian Hub Release Notes.


21/66

Before You Begin

Introduction 11

Before You Begin

Read this section before you begin the process of upgrading your Siperian Hubenvironment.

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. Ifyou have multiple versions of Siperian Hub installed, each version must be installedin a separate environment. Different versions of Siperian Hub cannotco-exist in thesame environment.

Your environment complies with the Siperian Hub XU SP2 hardware and softwarerequirements for your platform. These software requirements include any unlockcodes required for your cleanse engine. To learn more about the requirements, seethe Siperian Hub Release Notes.

You are not making any major changes to your environment (such as databaseupgrades) while you are in the midst of upgrading your Siperian Hubimplementation.

Duration of Upgrade

The duration of the upgrade process is determined by the number and size of yourbase objects. XU SP2 Patch B is a low-impact upgrade that, for a basic configuration,can usually be completed in a few hours.


22/66

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:

Important: The instructions in this document remind you to capture and save thisinformation if needed for future reference. In Create an Upgrade DocumentationDirectory on page 15, you will create a folder (such as upgradedoc) where you willcentrally store copies of all your upgrade documentation.

Information About Source of Information

ORS metadata Validation Results report from the Metadata Manager tool in the HubConsole. Used to document ORS metadata before and the upgrade.For instructions, see Siperian Hub Metadata Manager Guide.

configuration settings Environment Report from the Enterprise Manager tool in the HubConsole. Used to document Hub Server, Cleanse Match Server,Master Database, and ORS database information before and after theupgrade. For instructions, see Appendix D, Viewing ConfigurationDetails, in the Siperian Hub Administrator Guide.

content metadata ZIP archive file containing the results of running the DVT (datavalidation) scripts that validate your content metadata.

database changes Database debug log. Used to log database events for your Hub Store.Enabled according to the instructions in the Siperian Hub InstallationGuidefor your platform.

upgrade process Siperian Hub Installer log files. Used to log upgrade events for yourHub Server and Cleanse Match Server upgrades.

Hub Server andCleanse Match Server

Hub Server and Cleanse Match Server log files

Hub Console Hub Console log files


23/66

13

2Before You Upgrade

This chapter describes what you need to do beforeupgrading your Siperian Hub XUSP2 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

P ti O i


24/66




Before you upgrade, you need to complete the following tasks.

Step Task Instructions

1 Create a documentation folder Create an Upgrade DocumentationDirectory on page 15

2 Run Metadata Manager to validate anddocument your ORS to ensure that thereare no errors

Validate Your Metadata on page 15

3 Run Enterprise Manager to review anddocument your current Siperian Hubenvironment

Verify Your Siperian Hub Environmenton page 15

4 Run data validation scripts to validateyour content metadata

Validate Content Metadata on page 16

5 Back up key Siperian Hub components Back Up Your Current Implementationon page 17

6 Review space requirements Verify Available Space on page 18

7 Enable the database debug log Enable the Siperian Hub Database DebugLog on page 18



25/66


Before You Upgrade 15

Create an Upgrade Documentation Directory

Create a folder (such as upgradedoc) where you will centrally store copies of all yourupgrade artifactssuch as the Validation Results and Environment reports, databasedebug log, log files, and other items described in Documenting Your Upgrade onpage 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 HubStore with any invalid metadata may not perform as expected. To validate your

metadata, run the validation process using the Metadata Manager in the Hub Consoleaccording to the instructions in the Siperian Hub Metadata Manager Guide. Resolve anyvalidation issues encountered and re-run validation. Contact Siperian Support if youneed assistance.

Important: When finished, save a copy of the final validation results in your upgradedocumentation folder that you created in Create an Upgrade DocumentationDirectory on page 15.


Use the Enterprise Manager tool in the Hub Console to review your current SiperianHub configuration for Hub Servers, Cleanse Match Servers, the Master Database, andORS 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 upgradedocumentation folder that you created in Create an Upgrade DocumentationDirectory on page 15.



26/66




Your content metadata is information that describes the data that has been loaded intothe Hub Store. Siperian provides DVT (data validation) scripts that that you can run tovalidate your content metadata.

1. Contact Siperian Support to obtain the DVT scripts that apply to your SiperianHub implementation.

2. Run the DVT scripts according to the instructions in the readme that accompaniesthe DVT distribution.

At the end of the execution process, the scripts package the result files into a ZIParchive. 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 manyof them have been executed, and what time it took to complete them

3. Send the ZIP archive to Siperian Support ([email protected]) for analysis.

Important: Save a copy of the ZIP results in the upgrade documentation folder thatyou created in Create an Upgrade Documentation Directory on page 15.



27/66


Before You Upgrade 17


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 fromthis backup (there is no automatic rollback of the upgrade changes). Contact yourdatabase 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 manuallyreapply the customizations after you perform the upgrade. You may need to update theuser exits based on the XU SP2 Patch B stored procedure definitions.

Back Up Customizations

Any customizations that are registeredin the Hub Console (such as custom queries,custom functions, registered custom indexes, and so on) are automatically included inthe upgrade process. Be sure to register any unregistered custom indexes.

Any customizations that are notregistered in the Hub Console (such as user exits,custom client Java code, custom stored procedures, custom buttons, unregisteredcustom queries, and so on) require special attention. Before you start to upgrade, take

an inventory of all customizations in your Siperian Hub implementation and ensurethat 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 Directorif you have modified them in any way.



28/66

y p



Space requirements are minimal for upgrading to XU SP2 Patch B. To ensure sufficientstorage space to complete the upgrade, a good rule of thumb is to use the followingformula:

(2 x Hub Store Size) x 20%

Enable the Siperian Hub Database Debug LogMake sure that you have turned on the Siperian Hub database debug log(cmx_debug.log) according to the instructions in Enabling Debug Logging in theSiperian Hub Installation Guidefor your platform (Windows or UNIX). The databasedebug log contains run-time logging information for stored procedures that have beenexecuted. The Environment Report generated using the Enterprise Manager toolprovides the full path to your database debug log.

Note: If you have any difficulties enabling the CMX database debug log, contactSiperian Support. It is essentialto have this debug log enabled before starting theupgrade.


29/66

19

3Upgrade Siperian Hub

This chapter describes the tasks that you need to perform to your Siperian Hub XUSP2 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

Upgrade Overview


30/66


Upgrade Overview

Note: If you need help obtaining the Siperian Hub XU SP2 Patch B distribution,contact Siperian Support ([email protected]).

To upgrade your Siperian Hub implementation, complete the following general steps:

Once you have completed these steps, proceed to Chapter 4, After You Upgrade.


1 Upgrade the Hub Server by running theHub Server installer provided in thedistribution.

Upgrading the Hub Server on page 21

2 Upgrade any Cleanse Match Servers inyour Siperian Hub implementation byrunning the Cleanse Match Serverinstaller provided in the distribution.

Upgrading Cleanse Match Servers onpage 26

3 Upgrade the Master Database (CMX_SYSTEM) by running theupdatemasterdatabase script.

Upgrading the Master Database onpage 31

4 Upgrade ORS databases by running theupdateorsdatabase script. Upgrading ORS Databases on page 33

5 Restart your application servers, clearJava Web Start, and other

Restarting Your Environment on page35

6 Update Business Data Director Updating Business Data Director onpage 36



31/66

Upgrade Siperian Hub 21


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

About the Hub Server Upgrade

The Hub Server is the Siperian Hub software that runs in the application serverenvironment and provides core and common services, including access, security, andsession management.

To upgrade the Hub Server, you run the Hub Server Installer provided in thedistribution. The Hub Server Installer recognizes that this is an upgrade (patchinstallationinstead of a full installation) when, during installation, you point to yourexisting Siperian Hub installation as the target. Before overwriting your existingsoftware, 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 appropriatefor 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. Log in under the username that was used to install the Hub Server (see the Siperian

Hub Installation Guidefor details).

3. Run the Hub Server Installer to start the upgrade.

Windows: The Hub Server installer (hub_install.exe) is located on thedistribution in the \mrmserver\windows directory.



32/66


UNIX: The Hub Server installer (hub_install.bin) is located on thedistribution in the /mrmserver/ directory.

Note: For UNIX or Linux environments, if you are using character consolemode (when X-Windows is not available) to upgrade, then use the followingcommand:

./hub_install.bin -console

4. In the Introduction screen, clickNext to continue

5.

In the License Agreement screen, accept the terms and clickNext.6. In the Choose Install Folder screen, click the Choose... button, then locate and

select your previous Siperian Hub installation.

7. ClickNext.

8. In the Version Warning message, clickOKto confirm that you want to proceed.

9. If your previous installation uses WebLogic as its application server, the Hub

Server Installer prompts you to provide the WebLogic Admin password.

10. In the Deploy screen, clickYes to deploy automatically, and clickNext.

11. In the Pre-Installation Summary screen, if you want to change any options, clickthe Previous button to navigate back to previous screens and change yourselections.

Once the summary reflects the options you want, clickInstall to start theinstallation process.

The Hub Server Installer displays the Please Wait screen while it configures yoursystem. 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 storedin a backup folder in your Siperian Hub installation directory: The filename of thearchive 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. ClickDone to exit the Hub Server installer.

Note: If the install fails to complete successfully, the last screen of the Hub Serverinstaller will state that the patch failed and include a pointer to the appropriate log



33/66


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 DocDirectory 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. Log in under the username that was used to install the Hub Server (see the SiperianHub Installation Guidefor details).

3. Run the Hub Server Installer to start the upgrade.

Windows: The Hub Server installer (hub_install.exe) is located on thedistribution in the \mrmserver\windows directory.

UNIX: The Hub Server installer (hub_install.bin) is located on thedistribution in the /mrmserver/ directory.

Note: For UNIX or Linux environments, if you are using character consolemode (when X-Windows is not available) to upgrade, then use the following

command:./hub_install.bin -console

4. In the Introduction screen, clickNext to continue

5. In the License Agreement screen, accept the terms and clickNext.

6. In the Choose Install Folder screen, click the Choose... button, then locate andselect your previous Siperian Hub installation.

7. ClickNext.


9. If your previous installation uses WebLogic as its application server, the HubServer Installer prompts you to provide the WebLogic Admin password.

10. In the Deploy screen, choose No because you will deploy the EAR file manually.



34/66



Once the summary reflects the options you want, clickInstall to start theinstallation process, and clickNext.

The Hub Server Installer displays the Please Wait screen while it configures yoursystem. 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 thearchive uses a pattern similar to the following example:

Siperian Hub Server-2009-10-06_18-09.jar


12. ClickDone 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 theappropriate log file with the error or failure messages. To learn more about what todo if the install/upgrade fails, see Troubleshooting Hub Server Upgrades onpage 48.

13. Run following command to repackage the EAR file:

Windows

cd \bin

sip_ant.bat repackage

UNIX

cd /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 toyour application server documentation.

15. Save a copy of the Hub Server log files in your upgrade documentation directoryaccording to the instructions in Copy Hub Server Log Files to the Upgrade DocDirectory on page 25.



35/66


Copy Hub Server Log Files to the Upgrade Doc Directory

Once you have completed the Hub Server upgrade, copy the following log files to theupgrade documentation folder you created in Create an Upgrade DocumentationDirectory on page 15. You may need these log files to assist with troubleshooting. Formore information, see About the Siperian Hub Log Files in the Siperian HubInstallation Guide.

Important: You should save these files in a separate folder (such as hub_server_upgrade). If you upgraded multiple Hub Servers in a cluster, copy the files for eachHub Server instance into its own folder.

When finished, proceed to the next section, Upgrading Cleanse Match Servers onpage 26.

File Description/hub/server/Siperian_Hub_Server_InstallLog.xml

Contains log messages for the HubServer installation.

/hub/server/siperian_installer_debug.txt

Contains debug messages and allthe options that you selected whenyou ran the installation.

/hub/server/logs/patchInstallSetup.log

Contains thepatchInstallSetup messagesfor the script.

/hub/server/logs/cmxserver.log

Hub Server log. When the serverstarted, it created this file.

Application server log files. Located in the tree under the installdirectory for your applicationserver.

Upgrading Cleanse Match Servers


36/66



This section describes how to upgrade Cleanse Match Servers in your Siperian Hubimplementation.

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 theCleanse Match Server, you run the Cleanse Match Server Installer provided in thedistribution. The Cleanse Match Server Installer recognizes that this is an upgrade(patch installationinstead of a full installation) when, during installation, you point toyour existing Siperian Hub installation as the target. Before overwriting your existingsoftware, 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), ormultiple Cleanse Match Servers can be deployed in a cluster. Follow the instructionsthat are appropriate for your Siperian Hub implementation. If you encounter anyproblems, 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 isrunning.

Check the Jade library version according to the instructions in the CleanseAdapter Guide.

3. Start up the application server on which your Cleanse Match Server is deployed,and make sure that it is up and running.



37/66


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) islocated in the //mrmcleanse directory on the distribution.

Note: For UNIX or Linux environments, if you are using character consolemode (when X-Windows is not available) to upgrade, then use the following

command:./hub_cleanse_install.bin -console

5. In the Introduction screen, clickNext.


7. In the Choose Install Folder screen, click the Choose... button to locate yourprevious Cleanse Match Server installation, and then clickNext.


9. If your previous installation uses WebLogic as its application server, the CleanseMatch Server Installer prompts you to provide the WebLogic Admin password.Enter the WebLogic password.

10. In the Deploy screen, chooseYes to deploy the Cleanse Match Serverautomatically, and then choose Next.


Once the summary reflects the options you want, clickInstall to start theinstallation process.

The Cleanse Match Server Installer displays the Please Wait screen while itconfigures your system. During this process, the Cleanse Match Server Installerwill back up critical files (except what is in the tmp folder), compressing them intoan archive that is stored in a backup folder in your Siperian Hub installationdirectory: The filename of the archive uses a pattern similar to the followingexample:

Siperian Hub Cleanse Match Server-2009-11-26_17-21.jar



38/66



12. ClickDone to exit the Cleanse Match Server installer.Note: If the upgrade fails to complete successfully, the last screen of the CleanseMatch Server installer will state that the patch failed and include a pointer to theappropriate log file with the error or failure messages. To learn more about what todo if the install/upgrade fails, see Troubleshooting Cleanse Match ServerUpgrades on page 49.

13. Save a copy of the Cleanse Match Server log files in your upgrade documentationdirectory according to the instructions in Copy Cleanse Match Server Log Files tothe 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 isrunning.

Check the Jade library version according to the instructions in the CleanseAdapter 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) islocated in the //mrmcleanse directory on the distribution.

Note: For UNIX or Linux environments, if you are using character consolemode (when X-Windows is not available) to upgrade, then use the followingcommand:

./hub_cleanse_install.bin -console

5. In the Introduction screen, clickNext.



39/66



7. In the Choose Install Folder screen, click the Choose... button to locate yourprevious Cleanse Match Server installation, and then clickNext.


9. If your previous installation uses WebLogic as its application server, the CleanseMatch Server Installer prompts you to provide the WebLogic Admin password.

Enter the WebLogic password.

10. In the Deploy screen, choose No because you will deploy the Cleanse MatchServer manually.


Once the summary reflects the options you want, clickInstall to start the

installation process.

The Cleanse Match Server Installer displays the Please Wait screen while itconfigures your system. During this process, the Cleanse Match Server Installerwill back up critical files (except what is in the tmp folder), compressing them intoan archive that is stored in a backup folder in your Siperian Hub installationdirectory: The filename of the archive uses a pattern similar to the followingexample:

Siperian Hub Cleanse Match Server-2009-11-26_17-21.jar


12. ClickDone to exit the Cleanse Match Server installer.

Note: If the upgrade fails to complete successfully, the last screen of the CleanseMatch 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 todo if the install/upgrade fails, see Troubleshooting Cleanse Match ServerUpgrades on page 49.

13. Run following command to repackage the EAR file:

Windows

cd \bin

sip_ant.bat repackage



40/66


UNIX

cd /bin./sip_ant.sh repackage

14. Open the application server administration console (WebLogic Server orWebSphere) and manually deploy the Cleanse Match Server EAR file.For instructions, refer to your application server documentation.

15. Save a copy of the Cleanse Match Server log files in your upgrade documentationdirectory according to the instructions in Copy Cleanse Match Server Log Files to

the Upgrade Doc Directory on page 30.

Copy Cleanse Match Server Log Files to the Upgrade DocDirectory

Once you have completed the Cleanse Match Server upgrade, copy the following log

files to the upgrade documentation folder you created in Create an UpgradeDocumentation Directory on page 15. You may need these log files to assist withtroubleshooting. For more information, see About the Siperian Hub Log Files in theSiperian Hub Installation Guide.

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, copythe files for each Cleanse Match Server instance into its own folder.

File Description

/hub/cleanse/Siperian_Hub_Cleanse_Match_Server_InstallLog.xml

Shows the Cleanse Match Server installerrors and status.

/hub/cleanse/logs/patchInstallSetup.log

Shows the patchInstallSetup scriptresults.

/hub/cleanse/logs/cmxserver.log

Cleanse server logs.

/hub/cleanse/siperian_installer_debug.txt

Shows what was chosen during theupgrade installation.

Application server log files. Located in the tree under the installdirectory for your application server.

Upgrading the Hub Store


41/66


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

About Hub Store Upgrades

The Hub Store is the database that contains your Master Database and one or moreOperational Record Store (ORS) databases. You must use scriptsprovided in thedistribution to upgrade all of these databases according to the instructions inUpgrading the Master Database on page 31 and Upgrading ORS Databases onpage 33. If you encounter problems during the upgrade, refer to the tips inTroubleshooting Hub Store Upgrades on page 51.

Important: If you made changes to the metadata in any way other than through theSiperian 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 completedthe tasks described in Chapter 2, Before You Upgrade. You can update the databaseonly after you have successfully installed and patched the Hub Server softwareaccording 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



42/66


3. Provide the following information for your Master Database:

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 theuser really granted the privilege, and returns to the prompts, starting at theTNS name prompt.

AYes 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 processautomatically grants the privilege and continues the upgrade process.

File Description

TNS name Name by which your database is known on the network.

Master DB hostname Name of the host running your Master Database.

Master DB port number Port number on which Oracle is listening.

Master DB SID Database system identifier.

Master DB user name Upgrade process expects the user name CMX_SYSTEM.

Master DB user password Upgrade process expects the password for the user nameCMX_SYSTEM.

CMX DB user name Upgrade process expects the user name CMX.

CMX DB user password Upgrade process expects the password for the user nameCMX.



43/66


5. For JBoss, after you run updatemasterdatabase, you need to restart the JBossAppServer. Otherwise, when you launch the Hub Console, you will get an error.

6. Save a copy of the sip_ant log file in your upgrade documentation directoryaccording to the instructions in Copy Hub Server Log Files to the Upgrade DocDirectory on page 25. The log file is stored in the following directory:

\server\resources\database\db_changes\oracle\ORS

Important: The sip_ant log file is overwritten every time you execute sip_antfrom the command line. You must save a backup copy before you run sip_antagain.

Upgrading ORS Databases

Important: The instructions in this section assume that you have already completedthe 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 schemabefore 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:\hub\server\bin

UNIX:/hub/server/bin

3. Update your ORS database with the following command:

Windows:sip_ant.bat updateorsdatabase

UNIX:

./sip_ant.sh updateorsdatabase



44/66


4. Provide the following information for your ORS database:

5. During the ORS upgrade process, if you see the following questions, respondaccordingly. You may need to answer the following questions if your ORS does nothave a PROXY_ROLE defined, or if a PROXY_ROLE is not granted to the ORSdatabase.

question.grant.create.proxy_role:

This upgrade should be performed by a DBA to create proxy_rolefor 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 upgradedocumentation directory according to the instructions in Copy Hub Server LogFiles to the Upgrade Doc Directory on page 25. The log file is stored in thefollowing directory:

\server\resources\database\db_changes\oracle\ORS

Important: The sip_ant log file is overwritten every time you execute sip_antfrom the command line. You must save a backup copybeforeyou run sip_antagain (for example, to upgrade next ORS).

File Description

TNS name Name by which your ORS database is known on thenetwork.

Schema Name of your ORS database.

User password Upgrade process expects the password for the user nameCMX_USER.



45/66


7. Save a copy of the database debug log the your upgrade documentation directorythat you created previously in Create an Upgrade Documentation Directory onpage 15. You enabled this database debug log in Enable the Siperian HubDatabase Debug Log on page 18. To find the debug log, refer to the pathreferenced in the Environment Report, which you generated using the EnterpriseManager tool in the Hub Console according to the instructions in Verify YourSiperian Hub Environment on page 15.

8. If you have backed up your customized user exit stored procedures as specified in

Back Up User Exits on page 17, edit thecmxue

package in the followinglocation:

\server\resources\database\oracle

Apply the cmxue package to the ORS.

When finished, proceed to Restarting Your Environment on page 35.


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

2. Clear Java Web Start according to the instructions in the vendor documentation.You must do this because you now have an updated Siperian certificate.

3. Clear the Java cache according to the instructions in the vendor documentation.

4. Start the application servers that run the Hub Server and any Cleanse MatchServers.

5. Proceed to the next section, Updating Business Data Director on page 36.



46/66



This section describes tasks to update Business Data Director in your upgradedSiperian 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 itby adding a SIF-related property to the cmxserver.properties file.

To enable query results de-duplication:

1. Open the cmxserver.properties file:

Windows:\server\resources\cmxserver.properties

UNIX:/server/resources/cmxserver.properties

2. 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. Save your changes.4. Restart the Hub Server application for your changes to take effect.

WebSphere and WebLogic: Restart the application using the applicationserver administration console application.

JBoss: Restart the application server.



47/66


Update BDD Queries

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

Example of a BDD Query that Requires Updating

In the following example, beforethe upgrade, the Person subject area had two childobjectsBill Address and Ship Addressas shown in the Query Builder:

In the following example, afterthe upgrade to XU SP2 Patch B, the Bill Address and

Ship Address were merged into one Address subject area, because they bothreferenced the same physical base object and had the same match path UID configuredin BDDConfig.xml.



48/66


Note, however, that this new subject area node contains an additionalattributeAddress 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 insearch. If the type column is selected in a query, BDD renders it as a drop-down listpopulated 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, twoattributes need to be specified: Address Type (Bill Address) and Address Line 1.



49/66


BDD Query Update Steps

To update affected BDD queries:

1. Log into the BDD application.

2. Open the Query Builder.

3. Click the Saved Queries tab.

4. Mouse-over all saved queries to display the tool-tip showing the query definition.

Determine whichif anysaved queries require updating because they use anewly-created composite object (in the previous example, Address is thecomposite object).

5. For each query that uses a newly-created composite object, open the query, add theapplicable type attribute (in our example, Address type), select the appropriatevalue (in our example, Bill Address or Ship Address), and then save the query.

Refresh Business Data Director Help

For BDD upgrades, users will need to manually refresh the BDD Help for any existingapplications:

1. Obtain the BDDHelp.zip file from the Docs folder included with the FTP package.

2. Launch and login to the BDD Configuration Manager.

3. Select the BDD application for which you want to update the Help.

4. From the command menu, choose Import > Import to existing BDDApplication.

a. From the Configuration Type drop-down list, choose BDD Help and browseto the updated BDDHelp.zip file.

b. Complete the import to replace the existing Help file with the updated releaseversion.



50/66



51/66

41

4After You Upgrade

This chapter describes the tasks that you need to perform afterupgrading your SiperianHub 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




52/66



After completing an upgrade, complete the following tasks:


1 Run metadata validation on the ORS toensure that there are no errors.

Validate the Upgraded Metadata onpage 43

2 Run Enterprise Manager and Review theServer / Cleanse and ORS configuration

Verify Your Upgraded Siperian HubEnvironment on page 43

3 Run content metadata validation Validate the Upgraded ContentMetadata on page 43

4 Test Batch, API and BDD operations Test the Upgraded Environment onpage 44

5 Archive upgrade documentation Archive the Upgrade DocumentationDirectory on page 46




53/66

After You Upgrade 43


After upgrading, validate your metadata again and compare the results with theprevious results obtained in Validate Your Metadata on page 15. Run the validationprocess using the Metadata Manager in the Hub Console according to the instructionsin the Siperian Hub Metadata Manager Guide. Resolve any validation issues encounteredand re-run validation. Contact Siperian Support if you need assistance.

Important: When finished, save a copy of the final validation results (under a differentname) in your upgrade documentation folder that you created earlier (see Create anUpgrade 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, andORS databases. Review the version history as well. Compare this with the previousresults 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 anUpgrade Documentation Directory on page 15).


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 ([email protected]) if youencounter 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 UpgradeDocumentation Directory on page 15).




54/66



This section provides some suggestions for testing your upgraded Siperian Hubimplementation. Every Siperian Hub implementation is unique, and testingrequirements vary across environments (DEV, QA/TEST, and PROD). Therefore,your test activities should be designed to meet the unique requirements of yourimplementation.

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 Hubimplementation within Business Data Director:

If a BDD application is not currently deployed, launch the BDD ConfigurationManager 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


55/66

After You Upgrade 45

Testing with Hub Console Tools

Consider performing any or all of the following operations to test your Siperian Hubimplementation 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 theREPOS layout)

Connect to an ORS and run the Schema Viewer to look at the schema, and thenrun the Schema Manager to view match properties for a base object (verifies theCMX_ORS REPOS tables)

Run the Batch Viewer (verifies the Table_Object_View). If possible, execute testbatch jobs for Stage, Load, Match, and Merge jobs.

In the Cleanse Match Server tool, test connections to any registeredCleanse/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 testrecord, make a copy of the test record, find the test records, merge them, and thenunmerge them.

Testing Custom CodeIf you have custom code, such as client applications or custom stored procedures, runtests to verify that they work as expected.




56/66



Important: If you are upgrading a production environment, before you go live, youmustsubmit a copy of your upgrade documentation (see Documenting Your Upgradeon page 12) in order to flag and address potential upgrade issues. This is alsorecommendedbut not mandatoryfor upgrades to non-production environments.

Submit the following upgrade documentation to Siperian Support([email protected]):

pre-upgrade and post-upgrade validation results from the Metadata Manager

pre-upgrade and post-upgrade Environment Report results from the EnterpriseManager

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


57/66

47

ATroubleshooting

This appendix provides supplemental troubleshooting tips for Siperian Hub XU SP2Patch 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

Troubleshooting Hub Server Upgrades

Troubleshooting Hub Server Upgrades


58/66


g pg

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 youaccidentally 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):

Windows: \hub\server

UNIX: //hub/server

2. Execute the patchInstallSetup script to deploy the Hub Server application andapply 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=

-Ddatabase.password=

Note: If you include the ! character in your password, you must include a\ before the ! character. For example, if your password is !!cmx!!, youneed to enter the following: \!\!cmx\!\!

WebSphere

patchInstallSetup.sh -Ddatabase.password=


Note: If you include the ! character in your password, you must include a b f h h F l if d i


59/66

Troubleshooting 49

\ 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 runningit again over the updated files. However, you might need to run the Hub ServerInstaller and bypass this restriction (for example, installation was interrupted due to ahardware failure). In these circumstances, you can force a patch install by passing thefollowing 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, orif you accidentally answered No when asked whether to deploy to EAR fileautomatically, you can run the patchInstallSetup manually.

1. Go to the following directory (Siperian_Install_Directory):

Windows:\hub\cleanse

UNIX://hub/cleanse

2. Execute the patchInstallSetup script to deploy the Cleanse Match Serverapplication and apply some changes to your application server configuration.

Windows


WebLogic


60/66


patchInstallSetup.bat -Dweblogic.password=weblogic

-Ddatabase.password=!!cmx!!

WebSphere

patchInstallSetup.bat -Ddatabase.password=!!cmx!!

JBoss

patchInstallsetup.bat

UNIX

WebLogic

patchInstallSetup.sh -Dweblogic.password=

-Ddatabase.password=

Note: If you include the ! character in your password, you must include a\ before the ! character. For example, if your password is !!cmx!!, enter thepassword as follows: \!\!cmx\!\!

WebSphere

patchInstallSetup.sh -Ddatabase.password=

Note: If you include the ! character in your password, you must include a\ before the ! character. For example, if your password is !!cmx!!, enter thepassword 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 youfrom running it again over the updated files. However, you might need to run theCleanse Match Server Installer and bypass this restriction (for example, installation wasinterrupted due to a hardware failure). In these circumstances, you can force a patchinstall by passing the following argument in the hub_cleanse_install.bin or hub_cleanse_install.exe command line:

-DSIPERIAN_FORCED_PATCH_INSTALL=true




61/66

Troubleshooting 51

This section provides troubleshooting instructions for Master Database and ORSdatabase upgrades.

Restoring from a Full Backup

Re-running the upgrade on a partially upgraded schema will notwork. Instead, if the

upgrade failed, you need to go back to a clean version of the schema by restoring froma 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 thevalidation 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 thatyou created previously in Create an Upgrade Documentation Directory on page 15.You enabled this database debug log in Enable the Siperian Hub Database DebugLog on page 18. Review the debug log for database errors.

To find the debug log, refer to the path referenced in the Environment Report, whichyou generated using the Enterprise Manager tool in the Hub Console according to theinstructions in Verify Your Siperian Hub Env

siperian hub upgrade guide

Documents