Versions Compared

Old Version 7

changes.mady.by.user Shu-Hsiang.kao@zeticon.com

Saved on

compared with

New Version Current

changes.mady.by.user Bas Van den Steen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Facet Profile extends Profiles with extra properties

  • Facet Profile it is an ordered list of field definitions with options (see below)

  • It is used to configure front-end filters used in overview pages

    • image-20240409-071043.png

Business Rules

The following rules apply to which field definitions you can add to a facet profile

  • The field definition must be indexed

  • The field definition must be one of the Simple Fields except TextField

  • Only field definitions of type ThesaurusLabelField with the language property matching the current language of the users will be displayed

    • Ex. ThesaurusField.EN and ThesaurusField.NL are added to the profile and the language of the user is set to English => The user will only see the ThesaurusField.EN facet in the application

Properties (options per field definition)

Facets have the following options per field definition

Property

Description

Type

Default Value

Required

ReadOnly

SelectionType

The type of selection. SHOULD: at least one selected value must match. MUST: all selected values must match.

Enum

MUST

no

no

HideEmpty

Indicates if the empty facets are hidden.

Boolean

false

no

no

Sort

On what a facet is sorted. Possible values are MostFrequent, Alphabetically, Chronologically, FixedOrder.

Enum

depends on the field definition type

no

no

ReverseOrder

Sort the results in reverse order. Can only be true if Sort = Chronologically.

Boolean

false

no

no

DefaultNumberOfValues

The number of facets to show. Must be in range [1,100].

Number

depends on the field definition type

no

no

IncludeMissingValue

Include the missing value (e.g. No Keywords).

Boolean

true

no

no

IncludeActiveValues

Include values which are present as pure MUST terms in the query (e.g. +Descriptive.Keywords.Keyword:Cork).

Boolean

false

no

no

Notes: - The following rules apply to the Sort property:

  • Values MostFrequent and Alphabetically are only applicable for non-date fields and non-enum fields, the default value is MostFrequent.

  • Value Chronologically is only applicable for profile fields having a field definition with type DateField.

  • Value FixedOrder is only applicable for profile fields having a field definition with type EnumField: values are sorted in the order in which the possible values are defined on the field definition.

  • The default value for DefaultNumberOfValues is 10 for non-date fields, 12 for date fields.

  • If SelectionType = SHOULD, the following applies: if a facet value is selected, this will affect the counts of all facets, except the facet itself. SHOULD is not applicable for date fields.

Usage

Reference

  • previous documentation of /wiki/spaces/DEVELOPMENT/pages/3656679438

  • https://mh-dev.mediahaven.com/mediahaven-rest-api/v2/api-docs/index.html#mediahaven-rest-api-manual-profiles-create-profile-field-object-structure Jira LegacyserverSystem JiraserverIdb13bfa7d-a627-37d0-9f27-5b1bea629f5ckeyENG-4306