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

Configuring Master Index Processing Options

The Master Controller defines how transactions are processed, and is configured in master.xml. You can specify Java classes that insert additional logic into the match process, configure the blocking query to use for matching, define how merged record updates are handled, and specify whether a record’s potential duplicates are reevaluated after it is updated. You can customize the Master Controller by performing any of the following actions.

Specifying Master Index Custom Logic Classes

The logic-class element specifies custom match processing logic for messages coming from external systems. The and logic-class-gui element specifies custom match processing logic for the MIDM. If no custom plug-ins were created to define the custom logic, leave these elements empty. Custom logic classes can only be specified by modifying the XML file directly.

To Specify Custom Logic for External System Messages

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click master.xml.
  2. In the MasterControllerConfig element, change the value of the logic-class element to the name of the custom plug-in that contains the back-end logic.

    For example:

    <logic-class>com.sun.mdm.index.user.CustomProcessing</logic-class>
  3. Save and close the file.

To Specify Custom Logic for the Master Index Data Manager

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click master.xml.
  2. In the MasterControllerConfig element, change the value of the logic-class-gui element to the name of the custom plug-in that contains the MIDM logic.

    For example:

    <logic-class-gui>com.sun.mdm.index.user.CustomMIDM</logic-class-gui>
  3. Save and close the file.

Specifying the Master Index Update Mode

The update-mode element specifies whether potential duplicates are reevaluated for a record each time the record is updated. If you specify that potential duplicates are reevaluated, the reevaluation only occurs when updates are made to fields involved in blocking and matching. The update mode can only be specified by modifying the XML file directly.

To Specify Potential Duplicates be Reevaluated at Each Update

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click master.xml.
  2. In the MasterControllerConfig element, change the value of the update-mode element to Pessimistic.

    For example:

    <update-mode>Pessimistic</update-mode>
  3. Save and close the file.

To Specify Potential Duplicates not be Reevaluated at Each Update

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click master.xml.
  2. In the MasterControllerConfig element, change the value of the update-mode element to Optimistic.

    For example:

    <update-mode>Optimistic</update-mode>
  3. Save and close the file.

Configuring Master Index Merged Record Updates

The merged-record-update element allows you to define whether updates can be made to records with a status of Merged.

To Allow Merged Record Updates

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click master.xml.
  2. In the MasterControllerConfig element, change the value of the merged-record-update element to Enabled.

    For example:

    <merged-record-update>Enabled</merged-record-update>
  3. Save and close the file.

To Prevent Merged Record Updates

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click master.xml.
  2. In the MasterControllerConfig element, change the value of the merged-record-update element to Disabled.

    For example:

    <merged-record-update>Disabled</merged-record-update>
  3. Save and close the file.

Specifying the Master Index Blocking Query for Matching

You need to specify the query that will be used by the master index application to retrieve a candidate selection pool of records that closely match an incoming record and that will be used for probabilistic weighting. The name of the blocking query you specify here must match the name of one of the blocking queries defined in query.xml. You can only specify one blocking query for matching in the master index application.


Note - Modifying the blocking query once your system is in production is not recommended because it can cause issues with data integrity.


To Specify the Blocking Query for Matching

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click master.xml.
  2. Scroll to the execute-match element in the MasterControllerConfig element.
  3. Modify the value of the query-builder name to the name of the blocking query you want to use. For example:
    <execute-match>
     <query-builder name="MY-BLOCKER">
     <option key="key" value="value"/>
     </query-builder>
    </execute-match>

    Note - Make sure the name you specify exactly matches the name of one of the blocking queries defined in query.xml.


  4. Set the blocking query options, as described in Setting Master Index Blocking Query Options.
  5. Save and close the file.

Setting Master Index Blocking Query Options

Key and value pairs are designed to fine-tune the operation of custom blocking queries. In the default blocking queries defined in query.xml, key and value pairs are not used. However, if you create a custom blocking query, you can configure the query to use key and value pairs. The key describes the option, and the value specifies the value of the option.

To Set Blocking Query Options

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click master.xml.
  2. Scroll to the execute-match element.
  3. To specify a key and value pair, modify the values of the key and value attributes in the option element.

    For example:

    <option key="wildcard" value="true"/>
  4. To delete a key and value pair, remove the option element.
  5. Save and close the file.

Defining Master Index Transactional Support

You can define the master index application to distribute transactions across applications, to distribute transactions only within the master index application, or to not use distributed transactions at all. You can define transactional support by using the Configuration Editor or by modifying the XML file directly. When you define transactional support for the master index, make sure to use the appropriate transaction properties for the database connection in the GlassFish Admin Console.

To Configure the Master Index for Local Transactions

  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 Deployment tab.
  3. In the Transaction Mode field, select LOCAL.
  4. On the Configuration Editor toolbar, click Save.
  5. To configure the database connection, launch the application service Admin Console, and do one of the following:
    • If the database connection is already defined, do the following on the Admin Console:
      1. In the left frame, expand Resources > JDBC > Connection Pools.
      2. Select the database connection pool that is defined for your master index application.
      3. On the Edit Connection Pool page, select either javax.sql.DataSource or javax.sql.ConnectionPoolDataSource for the Resource Type and click Save.
    • If the database connection is not already defined, follow the instructions provided in Defining the Database Connection Pools in Oracle Java CAPS Master Index User’s Guide. Select either javax.sql.DataSource or javax.sql.ConnectionPoolDataSource for the connection pool Resource Type.

To Configure the Master Index to Distributed Transactions Across Applications

  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 Deployment tab.
  3. In the Transaction Mode field, select XA (across applications).
  4. On the Configuration Editor toolbar, click Save.
  5. Launch the application server Admin Console (from NetBeans, click the Services tab, expand Servers, right-click the domain, and select View Admin Console).
  6. To configure the database connection, launch the application service Admin Console, and do one of the following:
    • If the database connection is already defined, do the following on the Admin Console:
      1. In the left frame, expand Resources > JDBC > Connection Pools.
      2. Select the database connection pool that is defined for your master index application.
      3. On the Edit Connection Pool page, select javax.sql.XADataSource for the Resource Type and click Save.
    • If the database connection is not already defined, follow the instructions provided in Defining the Database Connection Pools in Oracle Java CAPS Master Index User’s Guide. Select javax.sql.XADataSource for the Resource Type.

To Configure the Master Index for Distributed Transactions Within the Master Index Application Only

  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 Deployment tab.
  3. In the Transaction Mode field, select XA (within application only).
  4. On the Configuration Editor toolbar, click Save.
  5. To configure the database connection, launch the application server Admin Console and do one of the following:
    • If the database connection is already defined, do the following on the Admin Console:
      1. In the left frame, expand Resources > JDBC > Connection Pools.
      2. Select the database connection pool that is defined for your master index application.
      3. On the Edit Connection Pool page, select javax.sql.XADataSource for the Resource Type and click Save.
    • If the database connection is not already defined, follow the instructions provided in Defining the Database Connection Pools in Oracle Java CAPS Master Index User’s Guide. Select javax.sql.XADataSource for the Resource Type.