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
Copying, Cutting, and Pasting 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)
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
After you create the master index framework and create the configuration files, you can modify the object structure that you defined. The properties for the objects and fields you will store in the master index database are defined in object.xml. For more information about this file and the configurable options, see Master Index Object Definition Configuration in Oracle Java CAPS Master Index Configuration Reference .
The object tree in the Configuration Editor corresponds to object.xml in the master index application. Any changes you make to the object structure in the Configuration Editor are reflected in object.xml, and MIDM field property changes are also reflected in midm.xml. If you modify the XML file directly, you need to update midm.xml manually.
Changing the object structure might also require that you make corresponding changes to the other configuration files. For example, if you add a new field to object.xml that you want to include in queries and matching, you need to make the corresponding changes to query.xml, mefa.xml, and update.xml. Only changes made before generating the project take effect for the new application.
You can configure the object structure either through the Master Index Configuration Editor or by modifying the XML file directly. Both methods are described here. Perform any of the following actions to configure the object structure.
You can add new objects to the object structure as needed. Note that the object structure can contain only one parent object but multiple child objects. If you use the Configuration Editor, you can either create an undefined object or create an object from a predefined template. A predefined object includes a set of predefined fields with default configurations.
Note - Due to database naming constraints, the length of the name of the parent object plus the length of any child object names must be 21 characters or less.
The Configuration Editor appears.
The object structure expands, and a new child object appears at the bottom of the object structure.
The Configuration Editor appears.
The new child object and any defined fields appear in the object tree.
The file opens in the NetBeans XML editor.
Make sure the new nodes element does not fall within any existing nodes elements. For example:
<nodes> <tag>Person</tag> ... </nodes> <nodes> <tag>Address</tag> </nodes>
You can modify the name of an object in object.xml, but you must also make the corresponding changes to the remaining configuration files.
The Configuration Editor appears.
The file opens in the NetBeans XML editor.
If you define an object in error, you can remove the object from object.xml. If you modify the XML file directly, you must also remove the relationship definition for the object. Remember to make the corresponding changes to the remaining configuration files.
The Configuration Editor appears.
The object and any fields associated with that object are deleted. If you remove the parent object, all child objects are also removed.
The file opens in the NetBeans XML editor.
For example, to delete the Address object below, delete the boldface text.
<nodes> <tag>Person</tag> </nodes> <nodes> <tag>Address</tag> </nodes>
Once you define an object in object.xml, you can add new fields to the object and configure the properties for those fields. Be sure to add the field to any relevant structures in the remaining configuration files. For information about field naming restrictions, see Master Index Field Name Restrictions.
The Configuration Editor appears.
The tree expands and a new field is inserted.
The file opens in the NetBeans XML editor.
For example:
<nodes> <tag>Address</tag> <fields> </fields> <nodes>
For example:
<fields> <field-name>AddressType</field-name> <field-type>string</field-type> <size>8</size> <updateable>true</updateable> <required>true</required> <code-module>ADDRTYPE</code-module> <pattern/> <key-type>true</key-type> </fields>
If a field is defined for an object but does not belong to that object, you can delete the field from the object structure. Make the corresponding changes to the remaining configuration files.
The Configuration Editor appears.
The field is removed from the object tree.
The file opens in the NetBeans XML editor.
For example, to delete the AddressLine1 field below, delete all text in the sample.
<fields> <field-name>AddressLine1</field-name> <field-type>string</field-type> <size>5</size> <updateable>true</updateable> <required>false</required> <key-type>false</key-type> <code-module/> <pattern/> <key-type/> </fields>
Every field in the object structure has a set of properties that must be configured before deploying the master index application. When a field is created, a set of default properties are defined for that field. You can modify the property configuration for each field to suit your data processing, storage, and display requirements. Field properties include general field attributes, such as the name, length, and data type, and MIDM field properties, such as the display name for the field and display formatting.
Note - On the Configuration Editor, the fields in the MIDM section cannot be configured if the field is not defined to appear on the MIDM (that is, it does not appear in midm.xml).
The Configuration Editor appears.
The General Properties page appears.
Note - After you modify a property value, press Enter to apply the change.
This tab is only visible for fields that have a value in the Match Type field.
The file opens in the NetBeans XML editor.
Note - If you modify the name of a field, make the corresponding changes to the remaining configuration files. Some property elements might not exist for a field; add any necessary elements to the field definition to configure the field.
Example 1 Field Properties in object.xml
The following example defines an address type field that is required in order to enter a record, and that uniquely identifies each address object in a record. It also defines a list, named ADDRTYPE, from which MIDM users can select a value to enter into the field.
<field-name>AddressType</field-name> <field-type>string</field-type> <size>8</size> <updateable>true</updateable> <required>true</required> <pattern></pattern> <code-module>ADDRTYPE</code-module> <key-type>true</key-type>
The following example defines an employee ID field where the must be equal to or greater than 100001 and less than or equal to 199999. Only the characters 0–9 are allowed.
<field-name>EmployeeID</field-name> <field-type>string</field-type> <size>6</size> <updateable>true</updateable> <required>true</required> <minimum-value>100001</minimum-value> <maximum-value>199999</maximum-value> <pattern>[0-9]{6}</pattern> <key-type>false</key-type>
Once all objects are customized, you must define relationships between those objects if you are modifying the XML file directly. If you are using the Configuration Editor, the relationships are automatically defined in the object tree.
The file opens in the NetBeans XML editor.
For example:
<name>Individual</name>
Note - This is not recommended. Changing the parent name requires changing all instances of the name in all configuration files. To change the parent object name, use the Configuration Editor, which automatically propagates the change.
Note - You can only specify one name element. The values you specify for the name and children elements must match an object name specified in the nodes elements earlier in the file.