DFE 2.3.0 - 5 Querying Assets

Owned by Martin Ulisse
Nov 04, 2024

Sometimes you, as a developer, might want to do more direct queries against the assets in Digizuite DAM. Maybe you want to:

  • Offer a listing of product white papers available for download that updates dynamically
  • Show an archive of videos for the current target audience
  • Give the end user access to direct free text search in certain assets
  • Have a gallery or a slider that automatically selects images marked in your DAM for that purpose by your image editor.

In cases such as these you might want to consider doing a custom query for assets. Luckily the Episerver/Digizuite integration is prepared for this and supports it fully.



Querying

In order to search, you basically have to construct an AssetQueryParameters object.

This will specify all the important parameters of your search. These are some of the parameters you can set:

  • AssetIds (IList<int>). A list of specific asset ID's you want to retrieve. There is method to help you set this, AssetsById(ContentReference) that will also convert the Episerver ContentReference into an AssetID.
  • FoldersToSearch (IList<ContentReference>). If this is set, only assets in those folders will be searched.
  • AssetTypes (IList<int>). A list of Asset Type ID's. If this is set, only assets of those types will be searched.
  • CropName (String). The name (or partial name) of a specific cropping. If this is set, only those crops will be returned.
  • Sort (string). The sorting scheme to use.
  • FreeText (string). A free text search query. By default this will do a free text search against the title, description, keywords and note field - but it can of course be configured.
  • OptionalFilters (Dictionary<string,string>). Any additional fields to filter for. For this to work, the custom filter should have been added to the DAM Center search as an input parameter. Read more: DFE 2.3.0 - 6 Customizing input and output metadata
  • Limit (int). How many assets to return.
  • Page (int). The page of assets to start from. Starts at 1.
  • QueryCacheDuraction (TimeSpan). The timespan to cache the results for. This is very important in order to ensure decent performance on your site and DAM Center. This can also be set through the method CacheFor.

When you have constructed a complete AssetQueryParameters object, you can use it in the DigizuiteClient.Search(AssetQueryParametres) method. This will return an IEnumerable<IContent> that in turn can be cast to whatever type you expect.

If you require the generated IContent objects to have a different 'Parent' property than the default (which is the Digizuite Content Providers entry point), you can specify it in an optional parameter. This can be useful if you want the objects to be listed below a certain folder for example.

The same Search method can also be called with a string query instead, which is in turn parsed to AssetQueryParameters as described below.


Figuring out which values to use for Crops, Sorting and Asset Types

When setting the above search parameters it's important to know which options is available to set. You can of course see this in your DAM Center's configuration, but that might not be available to the typical web site editor.

Luckily, whenever the Digizuite Client class (DFE 2.3.0 - 1 Understanding DAM For Episerver)  initializes, it connects to the DAM and retrieves lists of the various settings like Asset Types, Crop Names, Sorting methods and Media formats. They are then available in the "Configuration" object of the Client and can be called like myClient.Configuration.AssetTypes, myClient.Configuration.MediaFormats, myClient.Configuration.Crops, myClient.Configuration.SortFields.


Selection factories

To make it even easier to use the values from the DAM Center in custom property drop down lists - for example in a block to hold a dynamic gallery, the integration also provides SelectionFactories for AssetType, Crops and MediaFormats in the Digizuite.Episerver.Helpers namespace, ready to use in attributes on properties like this: 

[SelectOne(SelectionFactoryType = typeof(CropSelectionFactory))]
public virtual string CropName { get; set; }

See a full example further down!

Generating from Query String

The AssetQueryParameters has a Parse(string) method that can transform any string into an AssetQueryParameters object.

The parsing will check for the occurrence of key=value sets in the provided string and if the key is "crop" it will try to identify a crop name to filter on. If the key is "type" it will look for a single or a comma-separated list of asset types - either by their ID's or names.
If the key is "sort" it will try to identify a sort field from the value and set that. Any other key/value pairs will be added as OptionalFilters. Any additional text in the query that is not a key/value pair will be set as free text search.

If the entire query consists of a single number it will be treated as a request for a specific asset id.

Since this is exactly the same mechanism that is configured for the Digizuite Search Provider, you can actually try to search in the Digizuite Media tab and use this syntax!


Example: Building a Gallery Block

Putting it all together, let's create a gallery block that shows a dynamic gallery of images from Digizuite, based on editorial preferences.

First, we'll create the block definition. Note, that on this DAM Center we have a custom input (and output) parameter defined called "Status" that can either be "Creative", "Approved" or "Expired". It's added through the process described here: DFE 2.3.0 - 6 Customizing input and output metadata.

We will also make it optional which folders to search in, a Free text query, how many assets to show and so on. However, we won't worry about paging for now.


 [ContentType(DisplayName = "Gallery", GUID = "b05d16f0-877d-4784-8bf1-4a0ee2e57fd1", Description = "Shows a gallery of DAM assets")]
    [ImageUrl("~/Static/img/logo120x90.png")]
    public class GalleryBlock : BlockData
    {

        [CultureSpecific]
        [Display(
            Name = "Headline",
            Description = "Headline",
            GroupName = SystemTabNames.Content,
            Order = 1)]
        public virtual string Headline { get; set; }


        [Display(
   Name = "Max number of assets",
   Description = "",
   GroupName = SystemTabNames.Content,
   Order = 10)]
        public virtual int MaxNumberOfAssets { get; set; }

        [Display(
    Name = "Asset Folders",
    Description = "",
    GroupName = SystemTabNames.Content,
    Order = 20)]
        [UIHint(UIHint.AssetsFolder)]
        public virtual IList<ContentReference> Folders { get; set; }

        [Display(
    Name = "Free Text",
    Description = "",
    GroupName = SystemTabNames.Content,
    Order = 30)]
        public virtual string FreeText { get; set; }

        [Display(
    Name = "Crop Name",
    Description = "",
    GroupName = SystemTabNames.Content,
    Order = 40)]
        [SelectOne(SelectionFactoryType = typeof(CropSelectionFactory))]
        public virtual string CropName { get; set; }

        [Display(
Name = "Media Format",
Description = "",
GroupName = SystemTabNames.Content,
Order = 40)]
        [SelectOne(SelectionFactoryType = typeof(MediaFormatSelectionFactory))]
        public virtual string MediaFormat { get; set; }

        [Display(
    Name = "Status",
    Description = "",
    GroupName = SystemTabNames.Content,
    Order = 50)]
        [SelectOne(SelectionFactoryType = typeof(StatusSelectionFactory))]
        public virtual string Status { get; set; }


        public override void SetDefaultValues(ContentType contentType)
        {
            base.SetDefaultValues(contentType);
            this.MaxNumberOfAssets = 20;

        }
    }

    public class StatusSelectionFactory : ISelectionFactory
    {

        public IEnumerable<ISelectItem> GetSelections(ExtendedMetadata metadata)
        {
            return new ISelectItem[] { new SelectItem() { Text = "(Not set)", Value = "" }, new SelectItem() { Text = "Creative", Value = "Creative" }, new SelectItem() { Text = "Approved", Value = "Approved" }, new SelectItem() { Text = "Expired", Value = "Expired" } };
        }
    }

When we display this to the editors in edit-mode, this is what they'll see:


The folder selection can actually be dragged directly over from the Digizuite folder structure.

We also have to have a standard controller that will popular a View Model with the assets to show. We do that here:

        public override ActionResult Index(GalleryBlock currentBlock)
        {
            GalleryBlockViewModel gvm = new GalleryBlockViewModel();
            gvm.CurrentBlock = currentBlock;
            AssetQueryParameters aqm = new AssetQueryParameters();

            aqm.FoldersToSearch = currentBlock.Folders ?? new List<ContentReference>();
            aqm.Limit= currentBlock.MaxNumberOfAssets;
            aqm.Page = 1;
            aqm.AssetTypes = AssetTypes.Image.MakeIntList();
            aqm.CropName = currentBlock.CropName;
            aqm.OptionalFilters = new Dictionary<string, string>(); 
            if (!string.IsNullOrEmpty(currentBlock.FreeText)) aqm.OptionalFilters.Add("freetext", currentBlock.FreeText);
            if (!string.IsNullOrEmpty(currentBlock.Status)) aqm.OptionalFilters.Add("status", currentBlock.Status);
            gvm.Images = _client.Search(aqm.CacheFor(TimeSpan.FromMinutes(1))).Cast<IDigizuiteImage>().ToList();
            
            return PartialView(gvm);
        }

Notice how we also make sure to set a cache timeout of 1 minute when doing the searching? That ensures a pretty updated image list, while not cause load to the DAM server for every page view. We could probably safely increase this number a lot. 

We also ensure that we will only search for images. AssetTypes.Image (from Digizuite.Episerver.Constants) is a constant int, set to the default Image Asset Type ID. The view is basically just about rendering the gallery, with the addition of rendering the images in the selected media format as described here: DFE 2.3.0 - 4 Referencing and Rendering Assets. Here is what the end result could look like: