Design
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,
Feedback popin,
Help popin.
Those points are detailed in the next chapters.
Asset details area
Design | How it works |
---|---|
Back link redirects user to the page he was before | |
The header corresponds to the following metadata : Name + Photograph. The configuration can be changed with the metadata of your choice. | |
Next / Previous button allow navigation to the next or previous asset details following the order of the search results | |
Out of the box, Metadata section contains 3 sections :
Properties display depends on the property type. The configuration can be changed with the sections and metadata of your choice. | |
Contains all information calculated by Artificial Intelligence : Keywords, and specific information for video like transcript of the video, identified objects and concepts. | |
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. | |
Number of Views and downloads for the asset. The configuration can be modified to hide these information. |
Asset Actions list
Actions for an asset are :
Additionnal actions can be activated in the configuration :
|
Asset Relations (not configured in starter kit)
Assets can be linked with multiple options :
None of these sections come with the starter kit. 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)
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 |
---|---|---|
|
| I18n label to display as a tab title |
| [ "defaultAssetDetailSectionInformation", "defaultAssetDetailSectionRights", "defaultAssetDetailSectionTechMeta" ] | Sets the different section displayed in a tab |
| [ "detail.section.information", "detailFieldName", "description", "detailFieldKeywords", "lang", "collection" ] | Set the title (first element) and the fields to display in a section. A field can be either a string for simple configuration or referencing a |
Each field can be configured and by default if there is no data to display, the field is not displayed. For further informations regarding fields configuration, please refer to the fields configuration dedicated page.
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.
Config path | Default value | Description |
---|---|---|
|
| I18n label to display as a tab title |
| true | Use data model to handle the details display of column[0].tabs[0] |
Changing the header defaults (Name + Photograph)
The displayed header is set in $dam.details.defaultCursorConfig.defaultAssetDetailMeta.header
Config path | Default value | Description |
---|---|---|
| [ "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 |
Configuring the body
The body correspond to the informations displayed under the player and is set in $dam.details.defaultCursorConfig.defaultAssetDetailMeta.body
Config path | Default value | Description |
---|---|---|
| false | Show or not the section if their is no content to display |
| - | i18n key of the section title |
| - | Array of fields names to use to find related content |
| 6 | Number of maximum related items to retrieve and display |
Configuring the actions list
The action “Where is this asset published ?” required the plugin “PACKAGED_ReverseSearch” to be activated.
The action “Embed code generation” required feature “dxm“ to be activated (see : $features.dxm
).
Actions are placed under $dam.details.items.actions
as an array of actions. Removing or adding a value will remove or add an action.
Actions can have two different formats :
// simple form actions : [...] // advance form actions: { maxDisplayedActions: Int, actions: [...] }
Configuring the number of actions displayed
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 |
---|---|---|
|
| An array containing sections to display in the body. |
|
| An object or a string representing the field to display. |
Disabling Views and Downloads count
Set $dam.details.disableAnalytics
to true
.
Disabling AI Keywords
Remove the corresponding tab ($dam.details.defaultCursorConfig.defaultAssetDetailMeta.column[0].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 |
---|---|---|
| [ "detailFieldAiConcepts", "assetInsightsAiLabels", "assetInsightsAiKeywords", "assetInsightsAiTimeline" ] | An array containing the tabs to display:
|
If none of the three items are in the configuration, the “AI Insights” tab won’t be shown.