Help Center

Menu

ui.integration_url

URL to use to reach the search service from the marketing dashboard, when the search is wrapped inside another system (e.g. CMS).

Key: ui.integration_url
Type: String
Can be set in: profile.cfg, collection.cfg

Description

This setting specifies a custom URL to use to access the search interface for the results page when running a search from the marketing dashboard. This setting should be used in conjunction with the ui.modern.search_link, which is used in Freemarker templating.

The search URL for a Funnelback results page is usually of the form:

http://FUNNELBACK_SERVER:PORT/s/search.html?collection=SEARCH_PACKAGE_ID&profile=RESULTS_PAGE_ID&query=QUERY_TERMS

However, in some circumstances the search results are "wrapped" inside another system, such as a CMS. In this case the Funnelback search endpoint might not be directly accessible by the end users who would visit the CMS search URL instead, for instance:

http://example.com/global/search?q=query

This custom URL can be specified in this setting so that other parts of Funnelback are aware of the "real" URL used by users.

This URL can contain the following tokens in the form {TOKEN} that will be expanded to their actual values:

  • collection: The SEARCH_PACKAGE_ID - Identifier of the target search package

  • profile: The RESULTS_PAGE_ID - Identifier of the target results page

  • query: The QUERY_TERMS - Query to search for.

For example:

http://example.com/search/{collection}/{profile}/search?q={query}

and a search should be performed on the search package intranet, results page staff with the query smith, the resulting URL would be:

http://example.com/search/intranet/staff/search?q=smith

Default Value

The default value is not defined so that the search URL is derived from the Funnelback hostname and ports as configured in the server configuration

Examples

Use a custom URL:

ui.integration_url=http://example.org/search?q={query}

See Also