Skip Navigation Links | |
Exit Print View | |
Oracle Java CAPS Master Index Configuration Guide Java CAPS Documentation |
Oracle Java CAPS Master Index Configuration Guide
Master Index Configuration Overview
About the Master Index Configuration Files
Modifying the Master Index XML Files Directly
Using the Master Index Master Index Configuration Editor
Match Configuration File (matchConfigFile.cfg)
Maintaining Version Control in the Master Index Configuration Files
Configuring the Master Index Object Structure
Adding an Object to the Master Index Object Structure
To Add an Undefined Object (Configuration Editor)
To Add a Predefined Object (Configuration Editor)
To Add an Undefined Object (XML editor)
Modifying an Object's Name In the Master Index Object Definition
To Modify an Object's Name (Configuration Editor)
To Modify an Object's Name (XML Editor)
Deleting an Object From the Master Index Object Structure
To Delete an Object (Configuration Editor)
To Delete an Object (XML Editor)
Adding a Field to the Master Index Object Structure
To Add a Field (Configuration Editor)
Deleting a Field from the Master Index Object Structure
To Delete a Field (Configuration Editor)
To Delete a Field (XML Editor)
Modifying Master Field Properties
To Modify Field Properties (Configuration Editor)
To Modify Field Properties (XML Editor)
Defining Relationships Between Master Index Objects
To Define Object Relationships (XML Editor)
Master Index Field Properties and Name Restrictions
Master Index Field Name Restrictions
Master Index Configuration Editor Field Properties
Master Index Field Property Elements
Creating a Master Index Basic Query
To Create a Basic Query (Configuration Editor)
To Create a Basic Query (XML Editor)
Master Index Query Builder Dialog Box Fields and XML Elements
Creating Master Index Blocking Queries
To Create a Blocking Query (Configuration Editor)
To Create a Blocking Query (XML Editor)
Master Index Query Block Fields and XML Elements
Modifying Master Index Queries
Modifying a Master Index Query
To Modify a Basic Query (Configuration Editor)
To Modify a Query (XML Editor)
Adding a Query Block to a Master Index Query
To Add a Query Block (Configuration Editor)
To Add a Query Block (XML Editor)
Modifying a Query Block for a Master Index Query
To Modify a Query Block (Configuration Editor)
To Modify a Query Block (XML Editor)
Deleting a Query Block From a Master Index Query
To Delete a Query Block (Configuration Editor)
To Delete a Query Block (XML Editor)
To Delete a Query (Configuration Editor)
Configuring Master Index Processing Options
Specifying Master Index Custom Logic Classes
To Specify Custom Logic for External System Messages
To Specify Custom Logic for the Master Index Data Manager
Specifying the Master Index Update Mode
To Specify Potential Duplicates be Reevaluated at Each Update
To Specify Potential Duplicates not be Reevaluated at Each Update
Configuring Master Index Merged Record Updates
To Allow Merged Record Updates
To Prevent Merged Record Updates
Specifying the Master Index Blocking Query for Matching
To Specify the Blocking Query for Matching
Setting Master Index Blocking Query Options
Defining Master Index Transactional Support
To Configure the Master Index for Local Transactions
To Configure the Master Index to Distributed Transactions Across Applications
To Configure the Master Index for Distributed Transactions Within the Master Index Application Only
Configuring Matching Parameters
Specifying the Master Index Decision Maker Class
To Specify the Decision Maker Class
Defining How to Handle Multiple Assumed Matches (OneExactMatch)
To Create Potential Duplicates When Multiple Records Match
To Match the Highest Weighted Records When Multiple Records Match
Specifying Whether Same System Matches are Allowed (SameSystemMatch)
To Allow Same System Records to be Automatically Merged
To Prevent Same System Records From Being Automatically Merged
Specifying the Master Index Duplicate Threshold
To Specify the Duplicate Threshold (Configuration Editor)
To Specify the Duplicate Threshold (XML Editor)
Specifying the Master Index Match Threshold
To Specify the Match Threshold (Configuration Editor)
To Specify the Match Threshold (XML Editor)
Adding and Deleting Master Index Decision Maker Parameters
To Add a New Decision Maker Parameter
To Delete a Decision Maker Parameter
Configuring Master Index EUIDs
Specifying the Master Index EUID Generator Class
To Specify the EUID Generator Class
Specifying the Master Index EUID Length
Specifying a Master Index Checksum Length
Specifying the Master Index Chunk Size
Adding and Deleting Master Index EUID Generator Parameters
To Add EUID Generator Parameters
To Delete EUID Generator Parameters
Defining Master Index Normalization Rules
Defining a Master Index Field to be Normalized
To Define a Field to be Normalized (Configuration Editor)
To Define a Field to be Normalized (XML Editor)
Master Index Normalization and Standardization Structure Properties
Master Index Variants Properties
Modifying a Master Index Normalization Definition
To Modify a Normalization Definition (Configuration Editor)
To Modify a Normalization Structure (XML Editor)
Deleting a Master Index Normalization Definition
To Delete a Normalization Definition
To Delete a Normalization Structure
Defining Master Index Standardization Rules
Defining Master Index Fields to be Standardized
To Define Fields to be Standardized (Configuration Editor)
To Define Fields to be Standardized (XML Editor)
Master Index Standardization Source and Target Field Elements
Modifying a Master Index Standardization Definition
To Modify a Standardization Definition (Configuration Editor)
To Modify a Standardization Definition (XML Editor)
Deleting a Master Index Standardization Definition
To Delete a Standardization Definition (Configuration Editor)
To Delete a Standardization Definition (Configuration Editor)
Defining Phonetic Encoding for the Master Index
Defining Master Index Fields for Phonetic Encoding
To Define a Field for Phonetic Encoding (Configuration Editor)
To Define a Field for Phonetic Encoding (XML Editor)
Master Index Phonetic Encoding Fields and Elements
Modifying a Master Index Phonetic Encoding Definition
To Modify a Phonetic Encoding Definition (Configuration Editor)
To Modify a Phonetic Encoding Definition (XML Editor)
Deleting a Master Index Phonetic Encoding Definition
To Delete a Phonetic Encoding Definition (Configuration Editor)
To Delete a Phonetic Encoding Definition (XML Editor)
Defining a Master Index Phonetic Encoder
To Define a Phonetic Encoder (Configuration Editor)
To Define a Phonetic Encoder (XML Editor)
Master Index Encoder Elements and Types
Modifying a Master Index Phonetic Encoder
To Modify a Phonetic Encoder (Configuration Editor)
To Modify a Phonetic Encoder (XML Editor)
Deleting a Master Index Phonetic Encoder
To Delete a Phonetic Encoder (Configuration Editor)
To Delete a Phonetic Encoder (XML Editor)
Defining the Master Index Match String
Creating the Master Index Match String
To Create the Match String (Configuration Editor)
To Create the Match String (XML Editor)
Modifying the Master Index Match String
To Modify the Match String (Configuration Editor)
To Modify the Match String (XML Editor)
Defining how Master Index Query Blocks are Processed
To Specify the Pass Controller Class
Defining the Master Index Survivor Calculator
Specifying the Master Index Survivor Helper
To Specify the Survivor Helper
Specifying a Master Index Default Survivor Strategy
To Specify a Default Survivor Strategy
Configuring the Default Survivor Strategy
Master Index Default Survivor Strategy Parameter Elements
Defining the Master Index Single Best Record Structure
Defining a Master Index Survivor Strategy for a Field or Object
To Define a Survivor Strategy for a Field
Defining Master Index Custom Weighted Strategies
Defining Custom Weighted Strategies
Configuring Weighted Strategies
Modifying Weighted Calculator Parameters
Deleting Weighted Calculator Parameters
Master Index Weighted Calculator Parameter Elements
Filtering Default Values From Master Index Processes
To Filter Default Values From the SBR, Blocking Query, or Match Process
Configuring Master Index Update Policies
Defining Master Index Update Policies
Setting the Master Index Update Policy Flag
Defining Custom Field Validations for the Master Index
To Implement a Validation Rule
Specifying a Match Engine for the Master Index
Configuring the Comparison Functions for a Master Index Application
To Configure the Comparison Functions (Configuration Editor)
To Configure the Comparison Functions (Text Editor)
Match Comparator Configuration Properties for Oracle Java CAPS Master Index
Importing Custom Comparison Functions
To Import a Comparison Function
Deleting a Custom Comparison Function
To Delete a Custom Comparison Function
Configuring the Standardization Engine
Specifying a Standardization Engine for the Master Index
To Specify the Standardization Engine
Modifying Master Index Standardization Files
To Modify Standardization Data Configuration Files
Importing Standardization Data Types and Variants
To Import a Data Type or Variant
Deleting a Standardization Variant or Data Type
To Delete a Variant or Data Type
Configuring the Master Index MIDM Appearance
Deleting Objects From the MIDM
MIDM Field Configuration Elements
To Remove a Field From the MIDM
Modifying MIDM Field Display Options
To Modify a Field's Display Options
Specifying a Drop-Down List for an MIDM Field
Specifying an MIDM Field's Length and Format
To Modify a Field's Length and Format
Modifying an MIDM Field's Data Type
Defining Key Fields for an Object
Masking Field Values on the MIDM
To Mask Field Values on the MIDM
Defining MIDM Object Relationships
Configuring the Master Index MIDM Pages
Specifying the Initial View for the MIDM
Configuring the MIDM Duplicate Records Page
Configuring Duplicate Records Display Options
Configuring Duplicate Records Search Pages
Configuring the Duplicate Records Results List
Duplicate Records Page Configuration Elements
Duplicate Records Search Page Elements
Duplicate Records Search Results List Elements
Configuring the MIDM Record Details Page
To Configure Record Details Display Options
Creating Search Pages on the Record Details Page
Step 1: Define the Search Page
Step 2: Define the Search Fields
Step 3: Specify Search Options
Record Details Search Page Definition Elements
Record Details Search Field Definition Elements
Record Details Search Option Elements
Modifying a Search Page on the Record Details Page
Modifying a Search Page Definition
Modifying Record Details Search Page Options
Configuring the MIDM Assumed Matches Page
To Configure the Assumed Matches Page
Configuring the MIDM Transactions Page
To Configure the Transactions Page
Configuring the MIDM Reports Page
Configuring the Reports Page Definition
Configuring Production Reports
Production Reports Definition Elements
Activity Reports Definition Elements
Activity Reports Page Definition Elements
Activity Reports Search Elements
Activity Reports Results Elements
Configuring the MIDM Source Record Page
Configuring the Source Record Page Definition
Configuring the Tabbed Pages on the Source Record Page
Configuring the MIDM Audit Log Page
To Configure the Audit Log Page
Configuring Master Index MIDM Implementation Information
Specifying the Master Controller JNDI Class
To Specify the Master Controller JNDI Class
Specifying the Master Index Report Generator JNDI Class
To Specify the Report Generator JNDI Class
Specifying Master Index Validation Services
To Specify the Validation Service
Setting Master Index Debug Options
Oracle Java CAPS Master Index provides a very flexible framework for creating a master index application that is customized for your requirements. A Oracle Java CAPS Master Index project includes several files in XML format that define the configuration of the runtime environment. You can configure a master index application by modifying the XML files directly or by using the Configuration Editor. Make sure to verify the configuration of the application before deploying the project.
Note - It is helpful to review the information provided in Oracle Java CAPS Master Index Configuration Reference to learn about the relationships between the files and what components and processes can be configured. Certain components can only be configured by modifying the XML files directly.
The following topics provide an overview of the configuration files and editors.
Several XML configuration files define primary characteristics of the master index application, such as how data is processed, queried, and matched. These files configure runtime components of the master index application.
In the wizard, you define the objects and fields contained in the object structure, along with properties for those fields. The information you specify is written to object.xml in the master index project. This file defines the objects stored in the master index application and their relationships to one another. It also defines the fields contained in each object, as well as certain properties of each field, such as length, data type, whether it is required, whether it is a unique key, and so on. This file contains one parent object; all other objects must be child objects to that parent object. The object structure you define in object.xml determines the structure of the database tables that store object data, the structure of the Java API, and the structure of the OTD generated for the project.
In query.xml, you configure the Query Builder component of the master index application and define the available queries. In this file, you define the types of queries that can be performed from the Master Index Data Manager (MIDM) and the queries that are used during the match process. You can define both phonetic and alphanumeric searches for the MIDM. By default, these are called basic queries. You can also define blocking queries, which define blocks of criteria fields for the match process. The master index application queries the database using the criteria defined in each block, one at a time. After completing a query on the criteria defined in one block, it performs another pass using the next block of defined criteria. Blocking queries can also be used in place of the basic phonetic query in the MIDM.
In mefa.xml, you configure the Matching Service by specifying the fields to be standardized and the fields to be used for matching, as well as defining how the fields are standardized and matched. This file specifies the match and standardization engines to use and the query process for matching. Standardization includes defining fields to be reformatted (or parsed), normalized, or phonetically encoded. For matching, you must also define the data string to be passed to the match engine. The rules you define for standardization and matching are dependent on the standardization and match engine in use. Oracle Java CAPS Master Index Match Engine Reference and Oracle Java CAPS Master Index Standardization Engine Reference describe the rules for the Master Index Standardization Engine and Master Index Match Engine.
You can also configure portions of the match process in master.xml, described below, which defines certain match parameters that control weight thresholds, how assumed matches are processed, how potential duplicates are processed, and the query to use for matching.
In master.xml, you configure the Manager Service and define properties of the match process. You specify the match and duplicate thresholds in this file, and define certain system parameters, such as the update mode, how to process records above the match threshold, how to manage same system matches, and whether merged records can be updated. This file also specifies which of the queries defined in the Query Builder to use for matching queries.
This file also configures the EUIDs assigned by the master index application. You can specify an EUID length, whether a checksum value is used for additional verification, and a “chunk size”. Specifying a chunk size allows the EUID generator to obtain a block of EUIDs from the sbyn_seq_table database table so it does not need to query the table each time it generates a new EUID.
In update.xml, you define formulas that determine which data in an enterprise record should be considered the most reliable and how updates to the single best record (SBR) will be handled. The survivor calculator uses these formulas to decide what data from each system record to include in each object’s SBR. The SBR is the portion of the enterprise record that represents the data that is considered to be the most accurate and current for an entity.
The SBR is defined by a mapping of fields from external system records. Since there might be many external systems, you can optionally specify a strategy to select the value for an SBR field from the list of external values. You can also specify any additional fields that might be required by the selection strategy to determine which external system contains the best data, such as the object’s update date and time.
You can create Java classes that define special processing to perform against a record when the record is created, updated, merged, or unmerged. These classes must be created in the Source Packages folder of the EJB project and can be specified for each transaction type in update.xml.
You can further configure the survivor calculator, blocking query, and match process by defining exclusion lists in filter.xml. Exclusion lists allow you to define values that should not be populated into the SBR, that should not be considered in the composite matching weight, and that should be ignored in the blocking query. Values you would want to filter out primarily include default values that are used when the actual value for a field is unknown. Default values can cause the blocking query to return records that are not a close match and can skew matching results.
By default, validation.xml defines certain validations for the local identifiers assigned by each external system. You can create custom Java classes that define rules for validating field values before they are saved to the master index database. You can then specify the Java classes in validation.xml to make them part of the master index application.
This file defines security roles and permissions for the client applications that access the master index database.
In midm.xml, you configure the appearance and processing properties of the Master Index Data Manager (MIDM). In this file, you define each object and field that appears on the MIDM, along with the properties of each field, such as the field type and length, field labels, format masks, and so on. You can also define the order in which objects and fields appear on the MIDM pages.
This file defines several additional properties of the MIDM, including the types of searches available, whether wildcard characters can be used, the criteria for the searches, and the results fields that appear. You can also specify whether an audit log is maintained of each instance data is accessed through the MIDM. For healthcare-based master index applications this supports the privacy rules mandated by the HIPAA regulation for healthcare.
Finally, midm.xml defines certain implementation information, such as the application server in use, debugging rules, and security activation.
The files that configure the components of the master index application are created by the wizard and define characteristics of the application, such as how data is processed, queried, and matched, and how it appears on the MIDM. These files configure the runtime components of the master index application.
Make sure that when you modify the configuration files, you use the versioning controls in NetBeans to maintain version control. Even if you modify the files using the Master Index Configuration Editor, check the files in and out before and after using the editor.
There are a few restraints on modifying these files. In addition to the general rules listed below, the match or standardization engine you choose might place other requirements on customizations. Be sure to review Oracle Java CAPS Master Index Match Engine Reference and Oracle Java CAPS Master Index Standardization Engine Reference before modifying mefa.xml.
Keep the following guidelines in mind when modifying the XML files directly.
All fields specified in any of the configuration files must be included in object.xml.
If you add fields to the object structure, make sure you add them to the survivor calculator in update.xml.
If you define additional fields for normalization, parsing, or phonetic encoding, make sure to add the normalized, parsed, and phonetic fields to object.xml and, optionally, the blocking query.
After modifying any of the configuration files, you must regenerate the master index application and redeploy the project. You must also refresh any client projects that reference the master index server project.
The Configuration Editor has built in validations to ensure that integrity is maintained between the configuration files. For example, it does not allow you to define a field for normalization if that field is not already defined in the object structure. While you can use the Configuration Editor to modify most of the configurable components, some components can only be modified using the XML editor. Following is a summary of which features can be configured using the Configuration Editor and which need to be modified using an XML editor.
You can modify most elements of object.xml using the Configuration Editor. The following can only be modified using the XML editor:
Database type
Date format
Maximum field value
Minimum field value
It is not recommended you change the database type, but if you modify the database type or date format elements, you need to regenerate the application to create the updated database scripts. This does not recreate the Systems or Code Lists scripts; that needs to be done manually.
You can modify all elements in query.xml using the Configuration Editor. If you create a query to use in the MIDM or to use for the matching query, you need to add the query to the appropriate file manually (master.xml or midm.xml).
Most elements in master.xml cannot be modified using the Configuration Editor. You can only modify the duplicate and match thresholds from the Configuration Editor.
You can use the Configuration Editor to modify all commonly modified elements in mefa.xml, including defining standardization structures, normalization structures, and phonetic encoding. If you create custom classes to implement a block picker, pass controller, match engine, or standardization engine, you need to specify the implementation classes in this file using the XML editor.
The Configuration Editor does not modify update.xml. If you make any changes to the object structure (either through the Configuration Editor or XML editor) review this file to verify that all fields or objects are included in the survivor strategy and that the field and object names are correct.
The Configuration Editor does not modify update.xml. If you create a custom field validation class, you need to specify the implementation class in this file using the XML editor.
Most elements in midm.xml are not modified using the Configuration Editor. You can add and delete fields that appear on the MIDM and modify the display name and the value and input masks. All other field properties can only be modified using the XML editor.
Field integrity is maintained when you delete a field using the Configuration Editor. The field is automatically deleted from the MIDM object structure and from any MIDM page definitions that include the field, such as a search page or report.
You can modify all components of the Match Configuration file using the Configuration Editor, including adding and removing comparators. The Configuration Editor does not validate the extra parameters that can be used for certain comparators, so you should verify your changes by reviewing the match configuration file manually.
Whether you modify the XML files directly or configure the master index application through the Master Index Configuration Editor, be sure to maintain version control by checking files out before modifying them and checking them back in after you are finished. You can use any of NetBeans supported platforms for version control. When working with the Configuration Editor, make sure to check out each file that will be modified, either directly or indirectly. For example, if you add a new field to the object structure, add the field to the match string, and add the field to a blocking query, the Master Index Configuration Editor updates object.xml, query.xml, and mefa.xml.
You can use standard cut, copy, and paste commands to copy or move files between projects. Oracle Java CAPS Master Index follows the standard NetBeans functionality, with the exception that you can only copy or move a component from one project into the same node of another project. For example, you can only paste a copied configuration file into the Configuration node of another project. In addition, you cannot cut components that are essential to a project, such as the configuration files, match and standardization files, and so on.