Defining Phonetic Encoding for the Master Index

Oracle Java CAPS Master Index provides configurable phonetic encoding capabilities. Phonetic encoding is a part of the standardization process, and is the process of changing the value of a data field to its phonetic equivalent. It is used to retrieve records with similar field values from the database for matching. You can specify which fields are phonetically encoded before matching and how they are encoded. There are several different encoders you can use for this purpose. This is most commonly done for first names and street names.

Phonetic encoding is defined in mefa.xml. You can define phonetic encoding by either using the Configuration Editor or modifying the XML file directly. The changes you make on the Phoneticized Field page of the Configuration Editor are reflected in the phonetic encoding structures and the match service section of mefa.xml. The Configuration Editor provides a simplified way of defining phonetic encoding.

Perform any of the following tasks to define phonetic encoding rules:

• Defining Master Index Fields for Phonetic Encoding

• Modifying a Master Index Phonetic Encoding Definition

• Deleting a Master Index Phonetic Encoding Definition

• Defining a Master Index Phonetic Encoder

• Modifying a Master Index Phonetic Encoder

• Deleting a Master Index Phonetic Encoder

Defining Master Index Fields for Phonetic Encoding

You can specify the fields you want to be phonetically encoded, the fields that store the encoded values, and the type of phonetic encoder to use for each field, such as NYSIIS or Soundex. A sample phonetic encoding structure for the XML file is included at the end of these instructions.

To Define a Field for Phonetic Encoding (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. In the object structure in the left pane, create the field that will contain the phonetic value of the field to be encoded.

   For more information, see Adding a Field to the Master Index Object Structure.

3. Click the Phoneticized Fields tab.

   The Phoneticized Field page appears.

4. In the Phoneticized Fields section, click Add.

   The Phoneticized Field dialog box appears.

5. Select values for the fields described in Master Index Phonetic Encoding Fields and Elements.
6. Click OK.

   The phonetic encoding definition is added to the Phoneticized Fields list.

7. On the Configuration Editor toolbar, click Save.

To Define a Field for Phonetic Encoding (XML Editor)

In object.xml, create the field that will contain the phonetic value. For more information, see Adding a Field to the Master Index Object Structure.

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 phoneticize-fields element in the PhoneticEncodersConfig element.
3. Create a new phoneticize-field element within the phoneticize-fields element.
4. In the new phoneticize-field element, create and define the elements described in Master Index Phonetic Encoding Fields and Elements.
5. Save and close the file.

Example 4 Phonetic Encoding Structure

<phoneticize-fields>
   <phoneticize-field>
      <unphoneticized-source-field-name>Person.FirstName
      </unphoneticized-source-field-name>
      <phoneticized-target-field-name>Person.FirstNamePhoneticCode
      </phoneticized-target-field-name>
      <encoding-type>Soundex</encoding-type>
   </phoneticize-field>
</phoneticize-fields>

Master Index Phonetic Encoding Fields and Elements

The following table lists and describes the Configuration Editor fields and XML file elements used to define how fields will be phonetically encoded.

Modifying a Master Index Phonetic Encoding Definition

Once you create a phonetic encoding definition, you can modify it as needed. Use caution when modifying definitions once a system is in production. This can cause inconsistent match results.

To Modify a Phonetic Encoding Definition (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 Phoneticized Fields tab.

   The Phoneticized Field page appears.

3. In the Phoneticized Fields section, select the phonetic encoding definition you want to modify, and then click Edit.

   The Phoneticized Field dialog box appears.

4. Modify any of the fields listed in Master Index Phonetic Encoding Fields and Elements, and then click OK.
5. On the Configuration Editor toolbar, click Save.

To Modify a Phonetic Encoding Definition (XML Editor)

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 phoneticize-fields element.
3. In the phoneticize-field element that defines the phonetic encoding you want to modify, change the value of any of the elements described in Master Index Phonetic Encoding Fields and Elements.
4. Save and close the file.

Deleting a Master Index Phonetic Encoding Definition

Once you create a phonetic encoding definition, you can delete it as needed. Use caution when deleting definitions once a system is in production. This can cause inconsistent match results.

To Delete a Phonetic Encoding Definition (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 Phoneticized Fields tab.

   The Phoneticized Field page appears.

3. In the Phoneticized Fields section, select the phonetic encoding definition you want to delete.
4. Click Remove.
5. Click Yes on the dialog that appears.
6. On the Configuration Editor toolbar, click Save.

To Delete a Phonetic Encoding Definition (XML Editor)

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 phoneticize-fields element in the PhoneticEncodersConfig element.
3. Do either of the following:
   • To delete a field currently specified for phonetic conversion, delete all text between and including the phoneticize-field element that defines the field.

     Using the example below, to delete the first name phonetic field, delete the boldface text.

     <phoneticize-fields>
        <phoneticize-field>
           <unphoneticized-source-field-name>Person.LastName
           </unphoneticized-source-field-name>
           <phoneticized-target-field-name>Person.LastNamePhoneticCode
           </phoneticized-target-field-name>
           <encoding-type>NYSIIS</encoding-type>
        </phoneticize-field>
        <phoneticize-field>
           <unphoneticized-source-field-name>Person.FirstName
           </unphoneticized-source-field-name>
           <phoneticized-target-field-name>Person.FirstNamePhoneticCode
           </phoneticized-target-field-name>
           <encoding-type>Soundex</encoding-type>
        </phoneticize-field>
     </phoneticize-fields>

   • To delete all fields currently specified for phonetic conversion, delete all text between, but not including, the phoneticize-fields element.
4. Save and close the file.

Defining a Master Index Phonetic Encoder

Each type of phonetic encoder provided with Oracle Java CAPS Master Index is defined in the PhoneticEncodersConfig section of mefa.xml. They are listed in the Encoders section of the Configuration Editor.

To Define a Phonetic Encoder (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 Phoneticized Fields tab.

   The Phoneticized Field page appears.

3. In the Encoders section, click Add.

   The Phonetic Encoder dialog box appears.

4. In the Encoder field, enter a descriptive name for the encoder.
5. In the Implementation Class field, enter the fully qualified Java path of the class to use for the encoder.

   ---

   Note - For more information about the encoder class paths, see Master Index Encoder Elements and Types.

   ---

6. Click OK.

   The phonetic encoder is added to the Encoders list.

7. On the Configuration Editor toolbar, click Save.

To Define a Phonetic Encoder (XML Editor)

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 PhoneticEncodersConfig section.
3. Create a new encoder element, and then define the elements described in Master Index Encoder Elements and Types.
4. Save and close the file.

Master Index Encoder Elements and Types

The following table lists and describes the elements that configure the phonetic encoders used by the master index application.

The following table lists the phonetic encoders supported by the Master Index Standardization Engine along with the names of their default classes.

Modifying a Master Index Phonetic Encoder

Once you define a phonetic encoder, you can change the implementation class to use for the encoder. Use caution when modifying definitions once a system is in production. This can cause inconsistent match results.

To Modify a Phonetic Encoder (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 Phoneticized Fields tab.

   The Phoneticized Field page appears.

3. In the Encoders section, select the encoder you want to modify and then click Edit.

   The Phonetic Encoder dialog box appears.

4. Change the implementation class, and then click OK.
5. On the Configuration Editor toolbar, click Save.

To Modify a Phonetic Encoder (XML Editor)

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 PhoneticEncodersConfig section.
3. Modify the value of any of the elements in the encoder element you want to modify (for more information, see Master Index Encoder Elements and Types.
4. Save and close the file.

Deleting a Master Index Phonetic Encoder

Once you define a phonetic encoder, you can delete it if needed. Use caution when deleting encoders once a system is in production. This can cause inconsistent match results. If you delete an encoder that is referenced by a phonetic encoding definition, make sure to modify that definition by referencing an existing encoder.

To Delete a Phonetic Encoder (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. In the Configuration Editor toolbar, click the Phoneticized Fields tab.

   The Phoneticized Field page appears.

3. In the Encoders section, select the encoder you want to delete.
4. Click Remove.
5. Click Yes on the dialog box that appears.
6. On the Configuration Editor toolbar, click Save.

To Delete a Phonetic Encoder (XML Editor)

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 PhoneticEncodersConfig section.
3. Delete the text between and including the encoder element the defines the encoder you want to remove.
4. Save and close the file.