Normally, a user interface presents the search result list and allows the user to select a result for viewing. The View Item request supports this. The request requires only the identifier of the item to view, which is contained in the retrieved document result object. ATG Search uses the identifier to look up the original source content, typically an HTML or XHTML file (other rich content types are converted to HTML during indexing, except PDF files, which are described in the Viewing PDF Content section).

The View Item request can also accept text regions which will be highlighted in the returned source content. The text regions are also contained in the retrieved document result object. These text regions are translated into regions in the source content, and <span> tags are inserted to implement the highlighting.

Together, the item identifier and text regions are called the context ID, which is passed in the request XML as shown:

<docContextID>doc:begin.end,begin.end,... </docContextID>

The doc is the document identifier, and the pairs of begin and end values are the text regions. More than one region may be passed. A pair of 0.0 represents an empty highlighting region.

loading table of contents...