Skip Navigation Links | |
Exit Print View | |
Configuring Oracle Java CAPS Master Indexes (Repository) Java CAPS Documentation |
Configuring Oracle Java CAPS Master Indexes (Repository)
Master Index Configuration Overview (Repository)
About the Master Index Configuration Files (Repository)
Modifying the Master Index XML Files Directly (Repository)
Using the Master Index Configuration Editor-Repository
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
Saving a Configuration File to the Repository
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)
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)
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)
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)
Specifying a Master Index Checksum Length (Repository)
Specifying the Master Index Chunk Size (Repository)
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 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)
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)
Setting the Master Index Update Policy Flag (Repository)
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)
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)
Configuring the Master Index EDM Appearance (Repository)
EDM Field Configuration Elements
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
Specifying an EDM Field's Length and Format
To Modify a Field's Length and Format
Modifying an EDM Field's Data Type
Defining Key Fields for an Object (Repository)
Masking Field Values on the EDM
To Mask Field Values on the EDM
Defining EDM Object Relationships (Repository)
Defining EDM Local ID Labels (Repository)
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
Modifying a Search Page on the EDM (Repository)
Modifying a Search Page Definition
Configuring Master Index EDM Page Layouts (Repository)
Specifying the Initial View for the EDM (Repository)
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)
Configuring the EDM Match Review Page (Repository)
To Configure the Match Review Page
Configuring the EDM Reports and Reports Page (Repository)
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)
The survivor calculator is configured in the Best Record file and defines how field values are populated into the single best record, along with the type of survivor strategy to use for each field. If no strategy is defined for a field, the default survivor strategy is used to populate that field in the SBR. Before you begin to define the survivor calculator, make sure you know which fields to include in the SBR and how those fields should be updated. Typically, all but phonetic and standardized fields are included here.
The survivor calculator can only be configured by modifying the XML file directly. Perform the following tasks to configure the survivor calculator.
Specifying a Master Index Default Survivor Strategy (Repository)
Defining the Master Index Single Best Record Structure (Repository)
Defining a Master Index Survivor Strategy for a Field or Object (Repository)
Defining Master Index Custom Weighted Strategies (Repository)
The survivor helper class determines how to retrieve values from system records and how to set them in the SBR. The default class is com.stc.eindex.survivor.impl.DefaultSurvivorHelper, which uses the ePath method to retrieve and set the values. You can create a custom survivor helper class to support other methods for retrieving and setting values. If you implement a custom survivor helper class, it must extendcom.stc.eindex.survivor.AbstractSurvivorHelper.
The file opens in the NetBeans XML editor.
For example:
<helper-class>com.stc.eindex.survivor.impl.MySurvivorHelper </helper-class>
The default survivor strategy specifies the name of the Java class that defines the survivor calculation strategy to use for most of the fields in the SBR. By defining a default strategy, you do not need to define a strategy for every candidate field; you only need to define a strategy for fields that do not use the default strategy.
Note - If you create a customized class for the default survivor strategy, make sure the class implements com.stc.eindex.survivor.SurvivorStrategyInterface and is accessible by the EJB class loader.
The file opens in the NetBeans XML editor.
For example:
<default-survivor-strategy> <strategy-class>com.stc.eindex.survivor.impl.MySurvivorStrategy </strategy-class> </default-survivor-strategy>
Once you define a default survivor strategy, you might need to specify certain parameters for the strategy. One parameter is required for the WeightedSurvivorStrategy and for the DefaultSurvivorStrategy. If you create a custom strategy, additional parameters can be used.
The file opens in the NetBeans XML editor.
For example:
<default-survivor-strategy> <strategy-class>com.stc.eindex.survivor.impl.MySurvivorStrategy </strategy-class> <parameters> <parameter> <parameter-name>ConfigModuleName</parameter-name> <parameter-type>java.lang.String</parameter-type> <parameter-value>MySurvivorCalculator</parameter-value> </parameter> </parameters> </default-survivor-strategy>
The following table lists and describes the elements that configure the parameters for the default survivor strategy in the Best Record file.
|
In order for a field to be populated in the SBR, that field must be defined in the candidate field list of the survivor helper. By default, all the fields that were specified in the wizard are also defined here. Any candidate fields defined for the SBR must also be defined in the Object Definition file. If you add a field to the object definition, you should also add the field here.
The SBR can only be defined by modifying the XML file directly.
The file opens in the NetBeans XML editor.
For example:
<candidate-definitions> <candidate-field name="Person.LastName"/> <candidate-field name="Person.DateOfBirth"/> <candidate-definitions>
Once a field is defined in the SBR candidate field list, you can delete the field if you do not want to include the field in the SBR. If you delete a field from the object definition, make sure to delete the field here as well.
The file opens in the NetBeans XML editor.
Using the example below, to delete the Religion field, delete the boldface text; to delete the Alias object, delete the plain text.
<candidate-field name="Person.Religion"/> <candidate-field name="Person.Alias[*].*"/> <system-fields> <field-name>LastModified</field-name> </system-fields> <survivor-strategy> <strategy-class>com.stc.eindex.user.MyStrategy </strategy-class> </survivor-strategy> </candidate-field>
Note - Do not delete all candidate fields; at a minimum, the match fields must be defined.
To use a strategy for a specific field other than the strategy defined in the default-survivor-strategy element, you need to specify the new strategy for the appropriate candidate-field element. A candidate-field element can represent a field or child object. You do not need to specify a strategy for any fields that use the default survivor strategy.
The file opens in the NetBeans XML editor.
For example:
<candidate-field name="Person.Alias[*].*"> <survivor-strategy> </survivor-strategy> </candidate-field>
Make sure to specify the fully qualified name of the Java class for the strategy. For example:
<candidate-field name="Person.Alias[*].*"> <survivor-strategy> <strategy-class> com.stc.eindex.survivor.impl.UnionSurvivorStrategy </strategy-class> </survivor-strategy> </candidate-field>
Note - To specify the default survivor strategy for a field, make sure the corresponding candidate-field element does not contain a survivor-strategy element. If you implement a custom strategy class, that class must be defined as a custom plug-in.
The WeightedCalculator element defines the Java class used for weighted survivor calculations. If the weighted calculator is defined for the default-survivor-strategy element, then the strategies you define here are used for all fields for which no specific survivor strategy is defined. The weighted calculator defines a default strategy to use for most fields and specialized strategies to use for specific fields.
Configuring the weighted calculator involves the following tasks.
The WeightedCalculator element defines both default and custom survivor strategies. You can override the default weighted calculator strategy for specific fields by defining custom strategies for those fields in the candidate-field elements of the WeightedCalculator element.
The file opens in the NetBeans XML editor.
For example:
<WeightedCalculator module-name="WeightedSurvivorCalculator" parser-class= "com.stc.eindex.configurator.impl.WeightedCalculatorConfig"> <candidate-field name="Person.DOB"> </candidate-field>
<candidate-field name="Person.DOB"> <parameter> </parameter> <parameter> </parameter> </candidate-field>
<candidate-field name="Person.DOB"> <parameter> <quality>SourceSystem</quality> <preference>CDI</preference> <utility>80.0</utility> </parameter> <parameter> <quality>MostRecentModified</quality> <utility>75.0</utility> </parameter> </candidate-field>
The wizard creates a default weighted strategy that defines a general weighting structure to be used by most fields. Unless custom weighted calculator strategies are defined for a field, the default strategies defined in the default-parameters element are used for each field using the weighted calculator.
The file opens in the NetBeans XML editor.
For example:
<default-parameters> <parameter> <quality>SourceSystem</quality> <preference>CDA</preference> <utility>80.0</utility> </parameter> <parameter> <quality>MostRecentModified</quality> <utility>75.0</utility> </parameter> </default-parameters>
Once a candidate field is specified and custom weighted calculators are defined for the field, you can modify the parameters. You can also modify any existing default weighted calculator parameters.
The file opens in the NetBeans XML editor.
For example:
<parameter> <quality>SourceSystem</quality> <preference>DDI</preference> <utility>60.0</utility> </parameter>
Once default and custom parameters are defined, they can be deleted if necessary. If a candidate field is defined for custom weighted calculations, you can specify that the field use the default weighted calculator instead by removing the entire field from the candidate-fields list.
The file opens in the NetBeans XML editor.
For example, to delete the SourceSystem parameter below, delete the boldface text.
<parameter> <quality>SourceSystem</quality> <preference>CDI</preference> <utility>80.0</utility> </parameter> <parameter> <quality>MostRecentModified</quality> <utility>75.0</utility> </parameter>
Note - At least one parameter must be defined for the default-parameter element; you cannot delete all parameters from this section. You cannot delete all parameters from a candidate field, but you can delete the entire candidate field (see below for more information).
Using the following example, to delete the Person.DOB candidate field from the custom calculator, delete all the text below.
<candidate-field name="Person.DOB"> <parameter> <quality>SourceSystem</quality> <preference>CDI</preference> <utility>80.0</utility> </parameter> <parameter> <quality>MostRecentModified</quality> <utility>75.0</utility> </parameter> </candidate-field>
The following table lists and describes the elements that configure the parameters for the weighted calculator in the Best Record file.
|