Funnelback 16 change log
The change log below provides details on changes that have been made in Funnelback since the v15.24 release. Please see what’s new in Funnelback 16 for an overview of the changes.
Each entry has two release versions listed:
|
Use the filter to narrow down what’s in the list below and the sort controls on each column to help locate what you are looking for.
Type | Release version | Description | ||
---|---|---|---|---|
1 New and revised features |
Funnelback 16.2 |
Added a new upgrade utility to support the migration and upgrade of collections from Funnelback v15.24 to v16. Upgrading from Funnelback 15 and earlier into Funnelback 16 is complicated due to a number of architectural changes within Funnelback. The upgrade utility:
A detailed v15.24 to v16 migration guide is also provided. |
||
1 New and revised features |
Funnelback 16.2 |
Added a new configuration file, |
||
1 New and revised features |
Funnelback 16.2 |
Added various API calls to support the upgrade tool. |
||
4 Important changes |
Funnelback 16.2 |
Collection scheduled updates times are not preserved when upgrading from 15.24 and earlier. These must be recreated for all the data sources by applying configuration keys to each data source. See: scheduling data source updates. In addition, if running and in-place upgrade (running the v16 installer in upgrade mode on an older Funnelback server) any pre-existing cron jobs for collection updates will need to be manually removed by editing the search user’s crontab. |
||
4 Important changes |
Funnelback 16.2 |
Collection ID format change when upgrading from v15.24 There is a breaking change for collection IDs when upgrading from v15.24 and earlier. This will break existing integrations with Funnelback. System administrators can configure collection remapping using the |
||
4 Important changes |
Funnelback 16.2 |
v15 default roles are assigned to a default client on upgrade from Funnelback 15. Default roles will be prefixed with the e.g. the v15 role |
||
4 Important changes |
Funnelback 16.2 |
The Funnelback installer now automatically rebuilds indexes after an upgrade. In Funnelback 15, this was a step that had to be manually triggered when an administrator logged into Funnelback after an upgrade. As a result search indexes will be unavailable until the reindexing process is complete. |
||
4 Important changes |
Funnelback 16.2 |
Upgrading to v16 may affect ranking on any collections which were not of the web or meta types due to the automatic wrapping of such collections in a meta collection/search-package. Explicitly setting |
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2108 |
Added support for Funnelback for higher education in the Squiz experience cloud. The v16 release of Funnelback for higher education includes a tool for performing an initial setup of the package.
|
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2108 |
Added an auto-completion plugin which generates structured auto-completion to be generated from an existing Funnelback index. The auto-completion plugin enables structured auto-completion to be generated by:
|
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2108 |
Added a new enhanced update task scheduler. The new update task scheduler enables updates to be configured by a search administrator with schedules based on time between updates, or scheduled at a fixed time.
|
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2108 |
Added the ability to log in to the administration dashboard using a simple user ID that omits the client ID. This enables login with an email addresses as the ID if it has been used for the username when setting up the account. See: creating administration users |
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2108 |
Added support for a global plugin to validate all content updates added to the files via the admin-api. An example use case for this is to provide virus scanning of content that is submitted via the administration interface (or via the API). |
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2108 |
Added a new screen to the administration dashboard for the management of client application tokens. A new user permission, |
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2108 |
Added a new API ( |
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2108 |
Added a new API ( |
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2108 |
Added a new API ( |
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2108 |
Added a new API ( |
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2108 |
Added a new API ( |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2108 |
Updated the push API ( |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2108 |
Search packages analytics updates are now automatically scheduled when they are created. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2108 |
Updated the |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2108 |
Added support for system administrators to define range restrictions on configuration keys with a duration type value. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2108 |
Fixed an issue with accessibility auditor that caused the user interface to break when the user’s web browser language was not set to English. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2108 |
Fixed an issue with the web crawler that caused it to ignore the |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2108 |
Fixed an issue with best bets where it failed to remove a search result that had the same URL as the best bet URL when the removing matching search result option was selected. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2108 |
Fixed an issue with the web crawler form interaction feature that caused it to incorrectly handle form parameters with empty values. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2108 |
Fixed an issue that caused invalid XML to be returned when the query contained a vertical tab character. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2108 |
Fixed an XXE vulnerability in cached documents that allowed files to be read from disk. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2108 |
Updated the default configuration to enable accessibility auditor by default. Accessibility auditor can be disabled on a data source by setting the |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2108 |
The outliers (trend alerts) cron job is no longer able to be scheduled via the administration dashboard. A system administrator can update or delete this scheduled update by editing the search user’s crontab. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2108 |
Legacy best bets (from v14.2 and earlier) have been removed.
The removal of legacy best bets has the following implications:
Any legacy best bets should be manually re-entered via the best bets editor located within the marketing dashboard. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2108 |
Funnelback no longer supports additional administration service providers when using SAML authentication. Existing SAML configurations and the Groovy permission mapper may need to be updated. See: the v15.24 to v16 migration guide. |
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2041 |
Added support for client API access tokens, which enabled applications and scripts to access the admin API using a token that is independent of specific administration users. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2041 |
Added warnings to the administration dashboard when license limits are exceeded. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2041 |
Improved the admin API’s JSON representation of timezone and other date/time related config settings. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2041 |
Introduced support for higher-performance zstd compression in push document storage. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2041 |
Improved presentation of errors from SAML user mapper scripts. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2041 |
Improved performance of administration dashboard pages showing large numbers of data sources. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2041 |
Improved administration dashboard messaging when Funnelback server is in read only mode. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2041 |
Eliminated the use of jsessionid cookies when using SAML authentication. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2041 |
Product documentation links now refer to the hosted documentation which can be updated when errors are identified. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2041 |
Added user interface for enabling plugins. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2041 |
Improved administration dashboard breadcrumbs in a number of areas. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2041 |
Added client application tokens, an improvement for application tokens, suitable for use on the Squiz Experience Cloud (SXC) |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2041 |
Added plugin servlet filter hooks, a replacement for custom servlet filter hooks, suitable for use on the Squiz Experience Cloud (SXC) |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2041 |
Fixed handling of missing originalQuery entries in search query history. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2041 |
Fixed preservation of URL parameters through the SAML login flow. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2041 |
Fixed broken funnelback_documentation search result template. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2041 |
Fixed support for access_restriction settings based on hostnames when Funnelback is deployed behind a load balancer. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2041 |
Fixed accessibility auditor to account for the removal of the legacy facet data model. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2041 |
Fixed display of default web collection file type restrictions. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2041 |
Fixed return key handling when adding web data source URLs. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2041 |
Fixed a number of cases of old 'collection' terminology usage within administration dashboard. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2041 |
The legacy metaData section of the result data model has been removed. listMetadata should now be used instead. |
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2034 |
Introduced screens for managing plugins and enabling/disabling them on search packages and result pages. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2034 |
Added instant-update and push logs to data source log viewing and WebDAV. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2034 |
Analytics email settings are now configured in result page config instead of a dedicated file. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2034 |
Improved the performance of the tuning dataset administration dashboard when many entries are added. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2034 |
Added a message to the administration dashboard when the server is set to read-only mode. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2034 |
Simplified the search transaction data model by removing some deprecated sections. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2034 |
Fixed handling of profiles containing hyphens in the legacy perl CGI administration pages. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2034 |
Fixed handling of permissions within some areas of the administration dashboard to disable inaccessible options. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2034 |
Accounted for the new client ID requirement within LDAP authentication. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2034 |
The removal of some data model elements to simplify its usage may cause some freemarker templates, plugins and hook scripts to fail when they reference the removed elements. These implementation components must be updated to work with this and future versions of Funnelback. Specific data model elements removed include:
|
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2032 |
New administration dashboard, terminology and client separation Funnelback’s administration dashboard has been overhauled to make search implementation easier. As part of this improvement, new terminology of search packages, data sources and results pages has been introduced. Broadly, search packages are equivalent to meta collections in earlier versions of Funnelback, and a search package is now required to bundle up the data sources and results pages used to deliver a search. Data sources are equivalent to non-meta collections in earlier versions (but without the ability to serve search results), while result pages are the new equivalent of profiles and are used to define the search results page functionality and formatting. The new administration dashboard also formalises the separation of implementations in a multi-tenant Funnelback environment with the concept of a client, which groups together all components of an implementation. |
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2032 |
Plugins for reusable custom code A new bundled format for custom code to be run on the Funnelback server, known as a plugin, has been introduced to the product. Plugins are intended to separate customisations from individual data sources and results pages so that they can be more easily reused and can go through a separate approval process to ensure quality in multi-tenant environments. Plugins provide similar capabilities to custom Groovy scripts in earlier versions and add the ability to supply some types of data, such as external metadata, dynamically during a data sources update to avoid the need to assume the internal file system layout. The features superceded by plugins - Groovy document and Jsoup filters, hook scripts, custom workflow and custom gatherers are no available and any existing implementations that are updated to Funnelback 16 must rewrite this custom code using the plugin framework. |
||
1 New and revised features |
Funnelback 16.2 SXC 16.1.2032 |
The support for performing the following tasks via REST APIs has been introduced:
|
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2032 |
The |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2032 |
The individual data source components and associated relative weightings of data sources in search packages can now be set via the configuration APIs with the |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2032 |
Streamlined knowledge graph administration experience. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2032 |
Tuning runs are now subject to the same task queueing system as data source and analytics updates. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2032 |
Updates to the default template to support results page level configuration settings where possible. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2032 |
Added support for knowledge graph scripts at the results page level. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2032 |
The data source components of a search package can now be set within the configuration editing screens. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2032 |
A number of improvements to SAML authentication support, in particular reduction in the number of SAML service providers required for administration setups and to support integration with Auth0. |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2032 |
Added a Content-Type response header to the push API endpoint |
||
2 Minor improvements |
Funnelback 16.2 SXC 16.1.2032 |
The 'Intercom' support tool has been integrated into the Funnelback administration dashboard. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2032 |
Prevented WebDAV clients which take long-timeout locks and do not reliably release them from locking out other clients. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2032 |
Fixed recommender operation on filecopy data sources. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2032 |
Fixed the all-results.json endpoint to handle when search sessions are enabled. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2032 |
Fixed presentation of sparklines within trend alerts reports. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2032 |
Fixed possible configuration setting loss when encrypting configuration values for the first time after installation. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2032 |
Prevented creation of users with service user prefixes. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2032 |
Fixed the web crawler to handle responses without a Content-Type header. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2032 |
Improved Padre handling of invalid XML characters. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2032 |
Fixed handling of ui.modern.pseudonymise_client_ips when Funnelback is used behind a proxy or load balancer. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2032 |
Fixed publication of web resources files containing spaces in their filenames. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2032 |
Fixed isAdminUI Freemarker macro when search and administration ports are the same. |
||
3 Bug fixes |
Funnelback 16.2 SXC 16.1.2032 |
Fixed consistency of status codes resulted by the update history API. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
Tuning is now a task under the task queue, this means when it runs can be controlled by the task picker. Tuning can no longer be started by |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
The task queue now allows running tasks to be added to the queue and allows multiple tasks which use the same resources (for example, the same data source), to be in the queue at the same time. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
query_processor_options now supports configuration environments. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
The meta.cfg config file no longer exists, being replaced by the meta.components search package configuration setting. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
The groovy script specified by the auth.admin.saml.groovy-permission-mapper setting now supports defining roles the user is always permitted to edit. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
The administration dashboard’s edit file-manager rules pages are no longer available. Any remaining cases where custom file manager rules are required must be set directly in the relevant .ini files. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
Naming of log files has been made more consistent between data source types. For example, crawl.log is now named gather.log to be consistent across the product. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
Local data sources are not supported in this version, reflecting the restriction on direct filesystem access in the AWS SaaS environment. Existing local collections should be converted to either a web or custom data sources depending on the logic implemented in the local collection. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
Search package and data source IDs are now limited to 192 characters |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
Freemarker templates are now only able to import/include files which end in .ftl |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
The question.collection.configuration data model exposed to Freemarker no longer contains server (global) configuration settings. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
SAML authentication now creates user .ini files representing logged in users to support cross-component authentication. |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
Added a |
||
4 Important changes |
Funnelback 16.2 SXC 16.1.2032 |
Knowledge graph
|