Versions Compared

Key

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

Design

...

Default Configuration

...

Go to administration interface DAM Branding

Add cursors or queries

Queries

There are no conditions for the query to display in the dam page. It will always show.

...

On the home page however, the query is not visible.

Here is an overview:

Config path

Default value

Description

Translation i18n key:
topsearch.input-placeholder

I'm looking for

Cursors

By default, there are 2 cursors already configured : “All assets” and “All videos“. It also possible to add personalized cursors.

Default cursors

Here is it’s overview of the default cursors:

Config path

Default value

Description

Translation i18n key:

global.schemaNames.allAssets.cursor

All assets

Translation i18n key:

global.schemaNames.allVideos.cursor

All videos

$.common.cursors.all-assets.json

Code Block
languagejson
{
  "path": "dam/asset",
  "max": 60,
  "orderby": "created desc",
  "limit": 20,
  "withRights": true,
  "maxchildren": 6,
  "sortByRelevanceIfFulltext": true,
  "i18nQuery": true,
  "cacheDuration": "20000",
  "haveAssetNature": true,
  "staticQuery": {}
}

Describes how the cursor “All assets” will work: as the staticQuery is empty, all assets will be accepted.

$.common.cursors.all-videos.json

Code Block
{
  "path": "dam/asset",
  "max": 60,
  "staticQuery": {
    "assetnature": {
      "dof": {
        "code":"video"
      }
    }
  },
  "orderby": "created desc",
  "limit": 200,
  "haveAssetNature": true
}

Describes how the cursor “All videos” will filter the assets: will display all assets where the code property of assetnature is a video (in other words, will display all videos).

Adding a new cursor

When adding a new cursor, there are a few steps to take.

First, we’ll have to add it to $.dam.contexts.json. Here is an example with a cursor called “allProducts”:

Code Block
[
  {
    "cursor":"allAssets",
    "disableResourceSubFilter": true
  },
  {
    "cursor": "allVideos",
    "disableResourceSubFilter": true
  },
  {
    "cursor": "allProduct",
    "disableResourceSubFilter": true
  }
]

Then we have to create a file in $.common.cursors.<cursor-name-in-kebab-case>.json. In our example, we’ll have : $.common.cursors.all-product.json

We have to fill in the file with the basic information and the specific query:

Code Block
languagejson
{
    "path": "dam/asset",
    "max": 60,
    "orderby": "created desc",
    "limit": 20,
    "withRights": true,
    "maxchildren": 6,
    "sortByRelevanceIfFulltext": true,
    "i18nQuery": true,
    "cacheDuration": "20000",
    "haveAssetNature": true,
    "staticQuery": {
      "and": [
        {"width":{"eq":3450}},
        {"height":{"eq":5175}}
      ]
    }
  }
  

Here, we ask that the cursor displays all assets that have a width of 3450px and a height of 5175px.

It is also possible to configure the filter bar. If we don’t do it, the default one will be applied (from $dam.explore.filters.default-cursor-config.default-resource-config.json).

Separators

It is also possible to add separators to space out cursors. To do so, add null between each object of a cursor in the $.dam.contexts.json, like so:

Code Block
[
  [...]
  {
    "cursor": "allVideos",
    "disableResourceSubFilter": true
  },
  null,
  {
    "cursor": "allVideos",
    "disableResourceSubFilter": true
  }
]

Here is an overview of what a separator would look like:

Image Added

Image Added

without separators

with separators

Disabling cursors

We can disable the visiblity of the cursors in the dam explorer page by setting to false the $.dam.behaviors.display-contexts-filter.json.

Deactivating a features (upload or boards)

...