Workbench User's Guide

Transcription

1 IBM Initiate Workbench User's Guide Version9Release7 SC

2

3 IBM Initiate Workbench User's Guide Version9Release7 SC

4 Note Before using this information and the product that it supports, read the information in Notices and trademarks on page 361. Copyright IBM Corporation 1995, US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

5 Contents Tables vii Chapter 1. IBM Initiate Workbench basics Using the Update Manager Implementation overview IBM Initiate Workbench concepts and features... 2 Projects Hub Configuration Algorithm Configuration Synchronization and validation Deployment Jobs Custom callout handlers The IBM Initiate Workbench Screen Layout Perspectives Views Editors Using the Workbench menu options Search menu Initiate menu First step in using IBM Initiate Workbench Chapter 2. Managing projects and Hub connections Hub connections Adding a connection Editing a connection Removing a connection Managing projects Creating a new project Importing an existing project Renaming a project Deleting a project Managing Hub configurations Importing a Hub configuration Opening a Hub configuration Saving a Hub configuration Deploying a Hub configuration Upgrading Initiate projects Chapter 3. Jobs and job sets Storage files Data derivation Bulk cross match Creating a Job Set Job set execution Job files and custom Work directories Job Categories Algorithm & Analysis jobs Bulk Tools jobs Database Tools jobs Full text index jobs Hub Administration jobs Job Set Templates Chapter 4. Configuration editor Member types Member types properties Adding a member type Editing a member type Deleting a member type Attributes Entity types Composite Views Sources Algorithms Attribute types Attribute type properties Displaying attribute types Adding an attribute type Editing an attribute type Deleting an attribute type History Member type history Member attribute type history Relationship type history Relationship attribute type history Informational sources Informational source properties Adding an informational source Editing an informational source Deleting an informational source Tasks Task type properties Task status properties Adding a task type Editing a task type Deleting a task type Adding a task status Editing a task status Deleting a task status Linkages Linkage type properties Linkage status properties Editing a linkage type Adding a linkage status Editing a linkage status Deleting a linkage status Events Event properties Adding an event Editing an event Deleting an event Relationship types Relationship type properties Relationship type attributes properties Relationship type rules properties Adding relationship types Copyright IBM Corp. 1995, 2012 iii

6 Editing relationship types Deleting relationship types Adding relationship type attributes Editing relationship type attributes Deleting relationship type attributes Adding relationship type rules Editing relationship type rules Deleting relationship type rules Applications Application properties Adding an application Editing an application Deleting an application Application properties properties Adding application properties Editing application properties Deleting application properties Initiate Web Reports properties Adding Initiate Web Reports Handlers EDT (Enumerated Data Type) Enumerated data type properties Adding an EDT code Editing an EDT code Deleting an EDT code Sorting EDT elements Adding an EDT element Editing an EDT element Deleting an EDT element Strings String properties Anonymous addresses String Examples String codes String file fields to be defined Standardizing anonymous address strings Anonymous Value Utility Groups Running the Synchronize Group Definitions wizard Group permissions Auditing view Setting user audit logging Chapter 5. Algorithm editor Sticky selection Swimlane width Classic vs. composite algorithm function names 153 Algorithm and Member Type associations Loading an algorithm Saving an algorithm Renaming an algorithm Editing an algorithm The algorithm editor palette Setting top-level algorithm properties Top-level algorithm properties Adding or deleting an attribute Adding or deleting a standardization function 158 Setting standardization function properties Adding or deleting a comparison role Adding or deleting a query role Adding or deleting bucketing functions Adding or deleting comparison functions Adding or deleting bucketing groups Connecting a component Adding tooltips and labels Weight generation parameters Weight generation properties Setting CR and AL thresholds Setting thresholds manually Using the Threshold Calculator Chapter 6. Weight generation Enabling frequency-based bucketing Generating weights Generate Weights process step descriptions Validating Weights Validating weights using a job Validating weights locally Weight validation rules Chapter 7. Analytics The Analytics View Accessing the analytics view Connecting to a Hub Adding a query to a view Exporting query results to CSV format Loading previous analysis results Obtaining data Preparing analysis data for large datasets Entity Analysis Entities By Size Entity Composition Entity Size Distribution Member Comparisons Member Entity Frequency Member Entity Values Members by Entity Count Score Distribution Data Analysis Attribute Completeness Comparison Data Completeness Bucket Analysis Bucket Analysis Overview Bucket Composition Bucket Size Distribution Buckets By Size Bulk Cross Match Comparison Distribution Member Bucket Frequency Member Bucket Values Member Comparison Distribution Members By Bucket Count Linkage Analysis Member Duplicates Member Overlaps Chapter 8. Callout handlers Custom handlers Enabling engine callouts Packaging the handler Adding external libraries iv Workbench User's Guide

7 Creating the launch configuration Re-running the Ant script Registering the handler Java handlers NET handlers Handler metadata Available interaction codes Special considerations for Clover.ETL graphs 203 Adding a handler registration Editing a handler registration Deleting a handler registration Deploying the handler Testing the handler Chapter 9. User management Internal LDAP server Navigating the User Management perspective Adding users Editing users Deleting users Assigning users to groups Removing users from groups Navigating the LDAP perspective Connecting to the LDAP server Importing or exporting LDAP groups and users 212 LDAP groups Optional: Create a group DN container Adding new groups LDAP users Adding new users Adding a password that includes multi-byte characters Adding a user name that includes multi-byte characters Adding the user to a group Chapter 10. Hub administration Source Sequence Identifiers Chapter 11. Operational monitoring 221 Accessing the JMX browser The MBean Explorer view Listeners node Log4j node Search node ThreadPools node Administrative actions Chapter 12. IBM Initiate Pair Manager 227 The sample pair file Using the IBM Initiate Pair Manager Filtering members by status Selecting data columns to display Handling large sample pair files Chapter 13. Initiate Inspector Configuration Implementing configuration changes IBM Initiate Inspector Configuration Editor Attribute Display page Custom Task Summary Page General Preferences page Member and Entity page Search Forms page Search Results page Chapter 14. IBM Initiate Flexible Search Introduction Creating an index configuration Configuring the search index Index configuration file Index fields General configuration Search tuning Appendix A. Algorithm function descriptions Standardization functions Anonymous values Equivalent values Address standardization functions (street, postal, ZIP code, and ) Attribute standardization functions Biometric standardization functions Date standardization functions Geographic standardization functions Identifier standardization functions Name standardization functions Phone standardization functions Miscellaneous standardization functions Comparison functions Token comparison Address comparison functions Attribute comparison functions Biometric comparison functions Date comparison functions Edit distance comparison functions Equivalent comparison functions False Positive comparison functions Geographic comparison functions Name comparison functions Bucketing Bucket functions Generation Functions Appendix B. Algorithm validation rule syntax Adding validation rules Standardization function rules Comparison function rules Bucketing Functions Generation Functions Sample Validation Rules XML Appendix C. Understanding weight table names Contents v

8 Appendix D. Globalization Appendix E. Creating cheat sheets for Initiate tools Creating a new cheat sheet Specifying commands for cheat sheet steps Initiate tools executable through cheat sheets 350 Specifying an Input/Output Variable Running an Initiate-supplied cheat sheet Running your own cheat sheet Legal Statement Notices and trademarks Index Contacting IBM Appendix F. MPXDATA configuration file vi Workbench User's Guide

9 Tables 1. Compare Members (mpimcomp) options Generate Frequency Stats (mpxfreq) options Generate Threshold Analysis Pairs options Generate weights options Bucket analysis preparation options Validate weights options Compare Members in Bulk (mpxcomp) options Derive Data and Create UNLs (mpxdata) options Derive Data from Hub (mpxredvd) options Derive Data from UNLs (mpxfsdvd) options Export Linkage History (mpxxeia) options Link Entities (mpxlink) options Steps for executing Link Relationships Link Relationships options Prepare Binary Files (mpxprep) options Sort Binary Link Data (mpxsort) options Load UNLs to DB (madunlload) options Unload UNLS from DB (madunlunload) options Index by Members options Index by UNLs options Deploy Hub Configuration options Execute Remote Graph options Get File options Member types properties Attributes properties Entity type properties Source priorities for entity types Composite view properties Sources properties Attribute type properties Attribute field properties Informational source properties Task type properties Task status properties Linkage type properties Linkage status properties Event properties Relationship type properties Relationship type attributes properties Relationship type rules properties Application properties Application Properties properties Web Reports properties Enumerated Data Type properties String properties String file fields to be defined Interaction guidelines Matched pair threshold Attribute matched pair threshold Attribute matched pair percentage threshold Data quality percentage for initial weight estimates Minimum attribute count Convergence threshold False negative rate False positive rate Weight table percentage cut-off Minimum weight frequency Weight generation utilities used for various system states Weight generation properties with prompts Weight generation properties without prompts Available Queries List Analytics view toolbar icons Available interaction codes Clover handler metadata Preconfigured LDAP groups Interactions in the monitoring perspective Composite-to-classic standardization function Map Composite-to-classic comparison function mapping Composite-to-classic bucketing function mapping Weight tables and corresponding wgttypes Initiate tools executable through cheat sheets Sample mpxdata configuration file IBM resources Providing feedback to IBM Copyright IBM Corp. 1995, 2012 vii

10 viii Workbench User's Guide

11 Chapter 1. IBM Initiate Workbench basics Using the Update Manager About this task The IBM Initiate Workbench application enables implementers and administrators to easily manage the IBM Initiate Master Data Service software environment. Use this application to maintain user security, create composite views, edit data dictionary tables, and to develop member logical models, flows, and mappings to data sources. This guide is designed as a resource for system, application, and database administrators and those responsible for implementing Initiate software. IBM Initiate Workbench release 9.7 is an Eclipse-based technology and runs on computers using Microsoft Windows. Its primary use is to configure the Master Data Engine to operate as a Data Hub, but it has many additional features. This section describes how to start IBM Initiate Workbench and use its menus and views. For information on installing IBM Initiate Workbench, refer to the IBM Initiate Workbench Installation Guide. For information on Eclipse, refer to Note: The Sun Java JDK is installed with IBM Initiate Workbench and is required to run this application. From the Microsoft Windows start menu select: Start > All Programs > IBM Initiate > Workbench 9.7.x In order for the graphical interface to be displayed properly in Windows, your screen resolution setting should be 1024 x 768 pixels or higher. You will first be prompted to enter the path for your workspace. You may accept the default, located at windows_user_profile\workspace, or type the desired path. Throughout this documentation, this path will be referred to as workspace, for example workspace\project_name\jobtemplates might refer to C:\Documents and Settings\jdoe\workspace\localhub\jobTemplates. To always use this workspace location, check the Use this as the default and do not ask again box. IBM Initiate Workbench opens. To use the Update Manager built into IBM Initiate Workbench, follow the instructions below. Procedure 1. From the main menu, select Window > Preferences > General > Capabilities. 2. Enable the Classic Update option. 3. Use the Help > Software Updates > Find and Install or Help > Software Updates > Manage Configurations option to search for software updates. Copyright IBM Corp. 1995,

12 Implementation overview The steps below outline the high-level implementation process for deploying the IBM Initiate Master Data Service platform. Items 2, 3, 4, 6, 7, 8, 9, and 11 are performed using IBM Initiate Workbench. 1. Review customer requirements. 2. Configure the member model (see Chapter 4, Configuration editor, on page 89). 3. Configure the algorithm (see Chapter 5, Algorithm editor, on page 153). 4. Deploy the configuration (see Chapter 2, Managing projects and Hub connections, on page 11 or Chapter 3, Jobs and job sets, on page 21). 5. Obtain the data extract. 6. Clean the data extract (IBM Initiate Workbench Clover User's Guide). 7. Derive the data (see Chapter 3, Jobs and job sets, on page 21). 8. Generate weights (see Chapter 6, Weight generation, on page 175). 9. Perform the bulk cross match (see Chapter 3, Jobs and job sets, on page 21). 10. Analyze and review. 11. Reconfigure algorithm and repeat remaining steps as needed. As you can see, IBM Initiate Workbench is used extensively in the implementation process. Instructions for using the IBM Initiate Workbench user interface in performing these steps are discussed in this chapter. IBM Initiate Workbench concepts and features IBM Initiate Workbench enables you to create and/or edit a Master Data Engine configuration locally and then remotely deploy the validated configuration to a Master Data Engine instance. The following sections describe the primary features of IBM Initiate Workbench. Projects A IBM Initiate Workbench project is used to organize a Hub configuration that will be deployed to a Master Data Engine instance. Multiple projects can be worked on for the same Hub or multiple Hubs. Projects are persisted locally in directories below the workspace directory established the first time IBM Initiate Workbench is started. Projects are visible in the Navigator window in IBM Initiate Workbench. Hub Configuration A Hub configuration is a view of the members, attributes, and segments defined for an Initiate software implementation. This data dictionary configuration is stored in the Initiate Member Model file (.imm) found in the Navigator pane. The file is given the same name as the project, and additional information is populated based on the template option you chose during the project creation process. Details on configuring the Hub are found in Chapter 4, Configuration editor, on page 89. Algorithm Configuration Algorithms are used within the Hub to compare and score member attribute similarities and differences. Initiate software applies the algorithms to data to create tasks and to support search functionality. The algorithms are tailored to use 2 Workbench User's Guide

13 attributes specific to your business, and are defined using the Algorithm Editor. Details on configuring algorithms are found in Chapter 5, Algorithm editor, on page 153. Synchronization and validation IBM Initiate Workbench also provides advanced synchronization and validation features that help keep change management to a minimum and prevent invalid configurations from reaching the Hub. Whenever a project resource is modified, IBM Initiate Workbench works behind the scenes to ensure that all parts of the metadata (models, algorithms, and so forth) remain in synchronization. When a change to one resource adversely affects another resource, a task (or set of tasks) is generated in the Problems view. This view enables you to track each new problem the resource has generated. The tasks can then be worked in any order to resolve the issue. Typographical errors, incorrect syntax, and so forth are all checked and validated. Any problems encountered are entered as tasks in the Problems view for tracking and correction. Validation tasks in the Problems view When selecting tasks in the Problems view, the task opens the appropriate editor and automatically selects the corresponding problem area (for example, a comparison role or string code). Depending on the task in question, the task is either immediately removed when the invalid issue is corrected, or it is removed the next time a validation check is run (when a project resource is saved). Each IBM Initiate Workbench project is validated when it is opened (or after restarting IBM Initiate Workbench). This guarantees that the project resources are validated against any external changes made since the project was last edited. Some tasks have associated Quick Fixes which are available for guided resolution of the problem. To access the Quick Fix menu: select the task and bring up the context menu by right-clicking on it, then select the Quick Fix option. If the option is not selectable then there is no quick fix for that problem, and you will have to correct it without guided assistance. Deployment Hub configurations and algorithms are deployed directly to the Master Data Engine instance. IBM Initiate Workbench includes a wizard that takes you through the steps of deploying. See Deploying a Hub configuration on page 17. Jobs Some tasks need to be performed directly on the Hub, outside of configuration deployment. IBM Initiate Workbench provides a means for performing single jobs or grouping jobs within a job set, executing them directly on the Hub, and displaying the progress or state of the job execution within a IBM Initiate Workbench view. In many cases, job results can be retrieved or viewed from the Hub by right-clicking the completed job and selecting Get Job Results. Details on executing jobs are found in Chapter 3, Jobs and job sets, on page 21. Custom callout handlers IBM Initiate Workbench enables you to register custom callout handlers that manage your special business needs, such as: Chapter 1. IBM Initiate Workbench basics 3

14 v Callouts to a third-party API v Apply conditional security for certain types of interactions v Send event notifications to an external message queue, address, file system, and so forth. Consult the IBM Initiate Master Data Service SDK Reference for Java and Web Services for more information on creating custom handlers. Refer to Chapter 8, Callout handlers, on page 199 for information on registering and deploying the handlers. Undo/Redo IBM Initiate Workbench provides automatic local history undo/redo and compare/replace across save boundaries and Workbench instances. This history does not jeopardize the integrity of existing artifacts and is available for any text-based file, including XML and Java. Once a project is saved, however, the undo/redo history is cleared. Versioning and source control Workbench is an Eclipse-based technology and accepts many source control plug-ins. All project resources are text-based files which can be stored and versioned easily into source control systems. Refer to and search for source control plug-ins. Cheat sheets As an Eclipse-based application, Workbench supports the use of cheat sheets to guide users through completing specific tasks. To launch a cheat sheet, go to Help > Cheat Sheets... If this command is not in the menu, you can add it by opening Window > Customize Perspective > Commands, and checking Cheat Sheets. Workbench comes with a Tuning Search cheat sheet out-of-the-box, and more can be created on an as-needed basis. Instructions for creating cheat sheets and accessing Workbench utilities via cheat sheets can be found in Appendix E, Creating cheat sheets for Initiate tools, on page 349. Log in Many IBM Initiate Workbench features can be used while disconnected from a Hub. Some, however, require you to log in to a Hub. Once you log in, a dialog opens to display the date and timestamp of your last successful login to the selected Hub. The last successful login is not application-specific. If you last logged into the Hub from IBM Initiate Inspector, for example, that login timestamp is displayed. You can enable or disable the Show login confirmation dialog option by selecting Window > Preferences > Initiate. The default system administrator login name and password is system / system but Initiate Systems, Inc. suggests you change this at your earliest convenience. Procedures for adding, editing and deleting users are described in Chapter 9, User management, on page 207. The IBM Initiate Workbench Screen Layout The IBM Initiate Workbench screen utilizes the most common features of the Eclipse development tool, including perspectives, views and editors. 4 Workbench User's Guide

15 Perspectives The Workbench user interface contains an editor and a set of work areas called views. Together, they form a Workbench perspective. This perspective defines an optimized, task-based orientation of the most-used functions of Workbench. Views The shortcut bar appears along the right edge of the window and provides quick access to all perspectives currently in use. It also contains any fast views you create as shortcuts to the views you use most often. The Configuration, LDAP, User Management, CloverETL and Analytics perspectives are the perspectives most used within Workbench. Note: To change the docking, right-click on the perspective toolbar and select your desired docking location. The toolbar is docked at the Top Left position by default. The perspectives that enable you to work with the Hub and Hub data are: v Analytics: This perspective displays four Analytics views by default, which enable you to view multiple analytics queries side-by-side. You can find more information about using the views in this perspective in Chapter 7, Analytics, on page 187. v Configuration: The main editor window enables you to manage the dictionary data for the Hub or to design and edit algorithms. You can find more information about using the views in this perspective in Chapter 4, Configuration editor, on page 89 and Chapter 5, Algorithm editor, on page 153. v Clover ETL: The CloverETL function lets you design and execute data extract, transfer and load (ETL) operations in a graph format. You can find more information about using the views in this perspective in the IBM Initiate Workbench Clover User's Guide. v Inspector Configuration: The Inspector Configuration perspective is used to edit the inspector.arm file, which stores the IBM Initiate Inspector application configuration. When changes to this configuration file are deployed to the Hub, any browser used to open the IBM Initiate Inspector application automatically receives the IBM Initiate Inspector configuration when the user logs in. Details on using the views in the Inspector Configuration perspective are located in Chapter 13, Initiate Inspector Configuration, on page 231. v LDAP: The main editor window displays the LDAP server information for editing as needed. You can find more information about using the views in this perspective in Chapter 9, User management, on page 207. v Monitoring: The JMX browser packaged with Workbench provides an easy method for monitoring performance and resource consumption. You can find more information about using the views in this perspective in Chapter 11, Operational monitoring, on page 221. v User management: This perspective enables those unfamiliar with LDAP to add users and assign them to groups. You can find more information about using the views in this perspective in Chapter 9, User management, on page 207. Views are individual windows that contain specific types of data. Most views can be moved to different areas of the screen by dragging and dropping their tabs. To change views, select the Window menu and click Show View. You can then choose from a variety of views. Chapter 1. IBM Initiate Workbench basics 5

16 The following is a brief description of the different views included in the Workbench user interface. Navigator view The Navigator view appears at the upper left-hand side of the window and provides a tree structure for browsing the Workbench artifacts. The root of the tree structure begins at the workspace folder in your Master Data Engine software installation directory. From the Navigator view, you can: v Traverse project directories v Open and view project files v Copy, paste, move, delete and rename project files v Select a working set of files (and hide files not used in the working set) v Deselect a working set of files v Compare files with the local history v Compare a file with another file v Replace a file with one from the local history v Replace a file with another file If the Navigator view is hidden, you can display it by selecting to open the Window -> Show View > Other to open the Show View dialog, then expanding General and double-clicking Navigator. Properties view The Properties view appears at the bottom left of the window and enables you to edit the property values of any component you create. If the Properties view is hidden, you can display it by selecting to open the Window -> Show View > Other to open the Show View dialog, then expanding General and double-clicking Properties. Problems view The Problems view appears at the bottom left of the window and provides a list of configuration and validation problems in Workbench. Most validations are done when file resources in the project are saved, so errors appear instantly. Double-click a problem in the Problems view to go to the item that generated the error. See Validation tasks in the Problems view on page 3. If the Problems view is hidden, you can display it by selecting to open the Window -> Show View > Other to open the Show View dialog, then expanding General and double-clicking Problems. Console view A Console view appears at the bottom of the window and shows progress messages and errors during extensive background tasks. If the Console view is hidden, you can display it by selecting Window -> Show View -> Other to open the Show View dialog, then expanding General and double-clicking Console. 6 Workbench User's Guide

17 Jobs view The Jobs view appears at the bottom right of the window and shows progress or completion status for job sets executed from the jobs wizard. Click the + icon to expand the job and view output details, and click the - icon to collapse it. If the Jobs view is hidden, you can display it by selecting to open the Window -> Show View > Other to open the Show View dialog, then expanding Workbench and double-clicking Jobs. Analytics view The Analytics view appears at the bottom right of the window and displays the results of an analytics query. You need to create a connection to the Hub and then specify a query to run in order to see data in this view. If the Analytics view is hidden, you can display it by selecting to open the Window -> Show View > Other to open the Show View dialog, then expanding Workbench and double-clicking Analytics. Search view The Search view appears at the bottom right of the window and displays the results of a Search. You can double-click a row in the Search view to open the corresponding configuration object. If the Search view is hidden, you can display it by selecting to open the Window -> Show View > Other to open the Show View dialog, then expanding General and double-clicking Search. MBean Explorer view The MBean Explorer view appears at the left of the window in the Monitoring perspective and displays the MBeans accessible on the connected Hub. You can double-click a row in the MBean Explorer view to open the corresponding MBean object. If the MBean Explorer view is hidden, you can display it by selecting to open the Window -> Show View > Other to open the Show View dialog, then expanding Monitoring and double-clicking MBean Explorer. You can also display the view by clicking the MBean Explorer button in the bottom left corner of the Monitoring perspective. Configuration comparison view When changes have been made to a Hub configuration or algorithm in Workbench but have not yet been deployed to the Hub, you can view the differences between the configuration on the Hub and the one in Workbench by using the Configuration Comparison view. Similarly, if the Hub configuration was updated using a different Workbench instance, you can compare your current configuration with the changes made to the Hub. Comparing configurations: Procedure 1. Access the view by selecting the Window > Show View > Other... menu option and then selecting Configuration Comparison in the Workbench group. The Configuration Comparison view opens. 2. Click the source selection icon in the upper right corner of the view to open the Configuration Comparison Source Selection dialog. Chapter 1. IBM Initiate Workbench basics 7

18 8 Workbench User's Guide 3. For each of the Sources, select either a project or a Hub. You can compare two projects, two Hubs or a Hub and a project. When selecting a project, you can optionally include any unsaved editor changes by enabling the Include unsaved editor changes checkbox. 4. Click OK. The Configuration Comparison view is populated with comparison data. Rows highlighted in yellow indicate that one or more of its child objects differ between the two sources. Rows highlighted in pink indicate the differing object(s). a. To view algorithm differences, click the Algorithms tab. b. To view Hub configuration differences, click the Hub Configuration tab. c. To show only the objects that differ, enable the Only show differences checkbox. 5. If one of the Hub configurations or algorithms change, repeat steps 2-4 to refresh the view. Editors The main portion of the IBM Initiate Workbench perspectives is allocated to editors. IBM Initiate Workbench provides several special types of editors, such as the Hub configuration editor, algorithm editor and IBM Initiate Inspector configuration editor. The Hub configuration editor is for working with.imm files, the algorithm editor is for working with.alg files, and the Inspector Configuration editor is for working with.arm files. IBM Initiate Workbench also supports other editor types, including standard text and Java editors. About the Hub configuration editor The Hub configuration editor shows a view of member types, entity types, composite views, sources, attribute types, strings, security and so on. The following is a typical representation of a Hub configuration imported into Workbench. Refer to Chapter 4, Configuration editor, on page 89 for more information on using the Hub configuration editor. Most of the tables in the Hub configuration editor can be sorted by clicking on a column heading. A small arrow indicates how the data is sorted: an up arrow mean the sort is ascending, and a down arrow means the sort is descending. Note that not all tables or columns can be sorted. About the Algorithm editor The Algorithm Editor enables you to edit the algorithm files which are used by the Hub to apply comparison logic. Refer to Chapter 5, Algorithm editor, on page 153 for more information on using this editor. About the Inspector Configuration editor The Inspector Configuration Editor enables you to edit the inspector configuration file. Once the file is deployed to the Hub, all users of IBM Initiate Inspector will have access to the same configuration. The editor can be accessed by double-clicking the inspector.arm file in the inspector folder within the Navigator. To create a new inspector.arm file, select Initiate > Create Default Inspector Configuration... from the main menu. Refer to Chapter 13, Initiate Inspector Configuration, on page 231 for more information on using the Inspector Configuration editor. About the Flexible Search configuration editor The IBM Initiate Flexible Search editor enables you to edit the search index configuration file. Once the file is deployed to the Hub, all users of IBM Initiate Flexible Search will have access to the same index configuration.

19 The editor can be accessed by double-clicking the flexsearch.fsm file in the flexsearch folder within the Navigator. To create a new flexsearch.fsmfile, select Initiate > Create Default Flexible Search Configuration... from the main menu. Refer to Creating an index configuration on page 241for more information on using the Flexible Search Configuration editor. Using the Workbench menu options When you start Workbench, you are presented with the basic platform view with a full-featured menu at the top. Most of the menus are standard Eclipse menus. The following section describes the operations you can perform using the Search and Initiate menu options. For information on using the other menus, please consult the Eclipse documentation or help. Search menu The Search menu enables you to search for text strings in files. You can also search for objects within a Hub configuration using a text search. Use the Hub Configuration Search tab to search for objects whose identifying attributes include the specified text string. The search results are displayed in the Search view (see Search view on page 7). Initiate menu The Initiate menu provides a way to perform the following operations. v v v v Create a new Initiate project (Chapter 2, Managing projects and Hub connections, on page 11) Import a Hub configuration (Chapter 2, Managing projects and Hub connections, on page 11) Create a Flexible Search configuration file. (refer to Creating an index configuration on page 241) Create a default Inspector configuration file (Chapter 13, Initiate Inspector Configuration, on page 231) v Generate Enterprise Services (refer to the IBM Initiate Enterprise Service Oriented Architecture (SOA) Toolkit User's Guide) v Deploy handlers (Chapter 8, Callout handlers, on page 199) v Deploy a Hub configuration (Chapter 2, Managing projects and Hub connections, on page 11) v Generate Flex components (refer to the IBM Initiate Master Data Service Composer Guide for JavaScript Development) v Create a job set (Chapter 3, Jobs and job sets, on page 21) v Validate local weights (Chapter 6, Weight generation, on page 175) v Rescore members in sample pairs file(s) v Upgrade Initiate project artifacts from previous Workbench versions (Chapter 2, Managing projects and Hub connections, on page 11) v Register Hubs to projects (Chapter 2, Managing projects and Hub connections, on page 11) Rescoring members in sample pair files About this task If you change the algorithm after running Generate Threshold Analysis Pairs ( Database Tools jobs on page 78), you can rescore the sample pairs without having to rerun the job. Chapter 1. IBM Initiate Workbench basics 9

20 Procedure 1. From the menu, select Initiate -> Rescore members... The Rescore Members dialog opens. 2. Select the Project, Hub, Member Type and Entity Type as needed, then click Next. 3. Click Browse beside the Sample Pair Files box to navigate to the sample pair file(s) previously generated. 4. Click Finish to begin rescoring, or click Next to view the summary page prior to clicking Finish. The sample pair files are updated with the new scores. First step in using IBM Initiate Workbench The first step in performing Hub configuration tasks is to create an Initiate project. Refer to Chapter 2, Managing projects and Hub connections, on page 11 for instructions on creating a project and importing a configuration from the Hub. 10 Workbench User's Guide

21 Chapter 2. Managing projects and Hub connections About this task Hub connections About this task In IBM Initiate Workbench, a project is merely a container that holds the Hub configuration and its associated files. Before you import a Hub configuration into a project, you must first create a new project or import an existing project. The following sections describe how to use Workbench to: v Create a Hub connection (see Adding a connection ) v Create a new project (see Creating a new project on page 13) or Import an existing project (see Importing an existing project on page 14) v Import a Hub configuration into an existing project (see Importing a Hub configuration on page 15) v Deploy a Hub configuration (see Deploying a Hub configuration on page 17) v Upgrade the artifacts from an existing Initiate project to a new Workbench version (see Upgrading Initiate projects on page 18) A connection to the Master Data Engine instance is required in order to download and upload IBM Initiate Workbench project files. These topics describe various connection management steps. Adding a connection About this task To add a connection to the Master Data Engine instance, follow these steps. Procedure 1. From the menu, select Initiate > Register Hubs to Projects... The Register Hubs to Projects dialog opens. 2. If you have already created a project, select the Project from the drop-down list to which you wish to associate the Hub. 3. The section labeled Available Hubs lists the Hubs that have been registered, if any. To add a Hub to this list, click Edit... The Hub Connections dialog opens. 4. Click Add... The Add Hub Connection dialog opens. 5. On the Add Hub Connection dialog, set the following options: v Connection Name: Type a description for the connection (e.g., Production or Test). v Host: Type the machine name or IP address for the server where Hub software is running. v Port: Type the port number for the Hub. v If your Master Data Engine instance is configured to provide MPINet communications over HTTP, select the Use MPINet over HTTP check box. Copyright IBM Corp. 1995,

22 v If you are using SSL security, select the Use SSL for MPINET check box and select the SSL Version from the list. If you want Workbench to verify the SSL certificate returned from the Hub, click Verify SSL Certificate. v JMX Port: Type the port number to use for JMX monitoring. If desired, enable the Use SSL for JMX option. 6. Click OK. Repeat steps 4-6 as needed. 7. Click Close on the Hub Connections dialog. 8. On the Register Hubs to Projects dialog, check the server(s) to which you wish to associate the selected project, and then click Finish or Cancel. Results The next step is typically Creating a new project on page 13. Editing a connection About this task To edit a connection to the Master Data Engine instance, follow these steps. Procedure 1. From the Initiate menu, click Register Hubs to Projects. The Register Hubs to Projects dialog opens. 2. The section labeled Available Hubs lists the Hubs that have been registered. To edit a server in this list, click Edit. The Hub Connections dialog opens. 3. On the Hub Connections dialog, highlight the connection you want to update, and then click Edit Make the necessary changes to the Connection Name, Host Port, MPINet over HTTP, SSL and JMX options. Click OK. 5. Click Close on the Hub Connections dialog. 6. On the Register Hubs to Projects dialog, click Finish. Removing a connection About this task To remove a connection to the Master Data Engine instance, follow these steps. Procedure 1. From the menu, click Initiate > Register Hubs to Projects. The Register Hubs to Projects dialog opens. 2. The section labeled Available Hubs lists the Hubs that have been registered. To delete a Hub from this list, click Edit. The Hub Connections dialog opens. 3. On the Hub Connections dialog, highlight the connection you want to delete, and then click Remove. 4. Click Yes to remove the selected connection. 5. Click Close on the Hub Connections dialog. 6. On the Register Hubs to Projects dialog, click Finish. 12 Workbench User's Guide

23 Managing projects About this task The data that comprises a hub configuration is managed within IBM Initiate Workbench projects. Before you can create or edit a hub configuration, you need one or more projects. Creating a new project About this task To create a IBM Initiate Workbench project, follow these steps. Procedure 1. From the Initiate menu, select New Initiate Project In the Project name field, enter a name for your new project. If the Use default location option is checked, the project will be created in the current workspace directory. If not, specify a location outside of the current workspace (such as another local drive or network drive) using the Browse button. Click Next. 3. On the Registered Hubs page, select the Hub(s) to which you wish to associate the project. If the desired Hub is not listed, refer to Adding a connection on page 11. Click Next. 4. On the Templates page, select a template to use. Available templates are: Default This template contains predefined attribute type definitions, link types, task types, etc. It does NOT contain any member type, entity type, or source definitions. Empty Using this template creates an empty project. It contains no member type, entity type, source definitions, predefined attribute type definitions, link types, task types, etc. To populate this project, you must import a configuration from an existing Master Data Engine instance. Initiate Demo Person Using this template creates a demo project that has one member type called PERSON. It also includes a sample algorithm for the PERSON member type. Initiate Demo Householding Using this template creates a demo project that has one member type called "PERSON" and two entity types, id (identity) and hh (householding). It includes: v a sample algorithm for the "PERSON" member type that demonstrates the recommended comparison and bucketing functions and a sample set of weights that you can reference in implementing a Household Solution. v a Householding job set template containing recommended job sequences and options that can be used. v a Basic Householding Configuration cheat sheet that highlights the artifacts in this template project and aids in understanding how to implement the Household solution (see Running an Initiate-supplied cheat sheet on page 352). v a sample Clover.ETL graph for performing a Household data extract. 5. Click Finish. Chapter 2. Managing projects and Hub connections 13

24 Results IBM Initiate Workbench then creates the project and adds the following directories under the workspace directory:.settings contains files used by IBM Initiate Workbench to store preference settings anonutil contains sample default value files and filter files used by the Anonymous Value Utility handlers contains scripting support for packaging Java handlers lib contain any additional Java code library files needed for deployment (.jar) src contain any additional Java source files needed (.java) Additional directories are added if you select the default or demo templates, or import a hub configuration after creating an empty project. client contains a generic api.properties file for use with the ESOA Toolkit. Refer to the IBM Initiate Enterprise Service Oriented Architecture (SOA) Toolkit User's Guide for more information. inspector contains IBM Initiate Inspector configuration-related files. strings string value files associated with string codes defined in the hub configuration The next step is typically Importing a Hub configuration on page 15. Importing an existing project About this task To import an existing project, either switch your workspace to the project's parent directory using File > Switch Workspace... or copy the project files into your current workspace. To copy the project files into your current workspace: Procedure 1. Using a file browser, copy the existing project directories into the workspace directory on your file system. 2. From the Navigator view, right click the project and select Import On the Import:Select dialog, select Existing Projects into Workspace. Click Next. 4. On the Import:Import Projects dialog, Select root directory is the selected default. Use the Browse button to specify the location of the previously exported project(s). If desired, you can also select to import from an archive file (.jar,.zip,.tar,.tar.gz,.tgz) by choosing the Select archive file option instead. 5. Click the checkbox for each project you wish to import. 14 Workbench User's Guide