Criteria For Real-Time Searches

You can include a webform to present the search criteria for real-time searches for indexed (parametric) object attributes.

You can define a configurable webform to display the search criteria fields when real-time search is used. Real-time search is used if:


  • The emxFramework.FullTextSearch.QueryType property is set to Real Time in emxSystem.properties

    Or:

  • The querytype=RealTime URL parameter is passed to emxFullText.jsp.

When defining fields for this form, you must define a name and a label. Any select or expressiontype settings defined will be ignored. The field name must be the same as the indexed field definition in config.xml in a <BOTYPEFIELD> section for the object type being search for. For example, if the config.xml file includes these lines:

<BOTYPEFIELDS name="person">
     <FIELD name="FIRSTNAME" select="attribute[First Name]"
          type="STRING,PARAMETRIC" />
</BOTYPEFIELDS>

You would add a field named FIRSTNAME to the webform. In addition, the label for the field should refer to the string resource for that attribute, such as emxFramework.FirstName. This example assumes the registered suite is the default, Framework. For fields defined in other products, use the appropriate string resources file.

This table lists the settings supported for fields in the webform.

Setting Name Description Possible / Sample Values
Registered Suite The application the where the string resources are defined for the form labels. The system looks for files related to the component in the registered directory for that application, which is specified in emxSystem.properties. Framework (default)

suitename

Access Expression Controls access to the field based on a valid MQL expression. The expression gets evaluated at runtime against the context user's Person object. If the expression evaluates to True and no other access control prevents access, the field is shown, otherwise it is hidden. Any valid expression
Access Function The name of the JPO method to invoke in the JPO specified for the Access Program setting. The Access function gets the input parameter as a HashMap, which contain all the request parameters that were passed into the Form page. The JPO method must return an object of class Boolean. If the returned value is true and no other access control prevents access, the field is displayed. If false, it is hidden. JPO method name
Acces Program Controls access to a field based on the output from a method in the specified JPO program. This setting requires that the Access Function setting also be specified. If Access Function is not set, the Access Program setting is ignored. JPO program name