Configuring Sun Master Indexes (Repository)

Configuring the Master Index EDM Search Pages (Repository)

The search pages that appear on the EDM are configured in the Enterprise Data Manager file. The eo-search element, which is nested in the page-definition element of the gui-definition element, contains all of the configuration information for the search pages that appear on the EDM. If you add a new query to the Candidate Select file and you want to access that query from the EDM, you must create a new search page for the query.

Perform any of the following actions to configure the search pages of the EDM. Though some search options can be configured using the Configuration Editor, it is best to modify the XML file directly.

Specifying Standard EDM Search Page Properties (Repository)

Standard search properties include the type of object returned by each search, the name of the tabbed header for the search pages, and the URL for entry into the search area. These properties apply to all search pages you define, and they can be modified as needed.

To Specify Standard Search Page Properties

In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

The file opens in the NetBeans XML editor.

Scroll to the page-definition element in the gui-definition element.

In the eo-search element, modify any of the following elements. Do not modify the tab-entrance element.
- root-object – The name of the object returned by the search (this must be the name of the parent object).
- tab-name – A name for the search pages. This name appears on tab label associated with the search pages on the EDM.
For example:
<root-object>Person</root-object> <tab-name>Customer Search</tab-name> <tab-entrance>/stcedm/EnterEOSearchSimpleAction.do</tab-entrance>

Save and close the file.

Creating a Search Page for the EDM (Repository)

Several search pages are defined by default by the wizard, including the simple lookup page, advanced lookup pages, and the comparison lookup page. You can create additional search pages if needed. Perform the following 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, how many fields to list in each row, 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 optional 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.

To Define the Search Page

In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

The file opens in the NetBeans XML editor.

Scroll to the page-definition element in the gui-definition element.

In the eo-search element, create a simple-search-page element.

Make sure the new element falls within the eo-search element, but outside any existing simple-search-page elements. For example:
<eo-search> <simple-search-page> ... </simple-search-page> <simple-search-page> </simple-search-page> </eo-search>

In the new simple-search-page element, create the elements listed in EDM Search Page Definition Elements and enter the appropriate value for each element.

For example:

<eo-search>
   <simple-search-page>
    ...
   </simple-search-page>
   <simple-search-page>
      <screen-title>Address Search</screen-title>
      <field-per-row>1</field-per-row>
      <show-euid>true</show-euid>
      <show-lid>false</show-lid>
      <instruction>Enter address information below.</instruction>
   </simple-search-page>
</eo-search>

Continue to Step 2: Define the Search Fields.

Step 2: Define the Search Fields

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

To Define Search Fields

Complete Step 1: Define the Search Page.

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

For example:

<simple-search-page>
   <screen-title>Simple Person Search</screen-title>
   <field-per-row>2</field-per-row>
   <show-euid>false</show-euid>
   <show-lid>false</show-lid>
   <field-group>
   </field-group>
</simple-search-page>

In the new field-group element, create the elements and attributes listed inEDM Search Field Definition Elements and enter the appropriate value for each.

For example:

   <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>

Repeat steps 2 and 3 for each field group you want to display on the selected search page.

Continue to Step 3: Specify Search Options.

Step 3: Specify Search Options

After you define the criteria fields for the EDM search, you must 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.

To Specify Search Options

Complete Step 2: Define the Search Fields.

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>
   <field-per-row>2</field-per-row>
   <show-euid>false</show-euid>
   <show-lid>false</show-lid>
   <field-group>
    ...
   </field-group>
   <search-option>
   </search-option>
</simple-search-page>

In the new search-option element, create the elements listed inEDM 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>
   <candidate-threshold>2000</candidate-threshold>
   <parameter>
     <name>UseWildCard</name>
     <value>true</value>
   </parameter>
</search-option>

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.

Save and close the file.

EDM Search Page Definition Elements

The following table lists and describes the elements you can configure in the Enterprise Data Manager file to define the search pages on the EDM.

Element	Description
screen-title	The name of the search as it appears in the Search Type drop-down list, from which users can select a type of search to perform.
field-per-row	The number of fields to display in each row on the search page.
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. When the EUID is displayed, it appears in its own labelled box.
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). When the local ID is displayed, the local ID and system fields appear in their own labelled box.
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.

EDM Search Field Definition Elements

The following table lists and describes the elements you can configure in the Enterprise Data Manager file to define the fields for each search on the EDM.

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	The simple field names of the fields in the field group using 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.
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 – At least one of the fields with this designation is required to perform the search. This is used to specify 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 the Object Definition file. Otherwise, searches performed from the EDM 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 the Candidate Select file 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 EDM. For more information about range searching, see Candidate Select Configuration (Repository) in Understanding Sun Master Index Configuration Options (Repository).

EDM Search Option Elements

The following table lists and describes the elements you can configure in the Enterprise Data Manager file to define the attributes for each search on the EDM, 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 the Candidate Select file.
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 is only 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 EDM (Repository)

Once a search page is defined, it can be modified as needed. 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 in the Enterprise Data Manager file, you can modify the search page definition. The following properties can be modified: the name of the search, the number of fields that appear on each row of the search page, and whether the EUID or local ID fields are visible.

To Modify a Search Page Definition

In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

The file opens in the NetBeans XML editor.

Scroll to the page-definition element in the gui-definition element.

Scroll to the eo-search element, and then to the simple-search-page element you want to modify.

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

For example:

<simple-search-page>
   <screen-title>Customer Search</screen-title>
   <field-per-row>2</field-per-row>
   <show-euid>true</show-euid>
   <show-lid>false</show-lid>
   <instruction>Enter the EUID below.</instruction>
</simple-search-page>

Save and close the file.

Modifying Search Fields

Once field groups and fields are defined for a 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 EDM Search Field Definition Elements.

To Modify Search Fields

In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

The file opens in the NetBeans XML editor.

Scroll to the page-definition element in the gui-definition element.

Scroll to the eo-search element, and then to the simple-search-page element you want to modify.

In the simple-search-page element, scroll to the field-group you want to modify, and do any of the following:
- To modify the name of the boxed area in which the field group appears in the EDM, 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 appropriate field-ref element.
- To specify whether a field is required, add a required attribute and specify a value defined in EDM Search Field Definition Elements.
- To specify whether a field is used for range searching, add a choice attribute and specify a value defined in EDM 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.

Save and close the file.

Modifying Search Options

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

To Modify Search Options

In the Projects window, expand the Configuration node in the project you want to modify, and then double-click the Enterprise Data Manager file.

The file opens in the NetBeans XML editor.

Scroll to the page-definition element in the gui-definition element.

Scroll to the eo-search element, and then to the simple-search-page element you want to modify.

In the new simple-search-page element, scroll to 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 the Candidate Select file.
- 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.

Save and close the file.