Informatica MDM Multidomain Edition (Version ) Provisioning Tool Guide

Transcription

1 Informatica MDM Multidomain Edition (Version ) Provisioning Tool Guide

2 Informatica MDM Multidomain Edition Provisioning Tool Guide Version November 2015 Copyright (c) Informatica LLC. All rights reserved. This software and documentation contain proprietary information of Informatica LLC and are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright law. Reverse engineering of the software is prohibited. No part of this document may be reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica LLC. This Software may be protected by U.S. and/or international Patents and other Patents Pending. Use, duplication, or disclosure of the Software by the U.S. Government is subject to the restrictions set forth in the applicable software license agreement and as provided in DFARS (a) and (a) (1995), DFARS (1)(ii) (OCT 1988), FAR (a) (1995), FAR , or FAR (ALT III), as applicable. The information in this product or documentation is subject to change without notice. If you find any problems in this product or documentation, please report them to us in writing. Informatica, Informatica Platform, Informatica Data Services, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerExchange, PowerMart, Metadata Manager, Informatica Data Quality, Informatica Data Explorer, Informatica B2B Data Transformation, Informatica B2B Data Exchange Informatica On Demand, Informatica Identity Resolution, Informatica Application Information Lifecycle Management, Informatica Complex Event Processing, Ultra Messaging and Informatica Master Data Management are trademarks or registered trademarks of Informatica LLC in the United States and in jurisdictions throughout the world. All other company and product names may be trade names or trademarks of their respective owners. Portions of this software and/or documentation are subject to copyright held by third parties, including without limitation: Copyright DataDirect Technologies. All rights reserved. Copyright Sun Microsystems. All rights reserved. Copyright RSA Security Inc. All Rights Reserved. Copyright Ordinal Technology Corp. All rights reserved. Copyright Aandacht c.v. All rights reserved. Copyright Genivia, Inc. All rights reserved. Copyright Isomorphic Software. All rights reserved. Copyright Meta Integration Technology, Inc. All rights reserved. Copyright Intalio. All rights reserved. Copyright Oracle. All rights reserved. Copyright Adobe Systems Incorporated. All rights reserved. Copyright DataArt, Inc. All rights reserved. Copyright ComponentSource. All rights reserved. Copyright Microsoft Corporation. All rights reserved. Copyright Rogue Wave Software, Inc. All rights reserved. Copyright Teradata Corporation. All rights reserved. Copyright Yahoo! Inc. All rights reserved. Copyright Glyph & Cog, LLC. All rights reserved. Copyright Thinkmap, Inc. All rights reserved. Copyright Clearpace Software Limited. All rights reserved. Copyright Information Builders, Inc. All rights reserved. Copyright OSS Nokalva, Inc. All rights reserved. Copyright Edifecs, Inc. All rights reserved. Copyright Cleo Communications, Inc. All rights reserved. Copyright International Organization for Standardization All rights reserved. Copyright ejtechnologies GmbH. All rights reserved. Copyright Jaspersoft Corporation. All rights reserved. Copyright International Business Machines Corporation. All rights reserved. Copyright yworks GmbH. All rights reserved. Copyright Lucent Technologies. All rights reserved. Copyright (c) University of Toronto. All rights reserved. Copyright Daniel Veillard. All rights reserved. Copyright Unicode, Inc. Copyright IBM Corp. All rights reserved. Copyright MicroQuill Software Publishing, Inc. All rights reserved. Copyright PassMark Software Pty Ltd. All rights reserved. Copyright LogiXML, Inc. All rights reserved. Copyright Lorenzi Davide, All rights reserved. Copyright Red Hat, Inc. All rights reserved. Copyright The Board of Trustees of the Leland Stanford Junior University. All rights reserved. Copyright EMC Corporation. All rights reserved. Copyright Flexera Software. All rights reserved. Copyright Jinfonet Software. All rights reserved. Copyright Apple Inc. All rights reserved. Copyright Telerik Inc. All rights reserved. Copyright BEA Systems. All rights reserved. Copyright PDFlib GmbH. All rights reserved. Copyright Orientation in Objects GmbH. All rights reserved. Copyright Tanuki Software, Ltd. All rights reserved. Copyright Ricebridge. All rights reserved. Copyright Sencha, Inc. All rights reserved. Copyright Scalable Systems, Inc. All rights reserved. Copyright jqwidgets. All rights reserved. Copyright Tableau Software, Inc. All rights reserved. Copyright MaxMind, Inc. All Rights Reserved. Copyright TMate Software s.r.o. All rights reserved. Copyright MapR Technologies Inc. All rights reserved. Copyright Amazon Corporate LLC. All rights reserved. Copyright Highsoft. All rights reserved. Copyright Python Software Foundation. All rights reserved. Copyright BeOpen.com. All rights reserved. Copyright CNRI. All rights reserved. This product includes software developed by the Apache Software Foundation ( and/or other software which is licensed under various versions of the Apache License (the "License"). You may obtain a copy of these Licenses at Unless required by applicable law or agreed to in writing, software distributed under these Licenses is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the Licenses for the specific language governing permissions and limitations under the Licenses. This product includes software which was developed by Mozilla ( software copyright The JBoss Group, LLC, all rights reserved; software copyright by Bruno Lowagie and Paulo Soares and other software which is licensed under various versions of the GNU Lesser General Public License Agreement, which may be found at The materials are provided free of charge by Informatica, "as-is", without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. The product includes ACE(TM) and TAO(TM) software copyrighted by Douglas C. Schmidt and his research group at Washington University, University of California, Irvine, and Vanderbilt University, Copyright ( ) , all rights reserved. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (copyright The OpenSSL Project. All Rights Reserved) and redistribution of this software is subject to terms available at and This product includes Curl software which is Copyright , Daniel Stenberg, <daniel@haxx.se>. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. The product includes software copyright ( ) MetaStuff, Ltd. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at license.html. The product includes software copyright , The Dojo Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at This product includes ICU software which is copyright International Business Machines Corporation and others. All rights reserved. Permissions and limitations regarding this software are subject to terms available at This product includes software copyright Per Bothner. All rights reserved. Your right to use such materials is set forth in the license which may be found at kawa/software-license.html. This product includes OSSP UUID software which is Copyright 2002 Ralf S. Engelschall, Copyright 2002 The OSSP Project Copyright 2002 Cable & Wireless Deutschland. Permissions and limitations regarding this software are subject to terms available at This product includes software developed by Boost ( or under the Boost software license. Permissions and limitations regarding this software are subject to terms available at / This product includes software copyright University of Cambridge. Permissions and limitations regarding this software are subject to terms available at This product includes software copyright 2007 The Eclipse Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at and at

3 This product includes software licensed under the terms at license.html, httpunit.sourceforge.net/doc/ license.html, license.html, license-agreement; /copyright-software ; forge.ow2.org/projects/javaservice/, license.html; protobuf.googlecode.com/svn/trunk/src/google/protobuf/descriptor.proto; current/doc/mitk5license.html; blob/master/license; page=documents&file=license; blueprints/blob/master/license.txt; twbs/bootstrap/blob/master/license; master/license, and This product includes software licensed under the Academic Free License ( the Common Development and Distribution License ( the Common Public License ( the Sun Binary Code License Agreement Supplemental License Terms, the BSD License ( the new BSD License ( licenses/bsd-3-clause), the MIT License ( the Artistic License ( and the Initial Developer s Public License Version 1.0 ( This product includes software copyright Joe WaInes, XStream Committers. All rights reserved. Permissions and limitations regarding this software are subject to terms available at This product includes software developed by the Indiana University Extreme! Lab. For further information please visit This product includes software Copyright (c) 2013 Frank Balluffi and Markus Moeller. All rights reserved. Permissions and limitations regarding this software are subject to terms of the MIT license. See patents at DISCLAIMER: Informatica LLC provides this documentation "as is" without warranty of any kind, either express or implied, including, but not limited to, the implied warranties of noninfringement, merchantability, or use for a particular purpose. Informatica LLC does not warrant that this software or documentation is error free. The information provided in this software or documentation may include technical inaccuracies or typographical errors. The information in this software and documentation is subject to change at any time without notice. NOTICES This Informatica product (the "Software") includes certain drivers (the "DataDirect Drivers") from DataDirect Technologies, an operating company of Progress Software Corporation ("DataDirect") which are subject to the following terms and conditions: 1. THE DATADIRECT DRIVERS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 2. IN NO EVENT WILL DATADIRECT OR ITS THIRD PARTY SUPPLIERS BE LIABLE TO THE END-USER CUSTOMER FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR OTHER DAMAGES ARISING OUT OF THE USE OF THE ODBC DRIVERS, WHETHER OR NOT INFORMED OF THE POSSIBILITIES OF DAMAGES IN ADVANCE. THESE LIMITATIONS APPLY TO ALL CAUSES OF ACTION, INCLUDING, WITHOUT LIMITATION, BREACH OF CONTRACT, BREACH OF WARRANTY, NEGLIGENCE, STRICT LIABILITY, MISREPRESENTATION AND OTHER TORTS. Part Number: MDM-PTG

4 Table of Contents Preface Informatica Resources Informatica My Support Portal Informatica Documentation Informatica Product Availability Matrixes Informatica Web Site Informatica How-To Library Informatica Knowledge Base Informatica Support YouTube Channel Informatica Marketplace Informatica Velocity Informatica Global Customer Support Chapter 1: Introduction Provisioning Tool Overview Architecture Prerequisites Key Concepts Business Entities Reference Entities Root Node Configuration Files Logging In to the Provisioning Tool User Interface Chapter 2: Establishing a Root Node Establishing a Root Node Overview Example of Adding Root Nodes Prerequisites Root Node Properties Establishing a Business Entity Root Node Creating a Business Entity Root Node Establishing a Reference Entity Root Node Creating a Reference Entity Root Node Enabling State Management Validation Chapter 3: Defining the Business Entity Structure Defining the Business Entity Model Overview Example of Configuring the Business Entity Structure Prerequisites Table of Contents

5 Constraints Node Types Creating a Node with a One-to-Many Relationship Creating a Node with a One-to-One Relationship Creating a Lookup Node with a One-to-One Relationship Chapter 4: Configuring Business Entity Properties Configuring Business Entity Properties Overview Field Properties Adding a Field to a Node Filters Adding a Filter to a Field Custom Data Types Adding a Custom Data Type to a Field Node Labels in Informatica Data Director Configuring Node Labels Chapter 5: Configuring Reference Entity Properties Configuring Reference Entity Properties Overview Lookup Types Field Properties Adding a Field to a Node Configuring a Lookup Configuring a Dependent Lookup Chapter 6: Business Entity Views Business Entity Views Overview Transformations Types of Transformations Business Entity Views and Transformation Configuration XML Configuring the Business Entity Views and Transformation Configuration XML Business Entity Views Configuration XML Transformation Configuration XML Structural Transformation XML Data Transformation XML Business Entity to Business Entity Transformation XML Chapter 7: Entity 360 Framework Configuration Entity 360 Framework Configuration Overview Entity 360 Framework Components Entity 360 Framework Layout Entity View Example How to Enable the Entity 360 Framework Table of Contents 5

6 Enabling the Entity 360 Framework Entity 360 Framework Configuration Overview Layout Editor Entity 360 Framework Components Matched Records Component Matched Records Component Configuration Related Records Component Related Records Component Configuration Source Systems Component Source Systems Component Configuration Similar Business Entities Component Similar Business Entities Component Configuration Related Tasks Component Task Inbox Component History Component Effective Periods Component Match Merge Comparison Component Hierarchy Component Cross-Reference Component Custom Components HTML and Javascript Custom Component Configuration Inline Frame Custom Component Configuration Jaspersoft Report Component Configuration Jaspersoft Report Component Configuration Example Jaspersoft Report Component Configuration Example Configuring the Components Entity 360 Framework Layout Entity View Start Page Main Area and Sidebar Configuration Entity 360 Framework Layout Display Conditions Displaying Layouts for Business Entities or Business Entity Views Example of a Layout Based on a Business Entity Example of a Layout Based on a Business Entity View Displaying Layouts Based on User Roles Example of One Layout for Multiple Roles Example of Multiple Layouts for Multiple Roles Displaying Layouts for New and Existing Business Entities Example of a Layout for an Existing Business Entity Example of a Layout for Business Entity Creation Displaying Layouts Based on Tasks Example of a Layout Based on Task Kind Table of Contents

7 Example of a Layout Based on Task Type Data Validation in the Entity View Metadata Validation Required Fields Cleanse Validation Rules Informatica Data Quality Validation Rules Entity 360 Logging Chapter 8: Smart Search Smart Search Overview Example Use Case Smart Search Configuration Architecture Single-Host Deployment Multiple-Host Deployment Configuring Smart Search Step 1. Configure a Process Server as a ZooKeeper Server Step 2. Configure the Process Servers on Nodes Step 3. Configure the Hub Server for Smart Search Step 4: Configuring the Searchable Fields Step 5. Configure the Filter Type for a Field Step 6. Configure the Layouts to Display Similar Records (Optional) Step 7. Index the Smart Search Data Updating the Searchable Field Properties Updating the Searchable Field Properties by Using the Provisioning Tool Updating the Searchable Field Properties by Using a Change List Optimizing the Performance of Smart Search Requests Chapter 9: Task Configuration Task Configuration Overview Task Type Configuration Task Type Configuration Example for Final Review Task Task Template Configuration Task Template Example for Default Approval Task Template Example for Merge Descriptive Task Titles Configuring Descriptive Task Titles Workflow Trigger Configuration Parameters Workflow Trigger Example for Update with Approval Workflow Workflow Trigger Example for Merge Configuring Tasks Chapter 10: Publishing Changes Publishing the Configuration Overview Table of Contents 7

8 Generating the Business Entity Service Configuration Publishing to the MDM Hub Appendix A: Provisioning Tool Frequently Asked Questions Provisioning Tool Frequently Asked Questions Index Table of Contents

9 Preface Welcome to the Informatica MDM Multidomain Edition Provisioning Tool Guide. This guide explains how to use the Provisioning tool to configure business entities. This guide is intended for technical specialists who are responsible for configuring business entities. Informatica Resources Informatica My Support Portal As an Informatica customer, the first step in reaching out to Informatica is through the Informatica My Support Portal at The My Support Portal is the largest online data integration collaboration platform with over 100,000 Informatica customers and partners worldwide. As a member, you can: Access all of your Informatica resources in one place. Review your support cases. Search the Knowledge Base, find product documentation, access how-to documents, and watch support videos. Find your local Informatica User Group Network and collaborate with your peers. As a member, you can: Access all of your Informatica resources in one place. Search the Knowledge Base, find product documentation, access how-to documents, and watch support videos. Find your local Informatica User Group Network and collaborate with your peers. Informatica Documentation The Informatica Documentation team makes every effort to create accurate, usable documentation. If you have questions, comments, or ideas about this documentation, contact the Informatica Documentation team through at infa_documentation@informatica.com. We will use your feedback to improve our documentation. Let us know if we can contact you regarding your comments. The Documentation team updates documentation as needed. To get the latest documentation for your product, navigate to Product Documentation from 9

10 Informatica Product Availability Matrixes Product Availability Matrixes (PAMs) indicate the versions of operating systems, databases, and other types of data sources and targets that a product release supports. You can access the PAMs on the Informatica My Support Portal at Informatica Web Site You can access the Informatica corporate web site at The site contains information about Informatica, its background, upcoming events, and sales offices. You will also find product and partner information. The services area of the site includes important information about technical support, training and education, and implementation services. Informatica How-To Library As an Informatica customer, you can access the Informatica How-To Library at The How-To Library is a collection of resources to help you learn more about Informatica products and features. It includes articles and interactive demonstrations that provide solutions to common problems, compare features and behaviors, and guide you through performing specific real-world tasks. Informatica Knowledge Base As an Informatica customer, you can access the Informatica Knowledge Base at Use the Knowledge Base to search for documented solutions to known technical issues about Informatica products. You can also find answers to frequently asked questions, technical white papers, and technical tips. If you have questions, comments, or ideas about the Knowledge Base, contact the Informatica Knowledge Base team through at KB_Feedback@informatica.com. Informatica Support YouTube Channel You can access the Informatica Support YouTube channel at The Informatica Support YouTube channel includes videos about solutions that guide you through performing specific tasks. If you have questions, comments, or ideas about the Informatica Support YouTube channel, contact the Support YouTube team through at supportvideos@informatica.com or send a tweet Informatica Marketplace The Informatica Marketplace is a forum where developers and partners can share solutions that augment, extend, or enhance data integration implementations. By leveraging any of the hundreds of solutions available on the Marketplace, you can improve your productivity and speed up time to implementation on your projects. You can access Informatica Marketplace at Informatica Velocity You can access Informatica Velocity at Developed from the real-world experience of hundreds of data management projects, Informatica Velocity represents the collective knowledge of our consultants who have worked with organizations from around the world to plan, develop, deploy, and maintain successful data management solutions. If you have questions, comments, or ideas about Informatica Velocity, contact Informatica Professional Services at ips@informatica.com. 10 Preface

11 Informatica Global Customer Support You can contact a Customer Support Center by telephone or through the Online Support. Online Support requires a user name and password. You can request a user name and password at The telephone numbers for Informatica Global Customer Support are available from the Informatica web site at Preface 11

12 C H A P T E R 1 Introduction This chapter includes the following topics: Provisioning Tool Overview, 12 Architecture, 13 Prerequisites, 13 Key Concepts, 14 Configuration Files, 14 Logging In to the Provisioning Tool, 15 User Interface, 16 Provisioning Tool Overview You can use the Provisioning tool to create business entity models and configure the Entity 360 framework. To create a business entity model, you create a root node and then establish relationships between nodes. These relationships are based on foreign key constraints that you define using the Hub Console. After you build the business entity model and configure the nodes, you can publish the configuration to the MDM Hub. Technical specialists can use the Provisioning tool to perform the following activities: Create a business entity model when using business entity services as web services to directly access business entities. Use the graphic user interface to configure the business entity model. An XML editor is provided so you can configure the XML files directly for all configurations related to business entities. You cannot create a business entity model if you implement business entities in Informatica Data Director (IDD). Create a reference entity when using business entity services as web services to directly access business entities. You cannot create a reference entity if you implement business entities in Informatica Data Director. Configure the business entity nodes. Configure the search properties for each node in the business entity model. Generate the XML files for the following configurations: - REST services - Business entity service Configure the XML files for Entity 360 framework configuration. Configure the XML files for BPM tasks. 12

13 Configure the XML files for business entity view and the transformation service. Publish the configuration files to the MDM Hub. The Repository Manager validates the configuration and reports any errors. You do not need to upload BLOB files to a repository table manually. Related Topics: Business Entities on page 14 Reference Entities on page 14 Architecture The Provisioning tool reads schema information from an Operational References Store (ORS) in the MDM Hub. You use the Provisioning tool to configure business entities based on the schema information. After you have updated all the configuration files, you publish your changes to a table in the repository. The Provisioning tool runs on the same application server as the Hub Server. As you work on the configuration files, you save your changes to a temporary workspace. The changes are not applied until you publish your changes. If multiple users change the business entity configuration for an ORS simultaneously, the MDM Hub is updated with the most recently published configuration. Prerequisites To use the Provisioning tool, the Operational Reference Store (ORS) must contain a defined MDM schema. A defined schema contains base objects and constraints based on foreign key relationships between base objects. If you use Informatica Data Director to display business entities, you must generate business entities from a subject area configuration. Prerequisites when using business entities for web services or when using Informatica Data Director To add nodes to a business entity, you must first define the base objects. Use the MDM Hub Console to define base objects. To configure the business entity structure, you must first define the relationship constraints between the base objects. Use the MDM Hub Console to define foreign key relationship constraints. Prerequisites when using Informatica Data Director To use the Informatica Data Director (IDD) Match Merge Comparison view, Cross-reference view, History view, and Timeline view, task inbox, and Task Manager, create an Informatica Data Director application configuration based on subject areas. Use the IDD Configuration Manager to generate a business entity configuration from the subject area configuration. If you create a business entity model with the Provisioning tool, you cannot work with the business entity in the views that rely on subject areas. For more information about schema configuration, see the Informatica MDM Multidomain Edition Configuration Guide. For more information about subject area configuration, see the Informatica MDM Multidomain Edition Informatica Data Director Implementation Guide. Architecture 13

14 Key Concepts To work effectively in the Provisioning tool, you need a basic understanding of business entities and Informatica Master Data Management concepts. Business Entities Business entities represent entities with significance to an organization. Organizations commonly define business entity types to represent customers, suppliers, employees, products, and accounts. For example, a business entity type might be Person. The customer John Smith is a business entity of type Person. An organization can also define business entity types for data that is unique to the business. For example, a charity defines donors as a type of business entity. A medical device manufacturer defines unique device identifiers. Many organizations define more than one business entity type. The application developer controls which business entity types exist in the Informatica Data Director application. In the MDM Hub Store, a business entity corresponds to a record in a base object table. The parent record contains identifying information for the business entity. The parent record has a relationship to child records that contain data related to the business entity, such as addresses and telephone numbers. Reference Entities Reference entities are business entities that are associated with lookup base objects. A lookup base object is a table that contains a list of reference data. For example, a lookup table for a phone type field could contain the values Home, Work, and Mobile. The reference entity data can then be used to populate a list of values in Informatica Data Director. Root Node The root node is the uppermost node in the business entity structure and defines the business entity type. The root node is synonymous with the business entity. For example, a business entity model with a Person root node is considered to be a Person business entity. After you create the root node, you can then define the business entity structure. The nodes in the business entity contain information about the attributes of the root node. Configuration Files Use the Provisioning tool to configure configuration files related to business entities. Access the XML configuration files from the Advanced Configuration page. You can view and edit the following XML files on the Advanced Configuration page: Business entities configuration file Contains the configuration for business entities. The business entity model that you configure with the Provisioning tool is stored in this file. Business entities services configuration file Contains the configuration for business entity services. You can generate a default business entity services configuration that is based on the business entity configuration. 14 Chapter 1: Introduction

15 Business entity views configuration file Contains the configuration for business entity views. You cannot generate a default configuration from the business entities configuration. REST services configuration file Contains the configuration for business entity services REST APIs. You can generate a default business entity services configuration that is based on the business entity configuration. Write service configuration file Contains the configuration for business entity write service. Search configuration file Contains the search configuration. The search configuration that you perform with the Provisioning tool is stored in this file. Transformation configuration file Contains the configuration for business entity transformation service. The transformation service converts a business entity to a business entity view. Task configuration file Contains the BPM task configuration. You can view and edit the following XML files in the Layout Editor page: Entity 360 framework configuration file Contains the configuration to arrange the location of the components in the Entity view in Informatica Data Director. Entity 360 framework component configuration files Contains the configuration for each type of Entity 360 framework component. Logging In to the Provisioning Tool To log in, you need the URL for the Provisioning tool and your user credentials. The URL contains the MDM Hub server host name and port number. If you do not have this information, contact your MDM Hub administrator. The MDM Hub must be running on the same application server as the Provisioning tool. 1. Open a supported browser. 2. Enter the URL for the Provisioning tool. The URL has the following format: Secure connections. Hub Server host name>:<mdm Server port number>/ provisioning/ Non-secure connections. Hub Server host name>:<mdm Server port number>/ provisioning/ The Log In page opens. 3. Enter your user name and password. 4. Click Log In. 5. Select the Operational Reference Store for which you want to configure business entities. The Provisioning tool opens and displays the Home workspace. Logging In to the Provisioning Tool 15

16 User Interface The Provisioning tool user interface contains a business entity modeling page, an Entity 360 framework layout editor, and an advanced configuration page. Modeling Page Use the modeling page to create and configure a business entity model. The modeling page contains a panel to create a root node, a panel to build the business entity model, and a panel to configure node properties. The following image shows the Modeling page: 1. Root nodes 2. Business entity model 3. Node properties Layout Editor Use the layout editor to configure the XML configuration files for the Entity 360 framework. 16 Chapter 1: Introduction

17 The following image shows the Layout Editor: 1. Configuration files for Entity360 framework 2. XML editor Advanced Configuration Page Use the advanced configuration page to edit the XML for all configuration files related to business entities. User Interface 17

18 18 Chapter 1: Introduction The following image shows the business entity configuration in an XML editor on the Advanced Configuration page:

19 C H A P T E R 2 Establishing a Root Node This chapter includes the following topics: Establishing a Root Node Overview, 19 Root Node Properties, 20 Establishing a Business Entity Root Node, 21 Establishing a Reference Entity Root Node, 22 Enabling State Management Validation, 24 Establishing a Root Node Overview The root node is the uppermost node in the business entity structure and defines the business entity type. When you use the Provisioning tool to create a business entity model, the first step is to create a root node. After you establish the root node, you can configure the properties of the root node. After you create the root node, you can then define the business entity structure according to your business entity model. You can also configure reference entities. Reference entities are business entities that are associated with lookup base objects. After you establish a lookup root node, you can then configure the properties for the lookup root node. If you want to use business entities with Informatica Data Director (IDD), you must generate business entities through subject areas in the IDD Configuration Manager. Business entities created directly in the Provisioning tool do not work in IDD. If you do not use IDD, but use business entity services as web services to directly access business entities, you can use business entities created in the Provisioning tool. You can also use the Provisioning tool to edit business entities already defined in your MDM schema. Example of Adding Root Nodes You work in Human Resources for a large multinational corporation. You want to add all the employees in your organization. You want to add each employee as a "Person" business entity. To add the root node for a Person business entity, you perform the following steps: 1. On the modeling page of the Provisioning tool, select the Business Entities tab in the root node panel. 2. Click Create. 3. In the node properties panel, select C_PARTY in the Base Object field. 4. Enter Person as the name and label for the root node. 19

20 5. Define the structure of the business entity in the business entity model pane. 6. Save your changes. Because employees in your organization live in different countries, you then decide that you want to create the reference entity "LUCountry." This will be associated with the Country lookup base object in the MDM schema. To add the root node for a LUCountry reference entity, you perform the following steps: 1. On the modeling page of the Provisioning tool, select the Reference Entities tab in the root node panel. 2. Click Create. 3. In the node properties panel, select C_LU_COUNTRY in the Base Object field. 4. Enter LUCountry as the name and label for the root node. 5. Save your changes. Prerequisites To add nodes to a business entity, you must first define the base objects. Use the MDM Hub Console to define base objects. For more information about defining base objects, see the Informatica MDM Multidomain Edition Configuration Guide. Root Node Properties Use the Provisioning tool to configure the following properties for a root node. Base Object The base object in the MDM Hub that is associated with the root node. Name The node name in the business entity configuration file. Display Name The node name as it appears in the Provisioning tool tree view. Description A description of the root node. Optional. State Management Enforcement Determines if state management is enforced among all nodes in the business entity. 20 Chapter 2: Establishing a Root Node

21 Establishing a Business Entity Root Node To create a business entity, establish a root node for the business entity and then configure the root node properties. Creating a Business Entity Root Node To create a business entity model, the first step is to create the root node for the business entity. In this example, you want to create a Person business entity associated with the base object C_PARTY in the MDM schema. 1. On the modeling page of the Provisioning tool, select the Business Entities tab in the root node panel. 2. Click Create. A new root node appears in the Business Entities tab. 3. In the node properties panel, go to the Base Object field and select a base object from the MDM schema to associate with the business entity. For example, select the base object C_PARTY. Note: The base objects are created in the MDM Hub before you add root nodes to the business entity. 4. In the Name field, enter a name for the business entity. For example, enter Person. Note: Avoid the use of spaces in business entity names. 5. In the Display Name field, enter a display name for the business entity. For example, enter Person. 6. Optionally, enter a description of the business entity. 7. Optionally, enable the State Management Enforcement check box. When this check box is enabled, the Repository Manager validation checks that all base objects in the business entity are enabled for state management, except referenced lookups. 8. Click Apply. The changes are saved but are not published to the MDM Hub. Establishing a Business Entity Root Node 21

22 The following image shows the Person business entity that you created: Related Topics: Defining the Business Entity Model Overview on page 25 Establishing a Reference Entity Root Node To create a reference entity, establish a root node for the reference entity and then configure the root node properties. Creating a Reference Entity Root Node Reference entities are business entities that are associated with lookup base objects. As with a business entity, the first step is to create the root node for the reference entity. In this example, you want to create a reference entity associated with the lookup base object LUCountry in the MDM schema. 1. On the modeling page of the Provisioning tool, select the Reference Entities tab in the root node panel. 2. Click Create. 22 Chapter 2: Establishing a Root Node

23 A new root node appears in the Reference Entities tab. 3. In the node properties panel, go to the Base Object field and select a lookup base object from the MDM schema to associate with the reference entity. For example, select the base object C_LU_COUNTRY. Note: The lookup base objects are created in the MDM Hub before you create a reference entity root node. 4. In the Name field, enter a name for the reference entity. For example, enter LUCountry. Note: Avoid the use of spaces in reference entity names. 5. In the Display Name field, enter a display name for the reference entity. For example, enter LUCountry. 6. Optionally, enter a description of the reference entity. 7. Optionally, enable the State Management Enforcement check box. When this check box is enabled, the Repository Manager validation checks that all base objects in the reference entity are enabled for state management, except referenced lookups. 8. Click Apply. The changes are saved but are not published to the MDM Hub. Establishing a Reference Entity Root Node 23

24 The following image shows the LUCountry reference entity that you created: Related Topics: Defining the Business Entity Model Overview on page 25 Enabling State Management Validation To enable Repository Manager to check that state management is enabled consistently for all base objects in a business entity, set the attribute statemanagementenabled to true in the coroot element. The value of statemanagementenabled is false by default. In the Provisioning tool, you can enable state management through the State Management Enforcement check box. When statemanagementenabled is true the Repository Manager validation checks that all base objects in the business entity are enabled for state management, except referenced lookups. When statemanagementenabled is false the Repository Manager does not verify that the base objects in the business entity are all state management enabled. The business entity can contain base objects that are state management enabled and base objects that are not state management enabled. The value of statemanagementenabled affects the Repository Manager validation check. The value of statemanagementenabled does not affect run-time operations. When you change statemanagementenabled from true to false, state management is not disabled for base objects. 24 Chapter 2: Establishing a Root Node

25 C H A P T E R 3 Defining the Business Entity Structure This chapter includes the following topics: Defining the Business Entity Model Overview, 25 Prerequisites, 26 Constraints, 26 Node Types, 27 Creating a Node with a One-to-Many Relationship, 28 Creating a Node with a One-to-One Relationship, 29 Creating a Lookup Node with a One-to-One Relationship, 30 Defining the Business Entity Model Overview The business entity model is a tree structure of nodes. Each node corresponds to a base object table in the MDM Hub. Each field corresponds to a column of a base object table in the MDM Hub. The business entity model is based upon a root node. The root node is synonymous with the business entity. For example, a business entity model with a Person root node is considered to be a Person business entity. After the root node is established, you can use the tree panel in the Provisioning tool to create child nodes that have a one-to-one or one-to-many relationship with their parent nodes. 25

26 Example of Configuring the Business Entity Structure You are configuring the business entity structure for the Person business entity. The Person business entity contains data for the employees in your company. Under the Person root node, you want to add nodes for the employee details such as gender, address, and phone. The following image shows the structure of the business entity example: Prerequisites To configure the business entity structure, you must first define the relationship constraints between the base objects. Use the MDM Hub Console to define foreign key relationship constraints. To add nodes to a business entity, you must first define the base objects. Use the MDM Hub Console to define base objects. For more information about defining foreign key relationships and defining base objects, see the Informatica MDM Multidomain Edition Configuration Guide. Constraints The MDM Hub uses foreign key constraints to maintain relationships between child objects and parent objects. When you create a node in the business entity model, you must specify the MDM Hub constraint that defines the relationship between the child node and the parent node. A foreign key is a field in a relational table that matches the primary key column of another table. In a foreign key relationship, the child object has a foreign key column and the parent object has a primary key column. 26 Chapter 3: Defining the Business Entity Structure

27 The MDM Hub uses the keys to associate a parent record with a child record. The foreign key column of the child record contains the value of the associate parent primary key. The following image shows a Phone child object linked to a Person parent object by a foreign key relationship: The Person object has a primary key column called ROWID_OBJECT and the Phone object has a foreign key column called Person_ID. The primary key value of 3 links the record for Tom to the record for the phone number The constraint attribute requires the following syntax: <child base object name>(<foreign key column name>).<parent base object name>(primary key column name>) The following code shows the constraint attribute for the example: constraint="c_phone(person_id).c_person(rowid_object)" Node Types You build the business entity model by adding nodes of different types. Each node type defines the nature of the relationship between the parent node and child node. The business entity model can contain the following node types: coroot one many The root node of the business entity. The coroot node is established when you create the root node of the business entity. Specifies a one-to-one relationship between a parent node and a child node. For example, a one-to-one relationship between a Contact Address node and an Address node means that each contact address can only have one address associated with it. A person can have a home contact address and a work contact address, but only one address can be associated with the home contact address and only one address can associated with the work contact address. Specifies a one-to-many relationship between a parent node and a child node. Node Types 27

28 For example, a one-to-many relationship between a Person node and a Telephone node means that a person record can have many telephone number records associated with it. referenceone Specifies a one-to-one relationship between a parent node and a child reference entity node. For example, a referenceone relationship between a Person node and a Gender node means that a person record can be associated with only one gender value. The gender values reside in a lookup table. The following image shows the node types for each node in the business entity example: Creating a Node with a One-to-Many Relationship To create a node with a one-to-many child relationship, in the tree view panel, select many under the parent node and then click Create. For example, you create a telephone child node with a one-to-many relationship to a person node because one person can have more than one telephone number. 1. In the tree view, click the folder icon of the parent node under which you want to create a child node. For example, click the folder icon beside Person. 2. Select many under the parent node, and then click Create. 3. In the node properties panel, select the base object that contains the child node data. 28 Chapter 3: Defining the Business Entity Structure

29 For example, select the base object C_PARTY_PHONE. Note: The base objects are created in the MDM Hub before you configure the business entity structure. 4. Select the constraint reference that defines the MDM Hub relationship between the base object of the parent node and the base object of the child node. For example, select the constraint C_RL_PARTY_ADDRESS(ADDRESS_ID).C_ADDRESS(ROWID_OBJECT). Note: The constraints are created in the MDM Hub before you configure the business entity structure. 5. Optionally, enter a node name, a node display name, and a node description. For example, enter Telephone for the node name and node display name. 6. Click Apply. The changes are saved but are not published to the MDM Hub. Creating a Node with a One-to-One Relationship To create a child node with a one-to-one relationship to a parent node, in the tree view panel, select one under the parent node and then click Create. For example, you create an address child node with a one-toone relationship to a contact address node because one person can only have one address that is a home contact address. 1. In the tree view, click the folder icon of the parent node under which you want to create a child node. For example, click the folder icon beside Contact Address. The parent node expands. 2. Select one under the parent node, and then click Create. 3. In the node properties panel, select the base object that contains the child node data. For example, select the base object C_ADDRESS. Note: The base objects are created in the MDM Hub before you configure the business entity structure. 4. Select the constraint reference that defines the MDM Hub relationship between the base object of the parent node and the base object of the child node. For example, select the constraint C_RL_PARTY_ADDRESS(ADDRESS_ID).C_ADDRESS(ROWID_OBJECT). Note: The constraints are created in the MDM Hub before you configure the business entity structure. 5. Optionally, enter a node name, a node display name, and a node description. For example, enter Address for the node name and node display name. 6. Click Apply. The changes are saved but are not published to the MDM Hub. Creating a Node with a One-to-One Relationship 29

30 Creating a Lookup Node with a One-to-One Relationship To create a child lookup node with a one-to-one relationship to a parent node, in the tree view panel, select referenceone under the parent node and then click Create. You must associate the lookup node with a lookup base object. For example, you create a child reference node for a gender lookup with a one-to-one relationship to a person. 1. In the tree view, click the arrow by the parent node under which you want to create a child node. For example, click the arrow beside Person. The parent node expands. 2. Select referenceone under the parent node, and then click Create. 3. In the node properties panel, select the base object that contains the lookup child node data. For example, select the lookup base object LUGender. Note: The lookup base objects are created in the MDM Hub before you configure the business entity structure. 4. Select the constraint reference that defines the MDM Hub relationship between the base object of the parent node and the base object of the child node. For example, select the constraint C_PARTY(GENDER_CD).C_LU_GENDER(GENDER_CODE). Note: The constraints are created in the MDM Hub before you configure the business entity structure. 5. Optionally, enter a node name, a node display name, and a node description. For example, enter Gender for the node name and node display name. 6. Click Apply. The changes are saved but are not published to the MDM Hub. 30 Chapter 3: Defining the Business Entity Structure

31 C H A P T E R 4 Configuring Business Entity Properties This chapter includes the following topics: Configuring Business Entity Properties Overview, 31 Field Properties, 31 Filters, 33 Custom Data Types, 34 Node Labels in Informatica Data Director, 35 Configuring Business Entity Properties Overview Configure the business entity properties in the right-hand panel of the Provisioning tool. In the business entity properties panel, you can perform the following tasks: Add filters to a field. Configure node labels. Associate a base object with a node. You configure the root node properties when you create a root node. For more information, see the chapter Establishing a Root Node. Associate a constraint with a child node. You configure the child node properties when you define the business entity structure. For more information, see the chapter Defining the Business Entity Structure. Enable fields to be searchable and configure search properties. For more information about configuring searchable fields and configuring search properties, see the chapter Smart Search. Field Properties You can configure the field properties to associate a field with a base object column, specify the data type, mark the field as read-only, mark the field as required, and make the field searchable. You can configure the following field properties: 31

32 Column Reference Name The base object column associated with the field. You associate a field with a base object column when you add a field to the node. The field name in the business entity configuration file. Display Name The field name as it appears in the Provisioning tool tree view. Read-Only Defines if the field is editable. If this field is not enabled, the user can edit the field in the Entity view if the user has create or update privileges for the base object field in the MDM Hub. If the user has create or update privileges for the base object column in the MDM Hub, the field is editable in Informatica Data Director. If the user does not have create or update for the base object column in the MDM Hub, an error occurs when the user tries to save changes in Informatica Data Director. For information about configuring resource privileges, see the Informatica MDM Multidomain Edition Configuration Guide. Required Field Data Type URI Defines if users must enter data in the field when a business entity is created or updated. The data type of the field. By default, the data type is as close as possible to the data type of the lookup base object column that the field is associated with. You can define custom data types for business entity fields. For example, a string column in a base object might contain information for an image so you configure a custom Image data type for reference entity fields. Defines the namespace where custom data types are defined. Default is commonj.sdo. Searchable A smart search request searches only the fields that you configure as searchable fields. Before you perform a smart search, ensure that you configure the required fields as searchable fields. The scope of a search request increases with the increased number of searchable fields. Multiple searchable fields might affect the performance of a search request, so avoid configuring insignificant searchable fields. When you enable the Searchable property, the Searchable Configuration tab appears in the node properties panel. Related Topics: Custom Data Types on page 34 Adding a Field to a Node After you create a node in the business entity structure, you can add fields to the node. The fields correspond to columns in the base object that is associated with the node. For example, you want to add the City field to 32 Chapter 4: Configuring Business Entity Properties

33 the Address node. The Address node is associated with the C_ADDRESS base object, which has a CITY_NAME column. 1. In the tree view, expand the node to which you want to add a field. For example, expand the Address node. 2. Under the expanded node, select field. 3. In the tree view, click Create. 4. From the New Field form in the node properties panel, select the base object column to associate with the field from the Column Reference list. For example, select City_Name from the Column Reference list. Note: The base object column is created in the MDM Hub before you add a field to a node. 5. Enter a field name and a field display name. For example, enter City for the field name and field display name. 6. Optionally, configure the Read-only, Required Field, Data Type, URL, and Searchable properties. If you enable the Searchable property, the Searchable Configuration tab appears in the node properties panel. For information about the search properties, see the Smart Search chapter. 7. Click Apply. The changes are saved but are not published to the MDM Hub. Filters You can define a filter to regulate the data that users can enter in a field. You can specify the following filter behavior: IN The filter values are the only values allowed in the field. NOT_IN The filter values are not allowed in the field. Filters 33

34 Adding a Filter to a Field To add a filter to a field, in the tree view panel, select filter under the appropriate field and then click Create. For example, you can create a filter to only allow a value of Person for the Entity Type field of the Person node. 1. In the tree view panel, expand the arrow icon of the field to which you want to create filter. For example, click the arrow beside Entity Type under the Person node. 2. Under field, select filter, and then click Create. 3. In the node properties panel, select IN or NOT_IN from the Filter Behavior field. For example, select IN to create a filter that requires a specific value for a field. 4. Enter the filtered value. For example, enter a value of Person to allow only a value of Person is acceptable for the Entity Type field. 5. Click Apply. The changes are saved but are not published to the MDM Hub. Custom Data Types By default, the data type for a field is the same as the data type of the base object column that the field is associated with. You can define custom data types for business entity fields. For example, a string column in 34 Chapter 4: Configuring Business Entity Properties

35 a base object might contain information for an image so you configure a custom Image data type for business entity fields. You define custom data types in a namespace external to the Provisioning tool. When you associate a custom data type with a field, you must enter the location of the namespace where your custom data types are defined. Informatica provides some predefined custom data types in the schema co-types.xsd. You can find custom data types from the co-types.xsd schema in the urn:co-types.informatica.mdm namespace. Adding a Custom Data Type to a Field You can associate custom data types with business entity fields. When you associate a custom data type with a field, you enter the location of the resource where your custom data types are defined. For example, you want to associate an image data type with a field. 1. In the tree view, expand the node to which you want to add a field. 2. Under the expanded node, select field. 3. In the tree view, click Create. 4. From the New Field form in the node properties panel, select the base object column to associate with the field from the Column Reference list. For an image data type, select IMAGE_URL from the Column Reference list. Note: The base object column is created in the MDM Hub before you add a field to a node. 5. Enter a field name and a field display name. For example, enter Image URL for the field name and field display name. 6. Optionally, configure the Read-only, Required Field, Data Type, URL, and Searchable properties. If you enable the Searchable property, the Searchable Configuration tab appears in the node properties panel. For information about the search properties, see the Smart Search chapter. 7. Enter the URI for where your custom data types are defined. For example, enter urn:co-types.informatica.mdm. 8. In the Type field, enter the name of the custom data type that you defined in the URI. For image data type, enter ImageURL. Note: The custom data types are created in the namespace before you add a data type to a field. 9. Click Apply. The changes are saved but are not published to the MDM Hub. Node Labels in Informatica Data Director You can configure the node labels to define the business entity titles in Informatica Data Director. By default, the node name is the value for the node labels. If you do not configure the node labels, the node name appears as the node label. You can hard code text for the labels or you can display field values. To display field values, enter the field name in parenthesis. For example, use {lastname},{firstname} to display the values of the last name and first name in the title. Node Labels in Informatica Data Director 35

36 You can configure the following node labels: Label Format The title for an entity in the Informatica Data Director Entity view. The following image shows the Entity view with a red square around the title: The task format value for this example is {lastname}, {firstname}. Task Format The task title. 36 Chapter 4: Configuring Business Entity Properties

37 The following image shows the Task Manager with a red square around the portion of the task title that you can configure: The task format value for this example is {lastname},{firstname}. Exists No Attributes Format The title to display if the field you configured for a title does not contain a value. New Format The title of the page that appears when you create a new entity in Informatica Data Director. The following image shows the entity creation page with a red square around the title: The new format value for this example is New Person. Node Labels in Informatica Data Director 37

38 Configuring Node Labels To configure the labels for a node, configure the label formats in the node properties panel. 1. In the tree view panel, expand the arrow icon of the node for which you want to configure node labels. For example, click the arrow icon beside the Person node. 2. Under the node, select labelformat, and then click Create. 3. Enter the node labels. a. Enter the title that appears when view an entity in the Label Format field. For example, enter Person: {displayname}. b. Enter the task title in the Task Format field. For example to display the last name followed by the first name in the task title, enter {lastname}, {firstname}. The values in these fields are displayed in the task title separated by a comma. c. Enter the format of the title if you specified a field value for a title but the field does not contain a value in the Exists No Attributes Format field. For example, enter Person. d. Enter the title that appears when you create an entity in the New Format field. For example, enter New Person. 4. Click Apply. The changes are saved but are not published to the MDM Hub. 38 Chapter 4: Configuring Business Entity Properties

39 C H A P T E R 5 Configuring Reference Entity Properties This chapter includes the following topics: Configuring Reference Entity Properties Overview, 39 Lookup Types, 39 Field Properties, 40 Configuring a Lookup, 41 Configuring Reference Entity Properties Overview Configure the reference entity properties in the right-hand panel of the Provisioning tool. For many users, reference entities are synonymous with lookups. In the reference entity properties panel, you can perform the following tasks: Associate a lookup base object with a node. You configure the root node properties when you create a root node. For more information, see the chapter Establishing a Root Node. Enable fields to be searchable and configure search properties. For more information about configuring searchable fields and configuring search properties, see the chapter Smart Search. Lookup Types A lookup is a predefined list of values that are available for selection in a user interface. Within the Entity 360 framework, a regular lookup is linked to a lookup base object that contains a list of reference data. For example, a gender lookup is associated with the C_LU_GENDER base object. Dependent lookups are used when a dependency exists between two lookup tables. A typical example of this is a type table and subtype table. The list of values that display in the subtype table depends on the selection in the type table. Another example of a dependent lookup is where the list of values for state or province is populated based on the selected country. 39

40 Field Properties You can configure the field properties to associate a field with a lookup base object column, specify the data type, mark the field as read-only, mark the field as required, and make the field searchable. You can configure the following field properties: Column Reference Name The lookup base object column associated with the field. You associate a field with a base object column when you add a field to the node. The field name in the reference entity configuration file. Display Name The field name as it appears in the Provisioning tool tree view. Read-Only Defines if the field is editable. If this field is not enabled, the user can edit the field in the Entity view if the user has create or update privileges for the base object field in the MDM Hub. If the user has create or update privileges for the base object column in the MDM Hub, the field is editable in Informatica Data Director. If the user does not have create or update for the base object column in the MDM Hub, an error occurs when the user tries to save changes in Informatica Data Director. For information about configuring resource privileges, see the Informatica MDM Multidomain Edition Configuration Guide. Required Field Data Type URI Defines if users must enter data in the field when a business entity is created or updated. The data type of the field. By default, the data type is as close as possible to the data type of the lookup base object column that the field is associated with. You can define custom data types for business entity fields. For example, a string column in a base object might contain information for an image so you configure a custom Image data type for reference entity fields. Defines the namespace where custom data types are defined. Default is commonj.sdo. Searchable A smart search request searches only the fields that you configure as searchable fields. Before you perform a smart search, ensure that you configure the required fields as searchable fields. The scope of a search request increases with the increased number of searchable fields. Multiple searchable fields might affect the performance of a search request, so avoid configuring insignificant searchable fields. When you enable the Searchable property, the Searchable Configuration tab appears in the node properties panel. Adding a Field to a Node After you create a node in the reference entity structure, you can add fields to the node. The fields correspond to columns in the lookup base object that is associated with the node. For example, you want to 40 Chapter 5: Configuring Reference Entity Properties

41 add the Gender Code field to the LU Gender node. The LU Gender node is associated with the C_LU_GENDER lookup base object, which has a Gender_Code column. 1. In the tree view, expand the node to which you want to add a field. For example, expand the LU Gender node. 2. Under the expanded node, select field. 3. In the tree view, click Create. 4. From the New Field form in the node properties panel, select the base object column to associate with the field from the Column Reference list. For example, select Gender_Code from the Column Reference list. Note: The base object column is created in the MDM Hub before you add a field to a node. 5. Enter a field name and a field display name. For example, enter Gender Code for the field name and field display name. 6. Optionally, configure the Read-only, Required Field, Data Type, URL, and Searchable properties. If you enable the Searchable property, the Searchable Configuration tab appears in the node properties panel. For information about the search properties, see the Smart Search chapter. 7. Click Apply. The changes are saved but are not published to the MDM Hub. Configuring a Lookup To configure a lookup, create a new reference entity in the tree view panel and then associate the root node with a lookup base object. For example, you create a gender lookup reference entity related to the C_LU_GENDER lookup base object. 1. In the tree view, click the folder icon of the parent node under which you want to create a child node. For example, click the folder icon beside LU Gender. The parent node expands. 2. Under the expanded node, select field. 3. In the tree view, click Create. Configuring a Lookup 41

42 4. From the New Field form in the node properties panel, select the lookup base object column to associate with the field from the Column Reference list. For example, select Gender_Code from the Column Reference list. Note: The lookup base object column is created in the MDM Hub before you add a field to a node. 5. Enter a field name and a field display name. For example, enter Gender Code for the field name and field display name. 6. Create another field. In this example, select Gender_Disp from the Column Reference list. 7. Enter a field name and a field display name. In this example, enter Gender Disp for the field name and field display name. 8. Optionally, configure the Read-only, Required Field, Data Type, URL, and Searchable properties for the field you created. If you enable the Searchable property, the Searchable Configuration tab appears in the node properties panel. For information about the search properties, see the Smart Search chapter. 9. Click Apply. The changes are saved but are not published to the MDM Hub. Configuring a Dependent Lookup To configure a dependent lookup, create a new reference entity in the tree view panel and then associate the root node with a lookup base object. Then to create a one-to-many relationship within the lookup, in the tree view panel, select many under the parent node and then click Create. For example, you create a country lookup reference entity related to the C_LU_COUNTRY lookup base object. 1. In the tree view, click the folder icon of the parent node under which you want to create a child node. For example, click the folder icon beside LU Country. The parent node expands. 2. Under the expanded node, select field. 3. In the tree view, click Create. 4. From the New Field form in the node properties panel, select the base object column to associate with the field from the Column Reference list. For example, select Country_Code from the Column Reference list. Note: The base object column is created in the MDM Hub before you add a field to a node. 5. Enter a field name and a field display name. For example, enter Country Code for the field name and field display name. 6. Create another field. In this example, select Country_Name_Disp from the Column Reference list. 7. Enter a field name and a field display name. In this example, enter Country Name Disp for the field name and field display name. 42 Chapter 5: Configuring Reference Entity Properties

43 8. Optionally, configure the Read-only, Required Field, Data Type, URL, and Searchable properties for the field you created. If you enable the Searchable property, the Searchable Configuration tab appears in the node properties panel. For information about the search properties, see the Smart Search chapter. 9. Select many under the parent node, and then click Create. 10. In the node properties panel, select the base object that contains the lookup child node data. For example, select the lookup base object C_LU_State. 11. Select the constraint reference that defines the MDM Hub relationship between the base object of the parent node and the base object of the child node. For example, select the constraint C_LU_STATE(COUNTRY_CODE).C_LU_COUNTRY(COUNTRY_CODE). Note: The constraints are created in the MDM Hub before you configure the business entity structure. 12. Optionally, enter a node name, a node display name, and a node description. For example, enter LU State for the node name and node display name. 13. Click Apply. The changes are saved but are not published to the MDM Hub. Configuring a Lookup 43

44 C H A P T E R 6 Business Entity Views This chapter includes the following topics: Business Entity Views Overview, 44 Transformations, 44 Business Entity Views and Transformation Configuration XML, 45 Configuring the Business Entity Views and Transformation Configuration XML, 45 Business Entity Views Configuration XML, 46 Transformation Configuration XML, 47 Business Entity Views Overview Business entity views expose the data in a business entity to a user in a format suitable for the user. Business entity views provide a separation of low-level business entity and user interface related views. A business entity view is a business entity like structure with one root node and multiple child nodes. When you define views for a business entity, you can render a business entity in multiple ways. For example, you can define views based on user profiles or views based on the operations the user can perform. You can define one view when you create an entity and another view when you read or update a business entity. Only required fields are displayed in a business entity view. Field labels might be changed for the user to understand the data displayed and to interact with the data. Changes made by the user are detected and saved to the database. Transformations Transformations convert a business entity to a business entity view and a business entity view to a business entity. Transformations are required to read the data from the business entity and present the data in a format suitable to the user. Changes made by the user are detected, recorded, and transformed back to a format suitable for saving to the database. When a user adds or changes data in the business entity view, the data is checked against metadata and, optionally, validation rules. The metadata defines the expected format for the data, such as the data type or the number of characters permitted. The validation rules are cleanse rules or Informatica Data Quality rules. Transformations specify the metadata checks, the cleanse validation rules, and the Informatica Data Quality rules that must be used. 44

45 Types of Transformations The transformation XML defines the transformation of a business entity to a business entity view and from a business entity view back to a business entity. Transformation can be one of the following types: Structural transformation Field values are copied between the business entity and the business entity view. The field values do not change. Data transformation The field values are changed. For example, the title field of the Employee business entity might be a concatenation of the first and the last names. Data transformation is done in one of the following ways: Use of the cleanse functions defined in the MDM Hub. Use of the mapplets that are available as web services after the integration with Informatica Data Quality (Web Services). Business Entity Views and Transformation Configuration XML The business entity views XML defines the business entity views and the transformation configuration XML defines the transformation of a business entity to a business entity view and back. The business entity views XML is located in the repository table C_REPOS_CO_CS_CONFIG. The CONFIG_TYPE value in the repository table is CO_VIEWS. The transformation configuration XML is located in the repository table C_REPOS_CO_CS_CONFIG. The CONFIG_TYPE value in the repository table is TRANSFORMATIONS. Configuring the Business Entity Views and Transformation Configuration XML Use the Provisioning tool to manually define the business entity views and the transformation configuration XML. You can configure, validate, and publish the XML to the MDM Hub. Access the business entity views and the transformation configuration XML on the Advanced Configuration tab. If you have defined the XML, you can edit the XML in the editor. If you have not defined the XML, you can create the configuration XML in the empty editor panel. Follow the XML samples to write the XML correctly. When you validate and publish the XML, the configuration is saved to the MDM Hub. Business Entity Views and Transformation Configuration XML 45

46 Business Entity Views Configuration XML The business entity views configuration XML defines the views for business entities. The XML uses the business entity structure as the basis to define views for the business entity. Views are business entity like structures with a root node and fields. The following sample XML code shows the business entity definition based on which you configure a business entity view: <lookup name="country"> <field name="countrycode"/> <field name="countryname"/> </lookup> <coroot name="organization"> <field name="organizationname"/> <many name="addresses"> <field name="addresstype"/> <one name="address"> <field name="street"/> <referenceone name="country" object="country"/> </one> </many> </coroot> <coroot name="person"> <field name="firstname"/> <field name="lastname"/> <one name="details"> <field name="birthdate"/> </one> <many name="employer"> <field name="jobtitle"/> <one name="company"> <field name="companyname"/> </one> </many> </coroot> The following sample XML code shows the business entity views configuration: <viewroot name="company" co="organization"> <field name="name" type="string"/> <viewmany name="address"> <field name="type" type="string"/> <field name="street" type="string"/> <field name="country" type="country" uri="co-ors.informatica.com"/> <field name="map" type="string"/> </viewmany> </viewroot> <viewroot name="employee" co="person"> <field name="title" type="string"/> <field name="birthdate" type="date"/> <viewone name="names"> <field name="firstname" type="string"/> <field name="lastname" type="string"/> </viewone> <viewmany name="employer"> <field name="jobtitle" type="string"/> <field name="companyname" type="string"/> </viewmany> </viewroot> 46 Chapter 6: Business Entity Views

47 Transformation Configuration XML The transformation configuration XML transforms a business entity to a business entity view and back to a business entity. Use transformation configuration XML to validate, transform, and copy data. Define at least two transformations for each view, from a business entity to a business entity view and from business entity view back to the business entity. The following image shows two business entities and the business entity views: The following sample XML code shows a transformation configuration: <view2co view="company"> <group source="company" target="organization"> <transformation type="direct"> <input name="organizationname" field="company.name"/> <output name="organizationname" field="organization.organizationname"/> </transformation> </group> Use the following elements in the transformation configuration XML: transformation The transformation element defines the transformation for one group. Transformation Configuration XML 47

48 group The group element specifies a set of nodes connected by a one relationship. A child node with a one relationship is always in the same group as its parent node. You cannot create a separate group for a one child node. Only many relationship child nodes can form a new group. A business entity root node and each of its child nodes with a many relationship form new groups. This ensures that all nodes in a group have the same multiplicity. Each group in a view must have a corresponding group in the business entity. You can move the business entity data to any business entity view field in a corresponding group. Each group can have multiple transformation elements, one for each transformation. Each group has a source and target which specify the root nodes for the group. The following image shows how you can form groups: input and output type The input element specifies the field that you want to retrieve from the source group. The output element specifies the field to store the result of a transformation. For each input element, the configuration reads a field value and adds it to a map where the key is the input name. For each output element, the configuration uses the output name as a key to read the value from the map and set it as the field value. In direct transformations, for each output ensure that you have an input with the same name. The input and the output names need not match the business entity or business entity field names. The following sample XML code shows how to use the input and the output elements: <input name="organizationname" field="organization.organizationname"/> <output name="organizationname" field="company.name"/> The type attribute indicates the type of transformation. The type attribute can have one of the following values: Direct. Indicates no data transformation. Data is copied from one group field to another group field. Cleanse. Indicates the use of cleanse functions defined in the MDM Hub. 48 Chapter 6: Business Entity Views

49 Platform. Indicates the use of mapplets that are available as web services with the integration with Informatica Data Quality. Use the endpoint URL of the web service as a function for the transformation. For more information about how to use mapplets, see the Informatica MDM Multidomain Edition Version Cleanse Adapter Guide. The co2view element indicates the transformation is from the business entity to a business entity view. The veiw2co element indicates the transformation is from the business entity view to the business entity. The co2co element indicates the transformation of a business entity to a business entity. Related Topics: Cleanse Validation Rules on page 81 Informatica Data Quality Validation Rules on page 83 Applying Data Quality Rules During Server-side Validation on page 85 Structural Transformation XML In structural transformations, there is no data change. A business entity can be transformed into a business entity view and back, by moving attributes from one node to another. The following sample XML code defines a structural transformation: <co2view view="company"> <group source="organization" target="company"> <transformation type="direct"> <input name="organizationname" field="organization.organizationname"/> <output name="organizationname" field="company.name"/> </transformation> </group> <group source="organization.addresses" target="company.address"> <transformation type="direct"> <!-- inputs --> <input name="addresstype" field="addresses.addresstype"/> <input name="street" field="addresses.address.street"/> <input name="country" field="addresses.address.country"/> <!-- complex type --> <!-- outputs --> <output name="addresstype" field="address.type"/> <output name="street" field="address.street"/> <output name="country" field="address.country"/> <!-- complex type --> </transformation> </group> </co2view> <view2co view="company"> <group source="company" target="organization"> <transformation type="direct"> <input name="name" field="company.name"/> <output name="organizationname" field="organization.organizationname"/> </transformation> </group> <group source="company.address" target="organization.addresses"> <transformation type="direct"> <input name="type" field="addresses.type"/> <input name="street" field="addresses.street"/> <input name="country" field="addresses.country"/> <output name="type" field="addresses.address.addresstype"/> <output name="street" field="addresses.address.street"/> <output name="country" field="addresses.address.country"/> </transformation> </group> </view2co> Transformation Configuration XML 49

50 Data Transformation XML Transformations such as concatenation of first name and last name or address validation are data transformations. Use cleanse functions and mapplets to perform the data transformations. The following sample XML code uses a cleanse function to concatenate the first name and the last name. The business entity view defines the title field which contains the concatenated string: <co2view view="employee"> <group source="person" target="employee"> <transformation type="direct"> <input field="person.firstname" name="firstname" /> <input field="person.lastname" name="lastname" /> <input field="person.details.birthdate" name="birthdate" /> <output name="firstname" field="employee.names.firstname" /> <output name="lastname" field="employee.names.lastname" /> <output name="birthdate" field="employee.birthdate" /> </transformation> <transformation type="cleanse" name="string Functions Concatenate"> <input field="person.firstname" name="string1" /> <input field="person.lastname" name="string2" /> <output name="string" field="employee.title" /> </transformation> </group> </co2view> <view2co view="employee"> <group source="employee" target="person"> <transformation type="direct"> <input name="firstname" field="employee.names.firstname" /> <input name="lastname" field="employee.names.lastname" /> <input name="birthdate" field="employee.birthdate" /> <output field="person.firstname" name="firstname" /> <output field="person.lastname" name="lastname" /> <output field="person.details.birthdate" name="birthdate" /> </transformation> </group> </co2view> Business Entity to Business Entity Transformation XML A MDM Hub cleanse function or a Informatica Platform cleanse function is used to validate data and perform a data transformation of a business entity into a business entity. The following sample XML code shows the transformation of a business entity into a business entity: <co2co co="person"> <group source="person.address" > <transformation type="cleanse" name="bdd Cleanse and Validation Library CVAddress"> <input field="address.addressline1" name="addressline1" /> <input field="address.cityname" name="cityname" /> <output name="addressline1" field="address.addressline1" /> <output name="cityname" field="address.cityname" /> </transformation> </group> </co2co> 50 Chapter 6: Business Entity Views

51 C H A P T E R 7 Entity 360 Framework Configuration This chapter includes the following topics: Entity 360 Framework Configuration Overview, 52 Entity 360 Framework Components, 52 Entity 360 Framework Layout, 54 Entity View Example, 54 How to Enable the Entity 360 Framework, 55 Entity 360 Framework Configuration Overview, 56 Layout Editor, 57 Entity 360 Framework Components, 57 Matched Records Component, 58 Related Records Component, 59 Source Systems Component, 60 Similar Business Entities Component, 62 Related Tasks Component, 62 Task Inbox Component, 63 History Component, 63 Effective Periods Component, 64 Match Merge Comparison Component, 64 Hierarchy Component, 65 Cross-Reference Component, 66 Custom Components, 66 HTML and Javascript Custom Component Configuration, 66 Inline Frame Custom Component Configuration, 67 Jaspersoft Report Component Configuration, 68 Configuring the Components, 70 Entity 360 Framework Layout, 71 Entity View, 72 Start Page, 73 Main Area and Sidebar Configuration, 73 51

52 Entity 360 Framework Layout Display Conditions, 74 Displaying Layouts for Business Entities or Business Entity Views, 75 Displaying Layouts Based on User Roles, 76 Displaying Layouts for New and Existing Business Entities, 77 Displaying Layouts Based on Tasks, 78 Data Validation in the Entity View, 79 Entity 360 Logging, 85 Entity 360 Framework Configuration Overview The Entity 360 framework in Informatica Data Director consists of multiple components that display information about various aspects of a business entity. Each component displays data related to an entity. You can configure predefined components and custom components to appear in the Entity 360 framework. When you configure the layout of the Entity 360 framework workspace, you can configure a unique layout for a role, or you can configure the same layout for multiple roles. If you do not configure the layout or components for the Entity 360 framework, Informatica Data Director generates a default configuration for you. Note: Informatica Data Director Data Masking and Informatica Data Director Data Security are not available in the Entity 360 framework. Use the Entity 360 framework to create customized views of trusted business entity data. You can choose from a selection of components that display important information for a trusted 360-degree view of each entity. For example, you can configure an Entity View of a customer for users who have a data steward role. You select the entity data fields you want to display. You can then add components to the view. The lay out will be viewed by data stewards, so you decide to display a component that shows other records that the MDM Hub considers to be matches, and another component that shows the source systems that contribute data to the best version of the truth. When the data steward opens the Entity View for a particular customers, the most relevant trusted data that represents the best version of the truth appears. The components that you add to the layout present the data steward with a complete 360-degree view of the entity. The configuration for the Entity 360 framework layouts and components are contained in XML files. You make changes to the Entity 360 framework XML configuration files in the Layout Editor of the Provisioning tool. Entity 360 Framework Components MDM Multidomain Edition comes with preconfigured components that you can arrange in the Entity 360 framework workspace. You can also place custom components on the Entity 360 framework. Configure the components that require a configuration file in the Layout Editor. The configured component can then be placed in an Entity 360 framework configuration. You can add the following components to the Entity 360 framework: 52 Chapter 7: Entity 360 Framework Configuration

53 Matched Records Displays records that match the business entity. Related Records Displays the records that relate to the business entity. Source Systems History Displays the source systems that contributed to the business entity data. Displays the history of changes that were made to the business entity. Effective Periods Displays the effective periods of the root node and the child objects of the business entity that you selected for a specified history date. Match Comparison Displays a table that compares selected business entities. You can use the component to merge records and create merge tasks. Hierarchy View Displays the Hierarchy View. Cross-reference View Displays the cross-reference records. Related Tasks Displays the cross-reference records. Related tasks only display tasks that are created in the BE-AVOS adapter. Task Inbox Displays the Task Manager inbox. Similar Business Entities Displays a module that allows users to search for a similar business entity before they create one. External Link Displays a custom component, such as a Twitter feed or web page. You must also define a configuration type name for the component or it does not display any data. JasperReport Displays Jaspersoft reports that are configured in the IDD configuration file. Note: Use the ExternalLink component if you are a new customer and want to display a Jaspersoft report in IDD. Entity 360 Framework Components 53

54 Entity 360 Framework Layout You can add and arrange the Entity 360 Framework components in layouts for the Entity View and the Start page. You configure layouts by editing XML code in the Layout Editor. A layout consists of a main area and a sidebar. The main area is three columns wide. Components in the main area can span up to three columns. You can place multiple components in the main area. The sidebar is a single column on the right side of the layout. You can stack multiple components in the sidebar. Entity View Example The following image show a typical Entity view layout: 1. Main area. 2. Sidebar. 3. Tab, generated from configurable label. 4. Business entity title, generated from configurable label. 5. Root node navigation button. 6. Child nodes navigation buttons. 7. Related Tasks component. 8. Source Systems component. 9. Matched Records component. 10.Related Records component. 54 Chapter 7: Entity 360 Framework Configuration

55 How to Enable the Entity 360 Framework If the Entity 360 framework is not enabled by default, you can enable it. To enable the Entity 360 framework for Informatica Data Director (IDD), in the cmxserver.properties file, set cmx.e360.view.enabled to true. When cmx.e360.view.enabled=true, IDD applications contain the following user interface elements: Task Manager workspace tab Create menu in the application header Links to the Entity View from menus on other views The following temporary workspaces are available: - Entity workspace. An entity workspace tab appears when you add a new business entity or open a business entity from search results. The label on the tab is dynamic, based on the action that opens the workspace. - Search workspace. A Search workspace tab appears when you use the Search box in the application header. With the Entity 360 framework enabled, IDD users edit and manage master data from an entity workspace instead of the Data workspace. As a best practice, you can reduce confusion for IDD users by hiding the Data workspace and the related user interface elements. In the cmxserver.properties file, set cmx.dataview.enabled to false. When cmx.dataview.enabled=false, IDD applications hide the following user interface elements: Data workspace tab Tasks workspace tab Custom workspace tabs, if configured Create in Data View menu in the application header Queries menu in the application header Links to the Data View from menus on other views After you edit the properties file, you need to restart the application server to apply the changes. Enabling the Entity 360 Framework To enable the Entity 360 framework for Informatica Data Director applications, edit the cmxserver.properties file and then restart the application server. 1. Navigate to the following directory: <MDM installation directory>/hub/server/resources 2. Open the cmxserver.properties file in an editor. 3. Add the following properties: # Enable the Entity 360 framework cmx.e360.view.enabled=true # Hide the Data view and related UI elements cmx.dataview.enabled=false 4. Save the file. 5. Restart the application server. Log in to the IDD Configuration Manager. For each IDD application that uses the Entity 360 framework, regenerate business entities and business entity services. How to Enable the Entity 360 Framework 55

56 Entity 360 Framework Configuration Overview The Entity 360 framework in Informatica Data Director consists of multiple components that display information about various aspects of a business entity. Each component displays data related to an entity. You can configure predefined components and custom components to appear in the Entity 360 framework. When you configure the layout of the Entity 360 framework workspace, you can configure a unique layout for a role, or you can configure the same layout for multiple roles. If you do not configure the layout or components for the Entity 360 framework, Informatica Data Director generates a default configuration for you. Note: Informatica Data Director Data Masking and Informatica Data Director Data Security are not available in the Entity 360 framework. Use the Entity 360 framework to create customized views of trusted business entity data. You can choose from a selection of components that display important information for a trusted 360-degree view of each entity. For example, you can configure an Entity View of a customer for users who have a data steward role. You select the entity data fields you want to display. You can then add components to the view. The lay out will be viewed by data stewards, so you decide to display a component that shows other records that the MDM Hub considers to be matches, and another component that shows the source systems that contribute data to the best version of the truth. When the data steward opens the Entity View for a particular customers, the most relevant trusted data that represents the best version of the truth appears. The components that you add to the layout present the data steward with a complete 360-degree view of the entity. The configuration for the Entity 360 framework layouts and components are contained in XML files. You make changes to the Entity 360 framework XML configuration files in the Layout Editor of the Provisioning tool. 56 Chapter 7: Entity 360 Framework Configuration

57 Layout Editor The Layout Editor contains a list of Entity 360 framework configuration files that are you configure for the selected database. The Layout Editor also contains an XML editor to create and edit configuration files. The following image shows the Layout Editor: 1. Entity 360 Framework configuration files 2. XML editor Entity 360 Framework Components MDM Multidomain Edition comes with preconfigured components that you can arrange in the Entity 360 framework workspace. You can also place custom components on the Entity 360 framework. Configure the components that require a configuration file in the Layout Editor. The configured component can then be placed in an Entity 360 framework configuration. You can add the following components to the Entity 360 framework: Matched Records Displays records that match the business entity. Related Records Displays the records that relate to the business entity. Source Systems History Displays the source systems that contributed to the business entity data. Displays the history of changes that were made to the business entity. Layout Editor 57

58 Effective Periods Displays the effective periods of the root node and the child objects of the business entity that you selected for a specified history date. Match Comparison Displays a table that compares selected business entities. You can use the component to merge records and create merge tasks. Hierarchy View Displays the Hierarchy View. Cross-reference View Displays the cross-reference records. Related Tasks Displays the cross-reference records. Related tasks only display tasks that are created in the BE-AVOS adapter. Task Inbox Displays the Task Manager inbox. Similar Business Entities Displays a module that allows users to search for a similar business entity before they create one. External Link Displays a custom component, such as a Twitter feed or web page. You must also define a configuration type name for the component or it does not display any data. JasperReport Displays Jaspersoft reports that are configured in the IDD configuration file. Note: Use the ExternalLink component if you are a new customer and want to display a Jaspersoft report in IDD. Matched Records Component The matched records component lists the entities that are potential matches of the entity in the Entity View. The list of matches reflects the results of the most recent MDM Hub match batch process. Each potential match in the component is a link that you can click to open the matched entity in the Entity View. To configure the matched records component, associate the component with a business entity and configure the labels for the matching entities. After you configure the component, add it to the appropriate Entity View layout configurations. For example, when a user views a business entity in the Entity View, you want to display a list of business entities that match the entity shown in the Entity View. You want the matched entities to be listed by the display name. 58 Chapter 7: Entity 360 Framework Configuration

59 The following image shows the matched records component that appears for a Person business entity with the name John E. Smith: The following code shows the Matched Records component configuration for the component in the example: <dataviewlayout co='person'> <labelformatter pattern='{display_name}'/> </dataviewlayout> Matched Records Component Configuration The component type for the matched records component is MatchMerge. Use the following XML code to configure the matched records component: Where: <dataviewlayout co='business entity'> <labelformatter pattern='label'/> </dataviewlayout> business entity is the business entity name. For example, 'Person' to display a list of business entities that match the Person business entity. label is the syntax and text for the component label. For example, {DISPLAY_NAME} to list the matching business entities by the value of the DISPLAY_NAME field in the root node. Related Records Component To configure the related records component, you specify a hierarchy profile, sandbox, and entity type. The related records component is based on the Get One Hop function in the Hierarchy Manager. The related records component displays information about entities that directly relate to an entity in a specified hierarchy configuration. Related Records Component 59

60 For example, you want to display records that relate to a person business entity. The following image shows the related records component example that appears when you use the related records component configuration: The following XML sample shows the XML configuration code required to configure the related records component: <dataviewlayout> <hmconfiguration hmconfigurationuid='hm_configuration.default Master' hmentitytypeuid='hm_entity_type.person'> </hmconfiguration> </dataviewlayout> Related Records Component Configuration The component type for the related records component is GetOneHop. Use the following XML code to configure the related records component: Where: <dataviewlayout> <hmconfiguration hmconfigurationuid='hm_configuration.hierarchy profile sandbox' hmentitytypeuid='hm_entity_type.entity type'> </hmconfiguration> </dataviewlayout> hierarchy profile specifies the hierarchy profile. The hierarchy profile defines the hierarchy objects that can be accessed by users. For example, specify Default to use the default hierarchy profile. sandbox specifies the Hierarchy Manager sandbox. For example, specify Master to use the master sandbox. entity type specifies the Hierarchy Manager entity type. For example, specify Person to fetch the entities that are directly related to the Person entity type. Source Systems Component The source system component displays the source systems that contributed to the entity data. The source systems appear in order from the largest contributor of cross-reference records to the smallest contributor of cross-reference records. The bar graph color for the largest contributor appears is the color that you define first in the XML configuration code. Specify the HTML color names or the hexadecimal code number in the value attribute of the color element in the XML configuration code. To configure the source systems component, specify the colors of the bar graph that shows the proportion of contributing records from the source systems. You can specify the color by the HTML color names or by the hexadecimal code number. 60 Chapter 7: Entity 360 Framework Configuration

61 For example, you want to configure the bar chart colors for the source systems that contributed to a person business entity. The following image shows the source systems component example that appears when you use the sources systems component configuration: The following XML sample shows the XML configuration code required to configure the source systems component: <xrefsystems> <color value="darkmagenta" /> <color value="aqua" /> <color value="forestgreen" /> <color value="gold" /> <color value="lightseagreen" /> <color value="orange" /> <color value="#dbfcf5" /> <color value="#fbfa9c" /> </xrefsystems> Source Systems Component Configuration The component type for the source systems component is XrefSystems. Use the following XML code to configure the source systems component: Where: <xrefsystems> <color value="html color name 1" /> <color value="html color name 2" />... <color value="html color name n" /> <color value="hexadecimal code number 1" /> <color value="hexadecimal code number 2" />... <color value="hexadecimal code number n" /> </xrefsystems> HTML color name is the W3C color name for the color. Hexadecimal code number is the hexadecimal value of the color. Note: You can use the HTML color name, the hexadecimal code number, or both to specify the color values. Source Systems Component 61

62 Similar Business Entities Component The similar business entities component displays a list of business entities that are potential matches to a business entity. To configure the similar business entities component, list the fields to search for matches. The similar business entities component uses smart search to find records with similar data in these fields. Tip: When you test the component, if you do not see results, ensure that smart search is configured in the MDM Hub environment. For example, you want to specify that the MDM Hub identifies matching business entities by searching on the first name field, the last name field, and the display name field. The following code shows the similar business entities component configuration for the component in the example: <config> <searchablefields> <field name="firstname"/> <field name="lastname"/> <field name="displayname"/> </searchablefields> <label existsformat="{1} {2}"> <column columnuid="firstname" /> <column columnuid="lastname" /> </label> </config> Similar Business Entities Component Configuration The component type for the similar business entities component is SearchBeforeCreate. Use the following XML code to configure the similar business entities component: Where: <config> <searchablefields> <field name="field name 1"/> <field name="field name 2"/>... <field name="field name n"/> </searchablefields> </config> field name is the name of the field on which you want to search to identify similar records. Related Tasks Component The related tasks component displays tasks that are related to a business entity. To add the component to a layout, add the following code to the layout configuration: <component type="betaskinbox" /> Note: The related tasks component is not configurable. 62 Chapter 7: Entity 360 Framework Configuration

63 The following image shows the related tasks component: Task Inbox Component The task inbox component allows users to organize, claim, and resolve tasks that are generated by review processes. To add the component to a layout, add the following code to a layout configuration: <component type="taskinbox" /> Note: The task inbox component is not configurable. The following image shows the task inbox component: History Component The history component shows how data events have changed master data over time. To add the component to a layout, add the following code to a business entity layout configuration: <component type='behistoryview' colspan='3' /> Task Inbox Component 63

64 Note: The history component is not configurable. The following image shows the history component: Effective Periods Component The effective periods component displays the effective periods of the root node and selected child objects of the business entity for the date that you specify. To add the component to a layout, add the following code to a business entity layout configuration: <component type='beeffectiveperiodsview' colspan='3' /> Note: The effective periods component is not configurable. Match Merge Comparison Component The match merge comparison component displays any business entity that potentially matches another business entity. You can then select the potential matches as merge candidates. To add the component to a layout, add the following code to a business entity layout configuration: <component type='bematchcomparisonview' colspan='3' /> Note: The match comparison component is not configurable. 64 Chapter 7: Entity 360 Framework Configuration

65 The following image shows the match merge comparison component: Hierarchy Component The hierarchy component displays a graph that shows how a business entity is related to other business entities. To add the component to a layout, add the following code to a business entity layout configuration: <component type='behierarchyview' colspan='3' /> Note: The hierarchy component is not configurable. The following image shows the hierarchy component: Hierarchy Component 65

66 Cross-Reference Component The cross-reference component displays the records that contribute to the best version of the truth for a business entity. To add the component to a layout, add the following code to a business entity layout configuration: <component type='bexrefview' colspan='3' /> Note: The cross-reference component is not configurable. Custom Components You can use the ExternalLink configuration type to configure custom components. When you configure custom components, you can use an inline frame to embed an external web page in an Entity 360 component, or you can configure the component with HTML code and Javascript. You can pass data from the entity to the custom component by placing an entity field name in double braces. For example, if you want to pass the display name to a Bing search custom component, specify {{displayname}}. HTML and Javascript Custom Component Configuration You want to use HTML and Javascript to display the Twitter feed that belongs to the person entity. The following image shows the custom component as it appears when you use the custom component configuration for this example: The following XML sample shows the HTML and Javascript code required to configure the custom component in this example: <dataviewlayout> <widgetcontent><![cdata[ <div> <a target='_blank' class="twitter-timeline" href=" data-screen-name="{{taxid}}" data-tweet-limit="5" data-show-replies="false" data-widgetid=" ">tweets by {{displayname}}</a> <script>!function(d,s,id){ 66 Chapter 7: Entity 360 Framework Configuration

67 var widgetelem = d.getelementbyid(id); if (widgetelem) { var widgetparent = widgetelem.parentnode; widgetparent.removechild(widgetelem); } var js, fjs=d.getelementsbytagname(s)[0], p=/^ js=d.createelement(s); js.id=id; js.src=p+"://platform.twitter.com/widgets.js"; fjs.parentnode.insertbefore(js,fjs); }(document,"script","twitter-wjs"); </script> </div>]]> </widgetcontent> </dataviewlayout> For more information about the Twitter API code in the example, see the Twitter documentation regarding embedded timelines. Inline Frame Custom Component Configuration You want to configure an inline frame to display a Bing search page that is populated with the display name from the business entity. The following image shows the custom component as it appears when you use the Bing component configuration for this example: Inline Frame Custom Component Configuration 67

68 The following XML sample shows the inline frame configuration in the XML configuration code required to configure the custom component in this example: <dataviewlayout> <widgetcontent><![cdata[ <style> #box { height: 500px; overflow: auto; } </style> <div id="box"> <iframe src=" allowtransparency="true" frameborder="0" scrolling="no" style="border:none;overflow:auto;height:100%;width:100%" ></iframe> </div> ]]> </widgetcontent> </dataviewlayout> Jaspersoft Report Component Configuration If you use the business intelligence tool Jaspersoft to develop and analyze reports, you can display the reports in the Start workspace. To configure the Start workspace layout, you can use one of the following component types: DashboardReportsView DashboardReportsView. Use this component if you are a customer that already has Jaspersoft reports configured for subject areas in IDD. The DashboardReportsView component type acts as an inline frame for all reports configured in the IDD configuration file. ExternalLink Use this component if you are a new customer and want to display a Jaspersoft report in IDD. With the ExternalLink component, you can display a Jaspersoft report as an HTML image in the Start workspace. For more information about how to configure Jaspersoft reports in Informatica Data Director, see the Informatica MDM Multidomain Edition Resource Kit Guide. 68 Chapter 7: Entity 360 Framework Configuration

69 Jaspersoft Report Component Configuration Example 1 You already have Jaspersoft reports configured for subject areas in IDD. You want to display the existing Jaspersoft reports in the Start workspace. You also want the reports to span three columns of the main area. The following image shows the Start workspace layout as it appears when you use the Start workspace layout configuration in this example: The following XML sample shows the code required to configure the custom component in this example: <componentcontainer> <layout> <securityrole roleid="manager" /> <mainarea> <component type="taskinbox" /> <component type="dashboardreportsview" colspan="3" /> </mainarea> <toolsarea> </toolsarea> </layout> </componentcontainer> Jaspersoft Report Component Configuration Example 2 You have never used Jaspersoft reports in IDD and you want to configure a new Jaspersoft report to appear in the Start workspace. For more information about how to configure Jaspersoft reports in Informatica Data Director, see the Informatica MDM Multidomain Edition Resource Kit Guide. Jaspersoft Report Component Configuration 69

70 The following image shows the Start workspace layout as it appears when you use the Start workspace layout configuration in this example: The instance name of the XML component must be Report1_ExternalLink, and the configuration name must be ExternalLink. The following XML sample shows the code required to configure the ExternalLink component in this example: <dataviewlayout> <widgetcontent><![cdata[ <img src="/bdd/report?template=report2&ors=test&format=image&year=2014&user=admin" style="width:100%; border-bottom: 0; border-width:0;padding:0px;margin:0px;"></img> ]]> </widgetcontent> </dataviewlayout> The following XML sample shows how the ExternalLink component is configured within the Start workspace in this example: <componentcontainer> <layout> <securityrole roleid="manager" /> <mainarea> <component type="taskinbox" /> </mainarea> <toolsarea> <component type='externallink' configuration='report1_externallink' /> </toolsarea> </layout> </componentcontainer> Configuring the Components To configure the Entity 360 framework components, use the Layout Editor to specify the component type and configure the XML code. 1. In the Provisioning Tool, click Layout Editor. 2. In the XML Layouts pane, click Create. A new configuration instance is created. 70 Chapter 7: Entity 360 Framework Configuration

71 3. Click the edit button for the new instance. 4. In the New Instance field, enter an instance name. 5. In the New Type field, enter the component type. 6. In the XML editor, add the XML code to configure the component. 7. Click Update. 8. The changes are saved but are not published to the MDM Hub. You can now add the component to the Entity 360 Framework layouts. Entity 360 Framework Layout You can add and arrange the Entity 360 Framework components in layouts for the Entity View and the Start page. You configure layouts by editing XML code in the Layout Editor. A layout consists of a main area and a sidebar. The main area is three columns wide. Components in the main area can span up to three columns. You can place multiple components in the main area. The sidebar is a single column on the right side of the layout. You can stack multiple components in the sidebar. Entity 360 Framework Layout 71

72 Entity View The Entity view displays a complete 360-degree view of a business entity. You can add components to the Entity view layout to present the information that is the most useful to users. The following image shows a typical Entity View layout: 1. Main area. 2. Sidebar. 3. Tab, generated from configurable label. 4. Business entity title, generated from configurable label. 5. Root node navigation button. 6. Child nodes navigation buttons. 7. Related Tasks component. 8. Source Systems component. 9. Matched Records component. 10.Related Records component. Note: If you do not configure a layout for a business entity, a default layout displays the business entity without any additional components. 72 Chapter 7: Entity 360 Framework Configuration

73 Start Page The Start page appears when users log in to Informatica Data Director. For example, you can configure the Start page to display tasks in the Task Inbox and data reports. Users can return to the Start page by clicking the Start tab. The following image shows a typical Start page layout: Main Area and Sidebar Configuration The Entity 360 Framework layout spans four columns. The main area spans three columns and the sidebar spans one column on the right side of the layout. You can configure the arrangement of components within the main area and sidebar. Components can span up to three columns in the main area. You can place multiple components in the main area. In the sidebar, you can stack multiple components in a single column. For example, in the main area, you want to display an existing instance of a business entity that spans three columns. In the sidebar, you want to display the matched records component, the source systems component, and the related records component. The following code excerpt adds a view of business entity data that spans three columns in the main area: <mainarea> <component type="rootco" colspan="3"/> </mainarea> The following code excerpt adds four components to the sidebar: <toolsarea> <component type="matchmerge" configuration="person_matchmerge" colspan="1"/> <component type="xrefsystems" configuration="default_xrefsystems" colspan="1"/> <component type="getonehop" configuration="person_getonehop" colspan="1"/> <component type="externallink" configuration="twitter_externallink" colspan="1"/> </toolsarea> Start Page 73

74 Entity 360 Framework Layout Display Conditions You can configure multiple layouts and set the conditions that determine which layout appears. You can also configure layouts to display data for a full business entity or a subset of the business entity data in the form of a business entity view. You can configure the following layout display conditions: Business entity or business entity view Roles The business entity or business entity view to which the layout applies. You must specify a business entity or business entity view for a layout. For example, the following code excerpt specifies that the layout appears for the HouseholdView business entity view: <businessentity view="householdview"/> Determines which layout appears based on the role of the user. A layout can apply to more than one role. If you do not specify a role for a layout, the layout appears for all roles. For example, the following code excerpt specifies that the layout appears to the users who belong to the Manager role: <securityrole roleid="manager" /> Existing or new entity When you configure the layout to display a business entity, determines if the layout appears when a user views an existing business entity record, or appears when a user creates a business entity record. For example, the following code excerpt specifies that the layout appears when a user views an existing Person business entity record: <businessentity view="person" entitystate="existing"/> The following code excerpt specifies that the layout appears when a user creates a Person business entity record: Task type <businessentity view="person" entitystate="new"/> Determines in which layout a business entity appears when you open the entity from a task. You can configure the layout that is most appropriate for each task type. For example, the following code expert specifies that the layout appears when a user views an entity from a Merge task: <capability type="displaytasktype" name="merge"/> 74 Chapter 7: Entity 360 Framework Configuration

75 Displaying Layouts for Business Entities or Business Entity Views Each layout is associated with a business entity or a business entity view. All the components in the layout display information related to the entity. You can configure a layout for a business entity to see the complete set of fields and tables available for a business entity. Note that a layout configured for a full business entity also displays relationship tables that join nodes in a many-to-many relationship. You can configure a layout for a business entity view to operate on and view a subset of the business entity fields. You can configure the layout that is most appropriate for each business entity. For example, you might want to display a corporate Twitter feed in the sidebar for an Organization business entity, but you might want to display the LinkedIn profile for a Person business entity. Example of a Layout Based on a Business Entity You want to configure a layout for the Person business entity. When an administrator or data steward opens an instance of a Person business entity view, you want the Entity View to also display related records, matching records, and contributing sources systems. The following code shows how to configure the layout in this example: <layout id="existingrecord"> <label existsformat="person: {1}"> <column columnuid="displayname" /> </label> <securityrole roleid="administrator"/> <securityrole roleid="datasteward"/> <businessentity view="person"/> <mainarea> <component type="rootco" colspan="3"/> </mainarea> <toolsarea> <component type="getonehop" configuration="person_getonehop" colspan="1"/> <component type="matchmerge" configuration="person_matchmerge" colspan="1"/> <component type="xrefsystems" configuration="default_xrefsystems" colspan="1"/> </toolsarea> </layout> Example of a Layout Based on a Business Entity View You want to configure a layout for the HouseholdView business entity view. You have configured the HouseholdView business entity view to hide the relationship table that joins the Household table to the Members table. The following code shows how to configure the layout in this example: <componentcontainer> <layout id="1"> <businessentity view="householdview"/> <mainarea> <component type="rootco" colspan="3"/> </mainarea> <toolsarea> <component type="getonehop" configuration="household_getonehop" colspan="1"/> </toolsarea> </layout> </componentcontainer> Displaying Layouts for Business Entities or Business Entity Views 75

76 The following image shows the Entity View for this example: Displaying Layouts Based on User Roles You can specify which layout appears for a user based on the role of the user. You can associate multiple roles with a layout. For example, you can configure a layout that appears for both managers and administrators. You can also create multiple layouts for multiple roles. For example, you can configure one layout for data stewards and another layout for business users. If you do not specify a role for a layout, the layout appears for those users who belong to a role not associated with any layout. User roles are defined in the MDM Hub Console. For more information, see the Informatica MDM Multidomain Edition Configuration Guide. Example of One Layout for Multiple Roles You want administrators and data stewards to see the same Person business entity view. You want the layout to display related records, matching records, and sources systems. The following code shows how to configure the layout in this example: <componentcontainer> <layout id="existingrecord"> <label existsformat="person: {1}"> <column columnuid="displayname" /> </label> <securityrole roleid="datasteward"/> <securityrole roleid="administrator"/> <businessentity view="personview" entitystate="existing"/> <mainarea> <component type="rootco" colspan="3"/> </mainarea> <toolsarea> <component type="rootco" configuration="personimage" colspan="1"/> <component type="matchmerge" configuration="person_matchmerge" colspan="1"/> <component type="xrefsystems" configuration="default_xrefsystems" colspan="1"/> <component type="getonehop" configuration="person_getonehop" colspan="1"/> </toolsarea> </layout> </componentcontainer> 76 Chapter 7: Entity 360 Framework Configuration

77 Example of Multiple Layouts for Multiple Roles You want administrators to see one Entity View layout and you want data stewards to see another layout. You configure two different layouts, and specify to which role each layout applies. The following code shows how to configure the layouts in the example: <componentcontainer> <layout id="1"> <label existsformat="person: {1}"> <column columnuid="displayname" /> </label> <securityrole roleid="administrator"/> <businessentity view="personview" entitystate="existing"/> <mainarea> <component type="rootco" colspan="3"/> </mainarea> <toolsarea> <component type="rootco" configuration="personimage" colspan="1"/> <component type="xrefsystems" configuration="default_xrefsystems" colspan="1"/> <component type="getonehop" configuration="person_getonehop" colspan="1"/> </toolsarea> </layout> <layout id="2"> <label existsformat="person: {1}"> <column columnuid="displayname" /> </label> <securityrole roleid="datasteward"/> <businessentity view="personview" entitystate="existing"/> <mainarea> <component type="rootco" colspan="3"/> </mainarea> <toolsarea> <component type="rootco" configuration="personimage" colspan="1"/> <component type="matchmerge" configuration="person_matchmerge" colspan="1"/> </toolsarea> </layout> </componentcontainer> Displaying Layouts for New and Existing Business Entities You can specify if a layout appears when a user views an existing business entity record or creates a business entity record. To define if a layout is for a new or existing layout, configure the entitystate attribute of the businessentity element. The entitystate attribute can have the following values: existing new The layout appears when you open an existing business entity in the Entity View. The layout appears when you create a business entity in the Entity View. If you do not specify the entitystate attribute, the layout appears when a user views an existing entity and also when a user creates a new entity. Displaying Layouts for New and Existing Business Entities 77

78 Example of a Layout for an Existing Business Entity You want to configure an Entity View layout for the Person business entity. When a user opens the Entity View for an existing instance of Person business entity, the user sees the business entity data, a graph of the contributing source systems, a list of matching records, and a list of related records. The following code shows how to configure the layout in this example: <layout id="1"> <label existsformat="person: {1}"> <column columnuid="displayname" /> </label> <businessentity view="person" entitystate="existing"/> <mainarea> <component type="rootco" colspan="3"/> </mainarea> <toolsarea> <component type="xrefsystems" configuration="default_xrefsystems" colspan="1"/> <component type="matchmerge" configuration="person_matchmerge" colspan="1"/> <component type="getonehop" configuration="person_getonehop" colspan="1"/> </toolsarea> </layout> Example of a Layout for Business Entity Creation When a user creates an instance of a Person business entity, you want the Search Before Create component and custom help text to appear in the sidebar. The following code shows how to configure the layout in this example: <layout> <businessentity view="securepersonview" entitystate="new"/> <securityrole roleid="manager" /> <mainarea> <component type='rootco' colspan='3' /> </mainarea> <toolsarea> <component type="searchbeforecreate" configuration="person_searchbeforecreate" /> <component type='externallink' configuration='personhelp'/> </toolsarea> </layout> Displaying Layouts Based on Tasks You can configure the layout that appears when users view a business entity from a task. The layout can appear based on the task kind or the task type. You can configure the layout to provide users with the components needed to process a particular task kind or task type. The task kind is defined in the task trigger configuration for the workflow. The task kind can be MERGE, UNMERGE, or REVIEW. The task type is returned to Informatica Data Director by the ActiveVOS workflow process. The task type name corresponds to the service property in the ActiveVOS PDD file. Example of a Layout Based on Task Kind When a data steward opens a Person business entity from a Merge task, you want the entity to appear in the match comparison view. 78 Chapter 7: Entity 360 Framework Configuration

79 The following code shows how to configure the layout in the example: <componentcontainer> <layout id="mergelayout"> <securityrole roleid="datasteward"/> <label existsformat="person: {1}"> <column columnuid="displayname" /> </label> <capability type="displaytaskkind" name="merge"/> <mainarea> <component type='bematchcomparisonview' colspan='3' /> </mainarea> </layout> </componentcontainer> Example of a Layout Based on Task Type You want to configure a layout to appear when a contact manager opens a Person business entity view from a review without approval task. The layout contains the root node, a map component, a source systems component, and a related records component. The following code shows how to configure the layout in the example. <componentcontainer> <layout id="1234"> <securityrole roleid="contactmanager"/> <label existsformat="person: {1}"> <column columnuid="displayname" /> </label> <businessentity view="personview"/> <capability type="displaytasktype" name="avosreviewnoapprove"/> <mainarea> <component type="rootco" colspan="3"/> <component type="externallink" configuration="map_test_externallink" colspan="3"/> <component type="xrefsystems" configuration="default_xrefsystems" colspan="1"/> <component type="getonehop" configuration="person_getonehop" colspan="1"/> </mainarea> </layout> </componentcontainer> Data Validation in the Entity View When a user adds or changes data in the Entity view, Informatica Data Director checks the data against metadata and, optionally, validation rules. The metadata defines the expected format for the data, such as the data type or the number of characters permitted. The validation rules are cleanse rules or Informatica Data Quality rules. Validation processes run at the field level, section level, and entity level: Field level. When you add or edit data in a field in the Entity view, a client-side validation process verifies that the data satisfies the metadata. For example, when you enter a date in a Date field and then navigate away from the field, the process verifies that you entered the date in the expected date format. Section level. When you apply all changes in a section in the Entity view, a client-side validation process verifies that all data satisfies the metadata and that the required fields contain data. Entity level. When you save a business entity in the Entity view, a server-side validation process verifies that data satisfies the metadata, the cleanse validation rules, and the Informatica Data Quality rules. If user input does not satisfy the metadata or the validation rules, you see messages about the problems with the data. Data Validation in the Entity View 79

80 Metadata Validation For metadata validation, by default the validation process uses the metadata that is defined for all data in the Operational Reference Store (ORS). You can override the default metadata for client-side validation in the Entity view. The following image shows a Party base object and the metadata that is defined for the First Name field as it appears in the Hub Console. Note: Informatica does not recommend changing ORS metadata in a production environment. By default, the client-side validation process compares user input against the Data Type column to ensure that pattern of the data is valid. For example, if the data type is INT, the data must be an integer. If a user enters an incorrect value, the client-side validation process catches the error when the user navigates away from the field and displays a message. The client-side validation process checks for metadata overrides in the following order: 1. Business entity view configuration file 2. Business entity configuration file 3. ORS Required Fields The client-side validation process verifies that required fields contain valid input. You can identify a field as a required field when you add fields to a node. Related Topics: Field Properties on page 31 Adding a Field to a Node on page Chapter 7: Entity 360 Framework Configuration

81 Cleanse Validation Rules The server-side validation process can apply cleanse validation rules. For more information about cleanse engines, see the Informatica MDM Multidomain Edition Cleanse Adapter Guide. To apply cleanse rules during the server-side validation process, you must associate cleanse rules with <group> elements in the Transformation Configuration XML file. You can validate data, transform data, or copy data. Validate Data You can validate data based on the cleanse rules in a cleanse library. For each <group> element that you want to validate, add the <transformation type="cleanse" name=cleanse library name> element. Specify the name of the cleanse library. If a validation test fails, the IDD user sees an error message about the data. For example, use the following transformation to validate the Ship Addresses field. <group source="personview.shipaddresses" target="person.shipaddresses"> <transformation type="cleanse" name="bdd Cleanse and ValidationLibrary CVPerson"/> </group> Transform Data You can transform data by using cleanse functions. For each <group> element that contains a field that you want to transform, add the <transformation type="cleanse" function=cleanse function name> element. You define the source group and target group in the <group> element. The following table describes the attributes and the child elements that you can use with the <transformation type="cleanse"> element to transform data: Attribute or Child Element Value Description function statusoutput cleanse function name parameter name The name of the function in the cleanse library that contains the transformation that you want to run. Optional. The name of the output parameter that contains the result of running the cleanse function on the input data. For example, you can name this parameter validationstatus. statussuccess regex pattern Optional. A regex pattern that represents valid input. For example, you might specify OK. When the value returned in the statusoutput parameter matches this pattern, the user input is valid. Data Validation in the Entity View 81

82 Attribute or Child Element Value Description input source field Defines the fields to retrieve from the source group. Add one or more input elements in the following format: <input field=source field name=variable name /> The name attribute is a user-defined variable to pass to the cleanse function. output target field Defines the field to store the results of the transformation. Add one or more output elements in the following format: <output field=target field name=variable name /> The name attribute is a user-defined variable that holds the result of the transformation from the cleanse function. For example, use the following transformation to concatenate the First Name and Last Name fields from Person and assign the result to the Display Name field in the Contact group. <group source="person" target="contact"> <transformation type="cleanse" function="concatenate"> <input field="firstname" name="s1"/> <input field="lastname" name="s2"/> <output field="displayname" name="s"/> </transformation> </group> Copy Data You can copy a value from one group field to another group field. For each <group> element that you want to copy from, add the <transformation type="direct"> element. You define the source group and target group in the <group> element. The following table describes the child elements that you can use with the <transformation type="direct"> element to copy data: Child Elements Value Description input source field Defines the source field that contains the value that you want to copy. Add the input element in the following format: <input field=source field name=variable name/> The name attribute is a user-defined variable name. output target field Defines the target field where you want to paste the value that was copied from the source field. Add the output element in the following format: <output field=target field name=variable name/> The name attribute must be the same as the input element. For example, use the following transformation to copy a phone number from Person to Contact. <group source="person" target="contact"> <transformation type="direct"> <input field="phonenumber" name="p"/> <output field="phonenumber" name="p"/> </transformation> </group> 82 Chapter 7: Entity 360 Framework Configuration

83 Applying Cleanse Rules During Server-side Validation To apply cleanse rules during server-side validation, for each section of the business entity where you want to use cleanse rules, add a <transformation> element. 1. Log in to the Informatica MDM Provisioning tool. 2. If prompted, select the database that hosts the Operational Reference Store. 3. Click Advanced Configuration > Transformation Configuration (xml). 4. In the XML, search for the name of the group field. For example, search for Address. 5. In the <group> element, add a <transformation> element as a child element. For example, the following transformation validates the Ship Addresses of a business entity. <group source="personview.shipaddresses" target="person.shipaddresses"> <transformation type="cleanse" name="bdd Cleanse and Validation Library CVPerson"/> </group> 6. Click Validate + Publish. Informatica Data Quality Validation Rules If Informatica MDM is integrated with Informatica Data Quality, the server-side validation process can verify and transform user input by applying the rules that are defined in an Informatica Data Quality mapplet. The following table describes the attributes that you use with the <transformation type="platform"> element: Attribute Value Description function URL The endpoint URL of the web service running the mapplet. input list of source fields Defines the fields to retrieve from the source group. Add one or more input elements in the following format: <input field=source field /> output list of target fields Defines the field to store the results of the transformation. Add one or more output elements in the following format: <output field=target field /> Data Validation in the Entity View 83

84 Generating Data Quality Mapplets Informatica MDM can generate Informatica Data Quality mapplet stubs. You can then define rules in the mapplet by using Informatica Developer. In Informatica Data Director, when the server-side validation process runs to validate a new or changed business entity, the process applies the rules in the mapplet. You require a working knowledge of Informatica Data Quality mapplets. 1. In the Hub Console, open the Enterprise Manager and verify that the Model Repository Service (MRS) URL connection parameters are configured. The following image shows the Enterprise Manager with the MRS connection defined. If the connection is not defined, acquire a write lock and configure the connection to the MRS. 2. Log in to the Informatica MDM Provisioning tool. 3. If prompted, select the database that hosts the Operational Reference Store. 4. Click Advanced Configuration > Transformation Configuration (xml). 5. In the XML, search for the name of a section where you want to generate a mapplet. For example, search for Address. 6. In the <group> element, change <transformation type="direct"> to <transformation type="platform">. 84 Chapter 7: Entity 360 Framework Configuration

85 For example, the following code sample shows the ShipAddresses group. <group source="personview.shipaddresses" target="person.shipaddresses"> <transformation type="platform"> <input.../> <output.../> </transformation> </group> 7. Repeat the preceding step for each group where you want to use a mapplet. 8. Click Validate + Publish. Informatica MDM detects changes, connects to the MRS, and creates a mapplet stub for each <transformation type="platform"> element. 9. Log in to Informatica Developer, connect to the MRS, and edit the mapplets to add rules. 10. Deploy the mapplets as web services. Make a note of the endpoint URL for each mapplet. Applying Data Quality Rules During Server-side Validation To apply Data Quality rules during server-side validation, specify the Data Quality mapplets that contain the rules in the Transformation Configuration XML file. 1. Log in to the Informatica MDM Provisioning tool. 2. If prompted, select the database that hosts the Operational Reference Store. 3. Click Advanced Configuration > Transformation Configuration (xml). 4. In the XML, search for the name of the target section. For example, search for Address. 5. In the <group> element, add the function attribute to the <transformation type="plaform"> element and specify the URL for the mapplet. For example, the following code sample shows where to specify the mapplet in the ShipAddresses section of a business entity. <group source="personview.shipaddresses" target="person.shipaddresses"> <transformation type="platform" function=" <input.../> <output.../> </transformation> </group> 6. Repeat the preceding step for each generated mapplet. 7. Click Validate + Publish. Entity 360 Logging All messages, errors, and full stack traces for the Entity 360 framework are stored in cmxserver.log in the application server. Configuration information for the Entity 360 framework is stored in the log4j.xml file. The log4j.xml file also contains configuration information for the Hub Server. The log4j.xml file is in the following directory: On UNIX. <infamdm installation directory>/hub/server/conf On Windows. <infamdm installation directory>\hub\server\conf Entity 360 Logging 85

86 C H A P T E R 8 Smart Search This chapter includes the following topics: Smart Search Overview, 86 Smart Search Configuration Architecture, 87 Configuring Smart Search, 88 Updating the Searchable Field Properties, 100 Optimizing the Performance of Smart Search Requests, 102 Smart Search Overview Perform a smart search to find data within a specific searchable business entity type or within all the searchable business entity types based on a string value. The Informatica Data Director application displays the matching searchable fields. The results are ranked based on how closely the results match the string value. You can apply filters to identify more relevant results. The MDM Hub uses the SolrCloud feature of Apache Solr to perform smart searches. Apache Solr is an open-source enterprise search application. SolrCloud uses a cluster of Solr servers to provide distributed indexing and search. Apache ZooKeeper is a centralized service that synchronizes searches across multiple Solr servers. Before you perform a smart search, you must configure the process server and index the data. When you index the data, the Solr server reads the business entities and adds them to collections. Each collection represents a searchable business entity type. A collection consists of multiple documents, and a document contains searchable fields and their values. If the data is large for one node, you can use multiple nodes and store the data in one or more shards. Shards are the logical pieces of a collection split over multiple nodes. Example Use Case You are a data steward in an enterprise. You want to generate a list of practitioners who have worked with an organization that conducts approved trials of drugs for the treatment of emphysema. You might want to identify the practitioners who are currently active. You can perform a smart search with "emphysema" as the string value. The Informatica Data Director application returns references to all the matching searchable fields within the business entities and base objects as search results. To narrow down your search results to active practitioners, you can filter the results based on the status of the practitioners. 86

87 Smart Search Configuration Architecture You can configure the process server for smart search based on your MDM Hub environment. A process server is a servlet that cleanses data, processes batch jobs, and manages the smart search functionality. If you install all the MDM Hub components on a single host machine, configure the process server to function as a ZooKeeper server and enable smart search on the process server. If you install the MDM Hub components on multiple host machines, configure a process server to function as a ZooKeeper server and enable smart search on the process server of each node. Single-Host Deployment In a single-host deployment, you install all the MDM Hub components on a single host machine. For smart search, you must configure the process server to function as a ZooKeeper server and enable smart search on the process server. When you enable smart search on the process server, the process server functions as a Solr server. The following image shows an example deployment that has a single host machine configured for smart search: The host machine contains an application server and a database server. On the application server, you have the Hub Server, a cleanse server, and a process server. The process server functions as the ZooKeeper and Solr servers. The database server contains a master database and an ORS database. Multiple-Host Deployment In a multiple-host deployment, you distribute the installation of the MDM Hub components on multiple host machines. For smart search, you can configure a process server to function as a ZooKeeper server and enable smart search on the process server of each node. When you enable smart search on the process servers, the process servers function as the Solr servers. You can use multiple Solr servers to provide distributed indexing and search. The number of Solr servers that you can use depends on your MDM Hub environment. You can configure any existing process server as a ZooKeeper server. For optimal performance, use a dedicated process server as a ZooKeeper server. Smart Search Configuration Architecture 87

88 The following image shows an example deployment that has multiple host machines configured for smart search: The preceding multiple-host deployment contains a ZooKeeper server on host machine C and two Solr servers on host machines D and E. The host machine A contains the Hub Server on an application server. The host machine B contains the process and cleanse servers on an application server. The host machine F contains a master database and an ORS database. Configuring Smart Search Before you perform a smart search, perform the following tasks to configure smart search: 1. Configure a process server as a ZooKeeper server. 2. If you have a multiple-host deployment, enable smart search on the process server of each node. 3. Configure the Hub Server to enable smart search and Entity 360 framework. 4. Configure the searchable fields. 5. Optionally, configure the filter type for the fields. 6. Optionally, configure the layouts to display similar records when you create a business entity. 7. Restart the application server. 8. Index the smart search data. 88 Chapter 8: Smart Search

89 Step 1. Configure a Process Server as a ZooKeeper Server You can configure any existing Process Server as a ZooKeeper server. For optimal performance, use a dedicated Process Server as a ZooKeeper server for smart search. You must configure ZooKeeper only on a single Process Server even if you have multiple Operational Reference Stores (ORSs) or a multiple hosts deployment. Use the Process Server tool in the Hub Console and the <MDM Hub Installation Directory>\hub\cleanse \resources\cmxcleanse.properties file to configure the Process Server properties for smart search. 1. In the Hub Console, start the Process Server tool. 2. To acquire a write lock, on the Write Lock menu, click Acquire Lock. 3. In the right pane of the Process Server tool, click the Add Process Server button. The Add/Edit Process Server dialog box appears. 4. Set the following properties of a Process Server for smart search: Property Server Port Enable Search Processing Enable Secured Connection (HTTPS) Enable ZooKeeper ZooKeeper ID ZooKeeper Client Port ZooKeeper Leader Port Description Fully qualified host name of the application server on which you want to deploy the Process Server. The name is case sensitive. Note: Do not use localhost as the host name. Port of the application server on which you want to deploy the Process Server. Note: If you want to use the HTTPS protocol to communicate with the Process Server, specify the HTTPS port of the application server. Indicates whether to enable smart search on the Process Server. When you enable smart search, the Process Server functions as a Solr server. Select the check box to enable smart search, or clear the check box to disable smart search. Indicates whether to use the HTTPS protocol to communicate with the Process Server. Select the check box to use the HTTPS protocol, or clear the check box to use the HTTP protocol. Note: If you select to use the HTTPS protocol, you must specify the HTTPS port of the application server. Indicates whether to use the Process Server as a ZooKeeper server. Select the check box to use the Process Server as a ZooKeeper server, or clear the check box if you do not want to use the Process Server as a ZooKeeper server. Unique ID for the ZooKeeper server. Use any number from 1 to 255 as the ID. Port number on which ZooKeeper server listens for client connections. Reserved for future use. Use 0 as the ZooKeeper leader port. Configuring Smart Search 89

90 Property ZooKeeper Follower Port ZooKeeper Data Directory Description Reserved for future use. Use 0 as the ZooKeeper follower port. Absolute path for the ZooKeeper to store the in-memory snapshots of the data and the transactional log of updates to the database. For optimal performance, use a directory in a drive that other processes do not share. 5. Click OK. 6. Click the Save button. 7. Use a text editor to open the following file: <MDM Hub Installation Directory>\hub\cleanse \resources\cmxcleanse.properties 8. Configure the following properties for smart search: cmx.ss.enabled Indicates whether to enable smart search. In a new installation, the default is true. When upgrading, if this property is set, the value remains set to the pre-upgrade value. If this property is not set, the default is false. JBoss only. When you enable smart search in an environment that uses JBoss 6.4.0, you must set cmx.server.match.file_load to false. This setting forces the process server to use the JDBC uploader instead of native database utilities for matches. solr.allowadminconsole Manually add the property. Indicates whether you can access the Apache Solr Admin UI. Use the Solr Admin UI to view the configuration details, run queries, and analyze search data. Set to true to enable access to the Solr Admin UI. Set to false or remove the property to disable access to the Solr Admin UI. zookeeper.ticktime Optional. Length of a single tick, in milliseconds. ZooKeeper uses tick as the basic time unit to regulate timeouts. Default is Increase the time based on your requirement and the performance of the machine on which ZooKeeper is enabled. search.provisioning.maxshards Optional. Maximum number of shards to create for each collection on a single node when you index the search data. For optimal performance, create one shard for each collection on each node. Default is 1. search.provisioning.numshards Optional. Total number of shards to create on your environment. The value depends on the maximum number of shards and the total number of nodes. For example, if the maximum number of shards is 1 and the number of nodes is 3, you can create 3 shards. Default is the total number of process servers on which you enable smart search. facet.infacount Optional. Total number of search results for each shard that the smart search functionality uses to facet the results. The smart search functionality uses the results based on the rank of the results in the descending order. For example, if you have 3 shards and specify 2000 as the count, the smart search functionality facets 6000 search results. If you specify 0 or do not specify any value, the smart search functionality facets all the results. Default is Chapter 8: Smart Search

91 MAX_INITIAL_RESULT_SIZE_TO_CONSIDER Optional. Manually add the property. Total number of search results to display in the Informatica Data Director application. The recommended maximum value is 250. Default is 130. Any value higher than 130 affects the performance of the Informatica Data Director application. ssl.keystore Required if you use the HTTPS port of the application server to configure the process server. Manually add the property. Absolute path and file name of the keystore file. ssl.keystore.password Required if you use the HTTPS port of the application server to configure the process server. Manually add the property. Plain text password for the keystore file. ssl.truststore Required if you use the HTTPS port of the application server to configure the process server. Manually add the property. Absolute path and file name of the truststore file. ssl.truststore.password Required if you use the HTTPS port of the application server to configure the process server. Manually add the property. Plain text password for the truststore file. cmx.websphere.security.ssl.config.url Required if you use the HTTPS port of the application server to configure the process server. For WebSphere only. Manually add the property. Absolute path of the ssl.client.props file with the file name. 9. Save the cmxcleanse.properties file. 10. Restart the application server after you configure the properties. Step 2. Configure the Process Servers on Nodes On a multiple hosts deployment, after you configure a process server as a ZooKeeper server, you can configure a process server on each node to enable smart search. When you enable smart search on a process server, the process server functions as a Solr server. 1. In the Hub Console of a node, start the Process Server tool. 2. To acquire a write lock, on the Write Lock menu, click Acquire Lock. 3. In the right pane of the Process Server tool, click the Add Process Server button. The Add/Edit Process Server dialog box appears. 4. Set the following properties of a process server for smart search: Property Server Port Description Host name of the application server on which you want to deploy the process server. The name is case sensitive. Note: Do not use localhost as the host name. Port of the application server on which you want to deploy the Process Server. Note: If you want to use the HTTPS protocol to communicate with the Process Server, specify the HTTPS port of the application server. Configuring Smart Search 91

92 Property Enable Search Processing Enable Secured Connection (HTTPS) Description Indicates whether to use the process server to perform smart search. When you enable smart search, the process server functions as a Solr server. Select the check box to enable smart search, or clear the check box to disable smart search. Indicates whether to use the HTTPS protocol to communicate with the Process Server. Select the check box to use the HTTPS protocol, or clear the check box to use the HTTP protocol. Note: If you select to use the HTTPS protocol, you must specify the HTTPS port of the application server. Note: Do not enable ZooKeeper on the process server of the node. 5. Click OK. 6. Click the Save button. 7. Restart the application server after you configure the process server. 8. Similarly, configure the process servers on other nodes to enable smart search. Step 3. Configure the Hub Server for Smart Search You must configure the Hub Server to enable smart search and Entity 360 framework in Informatica Data Director. 1. Use a text editor to open the following file: <MDM Hub Installation Directory>\hub\server \resources\cmxserver.properties. 2. Configure the following properties for smart search: cmx.ss.enabled Indicates whether to enable smart search. In a new installation, the default is true. When upgrading, if this property is set, the value remains set to the pre-upgrade value. If this property is not set, the default is false. cmx.e360.view.enabled When developers implement the Entity 360 framework, IDD users use the Search box to find entities and an entity workspace to edit and manage master data. In a new installation, the default is true. When upgrading, if this property is set, the value remains set to the pre-upgrade value. If this property is not set, the default is false. cmx.server.batch.smartsearch.initial.block_size Maximum number of records that the Initially Index Smart Search Data batch job can process in each block. Default is 250. When you index a large data set, increase the number of records. The recommended maximum value is After you update the server properties, you must validate the schema, redeploy the Informatica Data Director application, and restart the Hub Console. Step 4: Configuring the Searchable Fields A smart search request searches only the fields that you configure as searchable fields. Before you perform a smart search, ensure that you configure the required fields as searchable fields. The scope of a search 92 Chapter 8: Smart Search

93 request increases with the increased number of searchable fields. Multiple searchable fields might affect the performance of a search request, so avoid configuring insignificant searchable fields. Use one of the following methods to configure a searchable field: Use the Provisioning tool. Apply a change list to the repository. You can configure the following properties for the searchable fields: searchable Indicates whether a smart search request can search the field for a search string. Set to true if you want to include the field in smart search requests. Set to false if you do not want to include the field in smart search requests. Default is false. displayable filterable facet fuzzy Indicates whether a smart search request can display the field values in the search results if the values match the search string. The displayable property functions in conjunction with the searchable property, so set the searchable and displayable properties to true if you want to display the matching field values in the search results. Set the displayable property to false if you do not want to display the field values in the search results. Default is false. Indicates whether you want to enable filtering on a field. The Informatica Data Directory application displays the filterable fields as filters in the Search workspace. The filterable property functions in conjunction with the searchable property, so set the searchable and filterable properties to true if you want to configure the field as a filter. Set the filterable property to false if you do not want to configure the field as a filter. Default is false. Indicates whether you want to set the field as a facet. A facet field groups the search result values and shows the count of each group. The Informatica Data Directory application displays the facet fields, the field values grouped based on the search results, and the count of each group in the Search workspace. The facet property functions in conjunction with the filterable property, so set the searchable, filterable, and facet properties to true if you want to configure the field as a facet. Set the facet property to false if you do not want to configure the field as a facet. Default is false. Indicates whether you want to perform exact search or fuzzy search on the field values. An exact search returns values that match the search string. A fuzzy search returns values that match the search string and values that are similar to the search string. Set to true if you want to perform fuzzy search on the field values. Set to false if you want to perform exact search on the field values. Default is false. suggester language Indicates whether you want to suggest the values of the field as the search string in the Informatica Data Director application. Set to true if you want to suggest the values of the field as the search string. Set to false if you do not want to suggest the values of the field as the search string. Indicates the language of the field values. You can set the language of a field to Chinese, Japanese, Korean, or English. Use one of the following values for the language property: Chinese Japanese Korean Configuring Smart Search 93

94 English You must specify a language. You can use the search string in any of the configured languages. A search request searches the fields that match the language of the search string. facetrange Indicates the range for the numeric or date fields that you configure as facets. Use the following format to specify the range: <Start Value>,<End Value>,<Frequency> The start value is inclusive, and the end value is exclusive in the range. For example, if you set facetrange=1000,2000,500 for an integer field, a smart search request returns the following ranges: [1000 to 1500] [1500 to 2000] The range 1000 to 1500 includes the values from 1000 to 1499, and the range 1500 to 2000 includes the values from 1500 to For a date field, suffix Y M D to the frequency, where Y indicates year, M indicates month, and D indicates day. For example, 2M indicates 2 months. If you set facetrange= , ,3y, the Informatica Data Director application displays the following range in the Search workspace: [ to ] [ to ] [ to ] [ to ] Note: The facet ranges are not visible in the Informatica Data Directory application. When you use the Search Business Entity REST API to perform the search, the response can return the facet ranges. Configuring a Searchable Field by Using the Provisioning Tool You can use the Provisioning tool to configure a field as a searchable field and set the field properties. 1. Open a supported browser, and enter the following URL: Hub Server host name>:<mdm Server port number>/provisioning/ The Log In page appears. 2. Type the user name and password to access the Provisioning tool. 3. Click Log In. 4. Select the Operational Reference Store (ORS) for which you want to configure the fields. 5. Open the modeling page. 6. On the Business Entities tab, select the business entity for which you want to configure the searchable fields. 7. In the tree view, under the business entity, select field, and click Create. 8. In the node properties panel, select a base object column that you want to associate with the field. 9. Optionally, configure one or more of the following properties based on your requirement: Name Name that appears in the business entity configuration file for the field. Display Name Name that appears in the Provisioning tool tree view for the field. 94 Chapter 8: Smart Search

95 Read Only URI Required Indicates whether you can edit the field in the Entity View. To disable editing the field in the Entity View, select the property. Namespace where custom data types are defined. Default is commonj.sdo. Indicates whether the field is a mandatory field. If the field is a mandatory field, select the property. By default, a field is not a mandatory field. Data Type Data type of the field. By default, the data type is the same as the data type of the base object column to which the field is associated. 10. Select Searchable. The Searchable Configuration tab appears. 11. On the Searchable Configuration tab, select one or more of the following properties based on your requirement: Displayable Filterable Facet Fuzzy Suggester 12. Optionally, specify the language for the field values. You can specify one of the following languages: Chinese Japanese Korean English Default is English. 13. Optionally, specify the range for the numeric or date fields that you configure as facets in the following format: <Start Value>,<End Value>,<Frequency> For example, 1000,2000,50 Note: The facet ranges are not visible in the Informatica Data Directory application. When you use the REST API to perform the search, the response can return the facet ranges. 14. Click Apply. 15. Click Validate+Publish. After a successful validation, the configuration changes are updated in the C_REPOS_CO_CS_CONFIG repository database table. Note: Restart the application server after you configure the searchable fields. Configuring Smart Search 95

96 Configuring a Field as a Searchable Field by Using a Change List You can apply a change list to the repository to configure the searchable fields. A change list contains a list of changes that you want to make to a target repository. Use the addsearchablefield change in a change list XML file to specify the fields that you want to configure as searchable fields. You can configure the following properties for the searchable fields. searchable displayable filterable facet fuzzy language suggester Use the following syntax for the addsearchablefield change: <addsearchablefield id="searchable_field.<field Hierarchy>" parentid="searchable_child.<parent Field Hierarchy>"> <name><field Name></name> <Property Name1>true false</property Name1> <Property Name2>true false</property Name2>... <Property NameN>true false</property NameN> </addsearchablefield> The addsearchablefield change uses the following parameters: Field Name. Indicates the name of the field that you want to configure as a searchable field. Field Hierarchy. Indicates the complete hierarchy of the field including the field name that you want to configure as a searchable field. Use pipes ( ) between the parent-child fields. Parent Field Hierarchy. Indicates the complete hierarchy of the parent field including the parent field name. Use pipes ( ) between the parent-child fields. Property Name1,2,...n. Optional. Indicates the properties that you want to configure. The following sample change list file configures the intfld field as a searchable field: <?xml version="1.0" encoding="utf-8"?> <changelist xmlns:java=" xmlns:xsi=" XMLSchema-instance" xsi:nonamespaceschemalocation="siperian-changelist.xsd" xsi:schemalocation=" java.xsd" creationdate=" t01:29: :30" description="add intfld and floatfld as searchable fields. DS_UI1" listtype="comparison" lockrequired="true" name="" version="10"> <changes> <addsearchablefield id="searchable_field.person intfld" parentid="searchable_root.person"> <name>intfld</name> <searchable>true</searchable> <displayable>true</displayable> <facet>false</facet> <filterable>true</filterable> <fuzzy>true</fuzzy> <language>english</language> </addsearchablefield> </changes> </changelist> For more information about how to apply a change list, see the Informatica MDM Multidomain Edition Repository Manager Guide. 96 Chapter 8: Smart Search

97 Note: After you configure the searchable fields, ensure that you restart the application server. Step 5. Configure the Filter Type for a Field After you perform a search, you can use filters or facets to narrow down the results. You can configure the fields to specify whether you want to use the field as a filter or a facet. Use filters to narrow down the results based on a value that you specify. Use facets to view the results that are grouped according to the matching fields. 1. Use a database tool to open the C_REPOS_COMPONENT_INSTANCE repository database table. 2. Select the BLOB data of the SearchUI instance and open the BLOB data in the XML format. The XML file displays the properties of the fields. For example: <searchuiconfiguration> <co name="secureperson"> <field name="displayname" filtertype="filter" /> <child name="billaddresses"> <field name="addresstype" filtertype="filter" /> <child name="address"> <field name="cityname" filtertype="facet" /> </child> </child> </co> </searchuiconfiguration> 3. Configure the filtertype property for the fields based on your requirement. Use the following filter types: FACET FILTER Indicates that the field is a facet. Indicates that the field is a filter. RANGE_FILTER Indicates that the field is a range-based filter. Use the RANGE_FILTER type for the date and numeric fields. UNDEFINED Indicates that the field is not a facet or a filter. Note: If you set filterable=true and facet=true or facet=false in the C_REPOS_CO_CS_CONFIG table, use the filtertype property to override the values. For example, if you set filterable=true and facet=true, you can set the filtertype property to FILTER, RANGE_FILTER, or UNDEFINED. If you set the filtertype property to UNDEFINED, the Search workspace does not display the field as a filter or a facet. 4. Save the file and upload the XML file to the BLOB data. Restart the application server after you upload the BLOB data of the SearchUI instance. Configuring Smart Search 97

98 Step 6. Configure the Layouts to Display Similar Records (Optional) When you enter data in the Informatica Data Director application to create a business entity, you can view similar records that are retrieved based on the data that you enter. To view the similar records, you must configure the layouts to define the fields based on which you want to search for the similar records. 1. Open a supported browser, and enter the following URL: Hub Server host name>:<mdm Server port number>/provisioning/ The Log In page appears. 2. Type the user name and password to access the Provisioning tool. 3. Click Log In. 4. Select the Operational Reference Store (ORS) for which you want to configure the fields. 5. On the layout editor page, perform one of the following tasks: If the ContainerCoView XML layout type is defined for the business entity to which the fields belong, select the layout. If the ContainerCoView XML layout type is not defined for the business entity to which the fields belong, perform the following tasks: 1. Click Create. 2. Enter the business entity name as the instance name. For example, use Person as the instance name for the Person business entity. 3. Specify ContainerCoView as the layout type. 4. In the XML editor, specify the attributes required for the layout configuration. For more information about the layout attributes, see the Informatica Data Director Implementation Guide. 6. In the XML editor, add the field names based on which you want to search for similar records in the following format: <componentcontainer> <layout> <securityrole roleid="<role Name 1>" /> <securityrole roleid="<role Name 2>" /> <businessentity view="<view Name>" entitystate="new" /> <label> <column columnuid="<field Name 1>" /> <column columnuid="<field Name 2>" />... <column columnuid="<field Name N>" /> </label> <mainarea> <component type="rootco" configuration="<instance Name>" colspan="<column Span>" /> </mainarea> <toolsarea> <component type="searchbeforecreate" configuration="<layout Name>" /> </toolsarea> </layout> </componentcontainer> For example, the following sample contains the firstname and lastname fields in the layout: <layout> <businessentity view="person" entitystate="new" /> <label> <column columnuid="firstname" /> <column columnuid="lastname" /> 98 Chapter 8: Smart Search

99 </label> <securityrole roleid="customer-ny" /> <securityrole roleid="manager" /> <mainarea> <component type="rootco" colspan="3" /> </mainarea> <toolsarea> <component type="searchbeforecreate" configuration="person_searchbeforecreate" /> </toolsarea> </layout> 7. Click Update. 8. On the layout editor page, perform one of the following tasks: If the SearchBeforeCreate XML layout type is defined for the business entity to which the fields belong, select the layout. If the SearchBeforeCreate XML layout type is not defined for the business entity to which the fields belong, perform the following tasks: 1. Click Create. 2. Enter the instance name in the following format: SearchBeforeCreate_<Business Entity Name> For example, use SearchBeforeCreate_Person as the instance name for the Person business entity. 3. Specify SearchBeforeCreate as the layout type. 9. In the XML editor, add the field names based on which you want to search for similar records in the following format: <searchablefields> <field name="<field Name 1>" /> <field name="<field Name 2>" />... <field name="<field Name N>" /> </searchablefields> For example, the following sample contains the firstname and lastname fields in the layout: 10. Click Update. <searchablefields> <field name="firstname" /> <field name="lastname" /> </searchablefields> 11. Click Validate+Publish. After a successful validation, the configuration changes are updated in the C_REPOS_COMPONENT_INSTANCE repository database table. 12. Use the Repository Manager tool in the Hub Console to validate the metadata of the ORS. 13. Restart the application server after you configure the layouts. Step 7. Index the Smart Search Data You must create indexes for the smart search data. A smart search request uses the indexes to search within the searchable fields. Use the Initially Index Smart Search Data batch job to create indexes for the business entities. When you run the Initially Index Smart Search Data batch job, the Solr server reads the business entities and adds them to collections. Each collection represents a searchable business entity type. A collection consists of multiple documents, and a document contains searchable fields and their values. When you perform a smart search, the Solr server reads the collections and returns the matching fields. Configuring Smart Search 99

100 Updating the Searchable Field Properties After you create indexes for the smart search data, you can update the searchable field properties based on your requirement. Use one of the following methods to update the searchable field properties: Use the Provisioning tool to update the searchable field properties. Use the modifysearchablefield change in a change list XML file to update the field properties and apply the change list to the repository. If you update the searchable field properties to the following values, you must run the Initially Index Smart Search Data batch job to update the indexes: searchable=true displayable=true filterable=true facet=true fuzzy=true false suggester=true language=chinese Japanese Korean English If you update the searchable field properties to the following values, some of the indexes might become irrelevant: searchable=false displayable=false filterable=false facet=false suggester=false The irrelevant indexes can affect the performance of the smart search requests. You can run the Initially Index Smart Search Data batch job to clean the irrelevant indexes and to improve the performance of the smart search requests. Updating the Searchable Field Properties by Using the Provisioning Tool You can use the Provisioning tool to update the properties of a searchable field. 1. Open a supported browser, and enter the following URL: Hub Server host name>:<mdm Server port number>/provisioning/ The Log In page appears. 2. Type the user name and password to access the Provisioning tool. 3. Click Log In. 4. Select the Operational Reference Store (ORS) for which you want to configure the fields. 5. Perform one of the following tasks to update the properties of the searchable fields: 100 Chapter 8: Smart Search

101 On the modeling page, perform the following tasks: 1. On the Business Entities tab, select the business entity to which the searchable fields belong. 2. In the tree view, under the business entity, expand field, and select the field for which you want to update the properties. 3. In the node properties panel, on the Searchable Configuration tab, update the properties based on your requirement. 4. Click Apply. On the advanced configuration page, perform the following tasks: 1. Select Search Configuration (xml). The XML file displays the properties of the searchable fields. For example, the following sample displays the properties of the searchable fields of the business entity named SecurePerson: <?xml version="1.0" encoding="utf-8"?> <searchablecoconfiguration xmlns=" <searchableco lastupdate=" t16:41: :30" displayname="displayname" name="secureperson"> <field sortable="true" filterable="false" facet="false" displayable="false" searchable="false" fuzzy="false" language="english" name="partytype" /> <field sortable="true" filterable="true" facet="true" displayable="true" searchable="true" fuzzy="true" language="english" name="birthdate" /> <field sortable="true" filterable="false" facet="false" displayable="false" searchable="false" fuzzy="false" language="english" name="taxid" /> <field sortable="true" filterable="false" facet="false" displayable="false" searchable="false" fuzzy="false" language="english" name="intfld" /> <field sortable="true" filterable="false" facet="false" displayable="false" searchable="false" fuzzy="false" language="english" name="floatfld" /> <field sortable="true" filterable="false" displayable="false" searchable="false" fuzzy="false" language="english" name="displayname" /> <child name="billaddresses"> <field sortable="true" filterable="true" displayable="true" searchable="true" fuzzy="false" language="english" name="addresstype" /> <child name="address"> <field sortable="true" filterable="false" displayable="false" searchable="false" fuzzy="false" language="english" name="addressline1" /> <field sortable="true" filterable="true" displayable="true" searchable="true" fuzzy="false" language="english" name="postalcd" /> <field sortable="true" filterable="false" displayable="false" searchable="false" fuzzy="false" language="english" name="cityname" /> <child name="statecd"> <field sortable="true" filterable="true" displayable="true" searchable="true" fuzzy="false" language="english" name="statecode" /> </child> </child> </child> </searchableco> </searchablecoconfiguration> 2. Update the properties of the required fields based on your requirement. 3. Click Save. 6. Click Validate+Publish. After a successful validation, the configuration changes are updated in the C_REPOS_CO_CS_CONFIG repository database table. Note: Restart the application server after you update the properties of the searchable fields. Updating the Searchable Field Properties 101

102 Updating the Searchable Field Properties by Using a Change List You can apply a change list to the repository to configure the properties of a searchable field. A change list contains a list of changes that you want to make to a target repository. Use the modifysearchablefield change in a change list XML file to configure the searchable field properties. The modifysearchablefield change uses the following syntax: <modifysearchablefield id="searchable_field.<field Hierarchy>" parentid="searchable_child.<parent Field Hierarchy>"> <Property Name1>true false</property Name1> <Property Name2>true false</property Name2>... <Property NameN>true false</property NameN> </modifysearchablefield> The modifysearchablefield change uses the following parameters: Field Hierarchy. Indicates the complete hierarchy of the field including the field name for which you want to configure the properties. Use pipes ( ) between the parent-child fields. Parent Field Hierarchy. Indicates the hierarchy of the parent field including the parent field name. Use pipes ( ) between the parent-child fields. Property Name1,2,...n. Indicates the properties that you want to configure. The following sample change list file configures the fuzzy property for the birthdate and taxid fields: <?xml version="1.0" encoding="utf-8"?> <changelist xmlns:java=" xmlns:xsi=" XMLSchema-instance" xsi:nonamespaceschemalocation="siperian-changelist.xsd" xsi:schemalocation=" java.xsd" creationdate=" t11:46: :00" description="compare "orcl- DS_UI1" (source) to "orcl-ds_ui1" (target)" listtype="comparison" lockrequired="true" name="source database "orcl-ds_ui1" vs target database "orcl-ds_ui1"" version="9.7.1"> <changes> <modifysearchablefield id="searchable_field.person birthdate" parentid="searchable_child.person"> <fuzzy>true</fuzzy> </modifysearchablefield> <modifysearchablefield id="searchable_field.person taxid" parentid="searchable_child.person"> <fuzzy>true</fuzzy> </modifysearchablefield> </changes> </changelist> For more information about how to apply a change list, see the Informatica MDM Multidomain Edition Repository Manager Guide. Note: After you configure the properties of the searchable fields, ensure that you restart the application server. Optimizing the Performance of Smart Search Requests The performance of a smart search request depends on the RAM of the machine on which you install the MDM Hub components. You must have sufficient operating system disk cache so that you can cache the entire index or the important parts of the index. Do not set a higher Java heap size that might reduce the 102 Chapter 8: Smart Search

103 operating system disk cache. You can also use solid-state disks instead of traditional spinning hard disks for better performance of the smart search requests. The scope of a smart search request increases with the increased number of searchable composite fields. Multiple searchable fields increase the indexing and searching time, so configure only the required fields as searchable fields. The number of filterable and facet fields can also affect the performance of a smart search request, so avoid configuring insignificant fields as filterable or facet fields. Some of the smart search indexes might become irrelevant when you update the searchable field properties. The irrelevant indexes can affect the performance of the smart search requests. After you update the searchable field properties, run the Initially Index Smart Search Data batch job to clean the indexes and to achieve improved search performance. Optimizing the Performance of Smart Search Requests 103

104 C H A P T E R 9 Task Configuration This chapter includes the following topics: Task Configuration Overview, 104 Task Type Configuration, 105 Task Template Configuration, 106 Descriptive Task Titles, 108 Workflow Trigger Configuration Parameters, 108 Configuring Tasks, 110 Task Configuration Overview You can define who can accept tasks, define who can launch workflows, and define the default task properties. You can configure ActiveVOS workflow behavior in the task configuration XML file in the Provisioning tool advanced configuration. Define who can accept tasks The task type configuration defines who can claim or be assigned ActiveVOS tasks. You can specify users of a certain role or you can specify users by name. If a business user chooses to assign a task to a user, only the appropriate users are available to choose from. Define who can launch workflows You configure task triggers so the appropriate ActiveVOS task workflow is launched after certain events. You can configure task triggers for a create event, an update event, or a merge event. A trigger can apply to more than one event. For example, you can configure a trigger so new business entities and updated business entities go through the two step approval review process. You can configure a trigger so new business entities go through the one step approval process, or you can configure a trigger so updated business entity to go through the update with approval process. You can configure specific task triggers for particular roles. For example, you can configure a business entity to go through the two step approval process when the entity is updated by a data steward or through the one step approval process when the entity is approved by a senior manager. You can configure specific task triggers for particular business entities. For example, you can specify that a new Person business entity goes through a one step approval process and that a new Organization business entity goes through a two step approval process. 104

105 Define the default task properties You can configure task templates so that a task is created with specific properties. For example, you can specify that when a trigger launches a workflow, the tasks have a particular title, priority, due date, and task status. Task Type Configuration The task type configuration establishes which roles and users can claim or be assigned tasks. The task template configuration consists of the following parameters: tasktype name Name of the task type. Corresponds to the mdmavxsd:name presentation parameter in the ActiveVOS workflow. role name The name of the role to which tasks of this type can be assigned. user name The name of the user to which tasks of this type can be assigned. businessentity name The business entity for which tasks can be created for a particular user or role. Task Type Configuration Example for Final Review Task The ActiveVOS workflows include activities that require people to make decisions to move the records to the next stage in the workflow. The Final Review activity occurs in the following default workflows: One step approval Two step approval Update with approval You can configure which roles and which users can be assigned these tasks, and for which business entities. For example, you want to allow any user with the role of Manager to be assigned a final review task. You also want to allow the user "John Smith" to be assigned the final review task for the Person business entity and Organization business entity. The following code shows how to configure the task type for the example: <tasktype name="avosbefinalreview"> <role name="manager"/> <user name="john Smith"> <businessentity name="person"/> <businessentity name="organization"/> </user> </tasktype> Task Type Configuration 105

106 Task Template Configuration The task template establishes the default title, priority, due date, comment, and status of a task. You can configure multiple task templates so that different triggers create tasks with different templates. The task template configuration consists of the following parameters: Title Priority The task display label. For example, the title can be Merge {taskrecord[1].label} into {taskrecord[0].label}. taskrecord[n] is the (N+1) th business entity node in the TaskData.getTaskRecords() list. taskrecord[1] is the source record and taskrecord[0] is the target record. label is the value of taskformat in the business entity labelformat configuration. The task priority. The following table describes the possible task priorities: Priority HIGH NORMAL LOW Description The task has a high priority. The task has a medium priority. Default is NORMAL. The task has a low priority. Due Date The amount of time from the day that the task is created that the task is due. The following table describes the components of the due date syntax: Type of Parameter Description Values sign number unit Determines if the due date is set to a date after the task is created or before the task is created. The amount of units to add or subtract from the current date when establishing the due date. The number of days, weeks, or months that the due date is from the date the task is triggered. If +, the due date is determined by adding time to the date the task is triggered. If -, the due date is determined by subtracting time from the date the task is triggered. Any integer value. If d, the specified number of days determines the due date. If w, the specified number of weeks determines the due date. If m, the specified number of months determines the due date. 106 Chapter 9: Task Configuration

107 Comment Populates the task comment field. Optional. Status The status of the task. Optional. The following table describes the possible task statuses: Status OPEN CLOSED Description The task status is Open. Default is Open. The task status is Closed. Task Template Example for Default Approval You want a particular trigger to create tasks with a normal priority that are due five days after the task is triggered with a status of Open. The title of the tasks is "Review changes in <record label>". The following code shows the task template configuration for the example: <tasktemplate name="defaultapproval"> <title>review changes in {taskrecord[0].label}</title> <priority>normal</priority> <duedate>+5d</duedate> <status>open</status> </tasktemplate> Task Template Example for Merge You want the merge trigger to create tasks with a normal priority that are due one week after the task is triggered with a status of Open. The title of the tasks is "<business entity name>: <source record display name><source record row ID> merges to <target record display name><target record row ID>". The following code shows the task template configuration for the example: Where: <tasktemplate name="mergetaskgenerator"> <title>{taskrecord[0].label}: {taskrecord[1].displayname} {taskrecord[1].rowidobject} merges to {taskrecord[0].displayname} {taskrecord[0].rowidobject}</title> <priority>normal</priority> <duedate>+1w</duedate> <comment>merge task autogenerated by Hub.</comment> <status>open</status> </tasktemplate> taskrecord[1] is the source record taskrecord[0] is the target record Task Template Configuration 107

108 Descriptive Task Titles You can configure descriptive task titles for each business entity on the Modeling page. For example, you can configure a task title that displays the business entity type, the display name of the business entity record, and the task type. Data stewards and business managers can more easily differentiate between tasks when the tasks have a descriptive task title. The following image shows generic task titles for the Organization business entity and descriptive task titles for the Person business entity: Configuring Descriptive Task Titles To configure descriptive task titles, edit the Task Format business entity attribute. 1. In the Provisioning Tool, click Modeling. 2. In the Business Entities panel, click the root node of the business entity. For example, click Person. 3. In the tree view, expand labelformat and then click LabelFormatType. 4. In the node properties panel, enter the descriptive task title in the Task Format field. For example, enter {label}: {lastname}, {firstname}. 5. Click Apply. The changes are saved but are not published to the MDM Hub. Workflow Trigger Configuration Parameters Configure triggers so that task workflows are launched after create, update, or merge events occur. If you do not configure workflow triggers for an event, the changes are made directly to the data without first going through a review process. The workflow trigger configuration consists of the following parameters: 108 Chapter 9: Task Configuration