Skip Navigation Links | |
Exit Print View | |
Oracle Java CAPS Master Index Configuration Guide Java CAPS Documentation |
Oracle Java CAPS Master Index Configuration Guide
Master Index Configuration Overview
About the Master Index Configuration Files
Modifying the Master Index XML Files Directly
Using the Master Index Master Index Configuration Editor
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)
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)
To Delete a Query (Configuration Editor)
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
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
Specifying a Master Index Checksum Length
Specifying the Master Index 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 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
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
Configuring Master Index Update Policies
Defining Master Index Update Policies
Setting the Master Index Update Policy Flag
Defining Custom Field Validations for the Master Index
To Implement a Validation Rule
Specifying a Match Engine for the Master Index
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
Deleting Objects From the MIDM
MIDM Field Configuration Elements
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
Specifying an MIDM Field's Length and Format
To Modify a Field's Length and Format
Modifying an MIDM Field's Data Type
Defining Key Fields for an Object
Masking Field Values on the MIDM
To Mask Field Values on the MIDM
Configuring the Master Index MIDM Pages
Specifying the Initial View for the MIDM
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 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
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
You can modify the configuration of the fields and objects to specify how they appear on the MIDM pages by modifying midm.xml. You can perform any of the following actions to customize the general appearance of the MIDM. Though some appearance options can be configured using the Configuration Editor, it is best to modify the XML file directly.
Perform any of the following tasks to configure the appearance of the MIDM.
You can define additional objects for the MIDM as long as those objects are defined in object.xml. Each object can only contain the fields that are also defined for that object in object.xml. If you add objects to the object structure using the Configuration Editor, the new objects are automatically added to the midm.xml and you do not need to perform these steps.
The file opens in the NetBeans XML editor.
name – The name of the object.
display-order – The order in which the child object types are displayed on the MIDM pages.
For example:
<node> <name>Phone</name> <display-order>3</display-order> </node>
Note - You might need to renumber any existing objects to keep the numbering sequential.
Once an object is defined in midm.xml, you can modify the name or display order. Only modify the name of an object if you modify the corresponding object name in object.xml and the remaining configuration files. Do not change the parent object name. If you modify an object in the object definition on the Configuration Editor, the midm.xml is automatically updated as well.
The file opens in the NetBeans XML editor.
Note - If you change an object name, modify the name in the relationships section as well.
Once an object is defined in midm.xml, you can remove the object. If the object remains defined in object.xml, then the object is still a part of the enterprise record, but does not appear on the MIDM. Before removing an object from the midm.xml, make sure none of its fields are required in order to create a new record. If you delete an object using the Configuration Editor, the object is automatically deleted from midm.xml.
The file opens in the NetBeans XML editor.
Using the sample below, to delete the Phone object, delete all the text in the sample.
<node> <name>Phone</name> <display-order>3</display-order> <field> <name>PhoneType</name> <display-name>Phone Type</display-name> <display-order>1</display-order> <max-length>8</max-length> <gui-type>MenuList</gui-type> <value-list>PHONTYPE</value-list> <value-type>string</value-type> <key-type>true</key-type> </field> <field> <name>Phone</name> <display-name>PhoneNumber</display-name> <display-order>2</display-order> <max-length>20</max-length> <gui-type>TextBox</gui-type> <value-type>string</value-type> <input-mask>(DDD)DDD-DDDD</input-mask> <value-mask>xDDDxDDDxDDDD</value-mask> </field> </node>
You can define new fields for an object in midm.xml, but the field must correspond with a field defined for that object in object.xml. Only the fields defined in midm.xml appear on the MIDM windows. If you add a field to the object structure using the Configuration Editor, it is automatically added to midm.xml.
The file opens in the NetBeans XML editor.
For example:
<field <name>LastName</name> <display-name>LastName</display-name> <display-order>2</display-order> <max-length>40</max-length> <gui-type>TextBox</gui-type> <value-type>string</value-type> <is-sensitive>false</is-sensitive> <key-type>false</key-type> </field>
The following table lists and describes the XML elements that define the fields that appear on the Master Index Data Manager.
|
If a field is defined for an object in midm.xml, that field appears on the MIDM windows. If there are any fields defined in the object structure that you do not want to display on the MIDM, you can remove the field definition from midm.xml. If you remove a field from the object structure using the Configuration Editor, it is automatically removed from midm.xml.
Note - If you remove a unique key type field, you must write a custom plug-in that will automatically populate a value into the field in order to meet unique key type field constraints.
The file opens in the NetBeans XML editor.
Once a field is defined for an object in midm.xml, you can change the name that appears on the MIDM for that field, the location of the field, and the type for the field (such as text box, menu list, and so on).
The file opens in the NetBeans XML editor.
For example:
<display-name>Last Name</display-name>
For example:
<display-order>1</display-order>
Note - If you change the order of one field, you must change the order of at least one other field to maintain sequential numbering. For example, if you change a field’s location from “2” to “1”, you must then change the location of the field originally specified for location 1.
For example:
<gui-type>TextBox</gui-type>
Note - You can enter TextBox (for a standard field), MenuList (for a field whose value must be selected from a drop-down list), or TextArea (for a long field that requires a scrollbar).
Once a field is defined for an object in midm.xml, you can specify or change the name of the drop-down list for the field. If you modify the Code Module for the field in the Configuration Editor, the drop–down list is automatically updated in midm.xml.
The file opens in the NetBeans XML editor.
If the element does not exist for the field, create a new value-list element. For example:
<value-list>STATE</value-list>
Note - The value of the gui-type element for the field must be “MenuList” if you specify a drop-down list. The value-list element must match a code column value in the sbyn_common_header database table unless the drop-down list is populated by information in the sbyn_user_code table (as they might be for auxiliary IDs). In this case, the value-list element must match a code_list column value in sbyn_user_code.
Once a field is defined for an object in midm.xml, you can change the number of characters that can be entered for the field in the MIDM. You can also specify whether to automatically enter punctuation into a field on the MIDM, but remove the punctuation in the database. If you modify the field's length and format in the object structure using the Configuration Editor, midm.xml is automatically updated as well.
Note - Field length here is constrained by the length of the database column containing the field and the length defined in object.xml. This applies to the max-length element and the input and value masks.
The file opens in the NetBeans XML editor.
For example:
<max-length>100</max-length>
If these element do not exist for the field, create new input-mask and value-mask elements. For example:
<input-mask>(DDD)DDD-DDDD</input-mask> <value-mask>xDDDxDDDxDDDD</value-mask>
Note - If an input mask is defined, in most cases a value mask must also be defined. If the input mask exceeds the length specified by the max-length element, update the max-length element to match. For information about input and value masks, see MIDM Field Configuration Elements.
Each field on the MIDM requires a specific type of data to be entered. For example, name fields generally require a data string and date fields require a valid date or numeric characters. The type of data defined for each field must correspond with the field type defined for that field in object.xml and in the database. If you modify a field's data type in the object structure using the Configuration Editor, midm.xml is automatically updated as well.
The file opens in the NetBeans XML editor.
For example:
<value-type>string</value-type>
You can specify that a certain field or combination of fields be unique in a system object or SBR. An example of a unique fields would be the address type if only one address of each type is allowed. A field’s key type status in midm.xml must match its key type status in object.xml. If you modify a field's key type status in the object structure using the Configuration Editor, midm.xml is automatically updated as well.
The file opens in the NetBeans XML editor.
For example:
<key-type>false</key-type>
You can specify that the values of certain fields be hidden on the MIDM from users without the appropriate access permissions. You can create a custom plug-in that uses the value of the VIP Flag field to determine whether the values of specified fields are hidden (typically in records with a VIP status of “VIP” or “Employee”). In records with any other VIP status, the field values would be visible regardless of whether the field is marked for masking.
This option is only available if the object-sensitive-plug-in-class element in the impl-details section is populated with the custom plug-in class (by default, this element is empty).
Note - To mask field values, you need to define a custom plug-in to implement the masking rules.
The file opens in the NetBeans XML editor.
If the element does not exist for the field, create a new is-sensitive element. For example:
<is-sensitive>true</is-sensitive>
Note - The is-sensitive element must appear before the key-type element in the field definition.
The relationships in midm.xml are predefined based on the information you provided when you created the object structure definition (object.xml). The relationship structure in midm.xml should match that of object.xml.
The file opens in the NetBeans XML editor.
For example:
<relationships> <name>Person</name> <children>Alias</children> <children>Address</children> <children>Phone</children> <children>AuxId</children> </relationships>
The local-id element, which is nested in the gui-definition element, defines alternate names for the local ID headings and labels. The name defined here replaces the default local ID heading and field names on all pages, including the search result column names. This element is optional, and if it does not exist the label names default to “Local ID”.
The file opens in the NetBeans XML editor.