Skip Headers
Oracle® Healthcare Master Person Index Configuration Guide
Release 1.1

Part Number E18473-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

4 Processing Options, Matching Parameters, and EUIDs

This chapter provides information and procedures for configuring processing options, matching parameters (including the Match Engine, and EUIDs).

This chapter includes the following sections:

Configuring Master Person Index Processing Options

The Master Controller defines how transactions are processed, and is configured in master.xml. You can specify Java classes that insert additional logic into the match process, configure the blocking query to use for matching, define how merged record updates are handled, and specify whether a record's potential duplicates are reevaluated after it is updated. You can customize the Master Controller by performing any of the following actions.

Specifying Master Person Index Custom Logic Classes

The logic-class element specifies custom match processing logic for messages coming from external systems. The logic-class and logic-class-gui elements specify custom match processing logic for the MIDM. If no custom plug-ins were created to define the custom logic, leave these elements empty. Custom logic classes can only be specified by modifying the XML file directly.

To Specify Custom Logic for External System Messages

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

  2. In the MasterControllerConfig element, change the value of the logic-class element to the name of the custom plug-in that contains the back-end logic.

    For example:

    <logic-class>com.sun.mdm.index.user.CustomProcessing</logic-class>
    
  3. Save and close the file.

To Specify Custom Logic for the Master Person Index Data Manager

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

  2. In the MasterControllerConfig element, change the value of the logic-class-gui element to the name of the custom plug-in that contains the MIDM logic.

    For example:

    <logic-class-gui>com.sun.mdm.index.user.CustomMIDM</logic-class-gui>
    
  3. Save and close the file.

Specifying the Master Person Index Update Mode

The update-mode element specifies whether potential duplicates are reevaluated for a record each time the record is updated. If you specify that potential duplicates are reevaluated, the reevaluation only occurs when updates are made to fields involved in blocking and matching. The update mode can only be specified by modifying the XML file directly.

To Specify Potential Duplicates be Reevaluated at Each Update

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

  2. In the MasterControllerConfig element, change the value of the update-mode element to Pessimistic.

    For example:

    <update-mode>Pessimistic</update-mode>
    
  3. Save and close the file.

To Specify Potential Duplicates not be Reevaluated at Each Update

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

  2. In the MasterControllerConfig element, change the value of the update-mode element to Optimistic.

    For example:

    <update-mode>Optimistic</update-mode>
    
  3. Save and close the file.

Configuring Master Person Index Merged Record Updates

The merged-record-update element allows you to define whether updates can be made to records with a status of Merged.

To Allow Merged Record Updates

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

  2. In the MasterControllerConfig element, change the value of the merged-record-update element to Enabled.

    For example:

    <merged-record-update>Enabled</merged-record-update>
    
  3. Save and close the file.

To Prevent Merged Record Updates

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

  2. In the MasterControllerConfig element, change the value of the merged-record-update element to Disabled.

    For example:

    <merged-record-update>Disabled</merged-record-update>
    
  3. Save and close the file.

Specifying the Master Person Index Blocking Query for Matching

You need to specify the query that will be used by the master person index application to retrieve a candidate selection pool of records that closely match an incoming record and that will be used for probabilistic weighting. The name of the blocking query you specify here must match the name of one of the blocking queries defined in query.xml. You can only specify one blocking query for matching in the master person index application.

Note:

Modifying the blocking query once your system is in production is not recommended because it can cause issues with data integrity.

To Specify the Blocking Query for Matching

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

  2. Scroll to the execute-match element in the MasterControllerConfig element.

  3. Modify the value of the query-builder name to the name of the blocking query you want to use. For example:

    <execute-match>
     <query-builder name="MY-BLOCKER">
     <option key="key" value="value"/>
     </query-builder>
    </execute-match>
    

    Note:

    Make sure the name you specify exactly matches the name of one of the blocking queries defined in query.xml.
  4. Set the blocking query options, as described in "Setting Master Person Index Blocking Query Options".

  5. Save and close the file.

Setting Master Person Index Blocking Query Options

Key and value pairs are designed to fine-tune the operation of custom blocking queries. In the default blocking queries defined in query.xml, key and value pairs are not used. However, if you create a custom blocking query, you can configure the query to use key and value pairs. The key describes the option, and the value specifies the value of the option.

To Set Blocking Query Options

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

  2. Scroll to the execute-match element.

  3. To specify a key and value pair, modify the values of the key and value attributes in the option element.

    For example:

    <option key="wildcard" value="true"/>
    
  4. To delete a key and value pair, remove the option element.

  5. Save and close the file.

Defining Master Person Index Transactional Support

You can define the master person index application to distribute transactions across applications, to distribute transactions only within the master person index application, or to not use distributed transactions at all. You can define transactional support by using the Configuration Editor or by modifying the XML file directly. When you define transactional support for the master person index, make sure to use the appropriate transaction properties for the database connection in the GlassFish Admin Console.

To Configure MPI for Local Transactions

  1. In the Projects window, right-click the Configuration node in the project you want to modify, and then click Edit.

    The Configuration Editor appears.

  2. Click the Deployment tab.

  3. In the Transaction Mode field, select LOCAL.

  4. On the Configuration Editor toolbar, click Save.

  5. To configure the database connection, launch the application service Admin Console, and do one of the following:

    • If the database connection is already defined, do the following on the Admin Console:

      • In the left frame, expand Resources > JDBC > Connection Pools.

      • Select the database connection pool that is defined for your master person index application.

      • On the Edit Connection Pool page, select either javax.sql.DataSource or javax.sql.ConnectionPoolDataSource for the Resource Type and click Save.

    • If the database connection is not already defined, follow the instructions provided in "Defining the Database Connection Pools" in Oracle Healthcare Master Person Index User's Guide (Part Number E18468-01). Select either javax.sql.DataSource or javax.sql.ConnectionPoolDataSource for the connection pool Resource Type.

To Configure MPI to Distributed Transactions Across Applications

  1. In the Projects window, right-click the Configuration node in the project you want to modify, and then click Edit.

    The Configuration Editor appears.

  2. Click the Deployment tab.

  3. In the Transaction Mode field, select XA (across applications).

  4. On the Configuration Editor toolbar, click Save.

  5. Launch the application server Admin Console (from NetBeans, click the Services tab, expand Servers, right-click the domain, and select View Admin Console).

  6. To configure the database connection, launch the application service Admin Console, and do one of the following:

    • If the database connection is already defined, do the following on the Admin Console:

      • In the left frame, expand Resources > JDBC > Connection Pools.

      • Select the database connection pool that is defined for your master person index application.

      • On the Edit Connection Pool page, select javax.sql.XADataSource for the Resource Type and click Save.

    • If the database connection is not already defined, follow the instructions provided in Oracle Healthcare Master Person Index User's Guide (Part Number E18468-01). Select javax.sql.XADataSource for the Resource Type.

To Configure MPI for Distributed Transactions Within the MPI Application Only

  1. In the Projects window, right-click the Configuration node in the project you want to modify, and then click Edit.

    The Configuration Editor appears.

  2. Click the Deployment tab.

  3. In the Transaction Mode field, select XA (within application only).

  4. On the Configuration Editor toolbar, click Save.

  5. To configure the database connection, launch the application server Admin Console and do one of the following:

    • If the database connection is already defined, do the following on the Admin Console:

      • In the left frame, expand Resources > JDBC > Connection Pools.

      • Select the database connection pool that is defined for your master person index application.

      • On the Edit Connection Pool page, select javax.sql.XADataSource for the Resource Type and click Save.

    • If the database connection is not already defined, follow the instructions provided in the Oracle Healthcare Master Person Index User's Guide (Part Number E18468-01). Select javax.sql.XADataSource for the Resource Type.

Configuring Matching Parameters

The Decision Maker is configured in master.xml and defines how to handle certain decision points in the matching process, such as weight thresholds, how to handle multiple records above the match threshold, and whether records originating from the same system can be automatically matched.

You can customize the Decision Maker by performing any of the following actions:

Specifying the Master Person Index Decision Maker Class

If you create your own Decision Maker class, you can specify the new class to be used by changing the value of the decision-maker-class element.

To Specify the Decision Maker Class

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

  2. Scroll to the DecisionMakerConfig element.

  3. Change the value of the decision-maker-class element to the path and name of the new Decision Maker class.

    For example:

    <decision-maker-class>com.sun.mdm.index.decision.impl.MyDecisionMaker
    </decision-maker-class>
    
  4. Save and close the file.

Defining How to Handle Multiple Assumed Matches (OneExactMatch)

The OneExactMatch parameter determines how records above the match threshold are processed. This parameter can only be modified directly in the XML file. For more information, see "Learning About Manager Service Configuration" in Oracle Healthcare Master Person Index Configuration Reference (Part Number E18592-01) and "Understanding Operational Processes" in Understanding Sun Master Index Processing.

To Create Potential Duplicates When Multiple Records Match

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

  2. Scroll to the OneExactMatch element in the DecisionMakerConfig element.

  3. Change the value of the parameter-value element to true.

    For example:

    <parameter>
       <parameter-name>OneExactMatch</parameter-name>
     <parameter-type>java.lang.Boolean</parameter-type>
     <parameter-value>true</parameter-value>
    </parameter>
    
  4. Save and close the file.

To Match the Highest Weighted Records When Multiple Records Match

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

  2. Scroll to the OneExactMatch element in the DecisionMakerConfig element.

  3. Change value of the parameter-value element to false.

    For example:

    <parameter>
     <parameter-name>OneExactMatch</parameter-name>
     <parameter-type>java.lang.Boolean</parameter-type>
     <parameter-value>false</parameter-value>
    </parameter>
    
  4. Save and close the file.

Specifying Whether Same System Matches are Allowed (SameSystemMatch)

The SameSystemMatch parameter determines whether two records with local IDs from the same system can be merged automatically. If your local systems contain reliable data, and rarely duplicate their own records, set this parameter to true. This parameter can only be modified directly through the XML file.

To Allow Same System Records to be Automatically Merged

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

  2. Scroll to the SameSystemMatch element in the DecisionMakerConfig element.

  3. Change the value of the parameter-value element to false.

    For example:

    <parameter>
     <parameter-name>SameSystemMatch</parameter-name>
     <parameter-type>java.lang.Boolean</parameter-type>
     <parameter-value>false</parameter-value>
    </parameter>
    
  4. Save and close the file.

To Prevent Same System Records From Being Automatically Merged

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

  2. Scroll to the SameSystemMatch element in the DecisionMakerConfig element.

  3. Change the value of the parameter-value element to true.

    For example:

    <parameter>
     <parameter-name>SameSystemMatch</parameter-name>
     <parameter-type>java.lang.Boolean</parameter-type>
     <parameter-value>true</parameter-value>
    </parameter>
    
  4. Save and close the file.

Specifying the Master Person Index Duplicate Threshold

The duplicate threshold is the lowest matching probability weight at which two records are considered potential duplicates of one another. Any records with lower probability weights are not considered to be possible matches. Any records between the duplicate and match thresholds are flagged as potential duplicates, and must be resolved manually. You can configure the duplicate threshold by using the Configuration Editor or by modifying the XML file directly.

To Specify the Duplicate Threshold (Configuration Editor)

  1. In the Projects window, right-click the Configuration node in the project you want to modify, and then click Edit.

    The Configuration Editor appears.

  2. Click the Matching tab.

  3. In the Duplicate Threshold field, enter the lowest weight at which two records should be considered a potential match.

    Note:

    This value can be any float value lower than the match threshold but higher than the lowest possible matching probability weight.
  4. On the Configuration Editor toolbar, click Save.

To Specify the Duplicate Threshold (XML Editor)

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

  2. Scroll to the DuplicateThreshold element in the DecisionMakerConfig element.

  3. Change the value of the parameter-value element. For example:

    <parameter>
       <parameter-name>DuplicateThreshold</parameter-name>
       <parameter-type>java.lang.Float</parameter-type>
       <parameter-value>7.9</parameter-value>
    </parameter>
    

    Note:

    This value can be any float value lower than the match threshold but higher than the lowest possible matching probability weight.
  4. Save and close the file.

Specifying the Master Person Index Match Threshold

The match threshold specifies the matching probability weight at which two records will be automatically merged, depending on the value of the OneExactMatch parameter and the number of records at or above the match threshold. You can configure the match threshold by using the Configuration Editor or by modifying the XML file directly.

To Specify the Match Threshold (Configuration Editor)

  1. In the Projects window, right-click the Configuration node in the project you want to modify, and then click Edit.

    The Configuration Editor appears.

  2. Click the Matching tab.

  3. In the Match Threshold field, enter the lowest weight at which two records should be considered a match.

    Note:

    This value can be any float value higher than the duplicate threshold but lower than the highest possible matching probability weight.
  4. On the Configuration Editor toolbar, click Save.

To Specify the Match Threshold (XML Editor)

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

  2. Scroll to the MatchThreshold element in the DecisionMakerConfig element.

  3. Change the value of the parameter-value element.

    For example:

    <parameter>
       <parameter-name>MatchThreshold</parameter-name>
       <parameter-type>java.lang.Float</parameter-type>
       <parameter-value>28.5</parameter-value>
    </parameter>
    

    Note:

    This value can be any float value higher than the duplicate threshold but lower than the highest possible matching probability weight.
  4. Save and close the file.

Adding and Deleting Master Person Index Decision Maker Parameters

New parameters cannot be used with the default Decision Maker class and existing parameters should not be deleted. If you create a custom Decision Maker class, you might need to add new parameters or delete existing ones for the new class. You can only perform these tasks by modifying the XML file directly.

To Add a New Decision Maker Parameter

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

  2. Scroll to the DecisionMakerConfig element.

  3. Create a parameter element inside the parameters element, but outside any existing parameter elements. Define the following elements:

    • parameter-name - The name of the parameter.

    • 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 example:

      <parameters>
         <parameter>
            <parameter-name>OneExactMatch</parameter-name>
            <parameter-type>java.lang.Boolean</parameter-type>
            <parameter-value>false</parameter-value>
         </parameter>
         <parameter>
            <parameter-name>MaxDuplicates</parameter-name>
            <parameter-type>java.lang.Boolean</parameter-type>
            <parameter-value>5</parameter-value>
         </parameter>
      </parameters>
      
  4. Save and close the file.

To Delete a Decision Maker Parameter

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

  2. Scroll to the DecisionMakerConfig element.

  3. To delete one parameter, remove all text between and including the parameter element.

    For example, to delete the ExtensiveSearch parameter in the following sample, you would delete the boldface text.

    <parameters>
       <parameter>
          <parameter-name>OneExactMatch</parameter-name>
          <parameter-type>java.lang.Boolean</parameter-type>
          <parameter-value>false</parameter-value>
       </parameter>
       <parameter>
          <parameter-name>ExtensiveSearch</parameter-name>
          <parameter-type>java.lang.Boolean</parameter-type>
          <parameter-value>true</parameter-value>
       </parameter>
    </parameters>
    
  4. To remove all parameters, remove all text between and including the starting and ending parameters element.

  5. Save and close the file.

Configuring the Match Engine

You can configure the match engine by specifying the match engine to use and configuring the predefined comparison functions. You can also plug in custom standardization and matching rules. You only need to specify the match engine to use if you are using an engine other than the OHMPI Match Engine.

Perform any of these steps to configure the match engine:

Specifying a Match Engine for the Master Person Index

Oracle Healthcare Master Person Index can support different match engines depending on the adapter configured to communicate with the engine. Default classes are provided for using the OHMPI Match Engine. You can implement a custom match engine along with custom adapters. The match engine configuration is defined by the matcher-api and matcher-config elements.

Note:

The default adapters for the OHMPI Match Engine are com.sun.mdm.index.matching.adapter.SbmeMatcherAdapter and com.sun.mdm.index.matching.adapter.SbmeMatcherAdapterConfig.

To Configure the Match Engine

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the matcher-api element in the MatchingConfig section.

  3. Specify the Java class for the matching adapter to use, using the fully qualified class name as shown below.

    <matcher-api>
       <class-name>com.sun.mdm.index.matching.adapter.SbmeMatcherAdapter
       </class-name>
    </matcher-api>
    
  4. In the matcher-config element, specify the Java class for the configuration of the matching adapter, using the fully qualified class name as shown below.

    <matcher-config>
       <class-name>
        com.sun.mdm.index.matching.adapter.SbmeMatcherAdapterConfig
       </class-name>
    </matcher-config>
    
  5. Save and close the file.

Configuring the Comparison Functions for a Master Person Index Application

The match configuration file in the Match Engine node of the master person index project lists and defines the configuration for each match type based on the predefined comparison function for the OHMPI Match Engine. These match types can be applied to each field in the match string. You can modify the configuration of the existing match types, add new match types, and specify whether the match engine should use agreement and disagreement weights or m-probabilities and u-probabilities.

For more information about the structure of the match configuration file and the comparison functions you can use, see Oracle Healthcare Master Person Index Match Engine Reference. (Part Number E18592-01)

To Configure the Comparison Functions (Configuration Editor)

  1. In the Projects window, right-click the Configuration node in the project you want to modify, and then click Edit.

    The Configuration Editor appears.

  2. Click the Matching tab.

    The Matching page appears with a list of fields defined for matching and a list of comparators that you can modify.

  3. In the Probability Type field, select one of the following:

    • Use Agree/Disagreement Weight Ranges - Uses agreement and disagreement weights for matching. If agreement and disagreement weights are used, the m-probability and u-probability fields are ignored and do not appear on the Matching page.

    • Use M-Probabilities/U-Probabilities - Uses m-probabilities and u-probabilities for matching. If m-probabilities and u-probabilities are used, the agreement and disagreement weight fields are ignored and do not appear on the page.

  4. To add a new matching rule:

  5. To edit an existing matching rule:

  6. To remove an existing matching rule:

    • In the matching rule table, select the rule you want to delete.

    • Click Remove.

  7. On the Configuration Editor toolbar, click Save.

To Configure the Comparison Functions (Text Editor)

  1. In the project window, expand the master person index project, and then expand the master person index application.

  2. In the Match Engine folder, double-click matchConfigFile.cfg.

  3. For the Probability Type, enter one of the following values:

    • 0 - Uses m-probabilities and u-probabilities for matching. If m-probabilities and u-probabilities are used, the agreement and disagreement weight fields are ignored.

    • 1 - Uses agreement and disagreement weights for matching. If agreement and disagreement weights are used, the m-probability and u-probability fields are ignored.

  4. For each comparison function you want to configure, modify the value of any of the columns described in "Match Comparator Configuration Properties for Oracle Healthcare Master Person Index".

  5. Save and close the file.

Match Comparator Configuration Properties for Oracle Healthcare Master Person Index

The following table lists and describes the Configuration Editor fields used to define the comparison functions. It also lists the corresponding column in the match configuration file if you want to modify the file directly.

Configuration Editor Field Match Configuration File Element and Column Number Description
Match Type match-type (column 1) A value that indicates to the OHMPI Match Engine how each field should be weighted. Each field included in the match string (the MatchingConfig section of mefa.xml) must have a match type corresponding to a match type defined in this file.
Match Size size (column 2) The number of characters on which matching is performed, beginning with the first character. For example, to match on only the first four characters in a 10-digit field, the value of this column should be 4.
Null Field null-field (column 3) An index that specifies how to calculate the total weight for null fields or fields that only contain spaces. You can specify any of the following values. The Configuration Editor value is given first, followed by the match configuration file value in parenthesis.
  • Zero weight (0) - If one or both fields are empty, the weight used for the field is 0 (zero).

  • Full Combination weight (1) - If both fields are empty, the agreement weight is used; if only one field is empty, the disagreement weight is used.

  • Full Agreement weight (a1) - Specifies to use the full agreement weight if both fields are null.

  • 1/x of the Agreement weight (ax) - Specifies to use the a fraction of the agreement weight if both fields are empty. The agreement weight is multiplied by the fraction 1/x to obtain the match weight for that field. When modifying the match configuration file directly, the default is 2 if no number is specified. You can specify any number from 1 through 10.

  • Full disagreement weight (d1) - Specifies to use the full disagreement weight if both fields are null.

  • 1/x of the disagreement weight (dx) - Specifies to use the disagreement weight if only one field is empty. The disagreement weight is multiplied by the fraction 1/x to obtain the match weight for the field. When modifying the match configuration file directly, the default is 2 if no number is specified. You can specify any number from 1 through 10.

In the above descriptions, the agreement and disagreement weights are either specified in this file or calculated using a logarithmic formula based on the m and u-probabilities (depending on the probability type).

Function function (column 4) The type of comparison to perform when weighting the field. For information about the available comparison functions, see "OHMPI Match Engine Comparison Functions" in Oracle Healthcare Master Person Index Match Engine. (Part Number E18470-01).
Agreement Weight agreement-weight (column 7) The matching weight to be assigned to a field given that the fields match between two records; that is, the maximum match weight for a field. This number can be between 0 and 100 and can have up to 16 decimal points. Only set this value if the Probability Type is set to use agreement and disagreement weights.
Disagreement Weight disagreement-weight (column 8) The matching weight to be assigned to a field given that the fields do not match between two records; that is, the minimum match weight for a field. This number can be between 0 and -100 and can have up to 16 decimal points. Only set this value if the Probability Type is set to use agreement and disagreement weights.
M-Probability m-prob (column 5) The initial probability that the specified field in two records will match if the records match. The probability is a double value between 0 and 1, and can have up to 16 decimal points. Only set this value if the Probability Type is set to use probabilities.
U-Probability u-prob (column 6) The initial probability that the specified field in two records will match if the records do not match. The probability is a double value between 0 and 1, and can have up to 16 decimal points. Only set this value if the Probability Type is set to use probabilities.
Extra Parameters parameters (column 9) Parameters correspond to the comparison function specified in the Function field or column. Some comparison functions do not take any parameters and some take multiple parameters. For information about which functions take parameters and the parameters they take, see "OHMPI Match Engine Comparison Functions" in Oracle Healthcare Master Person Index Match Engine (Part Number E18470-01).

Importing Custom Comparison Functions

The Master Index Match Engine is based on a very flexible framework that allows you to define new algorithms in the form of comparison functions that compare field values between two records. You need to import the comparison function into NetBeans to make it available to all master person index applications or only the current application.

This section only describes importing custom comparison functions after they have been created. For information about creating a custom comparison function, see "Creating Custom Comparators for the OHMPI Match Engine" in Oracle Healthcare Master Person Index Match Engine (Part Number E18470-01).

To Import a Comparison Function

  1. In the Projects window, expand the main master person index project.

  2. Right-click Match Engine, and select Import Comparator Plug-in.

  3. In the dialog box that appears, navigate to the location of the plug-in ZIP file.

  4. Select the file containing the plug-in, and then click Open.

  5. Do one of the following:

    • To import the plug-in and make it available to all future master person index application, click Yes.

    • To import the plug-in and make it only available to the current master person index application, click No.

    The contents of the ZIP file are imported into the Match Engine node and the new comparators are added to the list of comparator definitions in comparatorsList.xml.

  6. In the Match Engine node, navigate to the /lib folder that was added and verify that all of the required files are there.

  7. Open comparatorsList.xml and verify the new comparator definitions are included.

Deleting a Custom Comparison Function

If you add a custom comparison function to a master person index application in error, you can remove it from the Match Engine node. Optionally, you can simply make the comparison function unavailable by removing it from the comparators list in comparatorsList.xml.

To Delete a Custom Comparison Function

  1. Back up the source files for the function in case you need them at a later time.

  2. In the Project window, navigate to the Match Engine node in the master person index project and then to the /lib folder.

  3. Right-click the folder containing the files to remove, and then select Delete.

    A confirmation dialog appears.

  4. Click Yes.

    The source files are removed from the project.

  5. Open comparatorsList.xml and remove the comparator definitions from the list.

  6. Save and close the file.

Configuring Master Person Index EUIDs

The EUID Generator controls how the enterprise-wide unique identifiers (EUIDs) are created by the master person index application, including the length of the ID and the checksum value. The EUID generator can only be configured by modifying master.xml directly.

You can customize the EUID Generator by performing any of the following actions:

Specifying the Master Person Index EUID Generator Class

The default EUID generator creates sequential EUIDs based on the value specified for the EUID sequence in the sbyn_seq_table database table. If you create a new EUID generator class to process EUIDs differently, you must specify the name of the new class in the euid-generator-class element of master.xml.

To Specify the EUID Generator Class

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

  2. Scroll to the EuidGeneratorConfig element.

  3. Change the value of the euid-generator-class element to the path and name of the new EUID generator class.

    For example:

    <euid-generator-class>com.sun.mdm.index.idgen.impl.MyEuidGenerator
    </euid-generator-class>
    
  4. Save and close the file.

Specifying the Master Person Index EUID Length

By default, the length of the EUIDs generated by the master person index application is 10 characters. You can modify this value if needed. You can also specify a new starting EUID number. This is described in "Creating the Master Person Index Database" in Oracle Healthcare Master Person Index User's Guide (Part Number E18468-01).

If you increase the length of the EUIDs to longer than 20 characters or if the EUID length plus the checksum length is longer than 20 characters, you need to increase the length of the EUID columns in the script that creates the database tables.

To Specify the EUID Length

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

  2. Scroll to the first parameter element, IdLength, in the EuidGeneratorConfig element.

  3. Change the value of the parameter-value element to the desired length of the EUID.

    For example:

    <parameter>
       <parameter-name>IdLength</parameter-name>
       <parameter-type>java.lang.Integer</parameter-type>
       <parameter-value>12</parameter-value> 
    </parameter>
    
  4. Save and close the file.

Specifying a Master Person Index Checksum Length

A checksum value is a number appended to the end of each EUID that allows systems to validate EUIDs to ensure accurate identification of records throughout the network. For detailed information about checksum values and how they work, see "Manager Service Components" in Oracle Healthcare Master Person Index Configuration Reference (Part Number E18592-01).

If you specify 0 (zero), checksum values are not used for validation. If the EUID length plus the checksum length is greater than 20, you need to increase the length of the EUID columns in the database creation scripts.

To Specify a Checksum Length

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

  2. Scroll to the second parameter element, ChecksumLength, in the EuidGeneratorConfig element.

  3. Change the value of the parameter-value element to the desired length of the checksum value.

    For example:

    <parameter>
       <parameter-name>ChecksumLength</parameter-name>
       <parameter-type>java.lang.Integer</parameter-type>
       <parameter-value>2</parameter-value> 
    </parameter>
    
  4. Save and close the file.

Specifying the Master Person Index Chunk Size

You can specify a number of EUIDs to be allocated at one time to the EUID generator. This allows the generator to assign EUIDs to multiple records without needing to query the sbyn_seq_table database table each time, which improves performance. For detailed information about the chunk size and how EUIDs are allocated, see "Manager Service Components" in Oracle Healthcare Master Person Index Configuration Reference (Part Number E18592-01).

To Specify the Chunk Size

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

  2. Scroll to the third parameter element, ChunkSize, in the EuidGeneratorConfig element.

  3. Change the value of the parameter-value element to the desired chunk size.

    For example:

    <parameter>
        <parameter-name>EuidGeneratorConfig</parameter-name>
        <parameter-type>java.lang.Integer</parameter-type>
        <parameter-value>100</parameter-value>
    </parameter>
    
  4. Save and close the file.

Adding and Deleting Master Person Index EUID Generator Parameters

You cannot add or delete parameters for the default EUID Generator class, but if you create a custom EUID generator class, you can create additional parameters for the new class and delete the existing parameters if they are not used.

To Add EUID Generator Parameters

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

  2. Scroll to the EuidGeneratorConfig element.

  3. Create a new parameter element inside the parameters element, but outside any existing parameter elements. Add the following elements:

    • parameter-name - The name of the parameter.

    • 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 example:

      <parameters>
          <parameter>
            <parameter-name>IdLength</parameter-name>
            <parameter-type>java.lang.Integer</parameter-type>
            <parameter-value>10</parameter-value>
          </parameter>
          <parameter>
            <parameter-name>IncrementBy</parameter-name>
            <parameter-type>java.lang.Integer</parameter-type>
            <parameter-value>5</parameter-value>
         </parameter>
      </parameters>
      
  4. Save and close the file.

To Delete EUID Generator Parameters

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

  2. Scroll to the EuidGeneratorConfig element.

  3. To delete one parameter, scroll to the parameter element you want to delete and remove all text between and including the parameter element.

    For example, to remove the StartNumber parameter in the sample below, delete all boldface text.

    <parameters>
        <parameter>
           <parameter-name>IdLength</parameter-name>
           <parameter-type>java.lang.Integer</parameter-type>
           <parameter-value>10</parameter-value>
        </parameter>
        <parameter>
           <parameter-name>StartNumber</parameter-name>
           <parameter-type>java.lang.Integer</parameter-type>
           <parameter-value>1000000001</parameter-value>
        </parameter>
    </parameters>
    
  4. To remove all parameters, remove all text between and including the parameters element.

  5. Save and close the file.