Configuring Sun Master Indexes

Configuring the Master Index MIDM Pages

You can configure certain pages that appear on the MIDM by modifying the midm.xml. Each page on the MIDM is configured separately, though many contain the same XML elements and attributes. For the Record Details page, you can configure and create search pages and search results lists. If you add a new query to query.xml and you want to access that query from the MIDM, you need to create a new search page for the query on the Record Details page. The Dashboard page cannot be configured.

Perform any of the following actions to configure the pages of the MIDM.

Specifying the Initial View for the MIDM

By default, the Record Details page appears when a user logs in to the Master Index Data Manager. You can specify any of the other tabbed pages as the initial view. Each page on the MIDM is identified by a screen ID in midm.xml, which is an integer defined in the screen-id element for each page. Use this ID to specify which page to display first when a user logs in.

ProcedureTo Specify the Initial View

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

    The file opens in the NetBeans XML editor.

  2. Locate the page definition for the page you want to display first, and note the value of its screen-id element.

  3. Scroll to the initial-screen-id element, located in the gui-definition element.

  4. Enter the value of the screen-id element for the page you want to display first.

  5. Save and close the file.

Configuring the MIDM Duplicate Records Page

The Duplicate Records page allows you to search for potential duplicate records, view a results list, and then view a comparison of the records you select. It also provides features to resolve or merge the potential duplicates in question. You can configure several aspects of the Duplicate Records page, including display options, search pages, and the results list.

The following topics provide instructions for each type of configuration:

Configuring Duplicate Records Display Options

You can configure certain display options for the Duplicate Records page, such as the name of the tabbed heading and the order in which the tab appears on the MIDM. Below is a sample of the display option elements for the Duplicate Records page.


<duplicate-records>
   <root-object>Person</root-object>
   <tab-name>Duplicate Records</tab-name>
   <screen-id>3</screen-id>
   <display-order>1</display-order>
   ...
</duplicate-records>

You should never need to modify the root-object or screen-id element for the Duplicate Records page.

ProcedureTo Configure Duplicate Records Display Options

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the duplicate-records element (located in the gui-definition element).

  3. To specify a different name for the Duplicate Record tab, modify the value of the tab-name element.

  4. To change the order in which the Duplicate Records tab appears on the MIDM, change the value of the display-order element.


    Note –

    You might need to renumber the remaining tabs to keep the numbering sequential.


  5. Save and close the file.

Configuring Duplicate Records Search Pages

For the Duplicate Records search pages, you can configure the names of the searches that can be performed, the fields to use as search criteria (within a limited set of system fields), and instructions for performing a search. Below is a sample of the search page configuration for the Duplicate Records page.


<duplicate-records>
   ...
      <simple-search-page>
         <screen-title>Advanced Search</screen-title>
         <search-result-id>0</search-result-id>
         <search-screen-order>0</search-screen-order>
         <show-euid>true</show-euid>
         <show-lid>true</show-lid>
         <show-status>true</show-status>
         <show-create-date>true</show-create-date>
         <show-create-time>true</show-create-time>
         <instruction></instruction>
         <field-group/>
      </simple-search-page>
      ...
</duplicate-records>

ProcedureTo Configure the Duplicate Records Search Page

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the duplicate-records element (located in the gui-definition element).

  3. Modify any of the elements described in Duplicate Records Search Page Elements.

  4. Save and close the file.

Configuring the Duplicate Records Results List

For the Duplicate Records results list, you can configure the number of results to display at one time, the total number of results a search can return, and the fields that appear in the results list. Below is a sample results list configuration for the Duplicate Records page.


<duplicate-records>
   ...
   <search-result-pages>
      <search-result-list-page>
         <search-result-id>0</search-result-id>
         <item-per-page>10</item-per-page>
         <max-result-size>100</max-result-size>
         <field-group>
            <description></description>
            <field-ref>Person.FirstName</field-ref>
            <field-ref>Person.LastName</field-ref>
            <field-ref>Person.SSN</field-ref>
            <field-ref>Person.DOB</field-ref>
            <field-ref>Person.Gender</field-ref>
         </field-group>
      </search-result-list-page>
   </search-result-pages>
</duplicate-records>

ProcedureTo Configure the Duplicate Records Results List

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the duplicate-records element (located in the gui-definition element).

  3. Modify any of the elements described in Duplicate Records Search Results List Elements.

  4. To add a field to the results list, create and name a new field-ref element in the field-group element.

  5. To delete a field from the results list, delete the field-ref element defining the field.

  6. Save and close the file.

Duplicate Records Page Configuration Elements

The following two tables describe the configuration elements in midm.xml for the Duplicate Records search and results pages. The same elements are also used for the Source Record View/Edit page.

Duplicate Records Search Page Elements

The following table lists and describes the configurable elements for the Duplicate Records and Source Record search pages.

Table 1 Duplicate Records Search Page Configuration

Element/Attribute 

Description 

search-pages 

A container element that lists and defines the searches that are available from the page. 

simple-search-page

A container element that defines one type of search for the Duplicate Records page. You can define multiple simple search pages. 

screen-title

The name of the search as it appears on the search page. MIDM users can select a type of search to perform based on the titles you define for the searches here. 

search-screen-order 

The order in which the search page appears on the MIDM. 

show-euid

An indicator of whether to display the EUID field as search criteria. Specify true to display the EUID; otherwise specify false.

show-lid

An indicator of whether to display the local ID and system fields as search criteria. Specify true to display the fields; otherwise specify false.

show-status 

An indicator of whether to display the record status field as search criteria. Specify true to display the field; otherwise specify false.

show-create-date 

An indicator of whether to display the create date field to allow searching on the date the potential duplicate flag was created. Specify true to display the field; otherwise specify false.

show-create-time 

An indicator of whether to display the create time field to allow searching on the time the potential duplicate flag was created. Specify true to display the field; otherwise specify false.

instruction

A short statement to help the user process a search. The text you enter here appears above the search fields on the Search page. 

field-group

A list of fields that appear on the Search page. You can define multiple field groups, and each group can be contained in a labelled box on the Search page. 

description

A description of the fields defined for the field-group element. This value appears as a box label for the area of the page that contains the specified fields.

field-ref

One field definition for a field in the field group. Use the simple field name of the field with their corresponding objects as the root. For example, the path to the FirstName field in the Person object is “Person.FirstName”. You can define multiple field-ref elements for each field group.

Duplicate Records Search Results List Elements

The following table lists and describes the configurable elements for the Duplicate Records search results list.

Table 2 Duplicate Records Search Results Configuration

Element/Attribute 

Description 

search-result-pages 

A container element for a list of search result page definitions. 

search-result-list-page

A container element for the configuration information for the search results page. 

item-per-page

The number of resulting records to display on one page. 

max-result-size

The maximum number of records to return for a search. 

field-group 

A container element for a list of fields that appear in the search results. 

description 

A brief description for the field group. This value appears on the MIDM above the fields that are returned from a search. 

field-ref

A definition for one field that appears in the search results list. Use the simple field names with their corresponding objects as the root. For example, the path to the FirstName field in the Person object is “Person.FirstName”. You can define multiple field-ref elements.

Configuring the MIDM Record Details Page

You can configure certain display options for the Record Details page, such as the name of the tabbed heading and the order in which the tab appears on the MIDM. You can also create, modify, and delete search pages and search results lists. Search configuration is described in Creating Search Pages on the Record Details Page and Modifying a Search Page on the Record Details Page.

Below is a sample of the display option elements for the Record Details page.


<record-details>
   <root-object>Person</root-object>
   <tab-name>Record Details</tab-name>
   <screen-id>1</screen-id>
   <display-order>2</display-order>
   ...
</duplicate-records>

You should never need to modify the root-object or screen-id element.

ProcedureTo Configure Record Details Display Options

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the record-details element (located in the gui-definition element).

  3. To specify a different name for the Record Details tab, modify the value of the tab-name element.

  4. To change the order in which the Record Details tab appears on the MIDM, change the value of the display-order element.


    Note –

    You might need to renumber the remaining tabs to keep the numbering sequential.


  5. Save and close the file.

Creating Search Pages on the Record Details Page

Several search pages are created by the Master Index Wizard based on the information you specify. You can create and customize new search pages for the Record Details page. Each search you define must use a query that is defined in query.xml.

Follow these steps to create a new search page:

Step 1: Define the Search Page

The first step in creating a search page is to define certain properties for the appearance of the page, such as its name, whether to display the EUID or local ID field, and general instructions for the search.


Note –

If either the EUID field or the local ID and system fields appear on a search page, any values entered into these fields take precedence over information entered into other search fields. For example, if an invalid EUID is entered but valid first and last names are entered, no results are returned due to the invalid EUID. The EUID field takes precedence over the local ID and system fields.


ProcedureTo Define the Search Page

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the record-details element, and then create a simple-search-page element.

    Make sure the new element falls within the record-details element, but outside any existing simple-search-page elements. For example:


    <record-details>
       <simple-search-page>
        ...
       </simple-search-page>
       <simple-search-page>
       </simple-search-page>
    </record-details>
  3. In the new simple-search-page element, create the elements listed in Record Details Search Page Definition Elements and enter the appropriate value for each element.

    For example:


    <record-details>
       <simple-search-page>
        ...
       </simple-search-page>
       <simple-search-page>
          <screen-title>Address Search</screen-title>
          <search-result-id>1</search-result-id>
          <show-euid>true</show-euid>
          <show-lid>false</show-lid>
          <instruction>Enter address information below.</instruction>
       </simple-search-page>
    </record-details>
  4. Continue to Step 2: Define the Search Fields.

Step 2: Define the Search Fields

Once you define the search page, you need to specify the fields that appear on the page. Fields are specified in field groups, and each field group represents an area on the search page. All fields specified for a field group appear in the area defined by that group. The label for the area is defined by the description of the field group.

ProcedureTo Define Search Fields

  1. Complete Step 1: Define the Search Page.

  2. In the new simple-search-page element, create a field-group element.

    For example:


    <simple-search-page>
       <screen-title>Simple Person Search</screen-title>
       <search-result-id>2</search-result-id>
       <search-screen-order>1</search-screen-order>
       <show-euid>false</show-euid>
       <show-lid>false</show-lid>
       <field-group>
       </field-group>
    </simple-search-page>
  3. In the new field-group element, create the elements and attributes listed in Record Details Search Field Definition Elements and enter the appropriate value for each.

    For example:


    <simple-search-page>
       ..
       <field-group>
          <description>Address</description>
          <field-ref>Address.AddressType</field-ref>
          <field-ref>Address.AddressLine1</field-ref>
          <field-ref>Address.AddressLine2</field-ref>
          <field-ref required=“true”>Address.City</field-ref>
          <field-ref>Address.State</field-ref>
       </field-group>
    </simple-search-page>
  4. Repeat steps 2 and 3 for each field group you want to display on the selected search page.

  5. Continue to Step 3: Specify Search Options.

Step 3: Specify Search Options

After you define the criteria fields for the MIDM search, you can specify certain options for the search, such as the types of available searches, whether each search is weighted, and whether the search allows wildcard characters.


Note –

Wildcards should not be allowed for blocking queries or phonetic searches.


ProcedureTo Specify Search Options

  1. Complete Step 2: Define the Search Fields.

  2. In the simple-search-page element you created, create a search-option element.

    For example:


    <simple-search-page>
       <screen-title>Simple Person Search</screen-title>
       <search-result-id>2</search-result-id>
       <search-screen-order>1</search-screen-order>
       <show-euid>false</show-euid>
       <show-lid>false</show-lid>
       <field-group>
        ...
       </field-group>
       <search-option>
       </search-option>
    </simple-search-page>
  3. In the new search-option element, create the elements listed in Record Details Search Option Elements and enter the appropriate value for each element.

    For example:


    <search-option>
       <display-name>Alpha Search</display-name>
       <query-builder>ALPHA-SEARCH</query-builder>
       <weighted>false</weighted>
       <parameter>
         <name>UseWildCard</name>
         <value>true</value>
       </parameter>
    </search-option>
  4. Repeat the previous two steps for each search type you want to make available on the selected search page.


    Note –

    If you define multiple search option elements, an option button (labelled by the value of the display-name element) appears on the search page for each search option.


  5. Save and close the file.

Record Details Search Page Definition Elements

The following table lists and describes the elements you can configure in midm.xml to define the search pages on the Record Details page.

Element 

Description 

screen-title

The name of the search as it appears on the search page. Users can select a type of search to perform based on the titles you define for the searches here. 

search-result-id 

The unique identifier for the search results page that appears for the search. You can define multiple search results pages for each MIDM page, and each results page has a unique ID. You can enter any of the search result ID values defined in the search-results-pages element.

search-screen-order 

The order in which the search page appears on the MIDM. 

show-euid

An indicator of whether to display the EUID. Specify true to display the EUID; otherwise specify false. Only display this field if you want it to take precedence over all other search criteria.

show-lid

An indicator of whether to display the local ID and system fields. Specify true to display the fields; otherwise specify false. Only display these fields if you want them to take precedence over all other search criteria (except the EUID field).

instruction

A short statement to help the user process a search. The text you enter here appears above the search fields on the Search page. 

Record Details Search Field Definition Elements

The following table lists and describes the elements you can configure in midm.xml to define the fields for each search on the Record Details page.

Element/Attribute 

Description 

description

A description of the fields defined for the field-group element. This value appears as a box label for the area of the page that contains the specified fields.

field-ref

One field definition for a field in the field group. Use the simple field names of the fields with their corresponding objects as the root. For example, the path to the FirstName field in the Person object is “Person.FirstName”. You can define multiple field-ref elements for each field group, each of which are further configured by the following two optional attributes.

field-ref/required

An indicator of whether the field is required in order to perform a search. Specify any of the following values: 

  • true – The corresponding field is required to perform the search. These fields are marked with an asterisk (*) on the search page.

  • false – The corresponding field is not required to perform the search. If the required attribute is not defined, the default is false.

  • one of – The corresponding fields with this designation are a group of search criteria, at least one of which is required to perform the search. This designation specifies that at least one field in the group of fields with the “one of” designation is required. If a group of fields is designated as “one of”, those fields are marked with a dagger (†) on the search page.


Tip –

If you make a field required for a search, it is a good idea to make it required when creating a record as well by specifying true for the required property for the field in object.xml. Otherwise, searches performed from the MIDM could result in no possible matches even though possible matches exist.


field-ref/choice

An indicator of whether the field allows you to search by a range of values rather than an exact value. Specify any of the following values: 

  • exact – The search is performed on the exact value entered (wildcard characters may be allowed). If the choice attribute is not specified, this is the default value.

  • range – The search is performed on a range of values based on the entered search criteria. Fields with this designation appear twice on the search page, once with “From” appended to the field label and once with “to” appended to the field label. If you specify “range” for a field in a search that uses a blocking query, be sure to modify the query block in query.xml accordingly.


Tip –

You can specify the same field for both exact and range searching by adding it twice to the field list with different attribute values, giving the choice of performing an exact search or a range search from the MIDM. For more information about range searching, see Range Searching in Understanding Sun Master Index Configuration Options .


Record Details Search Option Elements

The following table lists and describes the elements you can configure in midm.xml to define the attributes for each search on the MIDM, such as which query to use, whether the search results are weighted, and so on.

Element 

Description 

display-name

A short phrase describing the type of search to perform, such as “Alphanumeric Search” or “Phonetic Search”. This appears next to the option button on the search page when multiple search options are defined. 

query-builder

The type of query to use when this type of search is selected. The value entered here must match a query-builder name in query.xml.

weighted

An indicator of whether the results of the search are assigned matching probability weights. Specify true to assign matching weights; specify false to return unweighted results.

candidate-threshold

The maximum number of records to return for a search. This value must be a positive number and can only be used for blocking queries. Setting the candidate threshold to zero is equivalent to not setting a threshold. 

parameter

A list of optional parameters for the search, specified by name and value elements (described below).

name

The name of the parameter. Currently, only UseWildCard is available.

value

The value of the parameter. For the UseWildCard parameter, this is an indicator of whether the parameter is enabled or disabled. Specify true to allow wildcard characters; specify false to perform exact-match searches.

Modifying a Search Page on the Record Details Page

Once a search page is defined for the Record Details page, it can be modified as needed. Be sure to review the search pages automatically generated by the wizard to see if any further configuration is required. You can perform any of the following actions to customize existing search page elements.

Modifying a Search Page Definition

Once a search page is defined for the Record Details page, you can modify the search page definition. The search page definition includes properties like the name of the page, the order of the search, the results list to use for the search, and so on.

ProcedureTo Modify a Search Page Definition

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the simple-search-page element you want to modify in the record-details element.

  3. In the simple-search-page element, change the value of any of the elements listed in Record Details Search Page Definition Elements.

    For example:


    <simple-search-page>
       <screen-title>Customer Search</screen-title>
       <search-result-id>2</search-result-id>
       <search-screen-order>2</search-screen-order>
       <show-euid>true</show-euid>
       <show-lid>false</show-lid>
       <instruction>Enter the EUID below.</instruction>
    </simple-search-page>
  4. Save and close the file.

Modifying Search Fields

Once field groups and fields are specified for a Record Details search page, you can modify the properties of the group and of the fields contained in a group. For more information about the elements that contain the search field configuration, see Record Details Search Field Definition Elements.

ProcedureTo Modify Search Fields

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the simple-search-page element you want to modify in the record-details element.

  3. In the field-group you want to modify, do any of the following:

    • To modify the name of the area in which the field group appears in the MIDM, change the value of the description element.

    • To add a new field to a field group, create and name a new field-ref element in the appropriate field-group element.

    • To modify the name of a field defined for a field group, change the value of the field-ref element.

    • To specify whether a field is required, add a required attribute and specify a value defined in Record Details Search Page Definition Elements.

    • To specify whether a field is used for range searching, add a choice attribute and specify a value defined in Record Details Search Field Definition Elements.

    • To delete a field from a field group, delete all text between and including the field-ref tags that define the field to be deleted.

    • To delete an entire field group, delete all text between and including the field-group tags that define the field group to be deleted.

  4. Save and close the file.

Modifying Record Details Search Page Options

Once search options are defined for a Record Details search page, you can modify those options if needed. For more information about the elements that define search options, see Record Details Search Option Elements.

ProcedureTo Modify Search Page Options

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the simple-search-page element you want to modify in the record-details element.

  3. In the search-option element, and do any of the following:

    • To modify the name of the search option button, change the value of the display-name element.

    • To modify the query type of the selected search, change the value of the query-builder element. The query you specify must match a query defined in query.xml.

    • To specify that a search return weighted results, change the value of the weighted element to true.

    • To specify that a search return unweighted results, change the value of the weighted element to false.

    • To specify that wildcard characters can be used in a search, change the UseWildCard parameter value element to true.

    • To specify that wildcard characters cannot be used in a search, change the UseWildCard parameter value element to false.

  4. Save and close the file.

Configuring the MIDM Assumed Matches Page

The Assumed Matches page allows you to search for assumed match records, view a results list, and then view the details for the record you select. You can also undo an assumed match if you think it was made in error. You can configure the name of the tabbed heading for the page, the display order, the number of records to return and display for a search, and the fields to display in the result list. The fields on the search page and in the results list are automatically generated and cannot be modified.

Below is a sample Assumed Matches page definition.


<assumed-matches>
   <root-object>Person</root-object>
   <tab-name>Assumed Matches</tab-name>
   <screen-id>4</screen-id>
   <display-order>3</display-order>
   <search-pages/>
   <search-result-pages>
      <search-result-list-page>
         <search-result-id>0</search-result-id>
         <item-per-page>10</item-per-page>
         <max-result-size>100</max-result-size>
         <field-group>
            <description></description>
            <field-ref>Person.FirstName</field-ref>
            <field-ref>Person.LastName</field-ref>
            <field-ref>Person.SSN</field-ref>
            <field-ref>Person.DOB</field-ref>
            <field-ref>Person.Gender</field-ref>
            <field-ref>Person.Address.AddressLine1</field-ref>
            <field-ref>Person.Address.AddressLine2</field-ref>
         </field-group>
      </search-result-list-page>
   </search-result-pages>
</assumed-matches>

ProcedureTo Configure the Assumed Matches Page

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the assumed-matches element (located in the gui-definition element).

  3. Make any of the following configuration changes:

    • To specify a new name for the Assumed Matches tab, modify the value of the tab-name element.

    • To change the order in which the Assumed Matches tab appears on the MIDM, change the value of the display-order element.


      Note –

      If you change the order of one tab, make sure to change the order of the remaining tabs so no tabs have an identical display order value.


    • To specify the number of records to display on the Assumed Matches search results list, change the value of the item-per-page element.

    • To specify a maximum number of records to return for an Assumed Matches search, change the value of the max-result-size element.

    • To add a search description, enter the description text into the description element.

    • To modify the fields that appear in the results list in addition to the system fields, change the value of an existing field-ref element, create a new field-ref element, or delete an existing field-ref element.

      For example:


      <field-group>
                  <field-ref>Person.FirstName</field-ref>
                  <field-ref>Person.LastName</field-ref>
                  <field-ref>Person.SSN</field-ref>
                  <field-ref>Person.DOB</field-ref>
             </field-group>
  4. Save and close the file.

Configuring the MIDM Transactions Page

The Transactions page allows you to search for transaction records, view a results list, and then view the changes for the record you select. You can configure the name of the tabbed heading for the page, the display order, and the number of records to return and to display in the results list. The fields on the search page and results list are automatically generated and cannot be modified with the exception of the EUID, system, and local ID.

Below is the default Transactions page definition.


<transactions>
   <root-object>Person</root-object>
   <tab-name>Transactions</tab-name>
   <screen-id>2</screen-id>
   <display-order>4</display-order>
   <search-pages>
      <simple-search-page>
         <show-euid>true</show-euid>
         <show-lid>true</show-lid>
      </simple-search-page>
   </search-pages>
   <search-result-pages>
      <search-result-list-page
         <search-result-id>0</search-result-id>
         <item-per-page>10</item-per-page>
         <max-result-size>100</max-result-size>
         <field-group/>
      </search-result-list-page>
   </search-result-pages>
</transactions>

ProcedureTo Configure the Transactions Page

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the transactions element (located in the gui-definition element).

  3. Make any of the following configuration changes:

    • To specify a new name for the Transactions tab, modify the value of the tab-name element.

    • To change the order in which the Transactions tab appears on the MIDM, change the value of the display-order element.


      Note –

      If you change the order of one tab, make sure to change the order of the remaining tabs so no tabs have an identical display order value.


    • To include the EUID as a Transactions search field, change the value of the show-euid element to true.

    • To exclude the EUID from the Transactions search fields, change the value of the show-euid element to false.

    • To include the system and local ID as Transactions search fields, change the value of the show-lid element to true.

    • To exclude the system and local ID from the Transactions search fields, change the value of the show-euid element to false.

    • To specify the number of records to display on the Transactions search results list, change the value of the item-per-page element.

    • To specify a maximum number of records to return for a Transactions search, change the value of the max-result-size element.

  4. Save and close the file.

Configuring the MIDM Reports Page

Configuring the Reports page consists of configuring the page itself and configuring the individual reports. Production reports are each configured in the same way in their own sub-screen definition element. Activity reports are configured together in one sub-screen definition. The sub-screen definitions means there are a series of tabbed pages within the Reports page for each different type of report.

Perform any of the following tasks to configure the reports:

Configuring the Reports Page Definition

For the Reports page, you can configure the name of the tabbed heading for the page and the order in which the tab appears on the MIDM. The report configuration section defines the appearance of the Reports page, and is located within a set of reports tags near the end of the file. Following is a sample of the Reports page configuration elements.


<reports>
   <root-object>Person</root-object>
   <tab-name>Reports</tab-name>
   <screen-id>6</screen-id>
   <display-order>5</display-order>
   <search-pages/>
   <search-result-pages/>

ProcedureTo Configure the Reports Page Definition

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the reports element (located in the gui-definition element).

  3. To specify a different name for the Reports tab, modify the value of the tab-name element.

  4. To change the order in which the Reports tab appears on the MIDM, change the value of the display-order element.


    Note –

    You might need to renumber the remaining tabs to keep the numbering sequential.



    Note –

    You might need to renumber the remaining tabs to keep the numbering sequential.


  5. When you have finished configuring the Reports page, save and close the file.

Configuring Production Reports

A sub-screen on the Reports page is defined for each of the production reports. Use these sections to configure each production report to display information as you want to view it. You can also specify which reports can be run from the MIDM. Following is an example of a report configuration stanza.


<subscreen>
   <enable>true</enable>
   <root-object>Person</root-object>
   <tab-name>Potential Duplicate Report</tab-name>
   <report-name>Potential Duplicate</report-name>
   <screen-id>0</screen-id>
   <display-order>5</display-order>
   <search-pages/>
   <search-result-pages>
      <search-result-list-page>
         <search-result-id>0</search-result-id>
         <item-per-page>10</item-per-page>
         <max-result-size>2000</max-result-size>
         <field-group>
            <description></description>
            <field-ref>Person.FirstName</field-ref>
            <field-ref>Person.LastName</field-ref>
            <field-ref>Person.SSN</field-ref>
            <field-ref>Person.DOB</field-ref>
            <field-ref>Person.Address.AddressLine1</field-ref>
            <field-ref>Person.Address.AddressLine2</field-ref>
            <field-ref>Person.Address.City</field-ref>
         </field-group>
      </search-result-list-page>
   </search-result-pages>
</subscreen>

ProcedureTo Configure Production Reports

Perform the following steps for each production report.

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the reports element (located in the gui-def element.

  3. For each report, specify values for the elements and attributes listed in Production Reports Definition Elements.

  4. When you have finished configuring each report, save and close the file.

Configuring Activity Reports

A sub-screen on the Reports page is defined for all of the activity reports. Use this sections to configure each activity report to display information as you want to view it. You can also specify which reports can be run from the MIDM. Following is an excerpt from the Activity report configuration stanza.


<subscreen>
   <enable>true</enable>
   <root-object>Person</root-object>
   <tab-name>Activity Report</tab-name>
   <report-name>Transaction Summary</report-name>
   <screen-id>5</screen-id>
   <display-order>4</display-order>
   <search-pages>
      <simple-search-page>
         <screen-title>Weekly Activity</screen-title>
         <report-name>Weekly Transaction Summary Report</report-name>
         <search-result-id>0</search-result-id>
         <search-screen-order>1</search-screen-order>
         <field-group/>
      </simple-search-page>
      ...
   </search-pages>
   <search-result-pages>
      <search-result-list-page>
         <search-result-id>0</search-result-id>
         <item-per-page>10</item-per-page>
         <max-result-size>2000</max-result-size>
         <field-group/>
      </search-result-list-page>
   </search-result-pages>
</subscreen>

ProcedureTo Configure Activity Reports

Perform the following steps for each production and activity report.

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the reports element. This section is located near the end of the file.

  3. In the subscreen element that defines the activity reports, modify any of the elements described in Activity Reports Page Definition Elements to configure the Activity Reports page:

  4. For each activity report, modify any of the elements described in Activity Reports Search Elements.

  5. To specify the size and display of the results returned for the search, modify any of the elements described in Activity Reports Results Elements.

  6. When you have finished configuring each report, save and close the file.

Production Reports Definition Elements

The following table lists and describes the elements you can configure in midm.xml to define the production reports.

Element/Attribute 

Description 

enable 

An indicator of whether to display the report search page on the Reports page. Specify true to display the report search page and enable the report; specify false to disable the report.

tab-name 

The name to display on the tabbed heading for the report. 

report-name 

The name of the report as it appears on the generated report. 

display-order 

An integer indicating the order in which each report tab appears on the Reports page. If you change the display order of one report, make sure to change the others to keep the numbers consecutive. 

item-per-page 

The number of items to display on one page of the report search results. 

max-result-size 

The number of records to display on the report. if no value is entered, or if the value is zero (0), the size defaults to 1000 records. To retrieve all records for a report, enter a very large value for this element. 

description

A description of the fields defined for the field-group element. This value appears as a label for the area of the page that contains the specified fields.

field-ref

One field definition for a field in the field group. Use the simple field names of the fields with their corresponding objects as the root. For example, the path to the FirstName field in the Person object is “Person.FirstName”. You can define multiple field-ref elements for each field group.

Activity Reports Definition Elements

The following tables list and describe the elements you can configure for the activity reports in midm.xml.

Activity Reports Page Definition Elements

The following table lists and describes the elements you can configure in midm.xml to define the Activity Reports page.

Element/Attribute 

Description 

enable 

An indicator of whether to display the Activity Reports search page on the Reports page. Specify true to display the report search page and enable the report; specify false to disable the report.

tab-name 

The name to display on the tabbed heading for the report. 

report-name 

The name of the report as it appears on the generated report. 

display-order 

An integer indicating the order in which the Activity Reports tab appears on the Reports page. If you change the display order of one report, make sure to change the others to keep the numbers consecutive. 

Activity Reports Search Elements

The following table lists and describes the elements you can configure in midm.xml to define each activity report search.

Element/Attribute 

Description 

screen-title 

The name of the report search page as it appears on the Activity Reports page. 

report-name 

The name of the report as it appears on the generated report. 

search-screen-order 

An integer indicating the order in which each activity report appears on the Activity Reports page. If you change the display order of one report, make sure to change the others to keep the numbers consecutive. 

Activity Reports Results Elements

The following table lists and describes the elements you can configure in midm.xml to define each activity report search result.

Element/Attribute 

Description 

item-per-page 

The number of items to display on one page of the report search results. 

max-result-size 

The number of records to display on the report. if no value is entered, or if the value is zero (0), the size defaults to 1000 records. To retrieve all records for a report, enter a very large value for this element. 

Configuring the MIDM Source Record Page

The Source Record page is where anMIDM user adds new records to the master index database and performs actions against a source record rather than an enterprise record. This page includes sub-screen configurations, which means there are a series of tabbed pages within the Source Record page. These pages each provide different functions, such as view and edit, compare and merge, and create a new record.

Configuring the Source Record Page Definition

You can configure certain display options for the main Source Record page, including the order in which the tab appears on the MIDM and the name of the page.

ProcedureTo Configure the Source Record Page Definition

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the source-record element (located in the gui-definition element).

  3. To specify a different name for the Source Record tab, modify the value of the tab-name element.

  4. To change the order in which the Source Record tab appears on the MIDM, change the value of the display-order element.


    Note –

    You might need to renumber the remaining tabs to keep the numbering sequential.


  5. Save and close the file.

Configuring the Tabbed Pages on the Source Record Page

You can configure any of the pages on the Source Record page by changing the tab name and display order and by enabling or disabling each page. Do not modify the search page or search results list for the sub-screens. Below is a sample configuration for the View/Edit page on the Source Record page.


<subscreen>
   <enable>true</enable>
   <root-object>Person</root-object>
   <tab-name>View/Edit</tab-name>
   <screen-id>0</screen-id>
   <display-order>0</display-order>
   ...  

You should never need to modify the root-object or screen-id elements.

ProcedureTo Configure the Source Record Tabbed Pages

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the source-records element, and then to the subscreen element containing name of the tab you want to modify.

  3. To specify a new name for the tab, modify the value of the tab-name element.

  4. To disable the sub-screen, change the value of the enable element to false.

  5. To enable the sub-screen, change the value of the enable element to true.

  6. To change the order in which the tab appears on the Source Records page, change the value of the display-order element.


    Note –

    You might need to renumber the remaining tabs to keep the numbering sequential.


  7. Save and close the file.

Configuring the MIDM Audit Log Page

When enabled, the audit log stores a history of each instance in which information from the object tables in the master index database is accessed. The MIDM allows you to search for and view the audit log entries. You can enable or disable the audit log, change the display order, and customize the size of the results list. Below is the default Audit Log page definition.


<audit-log>
   <allow-insert>false</allow-insert>
   <root-object>Person</root-object>
   <tab-name>Audit Log</tab-name>
   <screen-id>7</screen-id>
   <display-order>7</display-order>
   <search-pages>
      <simple-search-page>
         <show-euid>true</show-euid>
         <show-lid>true</show-lid>
      </simple-search-page>
   </search-pages>
   <search-result-pages>
      <search-result-list-page>
         <search-result-id>0</search-result-id>
         <item-per-page>10</item-per-page>
         <max-result-size>100</max-result-size>
         <field-group/>
      </search-result-list-page>
   </search-result-pages>
</audit-log>

ProcedureTo Configure the Audit Log Page

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

    The file opens in the NetBeans XML editor.

  2. Scroll to the audit-log element (located in the gui-definition element).

  3. Make any of the following changes:

    • To specify that records be written to the audit log, change the value of the allow-insert element to true.

    • To specify that records not be written to the audit log, change the value of the allow-insert element to false.

    • To change the name of the Audit Log tab on the MIDM, change the value of the tab-name element.

    • To change the order in which the Audit Log appears on the MIDM, change the value of the display-order parameter to a different integer.


      Note –

      If you change the order of one tab, make sure to change the order of the remaining tabs so no tabs have an identical display order value.


    • To change the number of Audit Log search results that appear on one page, change the value of the item-per-page element.

    • To change the maximum number of audit log records that can be returned for a search, change the value of the max-result-size element.

  4. Save and close the file.