beautypg.com

Module definition schema, Onebox element – Google Search Appliance OneBox for Enterprise Developers Guide User Manual

Page 22

background image

Google Search Appliance: Google OneBox for Enterprise Developer’s Guide

22

Module Definition Schema

The OneBox module definition schema file is available in the onebox.xsd file, which is available in the
OneBox simulator download (

http://google-developers.appspot.com/search-appliance/download/

downloadsdk

). Your OneBox module definition XML file must conform to this schema.

For information about GET call parameters, see “Call Parameters” on page 25.

The GoogleEnterpriseSources element contains the following elements:

child-elements

child-elements

child-elements

Note: The globals element provides the Admin Console with the maximum number of OneBox results
per search and the OneBox response timeout in milliseconds. Do not put the globals element in your
XML file. Similarly, the Admin Console uses the ModulesPerFrontend element internally. Do not put the
ModulesPerFrontend element in your XML file.

onebox Element

The onebox element provides the root element of a onebox module definition. This element contains all
of the settings for a module.

Note: Do not set the id= attributes that appear in the onebox.xsd file. The search appliance does not
use any of the id attributes.

Syntax

string

username
password


string
keyword1|keyword2|keywordn
url
name

...

The onebox.xsd elements are as follows:

attributes_and_child_elements

Required. Indicates OneBox configuration
parameters.