[MGNLUI-4765] Make Find Bar configurable via YAML Created: 05/Nov/18  Updated: 26/Mar/20  Resolved: 02/Dec/19

Status: Closed
Project: Magnolia UI
Component/s: None
Affects Version/s: None
Fix Version/s: 6.1.4, 6.2

Type: Improvement Priority: Neutral
Reporter: Antti Hietala Assignee: Roman Kovařík
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: 0d
Time Spent: 2h 44m
Original Estimate: Not Specified

Issue Links:
Cloners
clones MGNLUI-4728 Predictable result category order Closed
Relates
relates to MGNLUI-5523 Findbar queries all public users on i... Closed
relates to MAGNOLIA-7691 Populating the last editor filter dro... Closed
relates to MGNLUI-5428 Find bar: load more results Closed
causality
dependency
depends upon MAGNOLIA-6521 Module config via Light Module Closed
depends upon MAGNOLIA-7432 Draft concept for component configura... Closed
is depended upon by MGNLUI-4676 Find Bar search is configured by admi... Closed
documentation
to be documented by MGNLUI-5547 DOC: Admincentral module (new page) Closed
relation
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Documentation update required:
Yes
Date of First Response:
Epic Link: Periscope improvements
Sprint: UI Framework 11
Story Points: 5

 Description   

User story:

My site deals heavily with assets. I want to see assets higher in results because I work with them often.

My site doesn't use Stories very often. I want to demote them in the Suggestions order.

I have a custom app Products that is very important for my users. I want to make it higher in Suggestions.

The default group ordering (MGNLUI-4728) doesn't know what is important to users on a particular site. For example, Assets are in place #5 which may be too low. Make it easier for a practitioner to change the category order through configuration, for example via YAML.

Business benefit: Relevance. Content types that are important to your daily work are listed first.

Acceptance criteria:

  • A system admin can configure the group order.
  • A system admin can configure the number of suggestions & results in each group.
  • A system admin can configure the find bar to include/exclude specific user realms as last editors (see MGNLUI-5523)
  • Configuration is in a YAML file.
  • A developer can deploy new Magnolia sites with the correct group order.
  • Consider making everything in the Find Bar class configurable without having to touch code.


 Comments   
Comment by Michael Duerig [ 02/Dec/19 ]

I just merged https://git.magnolia-cms.com/projects/PLATFORM/repos/ui/pull-requests/1248/overview, making findbar configuration available for 6.1.4:

findBarConfiguration:
  suggestionCountPerSupplier: 3
  defaultCountPerSupplier: 10
  editorRoles:
    - superuser  
Comment by Federico Grilli [ 02/Dec/19 ]

Just for documentation purposes, these are the complete configuration options at admincentral/config.yaml

findBar:
  suggestionCountPerSupplier: # integer: defaults to 3
  defaultCountPerSupplier: #integer: defaults to 10
  supplierOrder:  # list: defaults to apps, pages, stories, assets, tours
  - assets
  - ...
  editorRoles: # list: used to create list of available content editors in advanced search (e.g. last editor filter). All users available if not specified.
 suppliers: # list: if empty defaults to all suppliers provided by Periscope module https://documentation.magnolia-cms.com/display/DOCS61/Periscope+module#Periscopemodule-Searchresultsuppliers
Generated at Mon Feb 12 09:19:52 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.