Google onebox for enterprise developer’s guide, Introduction – Google Search Appliance OneBox for Enterprise Developers Guide User Manual
Page 4
Google Search Appliance: Google OneBox for Enterprise Developer’s Guide
4
Google OneBox for Enterprise
Developer’s Guide
A OneBox module provides real-time access to data from an external source, or a collection on a search
appliance.
This document describes how to define a OneBox module and how to use the OneBox Simulator (
), which enables you to test
your OneBox code before putting your code on a search appliance.
Before starting development, refer to Google OneBox for Enterprise Design Principles, which provides
information about how to design a OneBox module. Google also provides the Custom KeyMatch
OneBox
).
Introduction
Google OneBox gives users access to real-time data through a simple, fast, and easy to configure search
interface.
A OneBox defines a search type, the keyword that invokes the search, and the way that a search
appliance obtains and returns information after a user invokes a search. You can define any number of
OneBox modules, and a user search page can display results from up to four OneBox modules.
A OneBox module consists of the following components:
•
General Information—Defines the module. Includes a name for reference and an internal
description.
•
Trigger—Specifies the keywords or query type that cause a module to request data from a search
appliance.
•
Provider—Gives the location of a search appliance collection or an external provider that is
responsible for resolving the query. Defines access control parameters that indicate whether the
module returns public or secure (user-specific) information.
•
Security—Optionally specifies whether a search appliance securely authenticates itself, the end
user, or both to the external provider, and passes authentication information if necessary.
•
Results Template—Defines an XSLT template that translates the returned data into HTML.
You define this information on a search appliance by entering the information in the Admin Console or
by specifying the information in an XML configuration file and importing it. For information on XML
schema, see the “OneBox Module Definition XML Reference” on page 21.