Siperian Hub XU for DB2. User s Guide

Transcription

1 XU Siperian Hub XU for DB2 User s Guide

2 2008 Siperian, Inc. Copyright 2008 Siperian, Inc. [Unpublished - rights reserved under the Copyright Laws of the United States] THIS DOCUMENTATION CONTAINS CONFIDENTIAL INFORMATION AND TRADE SECRETS OF SIPERIAN, INC. USE, DISCLOSURE OR REPRODUCTION IS PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SIPERIAN, INC. Siperian and the Siperian logo are trademarks or registered trademarks of Siperian, Inc. in the US and other countries. All other products or services mentioned are the trademarks or service marks of their respective companies or organizations.

3 Contents Preface Intended Audience...vii Organization...vii Learning About Siperian Hub...viii Contacting Siperian...x Chapter 1: Introducing Siperian Hub Introducing Master Data Management and Customer Data Integration...2 Components of Siperian Hub...3 Master Reference Manager...3 Hierarchy Manager...5 Activity Manager...6 Siperian Hub Architecture...6 Overview of the Siperian Hub Data Management Process...8 About Source Systems...8 Data Loading Stages for Batch Processes...8 Overall Process Flow...10 Trust Levels for Source Systems...11 Cleanse Process...11 Match Process...12 Consolidation Process...14 Siperian Hub Tools for Data Stewards...15 Chapter 2: Getting Started with the Hub Console About the Siperian Hub Console...18 Starting the Hub Console...20 iii

4 Chapter 3: Using the Siperian Hub Data Management Tools About Data Management in Siperian Hub About the Tools for Managing Data in Hub Store Overview of the Consolidation Process Using the Merge Manager Tool About the Merge Manager Starting the Merge Manager Setting Up a Merge Changing a Record to Unmerged or On Hold Matched Data About Merging Cell Data Manually Merging Records Using the Data Manager Tool About the Data Manager Starting the Data Manager Setting Up a Data Manager Session Instances for Base Object Records Via Package Cross-reference Instances Cell Data Editing Records About Unmerging Records Unmerging Records Querying, Editing, and Unmerging Records Using the Search Wizard to See a Subset of the Data Chapter 4: Using Hierarchy Manager About Hierarchy Manager About the Hierarchy Manager Tools About Transactional and Master Data Starting the Hierarchy Manager Tool Navigating Hierarchy Manager About Views in Hierarchy Manager iv Siperian Hub XU for DB2 User s Guide

5 Hierarchy Manager Tool Menu...99 Searching For Entities and Relationships About the Search for Data Objects Screen About Searches Working with Entities and Relationships About Fetching Relationships Managing Entities and Relationships Using Bulk Operations Working with Sandboxes Glossary Index Contents v

6 vi Siperian Hub XU for DB2 User s Guide

7 Preface Welcome to the Siperian Hub XU User s Guide. This guide explains how to use Siperian Hub. Intended Audience Organization This guide is intended for data stewards, who are the custodians of data quality. In Siperian terms, data stewards are the people responsible for reviewing and where necessary correcting and manually merging business data on a regular and ongoing basis. This guide contains the following chapters: Chapter 1, Introducing Siperian Hub Chapter 2, Getting Started with the Hub Console Chapter 3, Using the Siperian Hub Data Management Tools Chapter 4, Using Hierarchy Manager Glossary Introduces some of the key terms and concepts of Siperian Hub and is intended for all users. Explains how to use the basic functions of Siperian Hub and is intended for all users. Explains how to use data steward tools (Merge Manager and Data Manager) for reviewing, merging, unmerging, and correcting data. Explains how to use the Hierarchy Manager tool to define and manage hierarchical relationships in the schema for your Siperian Hub implementation. Defines Siperian Hub terminology. vii

8 Learning About Siperian Hub Learning About Siperian Hub Siperian Hub Documentation Navigator The Siperian Hub Documentation Navigator directs you to the books in the Siperian Hub documentation that are most useful to you based on your role. Siperian Hub Installation Guide The Siperian Hub Installation Guide for your platform explains how to install Siperian Hub and Cleanse Match Server. There is a Siperian Hub Installation Guide for each supported platform. Siperian Hub Release Notes The Siperian Hub Release Notes contain important information about this release of Siperian Hub. Read the Siperian Hub Release Notes before installing Siperian Hub. What s New in Siperian Hub What s New in Siperian Hub provides an enhanced description of the new features for this release. Siperian Hub Administrator s Guide The Siperian Hub Administrator s Guide explains how to configure, administer, and manage a Siperian Hub implementation. It provides a description of the Siperian Hub platform through a discussion of Siperian Hub concepts, services, tools, and databases. Administrators should read the Siperian Hub Administrator s Guide first. viii Siperian Hub XU for DB2 User s Guide

9 Learning About Siperian Hub Siperian Hub User s Guide The Siperian Hub User s Guide explains how to use Siperian Hub. It provides a description of the Siperian Hub platform through a discussion of Siperian Hub concepts and tasks. Data stewards and users who are new to Siperian Hub should read the Siperian Hub User s Guide first. Siperian Hub Implementer s Guide The Siperian Hub Implementer s Guide explains how to design, implement, test, and deploy a Siperian Hub implementation. Implementers must be familiar with the content of the Siperian Hub Administrator s Guide as well as the Siperian Hub Implementer s Guide before starting a Siperian Hub implementation. Siperian Services Integration Framework Guide The Siperian Services Integration Framework Guide explains how to use the Siperian Hub Services Integration Framework (SIF) to integrate Siperian Hub functionality with your applications and how to create applications using the data provided by Siperian Hub. SIF allows you to integrate Siperian Hub smoothly with your organization's applications. Siperian Training and Materials Siperian provides live, instructor-based training to help you become a proficient user as quickly as possible. From initial installation onward, a dedicated team of qualified trainers ensure that your staff is equipped to take advantage of this powerful platform. To inquire about training classes or to find out where and when the next training session is offered, please visit our web site or contact Siperian directly. ix

10 Contacting Siperian Contacting Siperian Technical support is available to answer your questions and to help you with any problems encountered using Siperian products. Please contact your local Siperian representative or distributor as specified in your support agreement. If you have a current Siperian Support Agreement, you can contact Siperian Technical Support: Method Contact Information World Wide Web support@siperian.com Voice U.S.: SIPERIAN ( ) We are interested in hearing your comments about this book. Send your comments to: by by Postal Service: docs@siperian.com Documentation Manager Siperian, Inc. 100 Foster City Blvd. 2nd Floor Foster City, California USA x Siperian Hub XU for DB2 User s Guide

11 1 Introducing Siperian Hub This chapter introduces and provides an overview of Siperian MDM Hub. It is recommended for all users. Chapter Contents Introducing Master Data Management and Customer Data Integration Components of Siperian Hub Siperian Hub Architecture Overview of the Siperian Hub Data Management Process Siperian Hub Tools for Data Stewards 1

12 Introducing Master Data Management and Customer Data Integration Introducing Master Data Management and Customer Data Integration Master data is a collection of common, core entities along with their attributes and their values that are considered critical to a company's business, and that are required for use in two or more systems or business processes. Examples of master data include customer, product, employee, supplier, and location data. Complexity arises from the fact that master data is often strewn across many channels and applications within an organization, invariably containing duplicate and conflicting data. Master Data Management (MDM) is the controlled process by which the master data is created and maintained as the system of record for the enterprise. MDM is implemented in order to ensure that the master data is validated as correct, consistent, and complete, and optionally circulated in context for consumption by internal or external business processes, applications, or users. Ultimately, MDM is deployed as part of the broader Data Governance program that involves a combination of technology, people, policy, and process. Customer Data Integration (CDI) is a discipline within MDM that focuses on customer master data and its related attributes. Organizations have begun to realize that having a unified view of master data across disparate data sources, applications and channels is a prerequisite to realizing any long-term return on investment from their applications. They have also discovered, in many cases after several failed attempts of doing it on their own, or having used tools and applications not designed for this purpose, that this is not an easy task. Siperian offers an integrated, model-driven, and flexible enterprise MDM platform that can be used to create and manage all kinds of master data, including customer master data. Siperian MDM Hub (hereafter referred to as Siperian Hub) is the best platform available today for deploying MDM and CDI solutions across the enterprise. 2 Siperian Hub XU for DB2 User s Guide

13 Components of Siperian Hub Components of Siperian Hub Siperian Hub is a suite of products, each of which addresses a particular aspect of MDM and CDI. Siperian Hub includes: Component Master Reference Manager Hierarchy Manager Activity Manager Description Manages the data cleansing and provides the consolidation, matching, and merging functionality to create the most accurate master records. Also known as MRM. Builds and manages the data describing the relationships between master records. Also known as HM. Evaluates data events, synchronizes master data, and delivers unified views of reference and activity data from disparate sources. Also known as AM. Master Reference Manager Master Reference Manager (MRM) is the foundation product of Siperian Hub. Its purpose is to build an extensible and manageable system-of-record for all master reference data. It provides the platform to consolidate and manage master reference data across all data sources internal and external of an organization, and acts as a system-of-record for all downstream applications. Siperian MRM consists of the following major components: Hub Store, Cleanse Match Server, Siperian Hub Data Access Services, Siperian Hub Security Services, and Hub Console. Hub Store The Hub Store contains all the master records for all entities across different source systems. In addition, Hub Store contains the Siperian Trust Metadata store, which houses all the rich metadata and associated rules needed to determine and continually maintain only the most reliable cell-level attributes in each master record. Finally, Hub Store provides the Siperian Consolidation Engine, which stores the logic and performs various data consolidation functions such as merging and unmerging data. The cleanse and match servers also work closely with the Siperian Consolidation Engine. Introducing Siperian Hub 3

14 Components of Siperian Hub Cleanse Match Server The Cleanse Match Server interfaces with any of the supported cleanse engines, such as the Trillium Director cleanse engine. The Cleanse Match Server and the cleanse engine work to standardize the data. This standardization works closely with the Siperian Consolidation Engine to optimize the data for consolidation. Siperian Hub Data Access Services These application server-level capabilities enable Siperian Hub to support multiple modes of data access and expose numerous Siperian Hub data services via the Siperian Services Integration Framework (SIF). This facilitates real-time synchronous integration, as well as asynchronous integration. To learn more about data access, see Siperian Services Integration Framework Guide. Siperian Hub Security Services Siperian Hub provides comprehensive and highly-granular security mechanisms to ensure that only authenticated and authorized users have access to Siperian Hub resources and functionality. Siperian Hub integrates with security providers third-party organizations that provide security services (authentication, authorization, and user profile services) for users accessing Siperian Hub. The way in which you configure and implement Siperian Hub security is governed by your organization s particular security requirements, by the IT environment in which it is deployed, and by your organization s security policies, procedures, and best practices. For more information about Siperian Hub security, see the Siperian Hub Administrator s Guide. 4 Siperian Hub XU for DB2 User s Guide

15 Components of Siperian Hub Hub Console Siperian has a rich set of user interfaces designed for different purposes and to be used by different users. These include: Component Design Console Data Steward Console Administration Console Description Used to configure the solution during deployment by the implementers, and for on-going configuration by data architects of the various types of metadata and rules in response to changing business needs. Used to review consolidated data as well as matched data queued for exception handling by data analysts or stewards who understand the data semantics and are guardians of data reliability in an organization. Note: This Siperian Hub User s Guide focuses on these tools. To learn more, see Siperian Hub Tools for Data Stewards on page 15. Used to assign role-based security and other database administrative tasks. The Administration Console is described in the Siperian Hub Administrator s Guide. Hierarchy Manager Note: These three consoles are conceptual groupings of the Siperian Hub tools they do not reflect the actual interface of the product. This Siperian Hub User s Guide is concerned with the tools used by data stewards. To learn more about the other tools, see the Siperian Hub Administrator s Guide. Siperian Hierarchy Manager (HM) is based on the foundation of Master Reference Manager. As the name implies, Hierarchy Manager allows you to manage hierarchy data that is associated with the records you manage in MRM. Typically, each of the applications that provide data to your MRM system also store relationship information across master data. These disparate systems make it difficult to view and manage relationship data because each application has a different hierarchy, such as customer-to-account, sales-to-account or product-to-sales. Meanwhile, each data warehouse and data mart is designed to reflect relationships necessary for specific reporting purposes, such as sales by region by product over a specific period of time. Introducing Siperian Hub 5

16 Siperian Hub Architecture Activity Manager Hierarchy Manager leverages MRM s ability to provide the best version of the truth from disparate data sources and applications. Hierarchy Manager allows you to gather, visualize, and manage relationships and hierarchies within your data set. Siperian Activity Manager (AM) evaluates data events, synchronizes master data, and delivers unified views of reference and activity data from disparate sources. AM builds upon the extensible, template-driven schema of Siperian Hub and uses the rules-based, configurable approach to combining reference, relationship and activity data. It conducts a rules evaluation using a combination of reference, transactional, and analytical data from disparate sources. It also conducts an event-driven, rules based orchestration of data write-backs to selected sources, and performs other event-driven, rules-based actions to centralize data integration and delivery of relevant data to subscribing users and applications. AM has an intuitive, powerful UI for defining, designing, delivering and managing unified views to downstream applications and systems, as well as built-in lineage, history, and audit functionality. Siperian Hub Architecture Siperian Hub has a three-tier architecture. Tier Database Tier Middle Tier Client Tier Description Contains the Hub Store. Contains the Hub Server. External applications and the Hub Console interact with this tier. Contains the Hub Console, which may be viewed as an administration console (for configuring the environment), a business console (for data stewards to manage data), and a design console. This is a conceptual and logical description of the consoles, and does not reflect the actual console appearance in the product. 6 Siperian Hub XU for DB2 User s Guide

17 Siperian Hub Architecture The following figure shows an overview of the Siperian Hub architecture. The following figure shows a functional overview of Siperian Hub s core capabilities. Introducing Siperian Hub 7

18 Overview of the Siperian Hub Data Management Process Overview of the Siperian Hub Data Management Process Siperian Hub has a well-defined data management flow that proceeds through five distinct processes (Land, Stage, Load, Match, and Consolidate) in order for the data to get cleansed and consolidated. The Land process occurs before data gets to MRM, and the remaining four processes occur within MRM. Using its unique, metadata-driven Siperian Trust Framework, MRM ensures that its consolidated records, at the cell level, contain the most reliable information available from the data sources. About Source Systems Source systems are operational systems or third-party applications that provide data to Siperian Hub for cleansing, matching, consolidating, and maintenance. Source systems can either provide data for Siperian Hub in batch loads, or they can access Siperian Hub in on-line real-time mode through the Siperian Hub Services Integration Framework (SIF). Data Loading Stages for Batch Processes For batch processes, data proceeds from source systems to the Hub Store in a series of processes. Process Land Description An ETL (Extract-Transform-Load) tool or other external process copies data from a source system to Siperian Hub. This process is called Land because, within Siperian Hub, this data is placed in a table called a landing table. Note: This process is done by a separate ETL tool of your choice. This ETL tool is not part of the Siperian Hub suite of products. 8 Siperian Hub XU for DB2 User s Guide

19 Overview of the Siperian Hub Data Management Process Process Stage Load Match Consolidate Description A Siperian Hub Stage process reads the data from the landing table, performs any cleansing that you have specified, and moves the cleansed data into a corresponding table, called a staging table. If you enable the delta detection feature, Siperian Hub processes only new or changed records, ignoring unchanged records. To learn more about the stage process, see Cleanse Process on page 11. Note: The data cleansing step is performed by a separate data cleansing tool of your choice. Siperian Hub manages the cleansing process, but the engine can be any one of the supported engines. A Siperian Hub Load process loads data from the staging table into the corresponding Hub Store table, called a base object. If the new data overlaps with existing data in the Hub Store, Siperian Hub uses trust rules to determine which value is more reliable. To learn more about the loading process, see the Siperian Hub Administrator s Guide. A Siperian Hub Match process identifies data that conforms to the match rules that you have defined. These rules define duplicate data for Siperian Hub to consolidate. To learn more about the match process, see Match Process on page 12 and the Siperian Hub Administrator s Guide. A Siperian Hub Consolidate process consolidates the data determined by the match process to be duplicate. To learn more about the consolidate process, see Consolidation Process on page 14 and the Siperian Hub Administrator s Guide. Introducing Siperian Hub 9

20 Overview of the Siperian Hub Data Management Process Overall Process Flow The following figure shows the overall process flow for loading data into Siperian Hub. Data can be loaded in two different modes: Mode Type batch real-time Description Run Siperian Hub batch jobs. There are two ways to do this: executing batch jobs in the Hub Console, as described in the Siperian Hub Administrator s Guide using third-party job management tools to schedule and execute batch jobs (in the form of stored procedures) on the database server, as described in the Siperian Hub Implementer s Guide Real-time applications invoke Siperian Hub operations via the Services Integration Framework (SIF) interface. SIF provides operations for various services, such as reading, cleansing, matching, inserting, and updating records. To learn more about SIF, see the Siperian Services Integration Framework Guide. Siperian Hub automatically provides all the necessary logic for the stage and load processes, and for updating all of the underlying cross-reference, history, and control tables necessary for managing the data. 10 Siperian Hub XU for DB2 User s Guide

21 Overview of the Siperian Hub Data Management Process Trust Levels for Source Systems Cleanse Process When you define source systems (both batch and online) in Siperian Hub, you can configure trust levels for the data elements that each source system provides. Trust measures the confidence that you have in each cell in the base object. Confidence is based on various factors, including its source system, change history, and other business rules. Trust levels take into account the age of data, the validity of the data, when the data was refreshed or updated, and how much its reliability has decayed over time. Decay occurs according to a defined trust profile that determines the decay curve, decay rate, and decay timeline. You must define trust for any data element that is provided by multiple source systems. If there are no overlapping sources of data for an element, then there is no need to define trust settings. See the Siperian Hub Administrator s Guide for more information. Data cleansing is the process of: standardizing data content and layout decomposing/parsing text values into identifiable elements verifying identifiable values (such as zip codes) against data libraries replacing incorrect values with correct values from data libraries Siperian Hub uses mappings for data cleansing. A mapping is a set of transformations that are applied to source data either from a landing table or via a real-time API interaction (invocation of a Siperian Hub operation). Introducing Siperian Hub 11

22 Overview of the Siperian Hub Data Management Process The following figure explains the concept behind these mappings. Match Process Each step in a mapping is a pre-defined function that provides access to specialized cleansing functionality, such as address verification, address decomposition, gender determination, title/upper/lower-casing, white space compression, and so forth. Matching is the process of comparing two records for points of similarity. If sufficient points of similarity are found to indicate that the two records are probably duplicates of each other, then Siperian Hub flags those records for consolidation. Base Objects and Match Columns Data that you are matching is stored in tables called base objects. These base objects have columns, some of which you designate for matching. The columns to be used for comparison purposes are called match columns. Each match column is based on one or more columns from the base object. Each match column also has a match type that determines how the match column will be tokenized in preparation for the match comparison. 12 Siperian Hub XU for DB2 User s Guide

23 Overview of the Siperian Hub Data Management Process Tokenization and Match Codes Tokenization is a specialized form of data standardization that is performed before the match comparisons are done. For the most basic match types, tokenizing simply removes noise characters like spaces and punctuation. The more complex match types result in the generation of sophisticated match codes strings of characters representing the contents of the data to be compared based on the degree of similarity required. Match Rules Match columns are combined into match rules to determine the conditions under which two records are considered to be similar enough to consolidate. Each match rule tells Siperian Hub the combination of match columns it needs to examine for points of similarity. Each match rule has a sequence number that tells Siperian Hub the order in which to apply the rules to the data. Siperian Hub uses the highest numbered match rule to determine whether two records match each other. Match rules are defined as belonging to either of the following categories. Type of Match Rule automatic match rules manual match rules Description Your best rules, the ones you are most sure will result in an accurate match. For matches resulting from automatic match rules, the records are consolidated automatically. Rules that you are less sure will generate accurate matches. These rules use looser criteria than automatic match rules. For matches resulting from manual match rules, the records are consolidated manually after being reviewed by a data steward. Manual match rules identify records that have enough points of similarity to warrant attention from a data steward, but not enough points of similarity to allow the system to automatically consolidate the records. When Siperian Hub finds two records that satisfy a match rule, it records the primary keys of the records, as well as the match rule identifier. The records are flagged for either automatic or manual consolidation according to the category of the match rule. To learn more about matching, see the Siperian Hub Administrator s Guide. Introducing Siperian Hub 13

24 Overview of the Siperian Hub Data Management Process Consolidation Process Duplicate records in a base object can be merged to create a consolidated record that contains the most reliable cell values from the source records. Before consolidating the records, Siperian Hub calculates a trust rating for each cell on each record, and then compares the trust values to determine the most reliable values. You consolidate matched records by merging them. Merging involves a physical consolidation that combines the matched records and updates the base object. Consolidation can be done manually using the Siperian Hub Merge Manager, or it can be automated as a Siperian Hub batch process executed through the Hub Console or any external application that uses the Siperian Hub Services Integration Framework (SIF). To learn more about consolidation, see the Siperian Hub Administrator s Guide. 14 Siperian Hub XU for DB2 User s Guide

25 Siperian Hub Tools for Data Stewards Siperian Hub Tools for Data Stewards On the Workbench page in the Hub Console, the Data Steward Workbench provides the following tools: The following table provides a brief description of these tools. Tool Data Manager Merge Manager Actions Manage the content of consolidated data, view the cross-references, edit data, view history and unmerge consolidated records. To learn more, see Using the Data Manager Tool on page 50. Review and merge the matched records that have been queued for manual merging. To learn more, see Using the Merge Manager Tool on page 27. Introducing Siperian Hub 15

26 Siperian Hub Tools for Data Stewards Note: If you have purchased Hierarchy Manager, you might see a Hierarchy Manager workbench as well. These tools are accessible via the Hierarchy Manager workbench. Data stewards can use the Hierarchy Manager tool to define and manage hierarchical relationships in their Hub Store. To learn more about Hierarchy Manager, see Chapter 4, Using Hierarchy Manager. To learn more about the Hub Console, see the Siperian Hub Administrator s Guide. For a general introduction, see Organization of the Hub Console in Chapter 1, Introducing Siperian Hub, in that document. 16 Siperian Hub XU for DB2 User s Guide

27 2 Getting Started with the Hub Console This chapter explains how to access Siperian Hub features via the Siperian Hub user interface, which is called the Hub Console. Chapter Contents About the Siperian Hub Console Starting the Hub Console 17

28 About the Siperian Hub Console About the Siperian Hub Console The Siperian Hub Console comprises a set of tools. Each tool allows you to perform a specific action, or a set of related actions. Siperian Hub groups its tools in two different ways: By process, where tools are grouped into a logical workflow that walks you through the tools and steps required for completing a task. By workbench, where similar tools are grouped together. The Data Steward Workbench provides the following tools: Data Steward Workbench Data Steward Tools Note: When you log into Siperian Hub, you see only those workbenches and processes that contain the tools that your Siperian Hub security administrator has authorized for you to use. The previous screen shot shows the full set of workbenches, processes, and tools available. 18 Siperian Hub XU for DB2 User s Guide

29 About the Siperian Hub Console In the following example, only the Data Steward workbench is available. To learn more about using the Hub Console, see the Siperian Hub Administrator s Guide. Getting Started with the Hub Console 19

30 Starting the Hub Console Starting the Hub Console To access the Hub Console: 1. Open a browser window and enter the following URL: where YourHubHost is your local Siperian Hub host and port is the port number. Check with your administrator for the correct port number. Suggested port numbers are 8080 for JBoss and 9080 for WebSphere. The Siperian Hub launch screen is displayed. 2. Click the Launch button. The Siperian Hub Login dialog box is displayed. 3. Enter your user name and password. 20 Siperian Hub XU for DB2 User s Guide

31 Starting the Hub Console Note: If you do not have any user names set up, contact Siperian support. 4. Click OK. 5. After you have logged in with a valid user name and password, Siperian Hub prompts you to choose a target database with which to work. The list of databases that you can connect to is determined by your security profile. The Master Database stores system information, such as the connection settings for each Hub Store, user accounts for users who can access Siperian Hub, and the databases and tools that users can access. An Operational Record Store (ORS) stores the non-system data, including all of your master record data. A Siperian Hub configuration can have one or more ORSs. 6. Choose the Master Database or the ORS to which you want to connect. 7. Click Connect. Getting Started with the Hub Console 21

32 Starting the Hub Console The Hub Console screen is displayed. The tools you see in the left panel depend on what your company has purchased and the tools to which your admin has given you access. 8. If the Data Steward workbench does not show any tools, click Data Steward to expand the list of tools in the workbench. 9. Click the name of the tool that you want to use. 22 Siperian Hub XU for DB2 User s Guide

33 Using the Siperian Hub Data Management Tools 3 This chapter explains how to use the data management tools (Merge Manager and Data Manager in the Data Steward workbench) to manage your business data stored in Hub Store. To most effectively use this section, you must be familiar with the key concepts described in Chapter 1, Introducing Siperian Hub, in this guide. Chapter Contents About Data Management in Siperian Hub Using the Merge Manager Tool Using the Data Manager Tool Using the Search Wizard to See a Subset of the Data 23

34 About Data Management in Siperian Hub About Data Management in Siperian Hub As explained in Overview of the Siperian Hub Data Management Process on page 8, after data has been brought into your Hub Store and cleansed (see Cleanse Process on page 11), it is processed in the following manner: 1. Data is loaded into base objects using the load procedure. 2. Data within base objects is matched to identify rows that are candidates for consolidation. To learn more, see Match Process on page Rows that are identified as possible matches are either consolidated automatically or queued for a data steward to examine and determine whether the match is appropriate to consolidate. For DB2, there is one type of consolidation: merging. To learn more about merging, see Consolidation Process on page 14 and About Merging on page 25. About the Tools for Managing Data in Hub Store Siperian Hub provides two main tools for managing data in the Hub Store: Tool Merge Manager Data Manager Description Used to review and take action on the records that are queued for manual merging. It also shows the records that are queued for automerge. The Merger Manager shows any records that have been queued for automerge but have not yet been through the automerge process. Depending on your configuration, the Merge Manager can also show records that have been through the match process without any matches being found for them. To learn more, see Using the Merge Manager Tool on page 27. Used to review the results of all merges including automatic merges and to correct data if necessary. It provides a view of the data lineage for each base object record. The Data Manager also allows you to unmerge previously consolidated records, and to view different types of history on each consolidated record. To learn more, see Using the Data Manager Tool on page Siperian Hub XU for DB2 User s Guide

35 About Data Management in Siperian Hub Overview of the Consolidation Process The goal of merging in Siperian Hub is to eliminate all duplicate data and combine them together into a single, consolidated record all the while maintaining full traceability. Duplicates are identified using the match process. Traceability is keeping track of the data so that you can determine which systems, and which records from those systems, contributed to consolidated records. Typically, you use Merge Manager to view newly-loaded base object records that have been matched against other records in the base object. Based on this view, you can: combine duplicate records together to create consolidated records designate records that are not duplicates as unique records About Merging Merging is also called physical consolidation because it creates a single record from the two matched records. Naturally, all history information is maintained so the records can be unmerged, should that be necessary. Based on trust, the resulting record is the best version of the truth for the given data. This is the default type of consolidation. Merging results in a consolidated record. About the Consolidation State Each base object record has a consolidation state that indicates where it is in the consolidation process. This state is stored in a field called the consolidation indicator, which has the following values: Consolidation Indicator Values Indicator Value Meaning Purpose 1 Consolidated Indicates the record that has been determined to be a valid record and is fully consolidated. Note that the record is not necessarily the result of merging. 2 Queued for Merge Indicates that the record has gone through the match process, has potential duplicates identified, and is now ready to be merged. Using the Siperian Hub Data Management Tools 25

36 About Data Management in Siperian Hub Consolidation Indicator Values (Cont.) Indicator Value Meaning Purpose 3 Queued for Match Indicates that the record is ready to be put through the match process against the rest of the records in the base object. 4 Newly Loaded Indicates that the record has been newly loaded into the base object and has not gone through the consolidation process. 9 On Hold Indicates that the record is suspended in the consolidation process. About the Consolidation Sequence Base objects proceed through the consolidation process in the following order: 1. When a new record is added to Siperian Hub, the record is assigned a consolidation indicator of 4, indicating that it is new and has not yet been matched or merged. 2. When a record is queued for matching, Siperian Hub changes its consolidation indicator to When a record has gone through the match process and is queued for merge, it is assigned a consolidation indicator of 2. Records that have a consolidation indicator of 2: have been through the match process the match process may or may not have found matches for them are visible in Merge Manager 4. Once a record has no more duplicates to merge, its consolidation indicator can be set to 1, which means that the record is unique. Records that do not have any matches to start with can automatically be flagged as unique by Siperian Hub if your environment has been configured to do this. Once a record has its consolidation indicator set to 1, Siperian will never directly match it against any other record that also has a consolidation indicator value of Siperian Hub XU for DB2 User s Guide

37 Using the Merge Manager Tool New records (with consolidation indicator set to 4) can be matched against consolidated records, or against records with any other flag values. About Assignment Lists An assignment list is a list of records for manual merge that have been assigned to a particular data steward. Once records are in a data steward s assignment list, no other users can merge them. You can create and manage your assignment list using the Merge Manager. To learn more, see Using the Merge Manager Tool on page 27. Using the Merge Manager Tool This section describes how to use the Merge Manager. It covers the following topics: About the Merge Manager Setting Up a Merge Changing a Record to Unmerged or On Hold Matched Data About Merging Cell Data Manually Merging Records About the Merge Manager Use the Merge Manager tool to merge records and change their consolidation indicators. You can also change the default survivorship behavior for the merge by overriding trust values for specific cells. The Merge Manager displays the records queued for merging, and allows you to review and merge matched records that have been queued for merging. Using the Siperian Hub Data Management Tools 27

38 Using the Merge Manager Tool The Merge Manager consists of two screens: Merge Manager Screens Screen Setup Merge Manager Description Allows you to select the information you want to work with: base object, packages, unmerged records, query settings, and display settings. Shows you the records that have been selected, along with the records to which they match. You can manually merge these records to change their consolidation flags. To use the Merge Manager to merge records: 1. Start the Merge Manager. To learn more, see Starting the Merge Manager on page Use the Merge Manager to set up the merge. To learn more, see Setting Up a Merge on page In the Merge Manager, do the merge. To learn more about merging, see Manually Merging Records on page Siperian Hub XU for DB2 User s Guide

39 Using the Merge Manager Tool Starting the Merge Manager To start the Merge Manager tool: In the Hub Console, expand the Data Steward workbench, and then click Merge Manager. The Hub Console displays the Setup screen of the Merge Manager tool. To proceed with setup, see the next section, Setting Up a Merge on page 30. Using the Siperian Hub Data Management Tools 29

40 Using the Merge Manager Tool Setting Up a Merge To set up a merge: 1. Start the Merge Manager as described in the Starting the Merge Manager on page 29. The Hub Console displays the Merge Manager Setup screen. 2. Select the base object to merge. You select from a list of the base objects that can consolidate data. The base objects are your business entities (such as Customer, Location, Vendor, Product, and so on). The base object that you select determines some of the choices that you will have in the rest of the fields on the setup screen. 3. If you want, click the Get Count button to display the base object rows queued for manual merge. 4. Select the packages to use to display the data. You can customize your view of the data in the selected base object by specifying the display and merge packages you want to use. Packages determine which columns from the base object will be visible in the Merge screen. For more information about packages, see the Siperian Hub Administrator s Guide. 30 Siperian Hub XU for DB2 User s Guide

41 Using the Merge Manager Tool The packages that are available to you are determined by your access rights, as designated by your administrator. Package Merge Package Display Package Description Used for presenting the data in the cell-by-cell comparison area in the bottom section of the Merge screen. A merge package can only contain columns from the selected base object. Used for presenting the data in the top two sections of the Merge screen. The display package can be any package for which you have permission. The package is based on the base object, and it can contain columns from additional tables besides the base object. Note: The display package can be the package based on the selected Merge package. It can also contain columns from the additional tables (besides the base object) by creating a join to join the put-package to other tables not the base object directly. Note: If an administrator makes a change to the package you are using, these changes are not visible in the Merge Manager until you refresh the display. 5. Specify the number of unmerged records to add to your assignment list. You can specify the maximum number of records to be added to your assignment list. 6. If you want, click Clear Assigned Records to clear your assignment list. Resetting your assignment list does not delete any records or remove them from the manual merge queue. It simply makes it possible for another data steward to add those records to their own assignment list. 7. Specify the query to use when assigning records. Specify a query to control which records are assigned to you for merging. Your assignment is a subset of the queued records for the selected source system. Using the Siperian Hub Data Management Tools 31

42 Using the Merge Manager Tool To specify a query, use one of the following options. Option Predefined Query Search Wizard None Description You can choose to populate your assignment list based on a pre-defined query. To do this, select a pre-defined query from the drop-down list. Your administrator defines these queries. Before you use them, make sure that you know what the parameters of the query are so that any additional filters you may add do not conflict with the pre-defined query. If this happens, you will see an empty result set. An example of conflicting queries is: The pre-defined query specifies only records in which the state field is CA. Your filter specifies only records that have a state field of NJ. There will be no records that satisfy both conditions, so you will see an empty result set. You can define the assignment based on any search criteria using the columns in the selected display package. To learn more about searching the queued records, see Using the Search Wizard to See a Subset of the Data on page 76. If you select None from the Query drop down list, Siperian Hub will simply assign queued records to you when you click the Begin Merge button (or whatever number of records you entered in step 3). Once records have been assigned to you, they are reserved for your use and no other users can merge them. Likewise, you will not be able to merge the records assigned to other users. If, after doing a query for your assignment, you get no records displayed in the Merge screen (even though there are records queued for merge), it is because all queued records have already been assigned to other users. 32 Siperian Hub XU for DB2 User s Guide

43 Using the Merge Manager Tool As you merge records, the number of records assigned to you is reduced until you have no further records to merge. 8. Select the number of records to return per page. Use this setting to control how many records are displayed per page when the merge screen is displayed. Note: The more data you display, the slower the performance of the Merge Manager. For the most efficient processing, display only a small number of records at a time (for example, 20 to 50 records). 9. Click Begin Merge. The Merge Manager screen is displayed. Using the Siperian Hub Data Management Tools 33

44 Using the Merge Manager Tool Merge Manager Screen for Merge Base Objects For merge base objects, the Merge Manager screen looks like this example. 34 Siperian Hub XU for DB2 User s Guide

45 Using the Merge Manager Tool The Merge screen is divided horizontally into three main sections: Section Unmerged / On hold Matched data Cell data Description Lists the records that are queued for merging either unmerged records or records that you have flagged as being on hold. To learn more, see Changing a Record to Unmerged or On Hold on page 35. Lists the matches for the record selected in the top section. To learn more, see Matched Data on page 39. Lists which cell values will be kept in the consolidated record after you click the Merge button. To learn more, see About Merging Cell Data on page 41. Note: When you sort in Merge Manager, you are sorting the current page of data not the entire data set. Changing a Record to Unmerged or On Hold This section of the Merge Manager screen lists the records that are queued for merging. These are either unmerged records or records that you have flagged as being on hold. You switch between the two queues by selecting either the Unmerged tab or the On Hold tab. Sometimes you might see multiple records for the same customer. This is due to the display package that you selected. For example, if you chose a display package that shows information for customers that includes their addresses, and a customer has two addresses, you will see two customer records in the grid. The columns you see for each record in this section are determined by the Display Package you selected on the Merge Setup screen. To return to the Merge Setup screen, click the Setup Merge button in the upper right corner of the page. The buttons on the right hand side of this section allow you to perform certain actions on the records displayed in the section. Using the Siperian Hub Data Management Tools 35

46 Using the Merge Manager Tool Selecting Multiple Records Click the Multiple Selection check box to select multiple records. Use CTRL or SHIFT to select multiple records in the Unmerged or On hold pane. When two or more records are selected, the bottom two panes are cleared and only the following commands are available: Accept the unmerged record as unique Accept all records without a match Accept all records without a match in the assignment list as unique Put on hold Queue for Matching Reset as New Record Reassign Accepting the Unmerged Record as Unique Accept the unmerged record as unique: Click this button to flag the selected unmerged or on-hold record as a consolidated record without it being merged with any other records. Use this option to remove the record from the queue if you are sure that it does not have any matches. Accepting All Records Without A Match in the Assignment List as Unique Accept all records without a match in the assignment list as unique: Click this button to flag all of the unmerged records in the assignment list as a consolidated record without it being merged with any other records. Use this option to remove records from the queue if you are sure that they have no matches. Accepting All Records Without A Match Accept all records without a match: Click this button to flag as unique all records that do not have matches. This removes them from the queue. Use this option 36 Siperian Hub XU for DB2 User s Guide

47 . Using the Merge Manager Tool if you are sure that the affected records do not have matches to any other records. If you click this button, the Merge Manager displays the following prompt: Viewing Cross-reference Records View cross-reference records: Click this button to view cross reference records for a selected record. Cross-references are the records that contributed information to this base object. The Cross-Reference Viewer displays the cross references Using the Siperian Hub Data Management Tools 37

48 Using the Merge Manager Tool Changing the Status of the Selected Record Change the status of the selected record: Click this button to change the status flag of the selected record to one of the following values: Status Put on hold Queue for matching Reset as new record Reassign Description Removes the row from the list of merge candidates, adds it to a list of on hold records, and sets the Consolidation Indicator to 9 ( on hold status). To work with these records, select the On Hold tab. Removes the row from the list of merge candidates, queues the row for possible matching, and sets the Consolidation Indicator to 3. The row has the same status that rows have part-way through the match job (after irrelevant data is removed but before the tokenized records are written to the match table). This is only rarely a good idea. The standard way to re-queue a record for matching is to reset the record as new. Removes the row from the list of merge candidates, queues the row for possible matching, and sets the Consolidation Indicator to 4. The row has the same status that rows have at the very beginning of the match job. Note that the row is still on the screen, in the same place. It is just no longer a candidate for merge. Allows you to reassign the record to another user for review. This will most likely be used if you want the match to be reviewed by an Admin user or other data stewards. Note: Once a record is reassigned, it no longer appears in your list, but appears in the list of the data steward or Admin user to whom it was reassigned. Custom-defined Buttons If configured and enabled for your Siperian Hub implementation, custom-defined buttons might be displayed in the top section of the Merge Manager screen. These custom-defined buttons can be used to invoke a particular external service or perform a specialized operation (such as launching a workflow). To learn more, consult your administrator. To learn about implementing custom-defined buttons, see the Siperian Hub Implementer s Guide. Edit record: Use this button to edit the data values in the selected record. For more information on editing records, see Editing Records on page Siperian Hub XU for DB2 User s Guide

49 Using the Merge Manager Tool Matched Data The middle section of the Merge Manager screen lists the matches for the selected record in the top section. The buttons on the right hand side of this section allow you to perform certain actions on the records displayed in the section. Searching for Potential Matches Search for potential matches: Click this button to open the Siperian Hub Search Wizard to do a manual search for potential matches on conditions that the match rules might not be set up to use. Any records that the Search Wizard finds will be loaded into the Matched Data section to allow you to manually merge them with the record selected in the Unmerged/ On Hold section. To learn more, see Using the Search Wizard to See a Subset of the Data on page 76. Viewing Cross-reference Records View cross-reference records: Click this button to view cross reference records for a selected record. Cross-references are the records that contributed information to this base object. The Cross-Reference Viewer displays the cross references. Using the Siperian Hub Data Management Tools 39

50 Using the Merge Manager Tool Editing a Record Edit record: Click this button to edit the data values in the selected record. For more information on editing records, see Editing Records on page 66. Showing a Match Rule Show Match Rule: Click this button to see the details of the match rule that resulted in the selected record in the Matched Data section being identified as a possible match for the selected record in the Unmerged/On Hold section. This option is not available for records from a manual search. 40 Siperian Hub XU for DB2 User s Guide

51 Using the Merge Manager Tool Displaying the Relationship Dialog Display the relationship dialog: Click this button to display the Relationship Viewer so that you can view the intertable match records. You can also double-click a record in the Matched Data grid to display the Relationship Viewer. About Merging Cell Data In the Merge Manager, the Cell data grid displays a list of the base object columns. It shows you which cell values will be kept in the consolidated record after you click the Merge button. In the Unmerged Data and Matched Data columns, the value with the higher trust (the value that the consolidated row will have) is highlighted in bold text. If both values have the same trust value, the value in the Unmerged Data column is highlighted. Base Object Column Properties In the Cell data section of the screen, each base object column has the following properties: Property Column Name Trust Description Name of the column. Trust level of the value from the selected row in the Unmerged/On Hold list box. Using the Siperian Hub Data Management Tools 41

52 Using the Merge Manager Tool Property Umerged Cell Matched Cell Trust Description Value from the selected row in the Unmerged/On Hold list box. Value from the selected row in the Matched Data list box. This is not necessarily unmerged data. The records could even be records that have previously been merged with other records. The record in the Unmerged list box gets merged into to the record in the Matched Data list box. Note: The rowid_object value that survives when two records merge is the ID of the record in the matched data list box. Trust level of the value from the selected row in the Matched Data box. Some Columns Might Not Have a Trust Value You might notice that not all columns have trust. This is expected because not all columns require trust trust involves some overhead in storage and calculation. In addition, there is a limit to the number of columns that your administrator can configure to have trust. Because not all columns require trust, some columns do not have it, thereby avoiding the overhead required. Overriding Merge Trust Behavior You can override the selection of which row will provide a value to the consolidated base object by clicking on the cell that is not highlighted and does not have bold text. This clicking will change the cell that is highlighted and make the text in the newly highlighted cell bold. The highlighted cell is the one that provides the data to the consolidated record. Guidelines for Overriding Consolidation Trust Behavior When overriding consolidation trust behavior, consider the following guidelines: Only one overridden trust setting (the last one you set either left or right) is used for consolidation. The trust score, displayed after the override trust settings change, is not applied to the database unless it is the one used for consolidation. The override applies only to manual merges. Override settings do not apply to automerges. If you do override trust, then you must use the Merge button to ensure that your changes are applied. Do not just set the automergeflag. 42 Siperian Hub XU for DB2 User s Guide

53 Using the Merge Manager Tool If a column does not have trust rules defined for it, then the Unmerged and Matched Trust will be blank, and the Unmerged Data value will always be highlighted in bold text. In this case, the selection cannot be overridden. Specifying the Confidence Level For each override that you specify (by selecting a cell that was not previously highlighted), you can click the button and then specify how confident you are of the correctness of the change. The Merge Manager displays the Override Trust Settings wizard. Using the Siperian Hub Data Management Tools 43

54 Using the Merge Manager Tool The confidence level you select determines the likelihood of whether the overridden value will be updated by a subsequent data change from one of the contributing source systems. Confidence Levels Confidence Level High Custom Description The maximum trust and minimum trust settings will be the settings that your administrator specified for the Siperian Hub Admin source system. The cell s last-update-date will be changed to the current date. The other trust settings (decay period and decay type) will be based on the trust profile of the system that provides the cell value. Merge Manager prompts you to provide trust settings that apply to this data value only, as shown in the figure below. You can specify the minimum and maximum trust, decay type, and decay time lines. For more information about trust settings, see the Siperian Hub Administrator s Guide. If you selected a Custom confidence level, the Hub Console displays this screen. 44 Siperian Hub XU for DB2 User s Guide

55 Using the Merge Manager Tool Consolidating the Unmerged Record with the Matched Merge the unmerged record with the matched: Click this button (in the Cell Data portion of the window) to consolidate (merge) the record selected in the Unmerged Data list box with the record selected in the Matched Data list box. Consolidating two records has the following effects: The row in the base object table that is displayed in the Matched Data box disappears. The corresponding row in the cross-reference now points to the surviving row in the base object table. If the record that you consolidated into (the record in the Matched data list) was already a consolidated record, then the record will be removed from the queue entirely. The surviving row in the base object table contains the most-trusted values from the cross-reference table. If the trust levels are equal, then the data from the unmerged row prevails. The row ID from the matched row remains in the base object. The consolidated record can have a value that is a pointer to a value in another table. For example, supposed you have two base objects, a Customer and an Address. The Customer base object contains customer name information. The Address object contains address information, as well as a pointer to the Customer information, as these things must go together. If a Customer record and its associated Address are consolidated with another Customer/Address record, then a pointer from one of the Address records is lost in the consolidation. In this case, the pointer value is changed so that it points to the surviving row. Note that values are never actually lost in the process of consolidating. Values that do not end up in the surviving record are always kept and managed by Siperian Hub so that they are available should you choose to unmerge records. Bear in mind that, if there are pointers to values in other tables that must be updated, the process of consolidating two records can result in many other records being affected. Using the Siperian Hub Data Management Tools 45

56 Using the Merge Manager Tool Manually Merging Records This section provides a step-by-step walkthrough of the process of manually consolidating (merging) records using the Merge Manager and example data. For this example, Siperian Hub is configured to consolidate customer data. Data has been loaded into Siperian Hub and has been processed through the Siperian Hub batch processes. Some records have been queued for manual review. To merge records: 1. Select the Merge Manager tool in the Data Steward workbench, or start the Consolidate Records process from the Processes tab. 2. In the Merge Manager setup screen, select the base object for which you want to merge records. The following example uses the Address base object. 3. Select the package to use for displaying the data, and the package to be used for the merge. In this example, it is the same package (AddressPackage) for both displaying and merging data. 46 Siperian Hub XU for DB2 User s Guide

57 Using the Merge Manager Tool Note: At this point, you could click Begin Merge and Siperian Hub will simply assign the first 50 queued records to you, or you can choose a query. 4. Either choose a predefined query or define a query by selecting Use Search Wizard from the drop down list. By default, None is selected. 5. Click Begin Merge. 6. If you selected Use Search Wizard, the Siperian Hub Search Wizard is displayed. You need to specify query parameters. Specify the query parameters you want. You can, for example, set up the query parameter to find all records where the State contains the string IL. To learn more, see Using the Search Wizard to See a Subset of the Data on page 76. Use the button to add a new parameter (query expression). If you need to remove a parameter, select the check box at the beginning of the row, then click the button. You must have at least one filter parameter. 7. Click Finish. 8. In the Unmerged tab on the Merge Manager screen, select the Naperville, IL address that has been queued for merging. 9. To further refine the search, click the Search for Potential Matches button. The Search Wizard is displayed. This is not a mandatory step. Using the Siperian Hub Data Management Tools 47

58 Using the Merge Manager Tool Use the button to add a new parameter, and then specify the query parameters. This example sets up the query parameter to find all records where the City contains Naperville. To learn more, see Using the Search Wizard to See a Subset of the Data on page Click Finish. In this example, the city named Naperville is selected. Naperville has one potential match, which is displayed in the Matched data list box. Note: When you sort in Merge Manager or Data Manager, you are sorting the current page of data not the entire data set. To find rows that are similar you must do a search from the setup page of these tools. 11. In the Matched Data list box, select one of these rows. 48 Siperian Hub XU for DB2 User s Guide

59 Using the Merge Manager Tool To view the Match Rule for the selected record, click the Show Match Rule button. The Rule Properties show that the rule that resulted in the match was determined by the similarity between the full names and addresses on each record. In the Cell Data list box, you see a side-by-side comparison of the Unmerged and Matched Data records, with comparative trust values for the columns that have trust settings defined for them. In this example, Address Line1, City, State, and Zip Code all have trust settings, so trust values are calculated for them. Address Line2, Zip4, and Full Address do not have trust rules, so their trust values are blank. Siperian Hub highlights the most trustworthy values in bold text. If you merge the two records, the resultant consolidated record will have the values shown in bold text. You can override Siperian Hub by selecting a less trustworthy cell value over a more trustworthy cell value, and specifying a confidence factor for the override. This example keeps the trust recommendations made by Siperian Hub. Using the Siperian Hub Data Management Tools 49

60 Using the Data Manager Tool Using the Data Manager Tool This section describes how to use the Data Manager. It covers the following topics: About the Data Manager Editing Records Querying, Editing, and Unmerging Records Cross-reference Instances Cell Data Editing Records Unmerging Records Querying, Editing, and Unmerging Records About the Data Manager Use the Data Manager tool to search for records, view their cross-references, unmerge records, view history records, create new records, edit records, and override trust settings. The Data Manager displays all records that meet the search criteria you define. The Data Manager consists of two screens: Screen Setup Data Manager Description Allows you to select the information you want to work with: base object, packages, query settings, and display settings. Allows you to view cross-references, unmerge records, view history records, create new records, edit records, and override trust settings. 50 Siperian Hub XU for DB2 User s Guide

61 Using the Data Manager Tool Starting the Data Manager To start the Data Manager tool: In the Hub Console, expand the Data Steward workbench, and then click Data Manager. The Hub Console displays the Setup screen of the Data Manager tool. To proceed with setup, see the next section, Setting Up a Data Manager Session on page 52. Using the Siperian Hub Data Management Tools 51

62 Using the Data Manager Tool Setting Up a Data Manager Session To set up a Data Manager session, start the Data Manager, as described in Starting the Data Manager on page 51. The Hub Console displays the Setup screen, as shown in the following example. 1. Select the base object to view. This section shows a list of the base objects that are defined in your Siperian Hub environment. The base object that you select determines the list of packages that will be shown in the next section on the setup screen. To learn more about packages, see the Siperian Hub Administrator s Guide. 2. Select the package to use to display the data. A package is a public view of one or more underlying tables in Siperian Hub it represents a subset of the columns in those tables. The packages you select are 52 Siperian Hub XU for DB2 User s Guide

63 . Using the Data Manager Tool used for presenting the data in the Data Manager screen and determines which columns can be viewed in that screen Package Type PUT package Display package Description The same sort of package you worked with as the Merge package in Merge Manager. It is used for editing data and viewing cell-level comparisons between the survived values in the base object and a selected cross-reference record. The PUT package has columns from only the base object you selected at the top of the Setup screen. Used for read-only purposes. The Display package can include data from multiple base objects for example, a Customer display package can also include Addresses. Note: If you have Customers with multiple Addresses, a display package that includes both Customer and Address will show multiple records in the Data Manager one for each Address per Customer. Note: The display package can be the package based on the selected PUT package. It can also contain columns from the additional tables (besides the base object) by creating a join to join the put-package to other tables not the base object directly. Note: If an administrator makes a change to the package you are using, these changes are not visible in the Merge Manager until you refresh the display. 3. Select the single option (Search Wizard) in the query drop-down menu. The Siperian Hub Search Wizard allows you to specify the criteria for displaying records. To learn more about using the Search Wizard, see Using the Search Wizard to See a Subset of the Data on page 76. Using the Siperian Hub Data Management Tools 53

64 Using the Data Manager Tool 4. Select the number of records to return per page. 5. Click the Begin Administration button. The Search Wizard prompts you to specify filter criteria for limiting the list of records displayed in the Data Manager screen. Once you have set your filter parameters, the Data Manager screen is displayed. 54 Siperian Hub XU for DB2 User s Guide

65 Using the Data Manager Tool Differences Between Data Manager and Merge Manager Screens At first glance, the Data Manager screen looks very similar to the Merge Manager screen. There is, however, a critical difference between the two screens. Merge Manager shows queued base object records and the base object matches found for each queued record. Data Manager shows any base object record that meets the filter criteria specified, regardless of the state of the records. This means that the Data Manager shows records regardless of whether they are queued for merging, new, or consolidated. The Data Manager also shows the cross-reference records for each base object record. Important: You must enter search criteria. If you do not, then every record in the base object will be returned. If your system has very large data sets, that could involve millions of records. In that case, the query would take a very long time and result in an extremely unwieldy result set. Note: When you sort in Merge Manager or Data Manager, you are sorting the current page of data not the entire data set. To find rows that are similar you must do a search from the setup page of these tools. Sections of the Data Manager Screen The Data Manager screen is divided horizontally into three main sections: Sections of the Data Manager Screen Section Instances for Base object records via package Cross-reference instances Cell data Description Lists the records that meet the filter criteria specified in the Search Wizard. To learn more, see Instances for Base Object Records Via Package on page 56. Lists the cross-reference records for the record selected in the top list. To learn more, see Cross-reference Instances on page 59. Lists the base object columns for the selected row. Allows you to edit data directly. To learn more, see Cell Data on page 61. Using the Siperian Hub Data Management Tools 55

66 Using the Data Manager Tool Instances for Base Object Records Via Package This section of the Data Manager screen lists the records that meet the filter criteria specified in the Search Wizard. The number of records per page is determined by the setting on the Setup screen. If you have not defined that value, then Siperian Hub will use the default page size your administrator defined for the schema. The columns for each record in this section are determined by the Display Package you selected on the Setup screen. To return to the Setup screen, click Setup Administration button at the top of the Data Manager screen. The records in this section are determined by the results of the search parameters you specified in the Search Wizard. To return to the Search Wizard, click the Search Again button at the top of the Data Manager screen. To learn more, see Using the Search Wizard to See a Subset of the Data on page 76. Click the Multiple Selection check box to select multiple records. Use CTRL or SHIFT to select multiple records in the base object pane. When two or more records are selected, the bottom two panes are cleared and only the following commands are available: Queue for matching, Queue for merge, and Set as new. The buttons on the right hand side of this section allow you to perform certain actions on the records displayed in the section. 56 Siperian Hub XU for DB2 User s Guide

67 Using the Data Manager Tool Resetting the Consolidation Flag Reset. Click this button to reset the consolidation flag to any of the following values: Consolidation Flag Settings Setting Queue for Matching Queue for Merge Set as New Description Queues the record for matching, but without the need for re-generating match tokens (which is what happens if the record is set as new as described below). The record will be queued for merge again later in a future match batch job. The Consolidation Indicator is set to 3. This is not the usual process. The recommended option is to set the record as new. Adds the record to the list of merge candidates. This row will appear the next time you use the Merge Manager tool for this base object. The Consolidation Indicator is set to 2. This option is useful if you have a consolidated record that you want to bring into Merge Manager to manually search for a match for it. For example, you know you want to merge two specific records together and there isn't enough similar data in the two records for the system to automatically match them. To merge two specific records: 1. Flag one of the records as queued for merge. 2. Go to the Merge Manager and search for that record to bring it into your assignment list. 3. Use the Search for Matches option to search for the other record. 4. Manually merge the records together. Queues the record for matching. The match tokens will be re-generated for the record and the record will be queued for merge again in a future match batch job. The Consolidation Indicator is set to 4. Using the Siperian Hub Data Management Tools 57

68 Using the Data Manager Tool Showing History Show History. If history is enabled for the base object, click the Show History button to display the history of changes on the selected base object record, as well as the merge history for the record, as shown in the following example. The Merge History panel (on the left) shows all of the rows that were merged into this row. The Base Object History panel (on the right) shows the history for the selected base object row. Editing Records Edit Record. Click this button to edit the data values in a selected record. To learn more, see Editing Records on page 66. Adding a Record Add Record. Click this button to display the Record Editor Window that enables you to add new records. To learn more, see Editing Records on page Siperian Hub XU for DB2 User s Guide

69 Using the Data Manager Tool Displaying the Relationship Dialog Display the relationship dialog. Click this button to display the Relationship Viewer. Custom-defined Buttons If configured and enabled for your Siperian Hub implementation, custom-defined buttons might be displayed in the top section of the Data Manager screen. These custom-defined buttons can be used to invoke a particular external service or perform a specialized operation (such as launching a workflow). To learn more, consult your Siperian Hub administrator. To learn about implementing custom-defined buttons, see the Siperian Hub Implementer s Guide. Cross-reference Instances The middle section of the Data Manager screen shows the cross-reference records for the record that is selected in the top list. The cross-reference records are the source system records that have been combined to form the record in the top list. The buttons on the right hand side of this section allow you to perform certain actions for the cross-reference records displayed in the section. Unmerging a Cross Reference Unmerge: Click this button to unmerge a cross reference from the selected base object. For more information about unmerging a cross reference, see Unmerging Records on page 70. Using the Siperian Hub Data Management Tools 59

70 Using the Data Manager Tool Showing Raw Records Show Raw Record: Click this button to show the raw source history for the cross-reference record. The raw source history contains the history of the record as it was received from the source system, prior to data cleansing and standardization. Showing History Show History. If history is enabled for the cross-reference record, click the Show History button to display the history of changes on the selected record. 60 Siperian Hub XU for DB2 User s Guide

71 Using the Data Manager Tool The Show History option is available only if your Hub Store is configured to track history on raw source records. Cell Data In the Data Manager screen, the Cell data grid displays a list of the base object columns. Base Object Column Properties Each base object column has the following properties: Property Column Name Trust Base Object Cell Cross-reference Cell Description Name of the column. Current trust level associated with the column value from the selected base object (calculated to current date and time). This will show only if the column has trust enabled for it. If the column does not have trust enabled, nothing will show in the trust cell. Column value from the selected base object. Column value from the selected cross-reference row. Using the Siperian Hub Data Management Tools 61

72 Using the Data Manager Tool Property Trust Description Current trust level associated with the cross-reference value (calculated to current day and time). This will show only if the column has trust enabled for it. If the column does not have trust enabled, nothing will show in the trust cell. The buttons on the right hand side of the Cell data grid allow you to do data maintenance for the merged base object at the cell level. Increasing the Trust Store Increase trust score. Click this button to increase the trust score of the selected cross-reference cell value to promote it over the cell value currently in the base object. Increasing the trust score of a cross-reference value to higher than what is currently in the base object replaces the current value of the selected cell with the cell value from the selected cross-reference record. Typically, you do this when you want a lower trust value to be increased above a higher trust value. Important: A trust score increase on a non-trusted cell does not make sense because the next time the record comes in, it will get overwritten because there is no trust. Therefore, if you override, it will be lost on the next input. As such, the option to increase the trust score on a non-trusted cell is not available in the Data Manager or Merge Manager. The Increase trust score option is very similar to the Merge Manager s trust override option. When you highlight a row with a trust value and then click the Increase trust 62 Siperian Hub XU for DB2 User s Guide

73 Using the Data Manager Tool score button, Siperian Hub prompts you to specify how confident you are of the correctness of the change. Using the Siperian Hub Data Management Tools 63

74 Using the Data Manager Tool The confidence level that you select determines the likelihood of the overridden value being updated by a subsequent data change from one of the contributing source systems. Confidence Level Low Medium High Custom Description The data value will keep the same trust settings that it had before. This will result in a low trust level. (Remember that this was not the cross-reference cell with the highest trust level). This option is greyed-out you cannot choose this option. The maximum trust and minimum trust settings will be an average of the settings that you specified for (a) the source system that provides the cell value, and (b) the Siperian Hub Admin system. In most cases, you should specify high trust settings for the Siperian Hub Admin system. The other trust settings (decay period and decay type) are based on the source system that provides the cell value. Medium confidence is the default. This option is greyed-out you cannot choose this option. Sets the maximum trust and minimum trust settings to the settings you specified for the Siperian Hub Admin source system. The cell s last update date will be changed to the current date. The other trust settings (decay period and decay type) will be based on the trust profile of the system that provides the cell value. The Data Manager prompts you to provide trust settings that apply to only this data value (as shown in the figure below). You can specify the minimum and maximum trust, decay type, and other decay settings. For more information about trust settings, see the Siperian Hub Administrator s Guide. 64 Siperian Hub XU for DB2 User s Guide

75 Using the Data Manager Tool Note: To simplify data entry, if you change the trust score for one or more cross-reference rows and then click the Commit button (see Committing Changes on page 65), the Data Manager remembers your new trust settings and applies them to any subsequently selected cross-reference rows. As with any cross-reference row, you can choose to commit, change, or cancel these automatically-applied trust values. This note applies only when the Always Commit My Updates check box is disabled (unchecked). Committing Changes For the Cell Data panel, you can have the Data Manager commit (save) any of your changes automatically, or you can configure the Data Manager to allow you to commit your changes manually. This feature applies whenever you override the trust setting or edit a record in the Cell Data panel. Committing Changes Automatically If the Always Commit My Updates check box is checked (selected), then the Data Manager will commit any of your changes automatically. This applies whenever you override the trust setting or edit a record in the Cell Data panel. Using the Siperian Hub Data Management Tools 65

76 Using the Data Manager Tool Committing Changes Manually Commit: Editing Records You can edit the data in the base object to correct incorrect values, if required. This applies whenever you override the trust setting or edit a record in the Cell data grid. One way to do this is to double-click the base object cell in the Cell data grid at the bottom of the Data Manager screen, and then type the correct value in the cell. To save your changes, click the Commit button. Alternatively, you could use the Edit Record button to the right of the Instances for Base Object grid at the top of the screen. This section describes how to edit or add records. Guidelines for Editing Records When editing records, consider the following guidelines: You can edit the data in the base object to correct incorrect values, if required. When you manually edit data, Siperian Hub does not overwrite the value provided by the source system. Instead, the manual edit is regarded as having come from a special source system called Siperian Hub Admin. The Siperian Hub Admin system has trust rules associated with it in exactly the same way that other source systems have. Siperian Hub will let you save an edit if it fails any validation rules that have been defined for the base object, but not if the validation rule will result in the trust on the value being downgraded to 0. When you first edit a record, Siperian Hub inserts a new cross reference that stores the cell values that you typed. Any later edits simply update that cross-reference record. If the edited cell does not have trust rules defined for it, then Siperian Hub simply applies the update to the base object. If the edited cell does have trust rules defined for it, then Siperian Hub calculates the trust for the update (using the trust 66 Siperian Hub XU for DB2 User s Guide

77 Using the Data Manager Tool weightings defined for the Siperian Hub Admin system) and for the existing value in the cell. Regardless of the trust setting, the edit is always applied to the base object (except when a validation rule will result in a trust value of 0, as described above). In the rare case where the Siperian Hub Admin system has been given a lower trust value than another source system, the update is still applied, but will most likely be overwritten the next time an update is received from the source systems. Editing or Adding a Record To edit an existing record or add a new one: 1. Do one of the following: Click This Button Edit Record Add Record To Edit the data values in a selected record. Be sure to select the record that you want to edit. Add a new record. Using the Siperian Hub Data Management Tools 67

78 Using the Data Manager Tool The Data Manager displays the Record Editor for the selected record, as shown in the following example. 2. Make the changes you want in the available fields. 3. If you want to see all cells (not just editable cells), uncheck (clear) the Show only editable cells check box. 4. Click OK to close this dialog box. Null Values The Record Editor supports null values in integer, date, and lookup fields. If these fields are edited, when you select OK, the values no longer are updated a null value remains null. Null Values in Record Editor Fields Value Integer Value Date Value Description When the value is null, the text is set to blank. You can set a value by typing a value in the field, or by clicking the up and down buttons. When the value is null, the date shows a blank field. You can use the standard editing features to set a date. As soon as you enter a value in any of the fields, the rest of the fields are populated with the current date and time. 68 Siperian Hub XU for DB2 User s Guide

79 Using the Data Manager Tool Null Values in Record Editor Fields (Cont.) Value Description Lookup Value When the value is null, no items in the list are selected. Overriding Trust Settings You can set override trusts wherever a Set Trust Override Settings button is displayed. After choosing Custom or High Confidence, be sure to click the Set Default Trust Override button. To learn more, see Increasing the Trust Store on page 62. Showing Only Editable Cells To show all cells, including system columns (such as rowid_object), uncheck (clear) the Show only editable cells check box. Looking Up a Value To look up a value for a cell: 1. Click the down arrow in the list for that field, as shown in the following example. Using the Siperian Hub Data Management Tools 69

80 Using the Data Manager Tool 2. Select the value you want in the list. 3. Click OK to save your changes with the selected value. Best Practice Guidelines Manual edits should be done only in exceptional cases. It is always better to have the data corrected in the source system, as that starts a process of continuous data improvement. Before you do a manual edit, consider the consistency with which that change must be applied to data. If you are making a change that must be consistently applied to many records, then it is usually better to define a data cleansing function to apply the change consistently and to reduce the amount of manual work. For example, if you change the abbreviation Co to Company in a record, chances are that there will be other records that should have the same change applied to them. In this case, your Siperian Hub implementation team can create a cleansing rule that automatically replaces Co with Company. About Unmerging Records Unmerging Records This section describes how to unmerge a record. Click the Unmerge button in Data Manager to reinstate the selected row in the cross-reference table as its own base object row and to remove the influence of that row on the current base object. Effects of Reinstating a Row To understand the implications of reinstating a row, consider the following example: 1. Start with four base object rows: A, B, C, and D. Merge A and B, and merge C and D. You later merge AB and CD. This gives you one row: ABCD. 2. If you reinstate C, you have two rows: C and ABD. Even though D was initially merged with C, it remains part of the merged base object ABD. 70 Siperian Hub XU for DB2 User s Guide

81 Using the Data Manager Tool 3. The new base object contains all of the cells in the current cross-reference row for C, and has the same value for ROWID_OBJECT that C originally had. If C does not contain some columns, the base object contains either the default value or NULL. Note: Siperian Hub will reinstate the original ROWID_OBJECT value of the cross-reference record. When you merge two or more rows, the merged row gets the same value for ROWID_OBJECT as one of the original rows. If you reinstate this row, Siperian Hub merges all of the remaining cross-reference records into a ROWID_OBJECT that originally belonged to one of the remaining cross references. 4. Every row in a dependent object that referred to C (based on the source system primary key) now refers to the new base object. 5. User-defined foreign key relationships are handled differently from the foreign key relationships that Siperian Hub automatically creates for a dependent object. Every user-defined foreign key that pointed to base object ABCD continues to point to ABD, even if that foreign key originally pointed to C. 6. All influence of the values from C is removed from the existing base object ABD. For columns that have trust rules defined, the values with the highest trust from A, B, and D will be reflected in the base object. For columns that do not have trust rules defined, the values from the last record merged will be reflected in the base object. About the Siperian Hub Admin Cross-reference Records The Siperian Hub Admin cross-reference records that are created by manual edits can be removed from the base object by selecting that cross-reference record and clicking the Unmerge button. In this case, Siperian Hub simply deletes the cross-reference record. This is the only situation in which Siperian Hub deletes any data. Using the Siperian Hub Data Management Tools 71

82 Using the Data Manager Tool Querying, Editing, and Unmerging Records This is a step-by-step walkthrough of the process of querying data, viewing data lineage and history, editing data, and unmerging records using the Data Manager tool. This example uses the same scenario as the Merge Manager step-by-step example (see Manually Merging Records on page 46). The example shows how to edit a city name, view the history of that record, and then unmerge a cross reference from the record. To query, merge, and unmerge records: 1. Select the Data Manager tool in the Data Steward workbench, or proceed to step 2 in the Consolidate Records process from the Processes tab. 2. Select the base object that you want to review, and the package to be used to view the data. 72 Siperian Hub XU for DB2 User s Guide

83 Using the Data Manager Tool 3. Click Begin Administration. 4. Specify the query parameters. The attributes you can choose in the drop-down list depend on the Display Package you selected in the Setup screen. To learn more, see Using the Search Wizard to See a Subset of the Data on page 76. The example sets up the query parameter to find all records in which the City Name begins with the letter N, or in which the city name includes the letters New York. The query is case-sensitive. Use the button to add a new parameter. You can use AND or OR conjunctions in this query, but never mix them in the same query. Mixing AND and OR conjunctions will generate unpredictable results. If you need to remove a parameter, select the check box at the beginning of the row, then click the button. Click Finish. 5. In the Base object list box (top) on the Data Manager screen, select one of the rows. Note that the cross-reference records for the selected row are automatically displayed in the middle list box. Using the Siperian Hub Data Management Tools 73

84 Using the Data Manager Tool In the example following, the customer named Elizabeth S O Brien is selected in the top list box. Elizabeth S O Brien has four cross-reference records one from the Credit Management source system, and three from the Call Center source system. In this example, a sales representative calls the data steward directly and says the customer has complained that the bank just cannot seem to get her name right. Her surname should be spelled O Brian and her middle initial is F, not S. The sales representative spells out the customer s full middle name as Frederika. Furthermore, the sales representative complains that there are call details for the customer that simply should not be linked to that customer. The data steward investigates and determines that the Call Center record for Beth O Brien should not be linked to the records for Elizabeth O Brian. The data steward must take the following steps to correct the data: Increase the trust score for the O Brian cell value from the Credit Management system over the O Brien value currently in the base object, giving the change a high confidence rating. Manually edit the Middle Name to be Frederika. Select the Beth O Brien cross-reference record and unmerge it from the Elizabeth Frederika O Brian base object record. 74 Siperian Hub XU for DB2 User s Guide

85 Using the Data Manager Tool 6. Click on O Brian in the cell data for the cross-reference record. 7. Click the Increase Trust Score button to override trust settings for the selected O Brian cell value over the value currently in the base object. 8. Choose High Confidence. 9. Click Finish. The base object details is updated to display O Brian instead of O Brien in the Last Name. 10. Select the Middle Name cell in the left hand section of the Cell data grid, and type the correct middle name for the customer into that cell. 11. Click the Commit button to save the data change. Using the Siperian Hub Data Management Tools 75

86 Using the Search Wizard to See a Subset of the Data The base object details will be updated to display Frederika instead of S in the Middle Name. An additional cross-reference record from the Siperian Admin source system will be shown in the cross reference, as shown in the following figure. 12. Select the record for Beth O Brien in the cross-references grid. 13. Click the Unmerge button to unmerge the cross-reference from the base object. The Data Manager will ask you to confirm the unmerge action. 14. Click Yes. Siperian Hub confirms the unmerge, and then refreshes the Data Manager display to remove the unmerged record from the list of cross-reference records. Using the Search Wizard to See a Subset of the Data The Search Wizard allows you to filter the data you want to work with by specifying a query. You can access the Search Wizard in both the Data Manager and Merge Manager tools. The instructions in this section apply to both tools. To use the Search Wizard to see a subset of the data: 1. In the Query drop-down list (of either the Data Manager or Merge Manager tool), choose Use Search Wizard. 2. After you have filled in the form, do one of the following: In the Data Manager, click Begin Administration. In the Merge Manager, click Begin Merge. 3. If the Welcome screen is displayed, click Next. 76 Siperian Hub XU for DB2 User s Guide

87 Using the Search Wizard to See a Subset of the Data The Siperian Hub Search Wizard is displayed. Note: If you want to retrieve all rows, simply click Finish without specifying any parameters. 4. Click the Add Parameter button to add a new parameter. Using the Siperian Hub Data Management Tools 77

88 Using the Search Wizard to See a Subset of the Data 5. For each query parameter, specify the following settings. Query Parameter Settings Parameter Logical Conjunction Column Name Description Used when multiple query parameters are defined. One of the following values: AND Logical AND. Indicates that, for a given row, this query parameter must be True in order for the row to be included in the search results. OR Logical OR. Indicates that, for a given row, this query parameter (or another query parameter) must be True in order for the row to be included in the search results. Note: For queries involving multiple query parameters, the conjunctions must be either all AND or all OR, but never a mixture of both. Mixing both will yield unpredictable results. Name of a column in the selected table. 78 Siperian Hub XU for DB2 User s Guide

89 Using the Search Wizard to See a Subset of the Data Query Parameter Settings (Cont.) Parameter Search Operator Search Value ignore case Description Expression used to determine whether a row is included in the search results. One of the following values: is exactly value in this column must be identical to the search value. begins with value in this column must begin with the search value. ends with value in this column must end with the search value. contains value in this column must contain the search value. does not contain value in this column must not contain the search value. is like value in this column must be like the search value (includes column values that match the search value). For example, if the search value is %JO% for the last_name column, then the parameter will match column values like Johnson, Vallejo, Major, and so on. is not like value in this column must not be like the search value (excludes column values that match the search value). For example, if the search value is %JO% for the last_name column, then the parameter will omit column values like Johnson, Vallejo, Major, and so on. is greater than value in this column must be greater than the search value. is less than value in this column must be less than the search value. is in between value in this column is in between two values. is empty this column must be empty (it cannot contain any value). is not empty this column cannot be empty (a value is required). Value used in conjunction with the column name and search operator to determine whether a given row is included in the search results. You can use the % wildcard, just as you would in SQL statements. To treat the % character as a literal character instead of a wildcard, precede it with the escape character (\), as in the following example: 50\% Sale If checked (selected), then the Search Wizard treats uppercase and lowercase letters as equivalent (for example, CA = Ca ). If unchecked (cleared), then the Search Wizard treats uppercase and lowercase letters differently (for example, CA does not equal Ca ). Using the Siperian Hub Data Management Tools 79

90 Using the Search Wizard to See a Subset of the Data For example, you can set up the query parameter to find all records where the State column contains the string NY. You can add more parameters using the button. If you need to remove a parameter, select the check box at the beginning of the row, then click the button. You must have at least one filter parameter. 6. Click Finish. 80 Siperian Hub XU for DB2 User s Guide

91 4 Using Hierarchy Manager This chapter explains how to use Hierarchy Manager (HM) to deliver consolidated customer relationship views that enable you to create, manage, navigate, and consolidate relationship data across different applications and data sources. Chapter Contents About Hierarchy Manager Starting the Hierarchy Manager Tool Navigating Hierarchy Manager Searching For Entities and Relationships Working with Entities and Relationships Note: Before using Hierarchy Manager, you must be thoroughly familiar with the schema and data sources used in your Siperian Hub implementation. You draw upon this understanding in order to establish or modify relationship criteria in Hierarchy Manager. 81

92 About Hierarchy Manager About Hierarchy Manager Siperian Hierarchy Manager (Hierarchy Manager or HM) builds on Siperian Master Reference Manager (MRM) and the repository managed by Siperian Hub for reference and relationship data. Hierarchy Manager gives you visibility into how relationships correlate between systems, enabling you to discover opportunities for more effective customer service, to maximize profits, or to enact compliance with established standards. Note: Hierarchy Manager is a part of Siperian Hub it is not a stand-alone product. It is used in conjunction with Siperian MRM and requires MRM s capabilities, such as match and merge. About the Hierarchy Manager Tools Hierarchy Manager consists of two tools in the Hub Console: Tool HM Configuration tool Hierarchy Manager tool Description Used by Siperian Hub administrators to set up the structures required to view and manipulate data relationships in Hierarchy Manager. Using the HM configuration tool, administrators can add tables; define foreign key constraints, queries and packages; add entity types, hierarchies and relationship types; and configure Hierarchy Manager packages. To learn more about these Siperian Hub structures, see the Siperian Hub Administrator s Guide. Used by data stewards to define and manage hierarchical relationships in their Hub Store. This chapter explains how to use the Hierarchy Manager to work with entities and relationships. These tools are accessible via the Hierarchy Manager workbench. 82 Siperian Hub XU for DB2 User s Guide

93 About Hierarchy Manager About Transactional and Master Data Companies generally accumulate and track two different types of data: transactional data and master data. About Transactional Data Transactional data represents the actions performed by an application, typically captured or generated by an application as part of its normal operation. It is usually maintained by only one system of record, and tends to be accurate and reliable in that context. For example, your bank probably has only one application for managing transactional data resulting from withdrawals, deposits, and transfers made on your checking account. Master Data Master data represents people and things (sometimes also known as reference data). Master data is usually scattered among a variety of applications, most or all of which do not communicate with each other. This makes it difficult to view and manage customer relationships across the entire system. For example, your bank may offer checking accounts, savings accounts, money market accounts, small loans, and college accounts, but it may not be set up to keep all customer name and address information in the same database. If you start with a checking account with them and later add a money market account, your name and address information will probably be entered again. If the information is entered incorrectly, or the information you give differs in any way from the information you gave when your checking account was created, the two sets of records may not match. Using Hierarchy Manager 83

94 About Hierarchy Manager About Entities and Entity Types An entity is any object, person, organization, place or thing that has meaning and can be acted upon in your database. Example entities include: Nicole Simon Checking Account #83270 Santa Cruz Medical Clinic 1820 Gateway Drive Each general class of entities can be described by a particular entity type that makes them easy to identify. Example entity types include: Doctors Medical Groups Hospitals You can have any number of entity types for your Hierarchy Manager implementation, but each entity can have one and only one entity type. About Hierarchy Manager Relationships and Relationship Types A relationship describes the affiliation between two specific entities. Hierarchy Manager relationships are defined by specifying the following properties: Property Relationship type Hierarchy type Attributes Description General class of relationship to which this particular Hierarchy Manager relationship belongs. General class of the hierarchy under which this relationship falls. Characteristics of this particular relationship. They are not necessarily unique. 84 Siperian Hub XU for DB2 User s Guide

95 About Hierarchy Manager Property Start and end dates Description Specific period of time during which the relationship is considered active. (If the current date is outside of that period, the relationship does not get deleted, it is just considered inactive.) Note: When you create Hierarchy Manager relationship tables in DB2, the data type for the start and end dates columns (REL_ START_DATE and REL_END_DATE) must be Timestamp, not Date. The following figure shows example relationships among data. Depending on the criteria, you can define relationships as broadly or narrowly as desired. Hierarchy Manager places no limits on the number of HM relationships an entity can have. Relationship types describe general classes of relationships. The relationship type defines: the types of entities that a relationship of this type can include the direction of the relationship (if any) how the relationship is displayed For example, if your database has two entity types doctor and hospital the Hierarchy Manager relationship type between doctors and hospitals might be something like Resident or Attending Physician. As with entity types, the label you give to each relationship type should be something that makes it easy to identify. You can have any number of relationship types for your Hierarchy Manager implementation, but each relationship can have only one relationship type. Using Hierarchy Manager 85

96 About Hierarchy Manager About HM Hierarchies Hierarchy Manager hierarchies are sets of relationship types. These relationship types are not ranked based on the place of the entities of the hierarchy, nor are they necessarily related to each other. They are merely relationship types that are grouped together for ease of classification and identification. For example, you might group organization-to-individual and organization-to-community relationships under the hierarchy Scholarships. Another common example is a Hierarchy based on the source system from which the relationship record came. For example, you might have Org-Customer relationship type in both Siebel and SAP hierarchies. The association between relationship types and hierarchies is many-to-many. Same relationship type can belong to multiple hierarchies and a hierarchy can have multiple relationship types. A relationship record however can have only ONE relationship type and hierarchy. About Sandboxes A sandbox is a virtual playground where users with the appropriate privileges (as defined in their HM Profile) can manipulate relationship records without affecting the original master record. In this way they can predict the results of their manipulations and see if they will be meaningful in the context for which they are created. Every sandbox (except the master) has a parent sandbox. When you create a new sandbox, new HM relationship base objects are created and records from relationship base objects in the parent sandbox are copied into the new relationship base objects. You cannot promote individual changes from one sandbox to another. Promoting a sandbox basically means switching that sandbox with the old master i.e. demoting the old master. When you promote a sandbox, you can specify a new name for the sandbox being promoted and the sandbox being demoted. All this really means that if your API calls or users use a specific sandbox, they do not have to know that a switch has been made. 86 Siperian Hub XU for DB2 User s Guide

97 About Hierarchy Manager Warning: There are number of restrictions in the way sandboxes are implemented and in certain cases we do not allow sandboxes to be promoted. In addition, if you get batch updates (after the initial load) for relationship base objects, it may not be wise to promote sandboxes because these updates will continue going to the relationship base objects associated with the old Master. For more information on sandboxes, see Working with Sandboxes on page 127. About HM Profiles The HM implementer is responsible for designing and setting up the hierarchies, entity types and relationship types. The Implementer then defines one or more HM Profiles, which describe what fields and records HM users may display, edit, or add. For example, there can be one profile that allows full read and write access to all entities and relationships and another profile that is read-only (no add or edit operations allowed). Another situation where you might use a profile is where a user may be allowed to access certain relationship types but not others. For example, you have two relationship types; Org-Customer and Org-Org. One user may have access to both these relationship types but another user may only have access to Org-Org Rel type. HM profiles are assigned to users through MRM roles. If a user ends up having access to multiple HM profiles via MRM roles, the user is prompted at the appropriate time to select the profile with which to work. Users specify which profile and sandbox they want to use at HM startup. For a description of what happens when you start HM, see Starting the Hierarchy Manager Tool on page 88. Using Hierarchy Manager 87

98 Starting the Hierarchy Manager Tool Starting the Hierarchy Manager Tool You access Hierarchy Manager through the Hub Console. Your software license must have Hierarchy Manager enabled in order to see the Hierarchy Manager workbench. If you cannot see this workbench, contact your administrator. Note: Most data stewards will only see the Hierarchy Manager tool in the Hierarchy Manager workbench. However, if you have privileges to access it, you also see the HM Configuration tool. To start the Hierarchy Manager tool: In the Hub Console, expand the Hierarchy Manager workbench, and then click Hierarchy Manager. Alternatively, in the Hub Console toolbar, click the Hierarchy Manager tool quick launch button. The Hub Console displays HM. You will be prompted to select the HM Profile & Sandbox if you have access to multiple HM profiles or if there are multiple sandboxes. The Hub Console window expands to include the Hierarchy Manager menu. The first time this window is displayed, the window is collapsed. Click the handles to expand all available windows. 88 Siperian Hub XU for DB2 User s Guide

99 Navigating Hierarchy Manager Navigating Hierarchy Manager This section describes how to navigate the Hierarchy Manager. About Views in Hierarchy Manager The Hierarchy Manager tool has two views for creating and manipulating relationships: Graphic View and Text View. About the Graphic View The graphic view allows you to add and display entities and relationships in a graphical format. You can also drag and drop entities and relationships into the text view area below in order to see more detailed information. The following figure shows an example graphic view. Using Hierarchy Manager 89

100 Navigating Hierarchy Manager The Graphic View consists of the following components: Component Graphic View toolbar Graphic View window Overview window Entity/Relations Objects window Description A collection of quick start buttons that enable you to manipulate the size and magnification of items in the graphic view pane, and provide quick access to HM functions in the graphic view. Displays a detailed graphic view of entities and relationships. Displays a telescoped view of all of the data in the graphic view. Used to navigate to the precise data of interest. Data so navigated displays in the graphic view window. Displays details of individual entity and relationship objects shown in the graphic view. When populated by relationship data, the graphic view windows look similar to this: All operations in the graphic view are performed using either the graphic view toolbar or the graphic view context menus. About Graphic View Toolbar The Graphic View toolbar provides access to functions that enable you to: Search for entities and relationships Fetch relationships and related entities Select and view relationships 90 Siperian Hub XU for DB2 User s Guide

101 Navigating Hierarchy Manager The following table introduces the Graphic View toolbar. To learn more about how to perform searches, see Searching For Entities and Relationships on page 102. To learn more about how to create and manipulate relationships, see Working with Entities and Relationships on page 111. Toolbar Button Search Fetch One Hop Fetch Many Hops Fetch Many Hops... Zoom In Zoom Out Zoom All Zoom Selected Select Mode Change to Edit Mode Select All Select Unselected Description Search for entities and relationships. To learn more, see About the Levels of Search on page 104. For the selected entities, fetch multiple levels of immediate relationships and related entities using current filter. To learn more, see Fetching One Hop on page 112. For the selected entities, fetch multiple levels of relationships and related entities using current filter and many hops. To learn more, see Fetching Many Hops on page 113. For the selected entities, allow changing the many hop options and fetch multiple levels of relationships and related entities using current filter. To learn more, see Fetching Many Hops Without Limits on page 113. Zoom in and enlarge the graphic view. Zoom out and make the graphic view smaller. Zoom in to display entire graphic view. Zoom in on selected entities and relationships. Toggle between Select mode and Edit mode. In Select Mode, you can select entities in the graphic view and drag and drop to transfer them to the text view or to create new relationships by dragging one or more entities of the same type and dropping them over another entity. In Edit Mode, you can select an entity in the graphic view and drag and drop to rearrange entities. Select all entities and relationships in graphic view. Reverse the selection of entities and relationships in the graphic view. Using Hierarchy Manager 91

102 Navigating Hierarchy Manager Toolbar Button Clear Selected Layout Filter Save Print Description Remove selected entities and relationships from the graphic view. No changes are made to these items in the database, they are just removed from the display. Change graphic view layout. For example, hierarchic, orthogonal, or tree layout. See Selecting Graphic View Layouts on page 92. Set type of information to display in graphic view. See Creating Graphic View Filters on page 95. Save the graphic view to a.jpg file. Print the graphic view. About Graphic View Context Menus Use the Graphic View context menu to perform various tasks such as, adding, editing, viewing history, and cross-referencing your hierarchies. There are four different context menus in the graphic view, depending on whether you select a single entity, a single relationship, a collection of different items, or the background (the mouse not over any entity or relationship). Selecting Graphic View Layouts The Graphic View window displays many levels of relationships in a graphical way. Choose a graphical layout, then use the Overview window to navigate to the part of the window you wish to examine more closely. You can choose any of the following graphical layouts: 92 Siperian Hub XU for DB2 User s Guide

103 Navigating Hierarchy Manager About Hierarchic Layouts The hierarchic layout highlights the main direction or flow within a directed graph. About Organic Layouts The organic layout is a multi-purpose layout for undirected graphs, based on the force-directed layout paradigm. Using Hierarchy Manager 93

104 Navigating Hierarchy Manager About Orthogonal Layouts The orthogonal layout represents complex networks using the topology-shape-metrics approach. About Circular Layouts The circular layout produces layouts that emphasize group and tree structures within a network. 94 Siperian Hub XU for DB2 User s Guide

105 Navigating Hierarchy Manager About Tree Layouts The tree layout creates a top-down graph with branches for subsidiary information (tree-structured graph). Creating Graphic View Filters You can use the Filter button to set the type of information to display in the graphic view. A filter controls the type of relationships you see. Filters apply to the data you already have in the display. It removes items that do not match the filter criteria. Filters also apply to subsequent fetch operations. Only items that match the filter criteria are displayed. To create a filter: 1. On the HM toolbar, click the Filter button. Using Hierarchy Manager 95

106 Navigating Hierarchy Manager The Filter Graph View screen is displayed. 2. Select and deselect the appropriate filter criteria in the Hierarchy, Relationship Type, and Relationship Directions lists. Use Shift-Click to select multiple items. 3. If desired, select a filter. Filter Show Inactive Relationships Perform Layout Hide Unconnected Entities Count relationships for leaf nodes Action Displays relationships whose duration has expired. The inactive relationships are shown using dotted lines in the graphic view window, and with a red background in the list. Rearranges the entities and relationships using the selected layout.it also removes unconnected entities from the graphic view. Removes unconnected entities from the graphic view. Calculates the total number of relationships for the leaf entities. If leaf entities have many relationships, un-check this option for better performance. 4. Click OK. 96 Siperian Hub XU for DB2 User s Guide

107 Navigating Hierarchy Manager When data is present in a display before you set a filter, setting a filter may remove relationships which do not match the filter criteria. It may also disconnect entities which previously connected to other items in the display, but now do not. About the Text View Use the Text View to display detailed information on entities and relationships in a table format, adding, editing and displaying entities and relationship. The following figure shows an example of the Text View. The Text View consists of the following components: Component Text View window Text view toolbar Description Displays a list of entities (on the left and right panes) and relationships (in the middle pane). Provides quick access to the following Hierarchy Manager functions in the text view: Search Edit Add Using Hierarchy Manager 97

108 Navigating Hierarchy Manager The following figure shows an example of the Text View windows when populated by relationship data. About the Text View Toolbar The following table introduces the Text View toolbar. To learn more about how to perform searches, see Searching For Entities and Relationships on page 102. To learn more about how to create and manipulate relationships, see Working with Entities and Relationships on page 111. Toolbar Button Search Edit Add Remove Edit All Remove All Description Search for entities or relationships depending on where the button was clicked. Edit the selected entity or relationship using the Record Editor. Add an entity or relationship. End Date a relationship. Edit all selected relationships (available if all selected relationships have the same Relationship Type). End Date all selected relationships. 98 Siperian Hub XU for DB2 User s Guide

109 Navigating Hierarchy Manager About Text View Context Menus Use the Text View context menu to perform tasks such as, adding, editing, viewing history, and cross-referencing your hierarchies. The context menu looks different, depending on whether you are in an entity panel or a relationship panel. Hierarchy Manager Tool Menu The Hierarchy Manager tool menu controls all the operational characteristics of your HM session. Setting the Hierarchy Manager Properties The HM Properties command configures constraints on the current views, configures how views will appear in new panes you may create, and other miscellaneous characteristics. To set HM properties: 1. Start the Hierarchy Manager tool. To learn more, see Starting the Hierarchy Manager Tool on page From the Hierarchy Manager menu, choose Hierarchy Manager properties. Using Hierarchy Manager 99

110 Navigating Hierarchy Manager The Hierarchy Manager Properties screen is displayed. 3. Set the desired HM properties, then click OK. To reset these values to the product defaults at any time, re-enter the HM properties and choose Reset to default values. The following table describes settings that you can change. Setting Number of visible entries in text panes Maximum # of results returned by one hop Search results page size Show graph mode Description The number of items to display in the text panes. When you have more than this number of entities, the paging control at the bottom of the panel can be used to move between pages of entities. Default value is 20. The maximum number of items to display when fetching one hop. Default value is20. The maximum number of matching items to display in the Search dialog results tab for any type of search. If the total items found exceeds this size, you can use the paging control to go to the next page of results. Default value is 20. Check this box to enable graph mode when using HM. Default value is checked. 100 Siperian Hub XU for DB2 User s Guide

111 Navigating Hierarchy Manager Setting Show text mode lists Show text mode properties Add one hop search results Link text view split panes Description Check this box to enable text mode lists. Default value is checked. Check this box to enable text mode properties. Default value is checked. Check this box to automatically display one hop results when entities are added to text panel either from search results or by drag-and-drop from the graph view. Default value is checked. Check this box to synchronize the resizing of all three text view properties panes that second layer of panes below the entity and relationship lists. (For example, when you change the height of one text view properties pane, the other two properties panes are changed accordingly). Default value is checked. To learn more about Hierarchy Manager properties, see Siperian Hub Administrator s Guide. Changing Other Hierarchy Manager Properties In addition to the properties that can be changed using the HM Properties menu, you can also override the default entity font size (38 pts) and maximum entity box width (600 pixels) using settings in the cmxserver.properties file. To change default entity font size: 1. Open the following file for editing: <Siperian_Home>/ /cmxserver.properties 2. Find the following values: sip.hm.entity.max.width=maxwidth sip.hm.entity.font.size=fontsize Using Hierarchy Manager 101

112 Searching For Entities and Relationships 3. Edit the values. The possible values for the entries are: sip.hm.entity.max.width (legal value = ) sip.hm.entity.font.size (legal font point size = 6-100) When you specify values, Hierarchy Manager resets them if: they are outside the acceptable range (resets to the closest value, either the minimum or maximum allowed value). they are non-numeric (reset to the default value) 4. Save and close the file. Searching For Entities and Relationships This section describes how to use Hierarchy Manager to search for and view entities and relationships.hierarchy Manager About the Search for Data Objects Screen You can search for records from the Graphic View window, or from any of the Text View lists: the left and right Entity list, and center Relationship list 102 Siperian Hub XU for DB2 User s Guide

113 Searching For Entities and Relationships When you initiate searches from the Graphic View window, the Search for Data Objects screen provides two tabs: one for searching for entities, and the other for searching for relationships. A search started from an Entity panel displays the tab enabling you to search for entities; a search started from a Relationship panel displays the tab enabling you to search for relationships. The above example Search for Data Objects screen contains the following components: Component Entity Search tab Relationship Search tab Search Level drop-down list Reset button Save Search/Bookmark Description Searches for entities based on criteria you supply. Available in searches initiated in Graphic View or in the Text View entity list. Searches for relationships based on criteria you supply. Available in searches initiated in Graphic View or in the Text View relationship list. Select from search levels: Basic, Advanced, and Indirect. To learn more, see About the Levels of Search on page 104. Clears the criteria of the current search. Saves the current query (search criteria) as a bookmark on the local machine, for future retrieval. Using Hierarchy Manager 103

114 Searching For Entities and Relationships About Searches This section describes the three different levels of entity or relationship search, and how to create a new basic search. About the Levels of Search Hierarchy Manager provides these levels of search: Level Basic Advanced Indirect (Entity search only) Description Enables you to search for entities or relationships by any or all searchable fields, each of which can be included in the query once. A field is used in the search query only when a search value is specified. Criteria are added to the search by use of the AND operator. For instance, all (not any) criteria must match for a record to be returned. Enables you to search for entities or relationships by any or all searchable fields, each of which can be included in the query more than once. Criteria are added to the search by use of AND or OR operators. Enables you to search for entities based on attributes of its relationships or related entities. It also allows you to search for entities based on the number of relationships of a specific type an entity has.for example: Households that have more than three members Customers who have a policy greater than $50,000 in value Customers who have more than 10 policies (connection count > 10, and account role of owner ) Customers who have a policy greater than $50,000 in value, which was created after 1 January 2006 (this assumes that the start date of the relationship between the customer and the policy is the date when the policy was created) 104 Siperian Hub XU for DB2 User s Guide

115 Searching For Entities and Relationships Creating a New Search To create a new search for records in Hierarchy Manager: 1. Start the Hierarchy Manager tool. To learn more, see Starting the Hierarchy Manager Tool on page On the HM toolbar, click the Search button. The Search for Entities screen is displayed, open to the Search tab. 3. If necessary, make sure the correct search tab (Entity or Relationship) is active. (See About the Search for Data Objects Screen on page 102.) 4. Select the appropriate entity type or relationship type for the records you wish to locate. The criteria change to match the type selected. 5. From the Search Type drop-down list, select the desired level of search (see About the Levels of Search on page 104). The default is Basic. 6. Fill in the criteria for the search. Using Hierarchy Manager 105

116 Searching For Entities and Relationships 7. Click Search. Hierarchy Manager redisplays the Search For Entities screen, open to the Results tab. 8. Highlight the record that you want to display and click Select. The selected record displays, in the window where you started your search; the Graphic window, the Text View Entities list, or the Text View Relationships list. Searching Again To save the search you just made, bookmark it according to the instructions in Bookmarking Your Search on page 106. To clear the screen and start again, click the Reset button. The records you selected are saved in the Recent tab for the rest of this working session. Bookmarking Your Search If you expect to use a particular set of search criteria often, you can bookmark them to save them for later re-use. Note: Bookmarks save search criteria only on the local machine. 106 Siperian Hub XU for DB2 User s Guide

117 Searching For Entities and Relationships To bookmark a search: 1. With the search still open, click the Bookmark button. The Bookmark dialog box is displayed. 2. Enter a name for the new bookmark. 3. Click OK. The bookmarked search now is displayed on the Bookmarks tab. To learn more about retrieving bookmarked searches, see Using Bookmarked Searches on page 110. Using Hierarchy Manager 107

118 Searching For Entities and Relationships Re-using a Previous Search You can re-display records that you found and displayed during a search you made earlier in this working session, or re-use search criteria that were bookmarked earlier on this machine. Note: A search can result in many records but you will probably select only a few of those records to view in the Graphic or Text view panes. Only the records you selected are saved in the Recent tab. Re-displaying items you examined in a recent unsaved search A search can result in many records. These records are displayed in the Results tab. If you select any items from the Results tab, they are saved in the Recent tab. To re-display results you examined earlier in this session: 1. On the Search For Entities screen, click the Recent tab. 2. Highlight the desired record from the list, and click Select. 108 Siperian Hub XU for DB2 User s Guide

119 Searching For Entities and Relationships The Search for Data Objects screen redisplays, with the Results tab in focus. The records you examined the last time you used those search criteria, are present there for the rest of this working session. 3. Select the desired record, then click Select. The selected record displays. in the same window in which the original search originated. To learn more about how to save search criteria on the local machine for future use, see Bookmarking Your Search on page 106. Using Hierarchy Manager 109

120 Searching For Entities and Relationships Using Bookmarked Searches To re-use search criteria that have already been bookmarked: 1. On the Search For Entities screen, click the Bookmarks tab. 2. Highlight the desired bookmark from the list and click Select. Note: To rename or remove a bookmark, right-click and use the context menu. The Search for Data Objects screen reappears, with the Results tab in focus. 3. Select the desired bookmark, then click Select. 110 Siperian Hub XU for DB2 User s Guide

121 Working with Entities and Relationships The selected bookmarked search executes. The results are displayed in the original search window. Working with Entities and Relationships This section describes how to fetch entities and relationships from the Siperian Hub server and how to work with them after they have been fetched. It describes how to add and modify entities and relationships and how to create copies of relationships for analysis. The instructions in this section assume that you are already familiar with the Graphic View and Text View features, as described in Navigating Hierarchy Manager on page 89), and that you understand how to display entities and relationships in Graphic View and Text View. About Fetching Relationships After performing a search on a particular entity, you can view its relationships to other entities. Retrieving information about relationships is called fetching. Note: The fetching options are only available in the graphic view. Displaying Entities and Relationships The Graphic View window displays many levels of a relationships in a graphical way. Choose a graphical layout, then use the Overview window to navigate to the part of the hierarchy you wish to examine more closely. To learn more about using the various graph view layouts, see Selecting Graphic View Layouts on page 92. Note: In the graphic view, what you see is determined by the settings in your filter. To learn more about setting up a data filter in Graphic View, see Creating Graphic View Filters on page 95. Using Hierarchy Manager 111

122 Working with Entities and Relationships The Text View windows display a single level of relationship: one entity related directly to another. You can start a search from either the Relationship List or the Entity List, as shown in the following example. Note: Inactive relationships are not cleared from the middle panel of the text view automatically. To clear them, either left-click in the middle panel and use the context menu options, or specify clear existing relationships when executing a one-hop search. Fetching One Hop To retrieve relationships directly related to one or more entities, use fetch one hop. To fetch one hop: 1. Highlight one or more entities of interest. 2. Right-click on the entity to display the context menu, and choose Fetch One Hop. 112 Siperian Hub XU for DB2 User s Guide

123 Working with Entities and Relationships Note: You can also go to the HM Tool bar and click the Fetch One Hop button. Hierarchy Manager fetches relationships directly related to the selected entities. Fetching Many Hops To retrieve multiple levels of relationships for one or more entities, use fetch many hops. Because fetching many hops can retrieve a lot of data, it is a good idea to set limits on how much data to display. If a fetch function does not return the entities and/or relationships you expect, it is probably due to limits or filters you have set. Note: In the graphic view, what you see is determined by the settings in your filter. To learn more about setting up a data filter in Graphic View, see Creating Graphic View Filters on page 95. Fetching Many Hops Without Limits To fetch many hops: 1. Highlight one or more entities of interest. Right-click on the entity to display the context menu, and choose Fetch Many Hops. OR Go to the HM Tool bar and click the Fetch Many Hops button. Hierarchy Manager fetches multiple levels of relationships related to the selected entities. Using Hierarchy Manager 113

124 Working with Entities and Relationships Fetching Many Hops With Limits To fetch many hops with limits: 1. Highlight one or more entities of interest. 2. Right-click on the entity to display the context menu, and choose Fetch Many Hops... OR Go to the HM Tool bar and click the Fetch Many Hops... button. The dialog box that allows you to set limits is displayed. 114 Siperian Hub XU for DB2 User s Guide

125 Working with Entities and Relationships You can modify any of the following fetch criteria: Fetch Criteria Maximum relationships per entity Maximum relationships levels Maximum total number of relationships Description Maximum number of relationships to fetch fro the starting entities. Maximum number of relationship levels to fetch per entity Maximum total number of relationships to fetch for the whole graph. 3. Move the slider to increase or decrease values as desired, then click OK: Hierarchy Manager returns relationships based on the criteria you just set. Search Related Entities The Search Related Entities menu option provides the ability to specify a specific entity type and a criteria for which you would like to search. When you click OK, a one hop search is performed, based on the search criteria. The Search Related Entities option is available in both the graphic and text views. Using Hierarchy Manager 115

126 Working with Entities and Relationships Managing Entities and Relationships This section describes how to add and edit entities and relationships in Hierarchy Manager. Adding an Entity You can add an entity in either Graphic View or Text View. To add an entity: 1. If you are starting in Graphic View, right-click in the Graphic View Window to display the context menu, and choose Add Entity. OR If you are starting in Text View, click the Add button in one of the Entity panels (right or left panels). The Entity Record Editor screen is displayed, similar to the following: 116 Siperian Hub XU for DB2 User s Guide

127 Working with Entities and Relationships 2. From the Type drop-down list, select the type for the desired entity. This provides the attributes for the entity being added. 3. Fill in the attributes for the new entity in the appropriate fields. Note that if any of the default fields for this type of entity are trust-enabled, the Trust Setting button is displayed. If you have already used the Data Manager record editor, this will look familiar to you. 4. If necessary, click Set Override Trust Settings for any trusted criteria you are editing. To learn more about trust settings, see the Siperian Hub User s Guide. 5. To add the new entity, click OK. Adding a Relationship You can create relationships in both Graphic View and Text View, one at a time. The procedure is slightly different depending on the view. For information on how to create several relationships at one time, see Using Bulk Operations on page 124. Adding a Relationship in the Graphic View In the Graphic View, relationships are created by dragging and dropping. To add a relationship: 1. Highlight the entity for which you want to create a new relationship. 2. Drag the selected entity to the entity you want to relate it to. 3. Drop the first entity onto the second entity. Using Hierarchy Manager 117

128 Working with Entities and Relationships The Relationship Record Editor screen is displayed. The selections for hierarchy and relationship type vary depending on the HM configuration and the types of the entities being related. 4. Enter the start and end dates for the new relationship, and edit any other attributes for the relationship as desired. Foreign key relationship types do not allow you to modify the start and end date. 5. If necessary, click Set Override Trust Settings for any trusted criteria you are editing. To learn more about trust settings, see the Siperian Hub User s Guide. 6. Click OK. The new relationship is indicated by an arrow joining the entities if both the entities are also there in the text view. The relationship is shown in the middle panel in text view. 118 Siperian Hub XU for DB2 User s Guide

129 Working with Entities and Relationships Adding a Relationship in the Text View You can create relationships in text view with the Add button in the text view. To add a relationship: 1. Select one entity in the left Entity panel, and one entity in the right Entity Panel. Note: You can only add new relationships one at a time. If both entities you want to relate are in the same panel (left or right) then just select one entity. When you click the Add Rel button, you will be prompted to select the second entity. 2. Go to the Relationship panel and click the Add button. The Relationship Record Editor screen is displayed. The selections for hierarchy and relationship type vary depending on the HM configuration and the types of the entities being related. 3. Enter the start and end dates for the new relationship, and edit any other attributes for the relationship as desired. Foreign key relationship types do not allow you to modify the start and end date. Using Hierarchy Manager 119

130 Working with Entities and Relationships 4. If necessary, click Set Override Trust Settings for any trusted criteria you are editing. To learn more about trust settings, see the Siperian Hub User s Guide. 5. Click OK. The new relationship is displayed in the Relationship panel in the middle. Editing an Entity or Relationship You can edit entities and relationships in either Graphic View or Text View. To edit an entity or relationship: 1. Highlight an entity or relationship. 2. Right-click to display the context menu, then choose Edit. OR In the Text View you can also click the Edit button. The Entity Record Editor or Relationship Record Editor screen is displayed. 120 Siperian Hub XU for DB2 User s Guide

131 Working with Entities and Relationships Note: You cannot change the entity type when editing entities. 3. Edit the attributes. Note: If any of the fields for this type of entity are trust-enabled, the trust setting button is activated. If you have already used the Data Manager record editor, this will look familiar to you. 4. If necessary, click Set Override Trust Settings for any trusted criteria you are editing. To learn more about trust settings, see the Siperian Hub User s Guide. 5. To save your changes, click OK. Removing a Relationship Siperian Hub does not delete records from a base object. Entities cannot be removed. When a relationship is removed (it is not really removed from the base object), it is just marked inactive by setting the end date to the current time. Viewing Cross-references and Relationships Use the cross-reference viewer to see a history of cross-reference and source data for the data source. To view the cross-references: 1. Highlight an entity or relationship. 2. Right click to display the context menu, choose Xref viewer. Using Hierarchy Manager 121

132 Working with Entities and Relationships The Cross-Reference Viewer screen is displayed. The Cross-Reference Viewer in Hierarchy Manager is the same Viewer used in the Merge Manager tool. For details on how Cross-Reference Viewer works, see Viewing Cross-reference Records on page When you are finished viewing the cross-reference history, click Close. Viewing History Use the History Viewer to view the merge and base object history for your data source. To view the history: 1. Highlight an entity or relationship. 2. Right click to display the context menu, choose History. 122 Siperian Hub XU for DB2 User s Guide

133 Working with Entities and Relationships The History Viewer screen is displayed. The base object history is displayed in the Data Manager History Viewer tool. To learn more about History Viewer, see Showing History on page When you are done viewing the history, click Close. Using Hierarchy Manager 123

134 Working with Entities and Relationships Using Bulk Operations Bulk operations enable you to work with multiple relationships as the same time. You can create many new relationships, reassign many existing relationships, modify many relationships, and remove many relationships at the same time. Creating New Relationships To create new relationships using a bulk operation: 1. Select two or more entities of the same type. 2. Taking care to remain in Select Mode, drag the selected entities to the entity you wish to relate them to, and drop them. Note: One or more of these relationships may already exist. Be careful not to create duplicates. The Relationship Record Editor screen is displayed. 124 Siperian Hub XU for DB2 User s Guide

135 Working with Entities and Relationships The selections for hierarchy and relationship type vary depending on the HM configuration and the types of the entities being related. 3. Enter the start and end dates for the new relationships, and edit any other attributes for the relationship. 4. If necessary, click Set Default Trust Override Settings for any trusted criteria you are editing. To learn more about trust settings, see the Siperian Hub User s Guide. 5. Click OK. The relationships are added and a screen shows how many relationships were added, duplicates found, etc. Note: Creating new relationships can only be done in the graphic view. Edit All Relationships To edit all relationships: 1. Select two or more relationships in either the text or graphic view. 2. Right-click and select Edit All Relationships. Using Hierarchy Manager 125

136 Working with Entities and Relationships The Relationship Record Editor screen is displayed. 3. Edit the relationships. If necessary, click Set Default Trust Override Settings for any trusted criteria you are editing. To learn more about trust settings, see the Trust Levels for Source Systems on page Click OK. Remove All Relationships To remove all relationships: 1. Select two or more relationships in either the text or graphic view 2. Right click and select Remove All Relationships. 3. Click OK. 126 Siperian Hub XU for DB2 User s Guide

137 Working with Entities and Relationships Reassigning Relationships This allows you to reassign relationships from one entity to another entity. The two entities must be of the same type. You can bulk-reassign all relationships being shown in the graph view, or all relationships in the database. To reassign relationships using a bulk operation: 1. Select two entities of the same type. 2. Right-click to display the context menu, and choose Reassign Relationships. The Reassign Relationships screen is displayed, enabling you to: switch the From and To Entity choose the relationships to assign 3. Click OK. The relationships are reassigned and a screen is displayed with the numbers of relationships added, updated, duplicates found, etc. Note: Reassigning relationships can only be done in the graphic view. Working with Sandboxes A sandbox is a virtual playground where you can make a copy of your relationships and manipulate data without changing the original master record data. Each sandbox you create is a copy of a particular set of relationships; for example, all of the relationships in the repository, or just a specific subset. Once play in a sandbox has given you the desired result, you can promote a sandbox to become the master copy of the relationships you just created. Promoting a sandbox involves changes to HM configuration data only. No base object data is updated. In order to use sandboxes, you must use an HM profile that gives you access to that sandbox. If you are not sure about sandboxes to which you have access, consult your Siperian Hub administrator. Using Hierarchy Manager 127

138 Working with Entities and Relationships Note: If you are creating a sandbox from selected relationships, you have to use Create Sandbox from the context menu; you cannot use the HM menu item. Conversely, you have to use the HM menu item if you are creating a sandbox for all relationships in one or more hierarchies or one of more relationship types. Creating a Sandbox To create a sandbox: 1. If you are creating a sandbox based on a subset of all relationships in one or more hierarchies, or in one or more relationship types, select all the relationships you want to copy into the sandbox. Note: You do not have to do this if you are creating a sandbox based on all relationships in one or more hierarchies or in one or more relationship types. 2. Go to the Hierarchy Manager menu and choose Create Sandbox. OR Right-click to display the context menu, and choose Create Sandbox. The Welcome Screen of the Create Sandbox Wizard is displayed. 3. Click Next. 128 Siperian Hub XU for DB2 User s Guide

139 Working with Entities and Relationships The Create Sandbox wizard Step 1 screen is displayed. 4. Enter the information in the appropriate fields and click Next. The Create Sandbox Step 2 screen is displayed. Using Hierarchy Manager 129

140 Working with Entities and Relationships 5. Select the option you want. Option Create sandbox based on selected relationships Create sandbox based on selected hierarchies Create sandbox based on selected rel types Description Disables hierarchy and relationship-type lists. This option is automatically selected when launched from the context menu. It is disabled when the create sandbox function is launched from the HM menu. Creates a sandbox that includes all relationship types for the selected hierarchies (disables the relationship-type list). This option is disabled when launched from the context menu. Creates a sandbox that includes all hierarchies for the selected relationship types (disables the hierarchy list). This option is disabled when launched from the context menu. 6. Select the appropriate hierarchies or relationship type for your sandbox. 7. Click Finish. The Sandbox Loading dialog is displayed. 8. To continue, click OK. Note: If sandbox creation fails, it may be because the server name is not set up correctly in the Hub Store. See your Siperian Hub administrator. The copy process can take some time, depending on how many relationships are being copied. To check on the status of the sandbox, go to the Hierarchy Manager menu and choose Manage Sandbox. 130 Siperian Hub XU for DB2 User s Guide

141 Working with Entities and Relationships The Manage Sandboxes screen is displayed. When the sandbox copy process is complete, the status will be Active. To begin using the new sandbox, highlight it and click Select. Selecting a Profile/Sandbox To select a Profile/Sandbox: 1. In the Hierarchy Manager menu, choose Select Profile/Sandbox. The Select Profile and Sandbox screen is displayed. 2. Select a Profile and Sandbox and click OK. Using Hierarchy Manager 131