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)
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)
You can modify the configuration of the fields and objects to specify how they appear on the EDM pages by modifying the Enterprise Data Manager file. You can perform any of the following actions to customize the general appearance of the EDM. 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 EDM.
You can define additional objects for the EDM as long as those objects are defined in the Object Definition file. Each object can only contain the fields that are also defined for that object in the Object Definition file. If you add objects to the object structure using the Configuration Editor, the new objects are automatically added to the the Enterprise Data Manager file and you do not need to perform these steps.
The file opens in the NetBeans XML editor.
<node-Phone> </node-Phone>
display-order – The order in which the child object types are displayed in the tree view pane on the EDM pages.
merge-must-delete – An indicator of whether EDM users must specify which the instances of the child object type to retain during a system record merge. Specify false to allow EDM users to select the child objects to retain or to accept the default objects (the default objects are those in the destination system). Specify true to force the user to select the child objects to retain. This allows you to hide certain child object types on the EDM while forcing the user to specify which visible child objects to retain.
For example:
<node-Phone display-order="3" merge-must-delete="false"> </node-Phone>
Once an object is defined in the Enterprise Data Manager file, you can modify the name or display order. Only modify the name of an object if you modify the corresponding object name in the Object Definition file 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 the Enterprise Data Manager file is automatically updated as well.
The file opens in the NetBeans XML editor.
For example:
<node-Alias display-order="2">
Once an object is defined in the Enterprise Data Manager file, you can remove the object. If the object remains defined in the Object Definition file, then the object is still a part of the enterprise record, but does not appear on the EDM. Before removing an object from the the Enterprise Data Manager file, 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 the Enterprise Data Manager file.
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-Phone display-order="3" merge-must-delete="false"> <field-PhoneType> <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-PhoneType> <field-Phone> <display-name>Phone</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 the Enterprise Data Manager file, but the field must correspond with a field defined for that object in the Object Definition file. Only the fields defined in the Enterprise Data Manager file appear on the EDM windows. If you add a field to the object structure using the Configuration Editor, it is automatically added to the Enterprise Data Manager file.
The file opens in the NetBeans XML editor.
For example:
<node-Person> <field-LastName> </field-LastName> </node>
For example:
<field-LastName> <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-LastName>
The following table lists and describes the XML elements that define the fields that appear on the Enterprise Data Manager.
|
If a field is defined for an object in the Enterprise Data Manager file, that field appears on the EDM windows. If there are any fields defined in the object structure that you do not want to display on the EDM, you can remove the field definition from the Enterprise Data Manager file. If you remove a field from the object structure using the Configuration Editor, it is automatically removed from the Enterprise Data Manager file.
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 the Enterprise Data Manager file, you can change the name that appears on the EDM 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 the Enterprise Data Manager file, 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 the Enterprise Data Manager file.
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 the Enterprise Data Manager file, you can change the number of characters that can be entered for the field in the EDM. You can also specify whether to automatically enter punctuation into a field on the EDM, but remove the punctuation in the database. If you modify the field's length and format in the object structure using the Configuration Editor, the Enterprise Data Manager file 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 the Object Definition file.
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. For information about input and value masks, see EDM Field Configuration Elements.
Each field on the EDM 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 the Object Definition file and in the database. If you modify a field's data type in the object structure using the Configuration Editor, the Enterprise Data Manager file 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 the Enterprise Data Manager file must match its key type status in the Object Definition file. If you modify a field's key type status in the object structure using the Configuration Editor, the Enterprise Data Manager file 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 EDM 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 the Enterprise Data Manager file are predefined based on the information you provided when you created the object structure definition (the Object Definition file). The relationship structure in the Enterprise Data Manager file should match that of the Object Definition file.
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 system-display-name-overrides 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”. If the value of either of the sub-elements is missing, the label names also default to “Local ID”.
The file opens in the NetBeans XML editor.
local-id-header – The name to use for the header label of the local ID search section of the EDM Lookup window.
local-id – The name to use for all fields and columns containing local IDs. In fields where the local ID label is abbreviated to “LID1” or “LID2”, the name becomes local-id1 or local-id2 (where local-id is the value specified for this element).
For example:
<gui-definition> <system-display-name-overrides> <local-id-header>System Identifier</local-id-header> <local-id>System ID</local-id> </system-display-name-overrides> ...