The master.xml File Structure (Understanding Sun Master Index Configuration Options)

Understanding Sun Master Index Configuration Options

The master.xml File Structure

This topic describes the structure of the XML file, general requirements, and constraints. It also provides a sample implementation.

master.xml File Description

Table 10 lists each element in master.xml and provides a description of each element along with any requirements or constraints for each element.

Table 10 master.xml File Structure


Element/Attribute	Description
MasterControllerConfig	The configuration class for the Manager Service. The attributes define the module name and Java class. The default values should not be changed.
logic-class	A custom plug-in that defines custom processing logic for the execute match functions that can be called from client applications. This element is optional.
logic-class-gui	A custom plug-in that defines custom processing logic for the execute match function that is called from the Master Index Data Manager (MIDM). This element is optional.
update-mode	An indicator of whether to recalculate potential duplicates when a record is updated. Specify Pessimistic to recalculate potential duplicates; specify `Optimistic` to prevent potential duplicate recalculation on updates.
merged-record-update	An indicator of whether records with a status of Merged can be updated. Specify `Enabled` to allow updates of merged records; specify `Disabled` to ensure that records with a Merged status are not updated.
execute-match	Specifies the blocking query to use for match processing.
query-builder	The name of the blocking query to use for match processing. The name must match a query defined in query.xml.
option	Optional parameters for the blocking query. Currently parameters are not used by any predefined blocking queries.
option/key	A parameter for the blocking query.
option/value	The value of the key specified by the corresponding `key` attribute.
transaction	The transaction mode for the master index application. Specify one of the following values: LOCAL – Transactions are not distributed. CONTAINER – Transactions are distributed across applications. BEAN – Transactions are distributed within the master index application.
DecisionMakerConfig	The configuration class for the Decision Maker. The attributes define the module name and Java class. The default values should not be changed.
decision-maker-class	The Java class that contains the methods used by the Decision Maker class. The default value, `com.sun.mdm.index.decision.impl.DefaultDecisionMaker`, should not need to be changed, but you can implement a custom Decision Maker class. The default class accepts the parameters described below.
parameters	A list of parameters for the Decision Maker class.
parameter	A definition of a Decision Maker parameter. The `parameters` element can contain multiple `parameter` elements, each defining one parameter.
description	A brief description of the parameter. This element is optional.
parameter-name	The name of the parameter. The default Decision Maker class takes the following parameters (see Decision Makerfor more information about these parameters). OneExactMatch - A Boolean indicator of whether an assumed match is made when there are more than one record above the match threshold. SameSystemMatch - A Boolean indicator of whether an assumed match can be made between two records that originate from the same external system. DuplicateThreshold - The lowest match weight at which two records are considered to be potential duplicates. MatchThreshold - The lowest match weight at which two records are assumed to be a match of one another.
parameter-type	The type of parameter. Valid values are `java.lang.Long, java.lang.Short`, `java.lang.Byte`, `java.lang.String`, `java.lang.Integer`, `java.lang.Boolean`, `java.lang.Double`, or `java.lang.Float`.
parameter-value	The value of the parameter. For `OneExactMatch` and `SameSystemMatch`, this must be a Boolean value. For `MatchThreshold` and `DuplicateThreshold`, this must be a Float value.
EuidGeneratorConfig	The configuration class for the EUID Generator. The attributes define the module name and Java class. The default values should not be changed.
euid-generator-class	The Java class used by the master index application to generate new EUIDs. The default class is `com.sun.mdm.index.idgen.impl.DefaultEuidGenerator`, which assigns sequential EUIDs based on the three parameters described below.
parameters	A list of parameters for the EUID Generator class.
parameter	A parameter definition. The `parameters` element can contain multiple `parameter` elements, each defining one parameter.
description	A brief description of the parameter. This element is optional.
parameter-name	The name of the parameter. The default EUID Generator class takes the following parameters (see EUID Generator for more information about these parameters). IdLength - The length of the EUIDs generated by the master index application. CheckSum - The length of the checksum value used to validate EUIDs. ChunkSize - The number of EUIDs allocated to the server at one time.
parameter-type	The type of parameter. Valid values are `java.lang.Long, java.lang.Short`, `java.lang.Byte`, `java.lang.String`, `java.lang.Integer`, `java.lang.Boolean`, `java.lang.Double`, or `java.lang.Float`.
parameter-value	The value of the parameter. For the default parameters, the values are all integers.

master.xml Example

Below is a sample of master.xml configuration.

<MasterControllerConfig module-name="MasterController" parser-class=
 "com.sun.mdm.index.configurator.impl.master.MasterControllerConfiguration">
   <logic-class>CustomMatchLogic</logic-class>
   <logic-class-gui>CustomMatchLogicMIDM</logic-class-gui>
   <update-mode>Pessimistic</update-mode>
   <merged-record-update>Disabled</merged-record-update>
   <execute-match>
      <query-builder name="BLOCKER-SEARCH"></query-builder>
   </execute-match>
</MasterControllerConfig>
<DecisionMakerConfig module-name="DecisionMaker" parser-class=
 "com.sun.mdm.index.configurator.impl.decision.DecisionMakerConfiguration">
   <decision-maker-class>
      com.sun.mdm.index.decision.impl.DefaultDecisionMaker
   </decision-maker-class>
   <parameters>
      <parameter>
         <parameter-name>OneExactMatch</parameter-name>
         <parameter-type>java.lang.Boolean</parameter-type>
         <parameter-value>false</parameter-value>
      </parameter>
      <parameter>
         <parameter-name>SameSystemMatch</parameter-name>
         <parameter-type>java.lang.Boolean</parameter-type>
         <parameter-value>true</parameter-value>
      </parameter>
      <parameter>
         <parameter-name>DuplicateThreshold</parameter-name>
         <parameter-type>java.lang.Float</parameter-type>
         <parameter-value>7.25</parameter-value>
      </parameter>
      <parameter>
         <parameter-name>MatchThreshold</parameter-name>
         <parameter-type>java.lang.Float</parameter-type>
         <parameter-value>29.0</parameter-value>
      </parameter>            
   </parameters>
</DecisionMakerConfig>
<EuidGeneratorConfig module-name="EuidGenerator" parser-class=
"com.sun.mdm.index.configurator.impl.idgen.EuidGeneratorConfiguration">
   <euid-generator-class>
      com.sun.mdm.index.idgen.impl.DefaultEuidGenerator
   </euid-generator-class>
   <parameters>
      <parameter>
         <parameter-name>IdLength</parameter-name>
         <parameter-type>java.lang.Integer</parameter-type>
         <parameter-value>10</parameter-value>
      </parameter>
      <parameter>
         <parameter-name>ChecksumLength</parameter-name>
         <parameter-type>java.lang.Integer</parameter-type>
         <parameter-value>0</parameter-value>
      </parameter>
      <parameter>
         <parameter-name>ChunkSize</parameter-name>
         <parameter-type>java.lang.Integer</parameter-type>
         <parameter-value>1000</parameter-value>
      </parameter>
   </parameters>
</EuidGeneratorConfig>