About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
configuration:blender

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
configuration:blender [2022/04/22 15:11] – created emaijalaconfiguration:blender [2023/11/01 10:55] (current) demiankatz
Line 1: Line 1:
 ====== Blended Search ====== ====== Blended Search ======
  
-:!: Supported from VuFind 9.0.+:!: Supported from VuFind® 9.0.
  
 ===== Introduction ====== ===== Introduction ======
Line 11: Line 11:
 ===== Limitations ===== ===== Limitations =====
  
-  * Currently only basic search is supported.+  * Advanced search (available from VuFind® 9.1) is relatively simple compared to backend-specific advanced searches.
   * It is recommended to keep maximum number of results available for paging low, as merging results further from the beginning is a heavy process.   * It is recommended to keep maximum number of results available for paging low, as merging results further from the beginning is a heavy process.
   * Blending the results is not a magic process, and relevance ranking works quite differently across platforms. There are settings available that affect blending of initial results, but currently it's mostly just round robin.   * Blending the results is not a magic process, and relevance ranking works quite differently across platforms. There are settings available that affect blending of initial results, but currently it's mostly just round robin.
 +  * Many of the advanced options, such as full facet lists, are not supported.
  
 ===== Prerequisites ===== ===== Prerequisites =====
Line 28: Line 29:
 :!: It is strongly recommended to enable search caching for each backend to improve performance and reduce duplicated requests. See the [SearchCache] section for the relevant search configuration file for details. Using Memcached is recommended. :!: It is strongly recommended to enable search caching for each backend to improve performance and reduce duplicated requests. See the [SearchCache] section for the relevant search configuration file for details. Using Memcached is recommended.
  
 +===== Accessing Blended Search =====
 +
 +''Blender'' can be configured as a search tab in SearchTabs section of config.ini or as default backend by setting `defaultSearchBackend = Blender` in Site section. The URL for blended search results is ''<vufind base address>/Search/Blended''
  
 ===== Configuration ===== ===== Configuration =====
  
-The following instructions assume that VuFind's local directory is ''local'', so all+The following instructions assume that VuFind®'s local directory is ''local'', so all
 configuration files to be modified are under the ''local/config/vufind'' directory. Adjust as necessary. configuration files to be modified are under the ''local/config/vufind'' directory. Adjust as necessary.
  
 The actual configuration is done with two files: [[.files:Blender.ini]] and [[.files:BlenderMappings.yaml]]. Blender.ini contains settings for configuring the search similarly to other backends. BlenderMappings contains all the mappings from backends to common values for facets, search type mappings and sort options. The actual configuration is done with two files: [[.files:Blender.ini]] and [[.files:BlenderMappings.yaml]]. Blender.ini contains settings for configuring the search similarly to other backends. BlenderMappings contains all the mappings from backends to common values for facets, search type mappings and sort options.
  
-It is recommended to choose one backend as the "primary" one and use its facet values etc. as the target to which all the other backends are mapped to. This makes configuration easier. However, there's nothing preventing from using a Blender-specific set of facets that all backends map to, if desired.+It is recommended to choose one backend as the "primary" one and use its facet values etc. as the target to which all the other backends are mapped to. This makes configuration easier. However, there's nothing preventing the use of a Blender-specific set of facets that all backends map to, if desired.
  
 ==== Basic Configuration ==== ==== Basic Configuration ====
  
-  - Copy ''config/vufind/Blender.ini'' to ''local/config/vufind/Blender.ini'' for modification.+  - Copy config/vufind/Blender.ini to local/config/vufind/Blender.ini for modification.
   - Enable desired backends in [Backends] section.   - Enable desired backends in [Backends] section.
   - Use the [Blending] section, if desired, to configure the selection of initial results. You can also define the block size used for records from each source. Block size can also be relative to the total number of results.   - Use the [Blending] section, if desired, to configure the selection of initial results. You can also define the block size used for records from each source. Block size can also be relative to the total number of results.
Line 51: Line 55:
 This is expected to be the most laborsome part of the configuration. This is expected to be the most laborsome part of the configuration.
  
-  - Copy ''config/vufind/BlenderMappings.yaml'' to ''local/config/vufind/BlenderMappings.yaml'' for modification.+  - Copy config/vufind/BlenderMappings.yaml to local/config/vufind/BlenderMappings.yaml for modification.
   - See the beginning of the file for information on the format and available settings.   - See the beginning of the file for information on the format and available settings.
   - Set up all mappings according to your needs. The sample file contains example mappings for several facets, including mappings to a hierarchical format facet.   - Set up all mappings according to your needs. The sample file contains example mappings for several facets, including mappings to a hierarchical format facet.
Line 57: Line 61:
 There are several noteworthy features particularly with facet mappings: There are several noteworthy features particularly with facet mappings:
  
-  * Facet mappings also work the other and define how active filters are mapped to each backend. You can also define fields that are only used e.g. with checkbox filters.+  * Facet mappings also work the other direction and define how active filters are mapped to each backend. You can also define fields that are only used e.g. with checkbox filters.
   * If a backend does not support a filter value, that backend gets automatically disabled. If you wish to keep the backend active and just ignore such values, list the values under the ''Ignore'' setting.   * If a backend does not support a filter value, that backend gets automatically disabled. If you wish to keep the backend active and just ignore such values, list the values under the ''Ignore'' setting.
   * If you're mapping a value to a hierarchical facet (those can be used with Solr), you can set ''Hierarchical: true'' to indicate that. In such case Blender will automatically populate any upper levels as well. Example:   * If you're mapping a value to a hierarchical facet (those can be used with Solr), you can set ''Hierarchical: true'' to indicate that. In such case Blender will automatically populate any upper levels as well. Example:
Line 100: Line 104:
  
 ---- struct data ---- ---- struct data ----
 +properties.Page Owner : emaijala
 ---- ----
  
configuration/blender.1650640312.txt.gz · Last modified: 2022/04/22 15:11 by emaijala