OpenSearch Engines property reference

Here is the list of properties for adding and configuring OpenSearch engines to your community.

Fastpath

Admin Console: System > Settings > OpenSearch Engines

You can view and edit the properties of a search engine when you manually add a new engine or edit the properties of a configured engine.

Option	Description
Name	The name of the OpenSearch engine.
Description	The description of the OpenSearch engine.
Descriptor URL	The URL of the descriptor XML file.
Icon URL	The URL of an icon representing the search engine. The Jive app displays this icon in the UI.
Search URL	The URL that is used to send user queries.
Search Result Content Type	The content type in which the search engine's results are returned. Note that if this is a type that the application can parse, such as HTML (`text/html`), the results are displayed directly; if not, the application displays a link through which the user can separately search the engine site itself. If you specify HTML as the content type, a sidebar displays a link that people can use to search for their phrase at the OpenSearch location. If they search, their results are displayed in a new window. If you specify RSS or Atom as the content type, the application displays a new tab with the Name value. The application parses returned results into a format that displays on the search results page, under the new tab. If you want to see a preview of the first 8 OpenSearch results displayed directly inside the main search results, so users are more readily aware of the OpenSearch alternative, you should also select the Show result preview check box.
External Search URL	The link that is displayed to users through which they can separately search the engine site itself. The field is available only when RSS (`application/rss+xml`) or Atom (`application/rss+xml`) is selected in Search Result Content Type
Query Test Term	A term you use to test queries.
Maximum Number of Results	The maximum number of results displayed on the search page.
Username	The username if the search engine requires login credentials
Password	The password if the search engine requires login credentials
Enabled	The check box that indicates if the search engine is enabled or disabled. By default, the check box is selected, and the search engine is available to users.
Show result preview	The check box that indicates whether OpenSearch results are shown in the body of your search results themselves. When you select this checkbox for any OpenSearch provider, your main search results show a preview of up to 8 results from the OpenSearch provider after the first four results from your Jive site. This setting makes OpenSearch more noticeable to users who might overlook its presence in the left pane of search. The check box is cleared by default.

Configuring OpenSearch