You can configure optional Relevance Ranking Evaluator properties in the evaluator.properties file.

The Relevance Ranking Evaluator offers additional configuration options that are geared towards overall application behavior changes. These options are for specific use cases, such as deployments with large data sets, large number of properties, or if you want to display record images. Some of the configuration options might be necessary if you observe performance issues when you use Relevance Ranking Evaluator.

To configure the Relevance Ranking Evaluator properties:

  1. Navigate to %ENDECA_TOOLS_CONF%\conf (on Windows) or $ENDECA_TOOLS_CONF/conf (on UNIX).

  2. Open evaluator.properties in a text editor.

  3. Add or edit any of the following properties:

    Property

    Description

    MDEX_VERSION

    To hide capabilities that are invalid for your version of the MDEX Engine, enter your MDEX Engine version as a three digit number.

    For example, MDEX_VERSION=642

    MDEX_PORT

    Set this property if you use an MDEX port other than the default of 15002.

    MDEX_HOST

    Set this property so that it points to the correct host name for the MDEX Engine in your environment. The default if you do not set this is localhost.

    DISPLAYED_ATTRIBUTES

    Set this property for data with large number of properties and dimensions on each record, or if you want to limit the properties that display within the evaluator Results section. This option must be listed on a single line and must consist of a comma-delimited list of property and dimension names.

    For example, DISPLAYED_ATTRIBUTES=P_DateReviewed,P_Description

    The dimension and property names display within the Search Results Comparison section when you click Show All Dimensions and Properties. If you receive an error or observe performance issues when you use Relevance Ranking Evaluator, it might be necessary to set this property.

    MAX_DISPLAYED_ATTRIBUTES

    If you have a large number of dimensions and properties, you can set MAX_DISPLAYED_ATTRIBUTES to restrict the number returned for display. If this is not set, the default is 100 -- only the first 100 dimensions and properties appear.

    For example, to show the first 50 properties and dimensions: MAX_DISPLAYED_ATTRIBUTES=50

    STATIC_MODULE_PROPERTIES

    If your data has a large number of properties, or if you want to limit the properties that are available for selection when choosing a property for the Static module, you can set STATIC_MODULE_PROPERTIES. Enter this property as a comma-delimited list of property names on a single line. The property names that you enter are the properties that display for selection when a user configures the Static module. If you receive an error or observe performance issues when attempting to configure the Static module, consider setting this option.

    For example:

    STATIC_MODULE_PROPERTIES=P_Name,P_Description

    RECORDS_TO_DISPLAY_OPTIONS

    If you want to display a different number of records than the default set of options provides (10, 25 and 50), set this property. Enter it on a single pipe-delimited line within the evaluator.properties file. For example: RECORDS_TO_DISPLAY_OPTIONS=10|25|50|100

    DEFAULT_ROLLUP_KEY

    Though the application allows users to specify the aggregated record rollup key, you can set a default one as well.

    For example, to have p_id as the default rollup key for your records, you can add this line to the evaluator.properties file:

    DEFAULT_ROLLUP_KEY=p_id

    STORED_STRATEGY_<N>

    You can include an arbitrary number of pre-defined search strategies in the evaluator. By default, the application ships with sample Retail and Document strategies, which can be modified, deleted, or extended. Each stored strategy must be distinct in both module order and module options enabled. Each strategy must be identified by STORED_STRATEGY_<N>, ending with its numeric identifier, which must start at 1 and increment by 1 for each additional strategy.

    For example, to include two additional strategies, you can add the following pipe-delimited lines to the evaluator.properties file similar to this:

    STORED_STRATEGY_1=stem|thesaurus|stratify(collection()/record[P_Score>90],*,collection()/record[P_Score<50])|nterms(considerFieldRanks)|maxfield|glom|phrase(subphrase,query_expansion,considerFieldRanks)|static(P_Price,descending)

    STORED_STRATEGY_2=nterms(considerFieldRanks)|maxfield|glom|exact(considerFieldRanks)

    STORED_STRATEGY_<N>_NAME

    If you use stored strategies as described in the previous section, include these properties to label them. Each strategy defined as a STORED_STRATEGY must have a corresponding name defined wtih this property.

    To specify names for the STORED_STRATEGY_1 and STORED_STRATEGY_2 examples, include the following properties in the evaluator.properties file:

    STORED_STRATEGY_1_NAME=Mike’s Stratify Strategy

    STORED_STRATEGY_2_NAME=Document Strategy

    ORDER_ATTRIBUTES

    Sets the display order for the properties to be the value set in DISPLAYED_ATTRIBUTES. By default, the application shows properties in alphabetical order. For example:

    ORDER_ATTRIBUTES=true

    IMAGE_DISPLAY_TEMPLATE

    Use with IMAGE_PROPERTY_NAME. This option lets you specify a URL format by which to retrieve images to display for the records.

    For example, if the default image path is http://www.acme.com/image/products/123456$thumbnail$, where 123456 is the image ID as in the value of IMAGE_PROPERTY_NAME, then add the following line to the evaluator.properties file:

    IMAGE_DISPLAY_TEMPLATE = http://www.acme.com/image/products/###IMAGE###?$thumbnail$

    IMAGE_PROPERTY_NAME

    Use with IMAGE_DISPLAY_TEMPLATE. This option lets you specify a URL format by which to retrieve images to display for the records.

    For example, if the default image path is http://www.acme.com/image/products/123456$thumbnail$, where http://www.acme.com/image/products/###IMAGE###?$thumbnail$ is the value of IMAGE_DISPLAY_TEMPLATE, then add the following line to the evaluator.properties file:

    IMAGE_PROPERTY_NAME = P_Product_Image

  4. Save and close the file.

  5. Restart the Endeca Tools Service.

After you have finished configuring properties for the Relevance Ranking Evaluator, business users can test and experiment with relevance ranking strategies. See the Workbench User's Guide for more information.


Copyright © Legal Notices