JMS Event Handling

JMS Event Handling

Note: The message classes described in this section have largely been superseded by the messages fired by ATG Search Routing. The Routing messages include information used in ATG Search reports, whereas these messages do not. For information about the Routing messages, see the ATG Search Installation and Configuration Guide.

Each of the search form handlers has a searchMessageSource property that specifies a component of class atg.search.query.messages.SearchMessageSource. This component is a Patch Bay message source that fires JMS messages when query results are received from ATG Search. The form handler uses the data in the Results object to construct a message object, which is sent off by the SearchMessageSource.

Each form handler uses a different search message class. The message classes are all subclasses of atg.search.query.messages.SearchMessage, which has several properties that are common to all query types. Each subclass has additional properties that are specific to the corresponding query type.

The following tables summarize the properties of the SearchMessage class, plus the properties added by the subclasses.

SearchMessage

Property	Description
`JMSType`	The JMS type (supplied by the message subclasses)
`optionSetName`	The option set used for the search; empty for the default option set
`resultCount`	The number of results returned from the search
`results`	The results object returned from the search
`siteName`	The search site name
`userProfile`	The profile of the user executing the query
`version`	The request version

BrowseMessage

Property	Description
`queryText`	Text submitted in the body of the `<input>`

CategorizeMessage

Property	Description
`queryText`	Text submitted in the body of the `<input>`
`queryMode`	One of the following: text \| question \| document \| xhtml

QueryMessage

Property	Description
`queryText`	The request’s `queryText` and concatenated prior input
`pageNumber`	The page number requested
`queryMode`	One of the following: nlp \| boolean \| and \| keyword \| matchall

SimilarDocsMessage

Property	Description
`queryText`	The request’s `queryText` and concatenated prior input
`queryMode`	One of the following: text \| question \| document \| xhtml

StructuredQueryMessage

Property	Description
`queryText`	A concatenation of all `<statement>` bodies that have an `op` attribute that is not `negative`
`excludeQueryText`	A concatenation of all `<statement>` bodies that have an `op` attribute that is `negative`
`pageNumber`	The page number requested

ViewInContextMessage

Property	Description
`docContextID`	Text submitted in the body of the `<docContextID>`
`input`	Text submitted in the body of the `<input>`
`property`	Text submitted in the body of the `<property>`
`return`	Text submitted as the value of the `returnType` request attribute
`url`	Text submitted in the body of the `<url>`
`value`	Text submitted in the body of the `<value>`

Contents
Search

loading table of contents...