Google Search Appliance OneBox for Enterprise Developers Guide User Manual
Page 27

Google Search Appliance: Google OneBox for Enterprise Developer’s Guide
27
OneBoxResults Elements
The OneBoxResults element supports the following child elements:
Element
Description
resultCode
Optional, a single use of this tag is permitted. The return code is from the
OneBox provider. The value success is assumed if no value is returned, and
results are processed only on success. Although this element is optional, it is
good practice to always return a result code. The value can be one of the
following:
•
success
•
lookupFailure
•
securityFailure
•
timeout
Diagnostics
Optional, a single use of this tag is permitted. If a lookup fails, the provider uses
this element to send diagnostic information and sets the resultCode attribute
to a value other than success. It is not illegal to send a diagnostic alone, or with
a resultCode of success, but the diagnostic message may be logged
differently depending on the implementation. The failure reason string can be
up to 256 characters in length.
provider
Optional, a single use of this tag is permitted. The name of the provider. If this is
an internal provider, specify the collection name. The name need not match the
name provided in the OneBox module definition, and can be more descriptive
than that name. This string can be a brand, URL, or other identifying
information. The provider name can be up to 128 characters in length.
title
Optional, a single use of this tag is permitted. The title of the result, consisting
of a line of text and a link to the full result set from the provider. If one of the
child elements is present, both must be present. The title element contains
the following child elements:
•
Required if you specify the
for example, Search Results. The title can be up to 40 characters in
length.
•
Required if you specify the