Planning, Defining a onebox module in the admin console – Google Search Appliance OneBox for Enterprise Developers Guide User Manual
Page 7
Google Search Appliance: Google OneBox for Enterprise Developer’s Guide
7
Planning
When defining a OneBox module, you need to work with the Admin Console for configuration and may
need additional software to facilitate your use of OneBox modules:
•
First time use, define the OneBox from the Admin Console. For more information, see “Defining a
OneBox Module in the Admin Console” on page 7.
•
Using an internal provider, you can define your OneBox from the Admin Console or with an XML
configuration file. For more information, see “Using an Internal Provider” on page 11.
•
Using an external provider:
•
You need to create an XML configuration file.
•
You need to ensure that the external provider has a programmatic way of formatting the data
and creating XML data for the data that appears in the search results. The output XML file must
conform to the OneBox Results Schema (see “OneBox Results Schema Reference” on page 26).
•
You need to determine the access control that a search user may need to access content. The
choices for access control are no authentication, HTTP Basic authentication, Windows NT LAN
Manager (NTLM) HTTP, Lightweight Directory Access Protocol (LDAP), or Single Sign On (SSO).
For more information, see “Using an External Provider” on page 11.
Working with an XML configuration file:
•
Ensure that you have a text editor that can output text files in UTF-8 format.
•
Ensure that the XML configuration file conforms to the “Module Definition Schema” on page 22.
•
Download the Google OneBox Simulator (
to test your XML configuration file. For more information, see “Testing
with the OneBox Simulator” on page 19. You can use any available XSLT tool with the simulator
such as XML Spy, OxygenXML, tools from the major software vendors, or open source tools. The
Saxon XSLT processor is available in open source at
. Saxon and many
other XSLT processors require that you have Java installed on your computer. Oracle provides J2SE
at
. Google has tested the simulator
with J2SE version 5.5.
Defining a OneBox Module in the Admin Console
To define a OneBox module in the Admin Console:
1.
In Serving > OneBox Modules, enter a name in the OneBox Name field and click Create Module
Definition.
2.
Enter a Description.