Configuring Sun Master Indexes (Repository)

Master Index Query Block Fields and XML Elements (Repository)

The following table lists and describes the fields on the Block Rule dialog box of the Configuration Editor, along with the corresponding elements and attributes in the Candidate Select file. To see how the XML elements are organized, see the sample in Adding a Query Block to a Master Index Query (Repository). For more information about the structure of a query block, see Candidate Select Configuration (Repository) in Understanding Sun Master Index Configuration Options (Repository).

Configuration Editor Field

XML Element/Attribute 

Description 

Field

field 

The name of the field to be included in the query block. On the Configuration Editor, you can click Browse to select a field or enter the fully qualified field name manually. 

Source

source 

The name of the source field in the object from which the criteria is obtained. Click Browse to select a field, or enter the qualified field name manually. An asterisk (*) can be used as a wildcard character.  


Tip –

When a field in a child object is defined for a blocking query, use the asterisk wildcard character in the ePath to the source field to ensure all instances of the child object in an incoming message are used as search criteria. Each instance is joined by an OR operator. For example, this configuration:


   <field>Enterprise.SystemSBR.Person.Name.FirstName
   </field>
   <source>Person.Name[*].FirstName</source>

would result in a WHERE clause similar to this:

WHERE Name.FirstName=”Meg” OR Name.FirstName=”Maggie”


Operator

type of search

An indicator of the type of search to perform on the field. On the Configuration Editor, you can select one of the following values from the drop-down list. In the XML file, you specify one of the following names for the XML element that defines one field in a query block. 

  • equals - Performs an exact search against either the criteria or the value defined for the “Use Constants” option.

  • not-equals - Searches for values that do not equal either the criteria or the value defined for the “Use Constants” option.

  • greater-than-or-equal - Performs a search for values that are greater than or equal to either the criteria or the value defined for the “Use Constants” option.

  • less-than-or-equal - Performs a search for values that are less than or equal to either the criteria or the value defined for the “Use Constants” option.

  • range - Performs a search against a range of either static or user-defined ranges. If you select this option, you must specify upper and lower bounds.


Tip –

If a field is to be used for simple range searching (where the user or incoming message supplies lower and upper limits of the range are supplied) be sure to define that field for range searching in the Enterprise Data Manager file for the searches that use this query. For more complex range searches that use offset values or constants instead of user-supplied limits, do not define the field for range searching in the Enterprise Data Manager file.


Use Constant/Value

constant 

On the Configuration Editor, this is an indicator of whether to use a constant value as the search criteria for the field. When this option is selected, you need to enter the constant in the corresponding Value field. In the XML file, enter the value of the constant in the constant element.

Upper Bound Type

upper-bound/type 

For range searching only, the type of value to use for the upper limit of the search range. Select or enter one of the following options. 

  • not defined - No specific upper limit is defined; a user enters the value when performing the search. Be sure to define this field for range searching in the EDM as well. In the XML file, this is indicated by omitting the upper-bound element.

  • constant - A specific value is defined to use as the upper limit of the range when no search criteria is entered or when incomplete information is available.

  • offset - A value to be added to the user-supplied value to determine the upper limit on the search range.

    For constant and offset, enter the value in the corresponding Value field.

Lower Bound Type

lower-bound/type 

For range searching only, the type of value to use for the lower limit of the search range. Select one of the options listed for Upper Bound Type. If you select offset, the value you specify for the offset will be subtracted from the user-supplied value. 

Value (for the upper and lower bounds)

upper-bound 

lower-bound 

For constant and offset range searching, the upper or lower limit of the range. For constants, this is the upper or lower limit; for offsets, this is the value added to or subtracted from the user-supplied value. It can be numeric, date, or string. In the XML file, the upper-bound and lower-bound elements fall within an element named default.