Implementing the Search Information Tool

Your site must have implemented the <isobject> tag in the storefront ISML templates for search results in order to use this tool. If your storefront is based on the SiteGenesis application, these tags are automatically implemented for your storefront. If you have tagged your storefront to take advantage of the active merchandising feature, these tags are already implemented for your storefront. You might need to implement these tags if your storefront is based on the legacy Reference Application.

To implement the Search Information tool, you must add the <isobject> tag in the template that loops over the product search results. You can specify either <isobject object="object" view="none"> or <isobject object="object" view="searchhit">. The value you choose determines whether you see the search information for search results or search model. If the value is searchhit, you see search results information. This is indicated by a light green icon. If the value is none, you see search model information. This is indicated by a dark green icon. See Using the Search Information Tool. If view="searchhit", the <isobject> tag must enclose a ProductHit passed as an attribute in your ISML template. If view="none", the <isobject> tag must enclose a SearchModel passed as an attribute in your ISML template.

For example, the productgrid.isml template in the SiteGenesis application contains the following:

<isobject object="${LoopProductHit}" view="searchhit">

Active Merchandising and the Search Information Tool

You don't have to enable active merchandising for your instance to use the <isobject> tag for the Search Information tool. If active merchandising isn't enabled, then analytics data is never collected, though search information is still shown in the Search Information tool.

If you tag the ProductHit with <isobject object="object" view="none">, then no analytics data is collected for this object, although search information is still collected for the Search Information tool. If you tag the ProductHit with <isobject object="object" view="searchhit"> then analytics data is collected.

SiteGenesis Implementation

SiteGenesis contains code that demonstrates how to implement the tags.

In the productdetails.isml file, for example:

<isobject object="${LoopProductHit}" view="searchhit">

Set the view attribute value to none if you don't want active merchandising to collect data for the search result. You would do this if you are not interested in the search result or expect that no results were found for a search.

Related Links

isobject element