Configuring OpenSearch

Overview

As a community manager, you can make external search engines (that support OpenSearch format) available to users in your community.

This article provides the procedure for adding (and configuring) an OpenSearch-supporting external engine.

Information

If a search engine supports the OpenSearch format for sharing of the search results, you can add support for it. The added external search engine is used in addition to the internal search engine when people search for content in Jive.

Engines that support OpenSearch provide a descriptor XML file and usually publish the file at a public URL. The descriptor tells OpenSearch clients what they need to know to query the search engine.

When adding a search engine, you need to provide the engine description. It can be a descriptor XML file (or its URL), or you can enter the required information yourself. Additionally, you might get prompted for more information, such as login credentials if the engine is secure. Note that you can edit engine properties later.

Process

To add an OpenSearch engine:

1. Navigate to Admin Console > System > Settings.
2. Under OpenSearch Engines:
   • If you have the descriptor XML file of the engine, do the following:
     1. In Descriptor URL, specify the URL of the descriptor XML file.
     2. Click Add engine from Descriptor URL.
        The application retrieves the descriptor file from the URL, then retrieves the required information from the file.
     3. If prompted, enter the required additional settings.
        For example, you can be prompted to specify the login credentials if the engine is secure.
     4. Click Save.
   • If you do not have the descriptor XML file, do the following:
     1. Click Add engine from form to open the entry form.
     2. Provide at least the following settings:
        • In Name, enter the search engine name.
          • In Search URL, specify the URL for sending user queries.
          • In Search Result Content Type, select the content type the search engine results are returned in.
          • In Query Test Term, enter the term you use for testing.
          • If the engine is secure, enter the login credentials in the Username and Password boxes.
        For more information about search settings, see OpenSearch Engines Property Reference.
     3. Click Update.

The search engine is listed on the OpenSearch Engines page. You can edit its properties when required.

Back to top