Defining the values for XML attributes for a search attribute

Name

Attribute

Attributes/Attribute

Indicates the XML name of the search attribute. This component, along with the XPath, is used to set the source and target binding for the control that is displayed in the UI.

DataType

Attribute

Attributes/Attribute

Indicates the data type of the search attribute. If data Type is not provided, it is derived using the XPath and the Name attribute values. You can use the DataType attribute to override the default data types. Each data type is mapped to String, Date, or Number. If query types are not explicitly mentioned, this mapping is used to display the query types in the UI.

DisplayName

Attribute

Attributes/Attribute

Indicates the bundle key of a label that is displayed in a drop-down list for search attributes. If the label is not mentioned, the Name attribute is considered as the bundle key to display the label. This bundle entry should be defined in the server-side bundle file.

XPath

Attribute

Attributes/Attribute

Indicates the XML path of the element to which the search attribute belongs.

DefaultQueryTypes

Attribute

Attributes/Attribute

Indicates the default query type for the search attribute. If DefaultQueryTypeDesc is not set for an attribute, set it by performing this procedure:

Get the supported query types by either reading the overridden query types or using the out-of-the-box query types for the data type of the attribute. Because Equal is the most commonly used query type, verify if it is one of the supported query types. If yes, use Equal as the default. Otherwise, use the first query type, which is displayed in the list of supported query types.

StringQueryTypes

Element

Attributes/Attribute

Indicates that out-of-the-box string query types are being overridden with the child elements of the StringQueryTypes element. If all the possible StringQueryTypes are not required, create one QueryType child element of StringQueryType for each query type you want to support.

DateQueryTypes

Element

Attributes/Attribute

Indicates that out-of-the-box date query types are being overridden with the child elements of the DateQueryTypes element. If all the possible date query types are not required, create one QueryType child element of DateQueryType for each query type you want to support.

NumericQueryTypes

Element

Attributes/Attribute

Indicates that out-of-the-box numeric query types are being overridden with the child elements of the NumericQueryTypes element. If all the possible NumericQueryTypes are not required, create one QueryType child element of NumericQueryType for each query type you want to support.

QueryType

Element

OR

OR

Indicates the query types that are supported for the search attribute. See the Query Types Supported for Search Attribute section for detailed information on the supported parameters.

QueryType

Attribute

OR

OR

Indicates the query type. For more information about the supported query types, see the description of the QueryType Element.

QueryTypeDesc

Attribute

OR

OR

Indicates the bundle key of the label that is displayed for the query type in the UI. If the value of QueryTypeDesc is not set, the QueryTypeDesc attribute value corresponding to the query type is considered as the bundle key that will display the query type label. This bundle entry should be defined in the server-side bundle file. For more information about the supported query types, see the description of the QueryType Element.

Configuration

Element

Attributes/Attribute

Indicates that the search attribute will have certain configuration for UI control and possible values of the search attribute.

ActionURL

Attribute

Attributes/Attribute/Configuration

Indicates the action that returns the list of possible values for the search attribute. This action may either return the static list of predefined values or call the corresponding API to get them, and then return them. For example, the ActionURL can return the values pertaining to the common codes, currency, and countries or regions.

UIControlConfiguration

Element

Attributes/Attribute/Configuration

Indicates that the search attribute will have certain configurations for UI control.

xtype

Attribute

Indicates the type of the control that is displayed in the Advanced Search screen for the search attribute. See the Possible xtypes for an Attribute section for the list of xtypes and descriptions.

optionsBinding

Attribute

The optionsBinding attribute is used to specify the repeating elements of the list that constitutes one value of either combination box values or radio button values.

displayField

Attribute

The displayField attribute specifies the attribute whose value is used as the label.

valueField

Attribute

The valueField attribute is used to uniquely identify the repeating element in order to display the correct value of the selected option from either a combination box or a radio button.