Serving > Front Ends > OneBox Modules

Use the Serving > Front Ends > OneBox Modules page to perform the following tasks:

• Selecting a OneBox module for use with a front end and specifying or changing the order in which OneBox modules are evaluated in search results
• Removing a OneBox module from the front end

You can select one or more OneBox modules for use with a front end. The search appliance evaluates each search query for a front end and invokes a OneBox module depending on the trigger value for the search query. You can set the trigger value to occur on all searches, to use a specific keyword sequence, or to use a regular expression. For more information on triggers and other OneBox settings, see Serving > OneBox > OneBox Modules.

Before Starting this Task

Before selecting a OneBox module for use with a front end, define the OneBox module by using the Serving > OneBox Modules page.

When a Search Query Invokes Multiple OneBox Modules

A search appliance might invoke multiple OneBox modules in response to a search query, but all modules might not return results. A OneBox module might encounter an error, fail to generate results, or respond too slowly and time out. Of the timely result sets that return from a query, the search appliance displays a specific number, based on which OneBox modules that you select for the current front end and the number of OneBox modules you want to display in the search results (set on Serving > OneBox Modules).

In addition to selecting OneBox modules for a front end, you specify their priorities with respect to each other by moving a OneBox module higher or lower in the list of selected modules. The search appliance displays result sets from OneBox modules that are higher in the Selected Modules list before displaying result sets from modules that are lower in the Selected Modules list. When there are multiple result sets, but only a limited number can be displayed, the search appliance chooses result sets based on a module's priority.

Selecting a OneBox Module

The Available Modules list includes all previously defined OneBox modules. The Selected Modules list specifies the OneBox modules that search queries in this front end can evoke.

To select a OneBox module for use with a front end to and to specify (or change) the order in which OneBox modules are evaluated in search results:

1. Select a OneBox module from the Available Modules list.
   
2. Click the right arrow to move the module to the Selected Modules list.
3. Use the Move Up or Move Down buttons to specify a priority for each module.
4. Click Save Settings when you are done.
   A delay may occur while the settings take effect.

Removing a OneBox Module

To remove a OneBox module from the front end:

1. Select the OneBox module that you want to remove from the Selected Modules list.
2. Click the left arrow to move the module to the Available Modules list.
3. Click Save Settings.

For More Information

For more information about OneBox modules, see the following topics:

• Serving > OneBox
• Serving > OneBox > OneBox Modules
• "OneBox for Enterprise Developer's Guide," which is linked to the Google Search Appliance help center
• "OneBox for Enterprise Design Principles," which is linked to the Google Search Appliance help center
• Google OneBox for Enterprise Simulator