Profile Options (profile.cfg)
profile.cfg is the main configuration file for a funnelback frontend.
The profile.cfg
configuration file is created when a profile within a collection is created (though it is permitted to be empty or absent).
The profile.cfg
configuration file can be edited by navigating from the administrator home page's through the Administer > Edit profile configuration.
Location
The locations on disk where these options can be read:
$SEARCH_HOME/conf/[collection]/[profile folder]/profile.cfg
: This file is optional, options in this file have the highest precendence overriding values in all other files.$SEARCH_HOME/conf/[collection]/collection.cfg
: Options in this file provide defaults for all profiles within the collection.$SEARCH_HOME/conf/collection.cfg
: Options in this file provide defaults for all profiles in all collections.$SEARCH_HOME/conf/collection.cfg.default
: Options in this file are read only, this provides the product default values.
Format
The format of the file is a simple name=value
pair per line, with the values $SEARCH_HOME
and $COLLECTION_NAME
automatically expanded to the funnelback installation path and the name of the current collection automatically.
Configuration options
The following tables contain descriptions of the options that are used in the configuration file. All values which can be set within profile.cfg can also be set in the containing collection.cfg, and default values are inherited from the collection's defaults
Option | Description |
---|---|
access_alternate | Provides an alternate collection to query if access is denied due to the access_restriction setting. |
access_restriction | Allows restricting search interface access to certain IPs/hosts. |
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. |
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.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. |
restrict_preview_to_authenticated_users | Allows restricting the preview search interface to authenticated users only. |
ui.integration_url | URL to use to reach the search service, when 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 given cache form |
ui.modern.cache.form.formName.headers.key | Specify custom headers for a cache form file. |
ui.modern.cache.form.formName.remove-headers | Removes headers for a given cache form. |
ui.modern.click_link | Set 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.content-auditor.template-directory | Specify the path to a directory containing the content auditor freemarker templates |
ui.modern.cors.allow_origin | Specify the value of CORS Access-Control-Allow-Origin response header sent by the modern UI |
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 form file. |
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 localisation 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.pseudonymise_client_ips | Specify whether client IP addresses should be pseudonymised 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 | Base URL used by search.html to link to itself e.g. the next page of search results. Allows search.html (or a pass-through script) to have a different name. |
ui.modern.serve.filecopy_link | Specify the URL used to serve filecopy documents when a filecopy result is clicked on |
ui.modern.serve.trim_link_prefix | Specify the prefix for the URL used to serve TRIM documents |
ui.modern.session | Specify whether to enable the search sessions in the Modern UI. |
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 | Specify 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. |