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

Google Search Appliance: Google OneBox for Enterprise Developer’s Guide 23
Element Attributes
Child Elements
Attribute Description
type="internal"|"external" Required. The type of onebox module, internal (calling a
collection) or external (calling an external provider).
suppressDateTime="true"|"false" Optional. Determines whether the search appliance
passes date and time information to the external
provider.
suppressIPAddr="true"|"false" Optional. Determines whether the search appliance
passes the IP address of the querying user’s machine.
Element Description
name string
Required. The name of the OneBox module. The name can be up to
32 characters in length and must contain at least one character. The name
can consist only of the characters A–Z, a–z, 0–9, dot, and dash.
security child-elements
Optional. Defines user-level access control and security between the search
appliance and the provider. User-level access is defined by the userAuth
attribute and security between the search appliance and a provider is defined
by means of the GSA_username and GSA_password attributes.
The element has the following attribute:
• userAuth="none"|"basic"|"LDAP"|"SSO"
Required if the element is present. The type of user-level
access control to apply. If you specify a value other than none, you must
configure the search appliance with the appropriate settings.
The element contains the following child elements:
• username
Optional. The user name for the search appliance, in an HTTP Basic
authentication request to the provider. The maximum user name length is
32 characters. If you define this element, the appliance makes an HTTP
Basic authentication request to the provider passing the credentials
defined in the HTTP header. If authentication is not required, specify
without a value as .
• password
Optional. The password for the search appliance, in an HTTP Basic
authentication request to the provider. The maximum password length is
32 characters. If you define this element, the appliance makes an HTTP
Basic authentication request to the provider passing the credentials
defined in the HTTP header. If authentication is not required, specify
without a value as .