Set the OpenSearch description document for a tenant - Fluid Topics - 3.10

Fluid Topics Configuration and Administration Guide
Category
Reference Guides
Audience
public
Version
3.10

The OpenSearch description document is used to describe the search engine's web interface.

It is possible to set the description document in the OpenSearch tab of the Integrations section of the Administration menu.

  1. In the Description document section, provide a description of the search engine.

    By default, the following content is displayed: 

    <?xml version="1.0" encoding="UTF-8"?>
    <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
        <ShortName>$PORTAL_URL</ShortName>
        <Description>This example must be edited in order to reflect your own engine</Description>
        <Url type="text/html" rel="results" template="https://$PORTAL_URL/search/all?query={searchTerms}"/>
        <Url type="application/atom+xml" rel="results" template="https://$PORTAL_URL/api/opensearch?query={searchTerms}&amp;limit={count?}&amp;startIndex={startIndex?}&amp;content-lang={language?}"/>
        <Query role="example" searchTerms="how" />
    </OpenSearchDescription>

    Where:

    • ShortName expects a human-readable name for the portal. By default, it is the hostname.
    • Description may be customized.
    • Url type="text/html" expects the URL used by the browser to send an HTML response.
    • Url type="application/atom+xml" expects the URL used by the browser to send an ATOM response.
    • Query expects an example word to replace {searchTerms} in the Url elements for OpenSearch integration tests.

      This list of parameters is not exhaustive. See the OpenSearch official documentation for additional tags.

      The XML is validated on the fly.

  2. Select Save to apply the updated configuration.