Versions Compared

Old Version 8

changes.mady.by.user Lucas CORSINI

Saved on

compared with

New Version Current

changes.mady.by.user Emilie Nucci

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Design

...

Default Behaviour(s)

...

How it works

Access, and composition of the page

User access the asset details page by clicking on an asset thumbnail from :

  • The search page,

  • A board.

Asset details page is composed of :

  • Asset Details area,

  • Asset Actions list

...

Related Asset

...

Related Keywords

  • ,

  • Feedback popin,

  • Help popin.

Those points are detailed in the next chapters.

Asset details area

...

Design

Composition

Out of the box, user can access the asset details page by clicking on the asset thumbnail from the search page. The asset details page is composed of :

Back button

How it works

Image Added

Back link redirects user to the page he was before

...

Title for the asset (next to Back button)

...

Image Added

The header corresponds to the following metadata : Name + Photograph.

The configuration can be changed with the metadata of your choice.

Image Added

Next / Previous button

...

allow navigation to the next

...

or previous asset details following the order of the search results

...

Metadata

...

Suggested IA

...

Player for the asset

...

Number of View and download for the asset

...

Metadata section

Image Added

Out of the box, Metadata section contains 3 sections :

  • Information

...

Name* (text)

...

Caption (text)

...

Keywords (multiple selection list)

...

Campaign  (Only one option throught thesaurus can be selected)

...

Langue de l'asset  (Multiple selection list)

...

  • Rights

    • Photograph* (multiple selection list)

    • Right types (multiple selection list)

    • Shooting date (date)

    • Expiration date* (date)

    • Usage Rights (radio button)

Technical information

...

Asset type

...

Orientation

...

Dimensions

...

File size

...

Colorspace

...

  • : Name, Caption, Keywords, Folder, Langue de l'asset, Collection, Organization

  • Negociated Rights : Photograph*, Right types, Shooting date, Expiration date*, Authorized Channel

  • Technical information : Asset type, Orientation, Dimensions, File size, Duration, Colorspace, Clipped.

Properties display depends on the property type.

The configuration can be changed with the sections and metadata of your choice.

Image Added

Contains all information calculated by Artificial Intelligence : Keywords, and specific information for video like transcript of the video, identified objects and concepts.

Image Added

In this area, the user can see the asset and play it (if it is a video, an audio file, or 3D). It has several additional options: zoom, full screen.
The configuration can be modified to include sharing on social networks.

Image Added

Number of Views and downloads for the asset.

The configuration can be modified to hide these information.

...

Info

AI Insights section

All AI Keywords related with the asset are listed in this section.

...

Asset Actions list

Image Added

Actions for an asset are : 

Additionnal actions can be activated in the configuration :

  • Reverse Search (with agreement of sales)

  • Embed code generation (with agreement of sales as it is related with DXM option)

  • Social Sharing

Asset Relations (not configured in starter kit)

Image Added

None of these sections come with the starter kit.

Assets can be linked with multiple options :

  1. Fulltext request

  2. Request on one or more metadata of the consulted asset

  3. Request on links between assets

The configuration can be changed to activate these sections which are displayed under the asset.

Feedback popin

No documentation available yet.

Help popin

No documentation available yet.

Advanced Configuration

Disabling the asset detail page

Access to the asset detail page can be disabled by switching the value of $features.canViewAssetDetails to false.

Configuring the details sections (Asset details area)

Automatic configuration (default) :

You can chose to display all fields containing data and having its “visible” property equals true by setting $dam.details.defaultCursorConfig.defaultAssetDetailMeta.column[].tabs[].auto to true. The order will follow the index property of each field. In this mode, if you want to re-order the metadata, create a section and decide which metadata to show, you can use the configuration interface.

Config path

Default value

Description

$dam.details.defaultCursorConfig.defaultAssetDetailMeta.column[0].tabs[0].i18n

asset.assetInformation.label

I18n label to display as a tab title

$dam.details.defaultCursorConfig.defaultAssetDetailMeta.column[0].tabs[0].auto

Code Block
true

Use data model to handle the details display of column[0].tabs[0]

Manual configuration :

The configuration of the details section is placed under $dam.details.defaultCursorConfig.defaultAssetDetailMeta.column. You can then configure some tabs to display details informations.

You can define in configuration what fields and sections you want to display in $dam.details.defaultCursorConfig.defaultAssetDetailMeta.column[].tabs[].config, the order will remain the same that the one you configured.

Tabs is an array containing objects :

Config path

Default value

Description

$dam.details.defaultCursorConfig.defaultAssetDetailMeta.column[0].tabs[0].i18n

asset.assetInformation.label

I18n label to display as a tab title

$dam.details.defaultCursorConfig.defaultAssetDetailMeta.column[0].tabs[0].config

Code Block
[
  "defaultAssetDetailSectionInformation",
  "defaultAssetDetailSectionRights",
  "defaultAssetDetailSectionTechMeta"
]

Sets the different section displayed in a tab

$dam.details.defaultCursorConfig.defaultAssetDetailMeta.column[0].tabs[0].config[0]

Code Block
[
  "detail.section.information",
  "detailFieldName",
  "description",
  "detailFieldKeywords",
  "lang",
  "collection"
]

Set the title (first element) and the

field

fields to display in a section.

A field can be either a string for simple configuration or referencing a named config. You can use an object for more precise configuration.

Each field can be configured and by default if there is no data to display, the field is not displayed.

Asset Actions list

...

Info

Default actions for a media are : 

...

. For further informations regarding fields configuration, please refer to the fields configuration dedicated page.

Changing the header defaults (Name + Photograph)

The displayed header is set in $dam.details.defaultCursorConfig.defaultAssetDetailMeta.header

Config path

Default value

Description

$dam.details.defaultCursorConfig.defaultAssetDetailMeta.header.config

Code Block
[
  "name",
  {
    "field": "photograph",
    "withoutLabel": true
  }
]

An array of fields to be displayed in the header section of a detail page.

A field can be either a string for simple configuration or referencing a named config. You can use an object for more precise configuration.

Configuring the body

See : this page

Configuring the actions list

The action “Where is this asset published ?” required the plugin “PACKAGED_ReverseSearch” to be activated.

...

The default value for $dam.explore.items.actions.maxDisplayedActions is 3. And the default configuration is 8.

...

Configuring the Asset

...

Relations

The configuration of the details section is placed under $dam.details.defaultCursorConfig.defaultAssetDetailMeta.body which did not exists by default (hence the body is empty and nothing is displayed under the asset).

...

Config path

...

Default value

...

Description

More information about configuring the asset relations

Disabling Views and Downloads count

Set $dam.details.disableAnalytics to true.

Disabling AI Keywords

Remove the corresponding tab ($dam.details.defaultCursorConfig.defaultAssetDetailMeta.

...

column[0]

...

An array containing sections to display in the body.

...

$dam.details.defaultCursorConfig.defaultAssetDetailMeta.body[0]

...

{} OR ""

...

An object or a string representing the field to display.

Feedback popin

See : Feedback's popin

Help popin

To complete

Advanced Configuration

Disabling the asset detail page

Access to the asset detail page can be disabled by switching the value of $features.canViewAssetDetails to false.

Changing the header defaults (name + Photograph)

The displayed header is set in $dam.details.defaultCursorConfig.defaultAssetDetailMeta.header .tabs[1] in default configuration).

Display a field even if facettes forbid it

If you have a facette on a field saying to not display it in some context but you still want to display it in the detail page, you can set a property "doNotHonorFacets": true to the related field to force it to be displayed.

Configuring AI Insights

...

It’s possible to add an “AI Insights” tab for videos with three different AI options:

  • objects

  • concepts

  • and timeline

Config path

Default value

Description

$common.namedDisplays.defaultAssetDetailTabAssetInsights.config

Code Block
[
  "detailFieldAiConcepts",
  "assetInsightsAiLabels",
  "assetInsightsAiKeywords",
  "assetInsightsAiTimeline"
]

An array containing the tabs to display:

  • assetInsightsAiLabels will display objects

  • assetInsightsAiKeywords will display the concepts

  • assetInsightsAiTimeline will display the timeline.

If none of the three items are in the configuration, the “AI Insights” tab won’t be shown.

Editing an asset configuration

Date fields

By default, the date field for the expiration date comes with a text to add a year from today.

...

It is possible to configure this display of text.

Config path

Default value

Description

$dam

$edit.

details

default.

defaultCursorConfig

fields.

defaultAssetDetailMeta

names.

header.config

dteendrights

Code Block
[
{
  "default": {
    "
name",
helpers": [
      {
        "
field
args": [1,"
photograph
years"],
        "
withoutLabel
method":
true
"add"
      }
    ]

An array of fields to be displayed in the header section of a detail page.

A field can be either a string for simple configuration or referencing a named config. You can use an object for more precise configuration.

Disabling View and download count

Set $dam.details.disableAnalytics to true.

Disabling AI Keywords

...


  }
}

Adds a number of days/weeks/months/year to the date.

Properties:

  • args: array of 2 elements (1 when using endOf method). the first element is a number and the second element is a string reprensenting the unit of time (days, weeks, months, years, ...).

    Code Block
    languagejson
    # Example of uses
"args": [10,"days"],
# or
"args": [2,"weeks"],
# or
"args": [6,"months"],
# or
"args": [1,"years"],

  • autoDisplayUnit: by default, the text displayed will be "humanized" to be user-readable-friendly. If you'd rather display the time reference in another unit of time, you can specify it here. If no time unit is specified, it will take it from the args property.

    Code Block
    languagejson
    # Use case example
{
  "default": {
    "helpers": [
      {
        "autoDisplayUnit": "months",
        "args": [6,"months"],
        "method": "add"
      },
      {
        "autoDisplayUnit": "months",
        "args": [1,"years"],
        "method": "add"
      },
      {
        "autoDisplayUnit": "months",
        "args": [2,"years"],
        "method": "add"
      }
    ]
  }
}

    Without the autoDisplayUnit, this is what we would have:

    Image Added

    By adding the autoDisplayUnit, we can have a unified unit of time:

    Image Added

    autoDisplayUnit is best if added to each helper.
    Here is an example of autoDisplayUnit set to “months” for the first 2 helpers (“6 months” and “1 year”) but not for the 3rd (“2 years”).

    Image Added

  • method: this is the "operation" you'd like to operate on the date. The possible values are add, subtract or endOf (1).

    Image AddedImage AddedImage Added

    (1) the endOf method needs another property when in use:

    Code Block
    "i18n": "duration.endofyear"

    This will change the text to “end of the year”.

  • i18n: is a i18n key that will change the label/text displayed.
    Example:

    Code Block
    {
    "args": [10,"years"],
    "method": "add",
    "i18n": "shared-board.fetching.title"
}

    Will have displayed :

    Image Added

    Or, if we change the property to :

    Code Block
    {
    "args": [10,"years"],
    "method": "add",
    "i18n": "foo bar"
}
    Image Added