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

Defining Master Index Normalization Rules (Repository)

Normalization is a part of the standardization process, and is the process of changing non-standard values to a common, standard value. For example, the first name a person uses might not be their given name, but might be a nickname instead. To ensure that a proper match is made between first names, nicknames are normalized based on a configurable list. For example, the common value for “Liz” and “Elizabeth” would be “Elizabeth”.

Normalization is defined in the Match Field file. You can define normalization by either using the Configuration Editor or modifying the XML file directly. The changes you make on the Normalization page of the Configuration Editor are reflected in the normalization structures of the Match Field file. The Configuration Editor provides a simplified way of defining normalization.

Perform any of the following tasks to define normalization:

Defining a Master Index Field to be Normalized (Repository)

When you define a field for normalization, you define which field contains the data that needs to be normalized and which field will contain the normalized data. You can also specify one or more national domains to use for normalization. A sample normalization structure for the XML file appears at the end of these instructions.

To Define a Field to be Normalized (Configuration Editor)

  1. In the Projects window, right-click the master index application you want to modify, and then click Open.
  2. If the Configuration Editor dialog box appears, click Edit to check out the listed files.

    The Configuration Editor appears.

  3. In the object structure in the left pane, add the field that will contain the normalized value.

    For more information, see Adding a Field to the Master Index Object Structure (Repository).

  4. Click the Normalization tab.

    The Normalization page appears.

  5. Click Add.

    The Normalized Field dialog box appears.

  6. Enter or select a value for each of the fields described in Master Index Normalization and Standardization Structure Properties (Repository).
  7. To specify a national domain for the type of data being standardized, do the following:
    1. In the Locale Field Name field, select the field whose value in incoming records will indicate which variant to use.
    2. In the Locale Codes section, click Add.
    3. On the dialog box that appears, enter values in the fields described in Master Index Locale Codes Properties (Repository).
    4. Click OK.

      If you selected the multiple domain selector, you can add multiple national domains; otherwise, you can add one default national domain and one field-defined national domain.

  8. On the Normalized Field dialog box, click OK.

    The new normalization definition appears in the list.

  9. On the Configuration Editor toolbar, click Save.

To Define a Field to be Normalized (XML Editor)

Before You Begin

In the Object Definition file, create the field that will contain the new normalized value. For more information, see Adding a Field to the Master Index Object Structure (Repository).

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

    The file opens in the NetBeans XML editor.

  2. In the structures-to-normalize element, create and name a new group element.

    Make sure the new element falls within the structures-to-normalize element, but outside any existing group tags.

  3. In the new group element, define the standardization-type and domain-selector attributes (these are described in Master Index Normalization and Standardization Structure Properties (Repository).
  4. If you specified the multiple domain selector for the domain-selector attribute, do the following:
    1. In the group element, create a locale-field-name element and a locale-maps element (described in Master Index Normalization and Standardization Structure Properties (Repository) and Master Index Locale Codes Properties (Repository)).
    2. For each variant you want to use, define a locale-codes, value, and locale element in the locale-maps element (described in Master Index Locale Codes Properties (Repository)).
  5. To specify the source fields to normalize, do the following:
    1. Create a new unnormalized-source-fields element in the group element.
    2. Create a source-mapping element in the new unnormalized-source-fields element.
    3. Define the unnormalized-source-field-name and standardized-object-field-id elements (these are described inMaster Index Normalization and Standardization Structure Properties (Repository)).
  6. To map the normalized data to destination fields, do the following:
    1. Create a new normalization-targets element under the unnormalized-source-fields element that defines the field to map.
    2. Create a target-mapping element in the new normalization-targets element.
    3. Define the standardized-object-field-id and standardized-target-field-name elements (these are described in Master Index Normalization and Standardization Structure Properties (Repository)).
  7. Save and close the file.

Example 2 First and Last Name Normalization

<structures-to-normalize>
         <group standardization-type="PersonName" domain-selector=
          "com.stc.eindex.matching.impl.MultiDomainSelector">
            <locale-field-name>Person.PobCountry</locale-field-name>
            <locale-maps>
              <locale-codes>
                <value>GB</value>
                <locale>UK</locale>
              </locale-codes>
              <locale-codes>
                <value>UNST</value>
                <locale>US</locale>
              </locale-codes>
              <locale-codes>
                <value>Default</value>
                <locale>US</locale>
              </locale-codes>
            </locale-maps>
            <unnormalized-source-fields>
               <source-mapping>
                  <unnormalized-source-field-name>
                   Person.Alias[*].FirstName
                  </unnormalized-source-field-name>
                  <standardized-object-field-id>FirstName
                  </standardized-object-field-id>
               </source-mapping>
               <source-mapping>
                  <unnormalized-source-field-name>
                   Person.Alias[*].LastName
                  </unnormalized-source-field-name>
                  <standardized-object-field-id>LastName
                  </standardized-object-field-id>
               </source-mapping>
            </unnormalized-source-fields>
            <normalization-targets>
               <target-mapping>
                  <standardized-object-field-id>FirstName
                  </standardized-object-field-id>
                  <standardized-target-field-name>
                     Person.Alias[*].StdFirstName
                  </standardized-target-field-name>
               </target-mapping>
               <target-mapping>
                  <standardized-object-field-id>LastName
                  </standardized-object-field-id>
                  <standardized-target-field-name>
                     Person.Alias[*].StdLastName
                  </standardized-target-field-name>
               </target-mapping>
            </normalization-targets>
         </group>

Master Index Normalization and Standardization Structure Properties (Repository)

The following table lists and describes the Configuration Editor fields and their corresponding XML elements that define the fields to be normalized or standardized in the master index application.

You can specify one or more national domains for data to be standardized. For a single national domain, you only need to specify the national domain if you need to standardize data that is not from the United States. If you are standardizing data from multiple countries, use the multiple domain selector. This requires that one field in the object structure identify which national domain to use for each field that will be standardized. For example, the value of the Country field in a system record could be used to tell the standardization engine which national domain to use for a particular set of data. If you specified the multiple domain selector in the domain-selector element, you must also define the identifying field and then map the values that can be populated into that field to their corresponding national domain.

The following rules apply to the multiple domain selector:

For more information about the fields and elements described in the following table, see Understanding the Oracle Java CAPS Match Engine.

Configuration Editor Field
XML File Element or Attribute
Description
Type
standardization-type
The type of standardization to perform on the source fields. This is specific to the type of data being processed.
Domain Selector
domain-selector
The Java class used by the standardization engine to determine the national domain of the data being processed. For the Oracle Java CAPS Match Engine, the following classes can be specified. If no selector is specified, the default is US. The Oracle Java CAPS Match Engine supports Australian, French, United Kingdom, and United States national domains. Possible values for this field are:
  • com.stc.eindex.matching.impl. SingleDomainSelectorAU

  • com.stc.eindex.matching.impl. SingleDomainSelectorFR

  • com.stc.eindex.matching.impl. SingleDomainSelectorUK

  • com.stc.eindex.matching.impl. SingleDomainSelectorUS

  • com.stc.eindex.matching.impl. MultipleDomainSelector

Locale Field Name
locale-field-name
The ePath to an identifying field in the object structure that identifies which of the defined national domains (element locale-codes) to use. If no field is specified for the Oracle Java CAPS Match Engine, the standardization engine defaults to the United States, regardless of whether any national domains are defined. This field must be contained in the object that contains the fields defined for normalization in this structure.
Unnormalized Source
unnormalized-source- field-name
The field that contains the data to be normalized. The field is designated by its ePath (for example, Person.FirstName).
Unnormalized Standardization Component
standardized-object- field-id
An identification code that identifies the field to normalize to the standardization engine. This ID is specific to the standardization engine and must correspond to a standardization component defined by that engine.
Normalized Standardization Component
standardized-object- field-id
An identification code that identifies the field that contains the normalized data to the standardization engine. This is specific to the standardization engine in use and must correspond to a standardization component defined by that engine.
Normalized Target
standardized-target- field-name
The field that will store the normalized data. The field is designated by its ePath (for example, Person.Alias[*].StdLastName).

Master Index Locale Codes Properties (Repository)

The following table lists and describes the Configuration Editor fields and XML elements that define a national domain for normalization or standardization. In the XML file, each value and locale pair are defined within a locale_codes element. A list of locale_codes elements can be defined in the locale_maps element.

Configuration Editor Field
XML File Element or Attribute
Description
Value
value
A value that indicates to the standardization engine which national domain to use to standardize the data. When the value is contained in the Locale Field Name field (or the locale-field-name element), the standardization engine uses the corresponding Locale field (or locale element) to determine the national domain. To specify a default national domain, enter “Default”.
Locale
locale
A code indicating which national domain to use to standardize data when the identifying field value in a transaction matches the corresponding Value field or element. Select one of the following codes.
  • AU - Australia

  • FR - France

  • UK - United Kingdom

  • US - United States

Modifying a Master Index Normalization Definition (Repository)

Once you create a normalization definition, you can modify it as needed. Use caution when modifying normalization definitions once a system is in production. This can cause inconsistent match results.

To Modify a Normalization Definition (Configuration Editor)

  1. In the Projects window, right-click the master index application you want to modify, and then click Open.
  2. If the Configuration Editor dialog box appears, click Edit to check out the listed files.

    The Configuration Editor appears.

  3. Click the Normalization tab.

    The Normalization page appears.

  4. In the Normalization Mappings list, click the definition you want to modify.
  5. Click Edit.
  6. Do any of the following:
    • Modify any of the fields described in Master Index Normalization and Standardization Structure Properties (Repository).
    • To modify a national domain, select the national domain under Locale Codes, and then click Edit. Modify either field on the dialog box that appears.
    • To remove a national domain, select the national domain under Locale Codes, and then click Remove. Click Yes on the dialog box that appears.
    • Click OK.
  7. On the Configuration Editor toolbar, click Save.

To Modify a Normalization Structure (XML Editor)

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the structures-to-normalize element in the StandardizationConfig element.
  3. To modify the normalization type, change the value of the standardization-type attribute.
  4. To change the national domain, change the value of the domain-selector element as described in Master Index Normalization and Standardization Structure Properties (Repository).
  5. To modify an existing source field, scroll to the unnormalized-source-fields element in the appropriate group element, and then change the value of any source field elements (these are described in Master Index Normalization and Standardization Structure Properties (Repository)).
  6. To modify an existing destination field, scroll to the normalization-targets element in the appropriate group element, and then change the value of any target field elements (these are described in Master Index Normalization and Standardization Structure Properties (Repository)).
  7. Save and close the file.

Deleting a Master Index Normalization Definition (Repository)

If a defined normalization structure is not needed, you can delete the normalization structure from the standardization configuration. If no data requires normalization, you can delete all normalization structures. It is not recommend that you delete a normalization definition once a system is in production. This can cause inconsistent match results.

To Delete a Normalization Definition

  1. In the Projects window, right-click the master index application you want to modify, and then click Open.
  2. If the Configuration Editor dialog box appears, click Edit to check out the listed files.

    The Configuration Editor appears.

  3. In the Configuration Editor toolbar, click the Normalization tab.

    The Normalization page appears.

  4. In the Normalization Mappings list, click the definition you want to delete.
  5. Click Remove.
  6. On the Configuration Editor toolbar, click Save.

To Delete a Normalization Structure

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the structures-to-normalize element in the StandardizationConfig element.
  3. Do either of the following:
    • To delete an existing normalization structure, delete all text between and including the group element that defines the structure.
    • To specify that no objects require normalization, delete all text between, but not including, the structures-to-normalize element.
  4. Save and close the file.