Design

Default Configuration

Default Behaviour(s) :

#01 : Top filter bar is displayed on the search results page. Each cursor can have its top filter bar.

#02 : Default top filter bar for all assets cursor is composed of the following filters :

Assets
Category
Campaign
Keywords
Language
Rights
People

#03 : Default top filter bar for all videos cursor is composed of the following filters :

Category
Campaign
Keywords
Language
Rights
People

Assets filter

Default Behaviour(s) :

The asset’s filter is composed of the following information :

Filter name : Assets
- Section name : Type
  - Option type : Multiple selection
  - Option Values : Values are automatically generated from technical assets’s data available
- Section name : Orientation
  - Option type : Multiple selection
  - Option Values : Landscape, Portrait, Square
- Section name : Size
  - Type : Number field
  - Field : Width, Height
- Section name : Dominant colors
  - Type : Multiple selection (colors band)
  - Option Values :
- Section name : Color Space
  - Option type : Multiple selection
  - Option Values : Values are automatically generated from technical assets’s data available
- Section name : Document type
  - Option type : Multiple selection
  - Option Values : Values are automatically generated from technical assets’s data available
- Section name : File extension
  - Type : Input text
  - Option values : None. Once the user start typing a word, the filter immediately applies.

Keywords filter

The Keywords filter is composed of the following information :

Filter name : Keywords
- The closed list filter will list all values, in a paginated list
- Search is enabled for looking a specific value
- Checkboxes will select the value
- Counts are available by default
- Option Values :
  - The list is composed of IA Keywords and manual Keywords listed in alphabetical order.

Rights filter

The Rights filter is composed of the following information :

Filter name : Rights
- Section name : Rights Type
  - Type : Multiple selection
  - Option values :
    - External
    - External but publication
    - Internal
- Section name : Expiration Date (radio button)
  - Type : Radio Button
  - Option values :
    - Never Expires
    - Expire within a year
    - Expire within a month
    - Expire within a week
    - Between two dates

People filter

The people filter is composed of the following information :

Filter name : People
- Section Name : People
  - Type : Radio button (currently working with multiple selection)
  - Option values :
    - With People
    - Without People
- Section Name : Age
  - Type : Multiple selection
  - Option values :
    - Baby
    - Children
    - Adults
    - Seniors

The Category filter is composed of the following information :

Filter name : Category
- Type : Thesaurus, single selection
- Trees and thesaurus will list all values by default
- Search is activated by default
- Option values :
  - Category 1
  - Category 2
    - Category 2.1
    - Category 2.2
  - Category 3
  - Category 4
    - Category 4.1
    - Category 4.2

Campaign filter

The Campaign filter is composed of the following information :

Filter name : Campaign
- Type : Thesaurus, single selection
- Option values :
  - Campaign 1
  - Campaign 2
    - Campaign 2.1
    - Campaign 2.2
  - Campaign 3
  - Campaign 4
    - Campaign 4.1
    - Campaign 4.2

Language

The Language filter is composed of the following information :

Filter name : Language
- Type : Multiple selection
- Option values :
  - English
  - French
  - Deutsch

Configuring the search bar

Resolving the search bar to use for a context

Search bars are configured per cursor and resource, based on the current context chosen by the user. The application falls back to default configuration if no search bar can be found for current context. Config is loaded from first existing configuration from:

$.dam.explore.filters.<cursorName>.<resourceName>
$.dam.explore.filters.<cursorName>.defaultResourceConfig
$.dam.explore.filters.defaultCursorConfig.<resourceName>
$.dam.explore.filters.defaultCursorConfig.defaultResourceConfig

Exemple: Given user has chosen a context mapping to cursor “activeCursor” and resource “activeResource”, the application will load first existing search bar config from the following paths:

$.dam.explore.filters.activeCursor.activeResource
$.dam.explore.filters.activeCursor.defaultResourceConfig
$.dam.explore.filters.defaultCursorConfig.activeResource
$.dam.explore.filters.defaultCursorConfig.defaultResourceConfig

Configuring a search bar

From a configuration perspective, a search bar is defined by an object with following properties:

hideSide: Boolean - Defines if a side search should be displayed
filters: Array<SearchItem> - Defines the items that are used as search entries. Each item will at that level will reflect either:
- A button in the search bar
- An entry in the side search (entry must describe a tree field filter)

`SearchItem` description

A SearchItem can be one of the following:

A String reflecting a NamedFilterConfig
An ItemFilterConfiguration
A GroupFilterConfiguration

`NamedFilterConfig` description

NamedFilterConfig are named filters configurations. This allows to define Filters once and to re-use them across different contexts.

NamedFilterConfig are defined in $.common.namedFilters. It can be one of:

A String reflecting a NamedFilterConfig
A String reflecting a field name (as defined in the admin structure area)
An ItemFilterConfiguration
A GroupFilterConfiguration

`ItemFilterConfiguration` description

An ItemFilterConfiguration reflects a single filter. It can be defined as:

A String representing the field you want to create a filter from. In such case, default behaviour of this filter will be defined base on the field type. This is equivalent to creating a FieldFilterConfig by only specifying the field property:
```
"myfieldname"
// equivalent to
{
  "field": "myfieldname"
}
```
An FieldFilterConfig describing the filter.

If ever you define a NamedFilterConfig with the same name as a structure field, you will not be able to access this field only as a String by its name: Otherwise, the application will end in an infinite loop calling the NamedFilterConfig

`FieldFilterConfig` description

An Object representing a filter for a given field.

Common `FieldFilterConfig` properties

Property	Type	Default	Description
`additional`	`Boolean`	`false`	When set to true, the field button won’t show by default. User will need to select the field from the + button
`class`	`String`	`undefined`	Allows to add one or more classes to the component
`component`	`String`	`undefined`	Allows to force a component to be used. Usage of this property is discouraged.
`constraintKey`	`String`	value of `field`	Name of the constraint to which this filter applies
`customParam`	`Boolean`	`false`	When set to true, the filter is considered as a custom parameter and sent as such to the REST service
`field`	`String`	`undefined`	The name of the field on which the filter applies
`i18n`	`String`	`undefined`	I18n key to use for the button of the field
`label`	String	`value` of resolved i18n if available field label if i18n not available	The label of the button

Additional `FieldFilterConfig` properties for `Boolean` fields

Property	Type	Default	Description
`inline`	`Boolean`	`false`	Shows boolean filter as a Switch

Boolean filter when inline is false or undefined

Boolean property when inline is true

Additional `FieldFilterConfig` properties for `Date` fields

Property	Type	Default	Description
`betweenOption`	`Boolean`	`false`	Adds ability to filter between two dates
`operators`	`Array`	`[]`	Can only define one value: `eq`, `neq`, `gt`, `gte`, `lt` or `lte`
`constraintsItems`	`Array<DateConstraint>`	`[]`	Allows to define “built-in” constraints for searching on the date field:

`DateConstraint` description

Property	Type	Description
`i18n`	`String`	Label of the constraint
`constraint`	`Object`	The constraint to apply on the date field

See in v0 config $.common.namedFilters.rightsGroupEndRights for examples

Additional `FieldFilterConfig` properties for `Number` fields

Property	Type	Default	Description
`operators`	`Array`	`["gte", "lte"]`	Will use each operator to produce an input

Filter bar

Design

Default Configuration

Assets filter

Keywords filter

Rights filter

People filter

Category filter

Campaign filter

Language

Configuring the search bar

Resolving the search bar to use for a context

Configuring a search bar

SearchItem description

NamedFilterConfig description

ItemFilterConfiguration description

FieldFilterConfig description

Common FieldFilterConfig properties

Additional FieldFilterConfig properties for Boolean fields

Additional FieldFilterConfig properties for Date fields

DateConstraint description

Additional FieldFilterConfig properties for Number fields