JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Oracle Java CAPS Master Index Configuration Guide     Java CAPS Documentation
search filter icon
search icon

Document Information

Oracle Java CAPS Master Index Configuration Guide

Related Topics

Master Index Configuration Overview

About the Master Index Configuration Files

object.xml

query.xml

mefa.xml

master.xml

update.xml

filter.xml

validation.xml

security.xml

midm.xml

Modifying the Master Index XML Files Directly

Using the Master Index Master Index Configuration Editor

object.xml

query.xml

master.xml

mefa.xml

update.xml

validation.xml

midm.xml

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)

To Add a Field (XML 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)

Deleting a Master Index Query

To Delete a Query (Configuration Editor)

To Delete a Query

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

To Set 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

To Specify the EUID Length

Specifying a Master Index Checksum Length

To Specify a Checksum Length

Specifying the Master Index Chunk Size

To Specify the 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 Block Picker

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

To Specify a Candidate Field

Deleting Candidate Fields

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

Filter Definition Elements

Configuring Master Index Update Policies

Defining Master Index Update Policies

To Define Update Policies

Setting the Master Index Update Policy Flag

To Set the Update Policy Flag

Defining Custom Field Validations for the Master Index

To Implement a Validation Rule

Configuring the Match Engine

Specifying a Match Engine for the Master Index

To Configure the Match Engine

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

Adding Objects to the MIDM

To Add an Object to the MIDM

Modifying MIDM Objects

To Modify an MIDM Object

Deleting Objects From the MIDM

To Delete an Object

Adding Fields to the MIDM

To Define New Fields

MIDM Field Configuration Elements

Removing Fields From the MIDM

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

To Specify a Drop-Down List

Specifying an MIDM Field's Length and Format

To Modify a Field's Length and Format

Modifying an MIDM Field's Data Type

To Modify the Data Type

Defining Key Fields for an Object

To Modify the Key Status

Masking Field Values on the MIDM

To Mask Field Values on the MIDM

Defining MIDM Object Relationships

To Define Relationships

Defining MIDM Local ID Labels

To Define Local ID Labels

Configuring the Master Index MIDM Pages

Specifying the Initial View for the MIDM

To Specify the Initial View

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 Search Fields

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

Configuring Activity 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

To Set Debug Options

Specifying a Master Index Field Masking Class

To Specify a Field Masking Class

Modifying Master Index Queries

By default, two basic queries and one blocking query are predefined in query.xml and you can create additional queries. Once a query is defined, you can modify it as needed. If you make changes to a query defined for a search in the MIDM, you might need to modify the search definition in midm.xml. For example, if you deselect the Use Wildcard option for a query and the wildcard feature is enabled for that query in the MIDM, you need to disable that feature in midm.xml.

You can customize the queries used in your implementation by performing any of the following actions.

You can also define exclusion lists to filter out unwanted values from a blocking query. For more information, see Filtering Default Values From Master Index Processes.

Modifying a Master Index Query

Once you define a basic query, you can modify the attributes and parameters for that query. If you defined a custom query, you might need to modify certain elements of the query directly in the XML file instead of through the Configuration Editor.

To Modify a Basic Query (Configuration Editor)

  1. In the Projects window, right-click the Configuration node in the project you want to modify, and then click Edit.

    The Configuration Editor appears.

  2. Click the Query tab.

    The Query page appears.

  3. Do one of the following:
    • To modify a blocking query, select the query to modify in the Blocking Queries section, and then click Edit.

      The Blocking Query Builder dialog box appears.

    • To modify a basic query, select the query to modify in the Basic Queries section, and then click Edit.

      The Basic Query Builder dialog box appears.

  4. Modify any of the fields and configuration options described in Master Index Query Builder Dialog Box Fields and XML Elements.
  5. For blocking queries, you can modify query blocks by performing any of the following procedures:
  6. When you are done editing the query, click OK.
  7. On the Configuration Editor toolbar, click Save.
  8. To modify or define values to be excluded as criteria (for blocking queries only), go to Filtering Default Values From Master Index Processes.

To Modify a Query (XML Editor)

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click query.xml.

    The file opens in the NetBeans XML editor.

  2. Scroll to the query-builder element that contains the query you want to modify.
  3. Modify any of the attributes listed in Master Index Query Builder Dialog Box Fields and XML Elements.

    For example:

    <query-builder name="ALPHA-SEARCH" class=
      "com.sun.mdm.index.querybuilder.MyQueryBuilder" 
      parser-class=
      "com.sun.mdm.index.configurator.impl.querybuilder.KeyValueConfiguration"
       standardize="true" phoneticize="false">
    </query-builder>
  4. To add a new query parameter (for custom query builders only):
    1. Add a new config element between the query-builder tags.
    2. In the new config element, create an option element and then define key and value attributes for the new element.

      For example:

      <config>
       <option key="SearchAlias" value="true"/>
      </config>

      See Master Index Query Builder Dialog Box Fields and XML Elements for information about the key and value pairs available to the default basic queries.

  5. To modify a parameter, scroll to the option element that defines the parameter and then change the value of the value attribute.
  6. To delete a parameter, scroll to the config element of that query, and then delete the option element containing the parameter to remove.

    For example, to remove the SearchAlias parameter in the following sample, delete the boldface text.

    <config>
       <option key="SearchAlias" value="true"/>
     <option key="UseWildCard" value="false"/>
    </config>
  7. For blocking queries, you can modify query blocks by performing any of the following procedures:
  8. Save and close the file.
  9. To modify or define values to be excluded as criteria (for blocking queries only), go to Filtering Default Values From Master Index Processes.

Adding a Query Block to a Master Index Query

Some query blocks might be predefined for you based on information you specified in the wizard. You can create additional query blocks for a blocking query.

To Add a Query Block (Configuration Editor)

  1. In the Projects window, right-click the Configuration node in the project you want to modify, and then click Edit.

    The Configuration Editor appears.

  2. Click the Query tab.

    The Query page appears.

  3. In the Blocking Queries section, select the query you want to modify and then click Edit.

    The Blocking Query Builder dialog box appears.

  4. In the Block Definitions section, click Add.

    The Block Definition dialog box appears.

  5. In the Block Name field, enter a unique name for the query block.
  6. (Optional) In the Hint field, define a database hint for the query block. For SQL Server, you can only use OPTION hints.
  7. In the Block By section, click Add.

    The Block Rule dialog box appears, where you can specify a field to include in the query block.

  8. Enter values for the fields on the dialog box as described in Master Index Query Block Fields and XML Elements, and then click OK.
  9. Repeat the previous two steps for each field to add to the query block.
  10. When you are done, click OK on the Block Definition dialog box.
  11. On the Blocking Query Builder dialog box, click OK.
  12. On the Configuration Editor toolbar, click Save.

To Add a Query Block (XML Editor)

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click query.xml.

    The file opens in the NetBeans XML editor.

  2. Scroll to the query-builder element that contains the blocking query to configure.
  3. If a config element does not exist for the query, create one between the query-builder tags.
  4. In the config element, create a new block-definition element with a number attribute and assign a unique ID code to the number attribute.

    For example:

       <config>
          <block-definition number="ID1">
          </block-definition>
       </config>
    </query-builder>
  5. To add a hint, create and define a new hint element in the new block-definition element.

    The following example illustrates an Oracle hint.

    <config>
       <block-definition number="ID1">
       <hint>FIRST_ROWS_100</hint>
       </block-definition>
    <config>
  6. In the new block-definition element, create a block-rule element.
  7. For each field in the data block, define the elements described in Master Index Query Block Fields and XML Elements.

    For example:

    <config>
       <block-definition number="ID1">
          <hint>FIRST_ROWS_100</hint>
          <block-rule>
             <equals>
                <field>Enterprise.SystemSBR.Person.FirstNamePh</field>
                <source>Person.FirstNamePh</source>
             </equals>
             <equals>
                <field>Enterprise.SystemSBR.Person.LastNamePh</field>
                <source>Person.LastNamePh</source>
             </equals>
             <range>
                <field>Enterprise.SystemSBR.Person.DateOfBirth</field>
                <source>Person.DateOfBirth</source>
                <default>
                   <lower-bound type=”offset”>-5</lower-bound>
                   <upper-bound type=”constant”>2006-01-01
                   </upper-bound>
                </default>
             </range>
          </block-rule>
       </block-definition>
    <config>
  8. Save and close the file.

Modifying a Query Block for a Master Index Query

Once block definitions are created for a blocking query, you can modify those definitions if needed. You can add, modify, and remove block fields. When adding or removing fields from a query block, verify that the query will still include all the needed fields.

To Modify a Query Block (Configuration Editor)

  1. In the Projects window, right-click the Configuration node in the project you want to modify, and then click Edit.

    The Configuration Editor appears.

  2. Click the Query tab.

    The Query page appears.

  3. In the Blocking Queries section, select the query you want to modify and then click Edit.

    The Blocking Query Builder dialog box appears.

  4. In the Block Definitions section, select the block to modify and then click Edit.

    The Block Definition dialog box appears.

  5. Do any of the following:
  6. When you are done modifying the query block, click OK.
  7. On the Blocking Query Builder dialog box, click OK.
  8. On the Configuration Editor toolbar, click Save.

To Modify a Query Block (XML Editor)

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click query.xml.

    The file opens in the NetBeans XML editor.

  2. Scroll to the block-rule element containing the query block you want to modify.
  3. To add a new blocking field, add and populate the elements described in Master Index Query Block Fields and XML Elements.

    For example:

    <block-rule>
      <equals>
       <field>Enterprise.SystemSBR.Person.DOB</field>
       <source>Person.DOB</source>
      </equals>
      ...
  4. To edit an existing field, modify any of the elements described in Master Index Query Block Fields and XML Elements.
  5. To delete an existing field, delete all text between and including the search type elements that define the field (such as equals, range, not-equals, and so on).

    For example, to delete the DOB field defined above, you would delete the text between and including the equals elements.

  6. Save and close the file.

Deleting a Query Block From a Master Index Query

Once you create a block definition, you can delete it if needed. When deleting a query block, verify that the query will still include all the needed fields.

To Delete a Query Block (Configuration Editor)

  1. In the Projects window, right-click the Configuration node in the project you want to modify, and then click Edit.

    The Configuration Editor appears.

  2. Click the Query tab.

    The Query page appears.

  3. In the Blocking Queries section, select the query you want to modify and then click Edit.

    The Blocking Query Builder dialog box appears.

  4. In the Block Definitions section, select the definition you want to delete.
  5. Click Remove.
  6. On the confirmation dialog box, click Yes.
  7. On the Configuration Editor toolbar, click Save.

To Delete a Query Block (XML Editor)

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click query.xml.

    The file opens in the NetBeans XML editor.

  2. Scroll to the query-builder element that contains the blocking query to modify.
  3. In that query-builder element, delete all text between and including the block-definition element defining the data block to remove.

    For example, in the sample below, to delete the SSN block you would delete the boldface text.

    <config>
       <block-definition number="ID000007">
          <block-rule>
             <equals>
                <field>Enterprise.SystemSBR.Person.SSN</field>
                <source>Person.SSN</source>
             </equals>
          </block-rule>
       </block-definition>
     <block-definition number="ID000008">
     <block-rule>
              <equals>
                 <field>Enterprise.SystemSBR.Person.DOB</field>
                 <source>Person.DOB</source>
              </equals>
     </block-rule>
     </block-definition>

    Note - Each blocking query must contain one config element, and the config element must contain at least one block definition.


  4. Save and close the file.