JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Configuring Oracle Java CAPS Master Indexes (Repository)     Java CAPS Documentation
search filter icon
search icon

Document Information

Configuring Oracle Java CAPS Master Indexes (Repository)

Related Topics

Master Index Configuration Overview (Repository)

About the Master Index Configuration Files (Repository)

Object Definition

Candidate Select

Match Field

Threshold

Best Record

Field Validation

Security

Enterprise Data Manager

Modifying the Master Index XML Files Directly (Repository)

Using the Master Index Configuration Editor-Repository

Object Definition File

Candidate Select File

Threshold File

Match Field File

Best Record File

Field Validation File

Enterprise Data Manager File

Match Configuration File (matchConfigFile.cfg)

Maintaining Version Control in the Master Index (Repository) Configuration Files

Checking Configuration Files Out With the Configuration Editor-Repository

Checking Configuration Files In With the Configuration Editor-Repository

Working With the XML Editor

Saving a Configuration File to the Repository

Validating XML Files

Copying, Cutting, and Pasting Files

Configuring the Master Index Object Structure (Repository)

Adding an Object to the Master Index Object Structure (Repository)

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 (Repository)

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 (Repository)

To Delete an Object (Configuration Editor)

To Delete an Object (XML Editor)

Adding a Field to the Master Index Object Structure (Repository)

To Add a Field (Configuration Editor)

To Add a Field (XML Editor)

Deleting a Field from the Master Index Object Structure (Repository)

To Delete a Field (Configuration Editor)

To Delete a Field (XML Editor)

Modifying Master Field Properties (Repository)

To Modify Field Properties (Configuration Editor)

To Modify Field Properties (XML Editor)

Defining Relationships Between Master Index Objects (Repository)

To Define Object Relationships (XML Editor)

Master Index Field Properties and Name Restrictions (Repository)

Master Index Field Name Restrictions (Repository)

Master Index Configuration Editor Field Properties (Repository)

Master Index Field Property Elements (Repository)

Creating a Master Index Basic Query (Repository)

To Create a Basic Query (Configuration Editor)

To Create a Basic Query (XML Editor)

Master Index Query Builder Dialog Box Fields and XML Elements (Repository)

Creating Master Index Blocking Queries (Repository)

To Create a Blocking Query (Configuration Editor)

To Create a Blocking Query (XML Editor)

Master Index Query Block Fields and XML Elements (Repository)

Modifying Master Index Queries (Repository)

Modifying a Master Index Query (Repository)

To Modify a Basic Query (Configuration Editor)

To Modify a Query (XML Editor)

Adding a Query Block to a Master Index Query (Repository)

To Add a Query Block (Configuration Editor)

To Add a Query Block (XML Editor)

Modifying a Query Block for a Master Index Query (Repository)

To Modify a Query Block (Configuration Editor)

To Modify a Query Block (XML Editor)

Deleting a Query Block From a Master Index Query (Repository)

To Delete a Query Block (Configuration Editor)

To Delete a Query Block (XML Editor)

Deleting a Master Index Query (Repository)

To Delete a Query (Configuration Editor)

To Delete a Query

Configuring Master Index Processing Options (Repository)

Specifying Master Index Custom Logic Classes (Repository)

To Specify Custom Logic for External System Messages

To Specify Custom Logic for the Enterprise Data Manager

Specifying the Master Index Update Mode (Repository)

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 (Repository)

To Allow Merged Record Updates

To Prevent Merged Record Updates

Specifying the Master Index Blocking Query for Matching (Repository)

To Specify the Blocking Query for Matching

Setting Master Index Blocking Query Options (Repository)

To Set Blocking Query Options

Configuring Matching Parameters (Repository)

Specifying the Master Index Decision Maker Class (Repository)

To Specify the Decision Maker Class

Defining How to Handle Multiple Assumed Matches (OneExactMatch) (Repository)

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) (Repository)

To Allow Same System Records to be Automatically Merged

To Prevent Same System Records From Being Automatically Merged

Specifying the Master Index Duplicate Threshold (Repository)

To Specify the Duplicate Threshold (Configuration Editor)

To Specify the Duplicate Threshold (XML Editor)

Specifying the Master Index Match Threshold (Repository)

To Specify the Match Threshold (Configuration Editor)

To Specify the Match Threshold (XML Editor)

Adding and Deleting Master Index Decision Maker Parameters (Repository)

To Add a New Decision Maker Parameter

To Delete a Decision Maker Parameter

Configuring Master Index EUIDs (Repository)

Specifying the Master Index EUID Generator Class (Repository)

To Specify the EUID Generator Class

Specifying the Master Index EUID Length (Repository)

To Specify the EUID Length

Specifying a Master Index Checksum Length (Repository)

To Specify a Checksum Length

Specifying the Master Index Chunk Size (Repository)

To Specify the Chunk Size

Adding and Deleting Master Index EUID Generator Parameters (Repository)

To Add EUID Generator Parameters

To Delete EUID Generator Parameters

Defining Master Index Normalization Rules (Repository)

Defining a Master Index Field to be Normalized (Repository)

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 (Repository)

Master Index Locale Codes Properties (Repository)

Modifying a Master Index Normalization Definition (Repository)

To Modify a Normalization Definition (Configuration Editor)

To Modify a Normalization Structure (XML Editor)

Deleting a Master Index Normalization Definition (Repository)

To Delete a Normalization Definition

To Delete a Normalization Structure

Defining Master Index Standardization Rules (Repository)

Defining Master Index Fields to be Standardized (Repository)

To Define Fields to be Standardized (Configuration Editor)

To Define Fields to be Standardized (XML Editor)

Master Index Standardization Source and Target Field Elements (Repository)

Modifying a Master Index Standardization Definition (Repository)

To Modify a Standardization Definition (Configuration Editor)

To Modify a Standardization Definition (XML Editor)

Deleting a Master Index Standardization Definition (Repository)

To Delete a Standardization Definition (Configuration Editor)

To Delete a Standardization Definition (Configuration Editor)

Defining Phonetic Encoding for the Master Index (Repository)

Defining Master Index Fields for Phonetic Encoding (Repository)

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 (Repository)

Modifying a Master Index Phonetic Encoding Definition (Repository)

To Modify a Phonetic Encoding Definition (Configuration Editor)

To Modify a Phonetic Encoding Definition (XML Editor)

Deleting a Master Index Phonetic Encoding Definition (Repository)

To Delete a Phonetic Encoding Definition (Configuration Editor)

To Delete a Phonetic Encoding Definition (XML Editor)

Defining a Master Index Phonetic Encoder (Repository)

To Define a Phonetic Encoder (Configuration Editor)

To Define a Phonetic Encoder (XML Editor)

Master Index Encoder Elements and Types (Repository)

Modifying a Master Index Phonetic Encoder (Repository)

To Modify a Phonetic Encoder (Configuration Editor)

To Modify a Phonetic Encoder (XML Editor)

Deleting a Master Index Phonetic Encoder (Repository)

To Delete a Phonetic Encoder (Configuration Editor)

To Delete a Phonetic Encoder (XML Editor)

Defining the Master Index Match String (Repository)

Creating the Master Index Match String (Repository)

To Create the Match String (Configuration Editor)

To Create the Match String (XML Editor)

Modifying the Master Index Match String (Repository)

To Modify the Match String (Configuration Editor)

To Modify the Match String (XML Editor)

Defining how Master Index Query Blocks are Processed (Repository)

To Specify the Block Picker

To Specify the Pass Controller Class

Defining the Master Index Survivor Calculator (Repository)

Specifying the Master Index Survivor Helper (Repository)

To Specify the Survivor Helper

Specifying a Master Index Default Survivor Strategy (Repository)

To Specify a Default Survivor Strategy

Configuring the Default Survivor Strategy

Master Index Default Survivor Strategy Parameter Elements (Repository)

Defining the Master Index Single Best Record Structure (Repository)

To Specify a Candidate Field

Deleting Candidate Fields

Defining a Master Index Survivor Strategy for a Field or Object (Repository)

To Define a Survivor Strategy for a Field

Defining Master Index Custom Weighted Strategies (Repository)

Defining Custom Weighted Strategies

Configuring Weighted Strategies

Modifying Weighted Calculator Parameters

Deleting Weighted Calculator Parameters

Master Index Weighted Calculator Parameter Elements (Repository)

Configuring Master Index Update Policies (Repository)

Defining Master Index Update Policies (Repository)

To Define Update Policies

Setting the Master Index Update Policy Flag (Repository)

To Set the Update Policy Flag

Defining Custom Field Validations for the Master Index (Repository)

To Implement a Validation Rule

Configuring the Match Engine (Repository)

Specifying a Match Engine for the Master Index (Repository)

To Configure the Match Engine

Configuring the Comparison Functions for a Master Index Application (Repository)

To Configure the Comparison Functions (Configuration Editor)

To Configure the Comparison Functions (Text Editor)

Match Comparator Configuration Properties for Oracle Java CAPS Master Index (Repository)

Configuring the Standardization Engine (Repository)

Specifying a Standardization Engine for the Master Index (Repository)

To Specify the Standardization Engine

Modifying Master Index Standardization Files (Repository)

To Modify Standardization Data Configuration Files

Loading Standardization Files to a Master Index Application (Repository)

To Load Standardization Files

Configuring the Master Index EDM Appearance (Repository)

Adding Objects to the EDM

To Add an Object to the EDM

Modifying EDM Objects

To Modify an EDM Object

Deleting Objects From the EDM

To Delete an Object

Adding Fields to the EDM

To Define New Fields

EDM Field Configuration Elements

Removing Fields From the EDM

To Remove a Field From the EDM

Modifying EDM Field Display Options

To Modify a Field's Display Options

Specifying a Drop-Down List for an EDM Field

To Specify a Drop-Down List

Specifying an EDM Field's Length and Format

To Modify a Field's Length and Format

Modifying an EDM Field's Data Type

To Modify the Data Type

Defining Key Fields for an Object (Repository)

To Modify the Key Status

Masking Field Values on the EDM

To Mask Field Values on the EDM

Defining EDM Object Relationships (Repository)

To Define Relationships

Defining EDM Local ID Labels (Repository)

To Define Local ID Labels

Configuring the Master Index EDM Search Pages (Repository)

Specifying Standard EDM Search Page Properties (Repository)

To Specify Standard Search Page Properties

Creating a Search Page for the EDM (Repository)

Step 1: Define the Search Page

Step 2: Define the Search Fields

Step 3: Specify Search Options

EDM Search Page Definition Elements

EDM Search Field Definition Elements

EDM Search Option Elements

Modifying a Search Page on the EDM (Repository)

Modifying a Search Page Definition

Modifying Search Fields

Modifying Search Options

Configuring Master Index EDM Page Layouts (Repository)

Specifying the Initial View for the EDM (Repository)

To Specify the Initial View

Configuring the EDM Search Results Page (Repository)

To Configure the Search Results Page

Configuring the EDM View/Edit Page (Repository)

To Configure the View/Edit Page

Configuring the EDM Create System Record Page (Repository)

To Configure the Create EO Page

Configuring the EDM History Page (Repository)

To Configure the History Page

Configuring the EDM Match Review Page (Repository)

To Configure the Match Review Page

Configuring the EDM Reports and Reports Page (Repository)

Configuring the Reports Page

Configuring Reports

EDM Reports and Reports Page Configuration Elements (Repository)

Configuring the EDM Audit Log Pages (Repository)

To Configure the Audit Log Pages

Configuring Master Index EDM Implementation Information (Repository)

Specifying the Master Controller JNDI Class (Repository)

To Specify the Master Controller JNDI Class

Specifying the Master Index Report Generator JNDI Class (Repository)

To Specify the Report Generator JNDI Class

Specifying Master Index Validation Services (Repository)

To Specify the Validation Service

Setting Master Index Debug Options (Repository)

To Set Debug Options

Specifying a Master Index Field Masking Class (Repository)

To Specify a Field Masking Class

Configuring Master Index Processing Options (Repository)

The Master Controller defines how transactions are processed, and is configured in the Threshold file. 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 (Repository)

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 EDM. 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 the Threshold file.
  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.stc.eindex.user.CustomProcessing</logic-class>
  3. Save and close the file.

To Specify Custom Logic for the Enterprise Data Manager

  1. In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Threshold file.
  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 EDM logic.

    For example:

    <logic-class-gui>com.stc.eindex.user.CustomEDM</logic-class-gui>
  3. Save and close the file.

Specifying the Master Index Update Mode (Repository)

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 the Threshold file.
  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 the Threshold file.
  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 (Repository)

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 the Threshold file.
  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 the Threshold file.
  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 (Repository)

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 the Candidate Select file. 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 the Threshold file.
  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 the Candidate Select file.


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

Setting Master Index Blocking Query Options (Repository)

Key and value pairs are designed to fine-tune the operation of custom blocking queries. In the default blocking queries defined in the Candidate Select file, 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 the Threshold file.
  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.