Non-MDEX Engine URL parameters

Although we have attempted to keep the UI reference implementation as pure as possible, it is still necessary to use some non-MDEX Engine URL parameters to maintain application state independent of the MDEX Engine query.

It is important, when building your own application, that you remove these parameters (unless they are required by your application). For example, if the MDEX Engine location is specified in a configuration file, it is no longer necessary to maintain or support the eneHost and enePort parameters.

The non-MDEX Engine URL parameters that are used in the UI reference implementation are described in the following table:

Parameter

Description

eneHost

Used by the misc_ene_switch module to dynamically set the MDEX Engine hostname with each request.

This parameter is particularly useful during development, but should be removed from a production deployment.

enePort

Used by the misc_ene_switch module to dynamically set the MDEX Engine port with each request.

As with eneHost, this parameter is particularly useful during development, but should be removed from a production deployment.

displayKey

Used by nav_records and nav_supplemental to identify the property key that should be used to represent the name of a record.

This parameter is useful for data inspection where different data sets may require different property keys to name the records.

You should remove the displayKey parameter from a production deployment as the record names should never change.

hideProps

Provides a simple means of hiding properties for each record in the nav_records module.

hideSups

Provides a simple means of hiding the data that is returned with each supplemental object in the nav_supplemental module.

hideMerch

Provides a simple means of hiding the data that is returned with each supplemental merchandising object in the nav_merch module.

Copyright © Legal Notices