Google Search Appliance OneBox for Enterprise Developers Guide - Manual (Page 24)

Google Search Appliance: Google OneBox for Enterprise Developer’s Guide 24
description text
Optional. A textual description of what the OneBox module does. This value is
important if you plan to make the modules that you develop available for
others to use. The description can contain up to 512 characters.
trigger keyword_or_regex
Optional. The trigger expression determines when the search appliance invokes
the module. For information on regular expression syntax, see “Triggering
When the Query Matches a Regular Expression” on page 10.
You can specify multiple trigger values by separating each value with an OR
symbol or a pipe (|). For example, you can specify bug|CR trigger>. The trigger element has the following required attribute:
• triggerType="null"|"keyword"|"regex"
Required if the element is present. The triggerType can have
one of the following values:
• null—Trigger the keyword on every search. The OneBox module then
appears in all search results.
• keyword—Trigger only when a search string starts with the indicated
keyword or keywords.
• regex—Trigger when a search string matches the regular expression
statement. For information on the regular expression syntax, see
“Triggering When the Query Matches a Regular Expression” on page 10.
collection collection_name
Optional. Specifies the collection that is the provider for an internal OneBox
module. If the type attribute of the onebox element is set to internal, this
element must contain a collection name. The collection name can be up to 32
characters in length.
providerURL url
Optional. A fully qualified URL to which the GET request is passed for an
external OneBox module. If the type attribute of the onebox element is set to
external, this element must contain a URL. If the URL uses the HTTPS protocol,
the search appliance creates a secure (SSL) session with the provider.
resultsTemplate child_elements
Optional. The search appliance uses the XSLT template to convert the XML
response from the provider into HTML for the end user. The top level element
must be the element which will be matched to generate the
HTML results. The element must include a name attribute, and
must not include have the match attribute, which interferes with other
stylesheet operations in the search appliance front end. You can include other
elements within the stylesheet.
Element Description