Results page configuration options (profile.cfg)

Results page configuration options are use to configure various results page features within Funnelback.

The configuration options can be edited using the results page configuration editor.

Configuration options

The following table contains descriptions of the options that are used in the configuration file. All values which can be set within the results page configuration can also be set in the parent search package configuration, and values which are not specified are inherited from either the parent search package or from the system default.

Option Description

access_alternate

Provides an alternate search package to query if access is denied due to the access_restriction setting.

access_restriction

Allows restricting search interface access to certain IPs/hostname suffixes.

access_restriction.ignored_ip_ranges

Configures any ranges which should be considered 'internal' and hence ignored in X-Forwarded-For processing.

access_restriction.prefer_x_forwarded_for

Configures whether the content of an X-Forwarded-For header is preferred to the apparent remote address.

analytics.email.addresses

List of email addresses to which reports should be sent.

analytics.email.frequency

How often to send query report summaries.

analytics.email.from

Reports email sender address (From field).

analytics.email.outliers_confidence_threshold

Minimum trend alert confidence value for which emails should be sent.

analytics.email.outliers_enabled

Enables or disables trend alert notifications.

analytics.email.send_hour_spikes

Enable or disable hourly trend alert notifications.

auto-completion

Enable or disable auto-completion.

auto-completion.alpha

Adjust balance between relevancy and length for auto-completion suggestions.

auto-completion.format

Set the display format of the suggestions in the search results page.

auto-completion.length

Minimum length of query term before triggering auto-completion.

auto-completion.program

Program to use for auto completion.

auto-completion.search.enabled

Turn on search-based auto-completion.

auto-completion.search.program

Program to use for search based auto completion.

auto-completion.show

Maximum number of auto completion to show.

auto-completion.sort

Sets the auto completion suggestions sort order.

auto-completion.source

Sets the source of the data for auto-completion suggestions.

auto-completion.source.csv.[name].url

Specifies a URL to download a auto-completion CSV from.

auto-completion.source.extra

Sets extra sources of data for auto-completion suggestions.

auto-completion.standard.enabled

Enables the standard auto-completion feature.

click_tracking

Enable click tracking

group.customer_id

The customer group under which collection will appear - Useful for multi-tenant systems.

group.project_id

The project group under which collection will appear in selection drop down menu on main Administration page.

plugin.[pluginId].enabled

Specifies if a plugin is enabled or not.

plugin.[pluginId].encrypted.[secretKey]

Plugin configuration fields for storing secret information such as a password in an encrypted format.

plugin.[pluginId].version

Specifies the version of the plugin to use.

query_processor_options

Query processor command line options.

restrict_preview_to_authenticated_users

Allows restricting the preview search interface to authenticated users only.

service.thumbnail

(deprecated) Specify the path to a thumbnail image for the results page.

service.thumbnail.max-age

Specify how long thumbnails may be cached for.

service.title

Specify the title of a service.

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).

ui.modern.accessibility-auditor.daat_limit

Specify how many results are examined in creating accessibility auditor reports

ui.modern.authentication

Specify whether to enable or disable Windows authentication for the modern UI

ui.modern.cache.form.[formName].content_type

Sets custom content type header for a specified cache template

ui.modern.cache.form.[formName].headers.[key]

Specify custom headers for a cache template.

ui.modern.cache.form.[formName].remove-headers

Removes headers for a given cache template.

ui.modern.click_link

Sets click URI

ui.modern.content-auditor.collapsing-signature

Specify how results are determined to be duplicates within content auditor

ui.modern.content-auditor.daat_limit

Specify how many results are examined in creating content auditor reports

ui.modern.content-auditor.display-metadata.[metadataName]

Specify which metadata classes should be displayed within the content auditor’s search results tab.

ui.modern.content-auditor.facet-metadata.[metadata]

specify which metadata classes should be displayed as facets

ui.modern.content-auditor.max-metadata-facet-categories

Specify how many categories are displayed within each facet shown in content auditor.

ui.modern.content-auditor.num_ranks

Specify how many results are displayed in the content auditor search results tab

ui.modern.content-auditor.overview-category-count

Specify how many facet categories are displayed for each facet

ui.modern.content-auditor.preferred-facets

Specifies which content auditor facets will be displayed in the content auditor panel of the marketing dashboard.

ui.modern.cors.allow_origin

Specify the value of the CORS Access-Control-Allow-Origin response header sent by the modern UI

ui.modern.curator.custom_fields.[custom_field]

Configure custom fields for Curator messages.

ui.modern.curator.query-parameter-pattern

Pattern used to identify 'query' parameters for curator to trigger on.

ui.modern.external_num_ranks_limit

Limit the maximum number of results that can be requested in a single search request

ui.modern.extra_search_cpu_count_percentage

Limit the percentage of processors extra searches can use per search.

ui.modern.extra_search_total_timeout_ms

How much time (in milliseconds) all extra searches are permitted to use before extra searches are terminated.

ui.modern.form.[formName].content_type

Sets custom content type header for a given form

ui.modern.form.[formName].headers.[key]

Specify custom headers for a template.

ui.modern.form.[formName].remove-headers

Removes headers for a given form.

ui.modern.freemarker.display_errors

Specify whether to display Freemarker errors in the browser or not.

ui.modern.freemarker.error_format

Specifies in which format the Freemarker errors should be displayed in the browser

ui.modern.geolocation.enabled

Specify whether the search user’s current location should be enabled on searches

ui.modern.geolocation.set_origin

Specify whether the user’s current location should automatically set as the search origin.

ui.modern.i18n

Specify whether to enable or disable localization support in the modern UI

ui.modern.max_facet_extra_searches

The maximum amount of extra searches that will be run for faceted navigation.

ui.modern.metadata-alias.[alias]

Creates a key for Metadata alias key

ui.modern.padre_fork_timeout_ms

How long in milliseconds a query can run for before it is terminated.

ui.modern.pseudonymise_client_ips

Specify whether client IP addresses should be pseudonymized before processing.

ui.modern.related-document-fetch.[relatedDocumentKey].depth

Configures repeating depth of fetching of documents related to the primary results.

ui.modern.related-document-fetch.[relatedDocumentKey].type

Configures fetching of documents related to the primary results.

ui.modern.remove-internal-extra-searches

Controls if any internal extra searches should be removed or not.

ui.modern.search_link

Sets the relative path (from /s) to the HTML search endpoint.

ui.modern.serve.filecopy_link

Specifies the URL to serve results stored from a file system data source.

ui.modern.serve.trim_link_prefix

Specify the prefix for the URL used to serve TRIM documents

ui.modern.session

Enables or disables search sessions.

ui.modern.session.search_history.metadata

Controls what metadata should be stored and returned by search sessions click history.

ui.modern.session.search_history.size

Specifies the size of the search and click history stored for each user

ui.modern.session.search_history.suggest

Specify whether to display search history in the auto-completion suggestions

ui.modern.session.search_history.suggest.category

Specify the name of the category which search history suggestions are displayed

ui.modern.session.search_history.suggest.display_template

Specify the template for the search history suggestions

ui.modern.session.timeout

Specify how long should Funnelback keep the session since the last visit of the search user.