Class Name

atg.search.cache.droplet.GetClickThroughId

Component

/atg/search/droplet/GetClickThroughId

This servlet bean takes as input a single search result, stores it in a document cache, and returns a click-through ID associated with the result. This ID can subsequently be used by the SearchClickThroughServlet to retrieve the result from the cache.

GetClickThroughId is typically used in a loop that renders a list of search results as hyperlinks to pages displaying those items. For each result, the click-through ID is set as the value of a query parameter that is appended to the URL.

Properties

The following table describes the properties of the GetClickThroughId component and their default settings.

Property

Description

searchResultParameter

Name of the input parameter that specifies the search result. Default: result

searchClickIdParameter

Name of the output parameter that holds the click-through ID. Default: searchClickId

searchQueryCachePath

String specifying the Nucleus pathname of the cache component. Default: /atg/search/cache/SearchQueryCache

searchClickIdDelimiter

Delimiter separating the query identifier and the document identifier in the click-through ID. Default: the comma character (,)

Input Parameter

result
The current search result.

Output Parameter

searchClickId
The click-though ID for retrieving the current search result from the cache.

Open Parameter

output
The open parameter for rendering the click-through ID.

Example
<dsp:droplet name="/atg/search/droplet/GetClickThroughId">
  <dsp:param name="result" value="${searchResult}" />
   <dsp:oparam name="output">
     <dsp:a href="/myapp/en/product.jsp">
       <dsp:param name="searchClickId" param="${searchClickId}"
     </dsp:a>
   </dsp:oparam>
</dsp:droplet>