Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 Optimizely/Digizuite integration is prepared for this and supports it fully.Image Removed


...


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:

  • 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.

  • Facets (List<FacetRequest>). Any additional fields to filter for.

  • Limit (int). How many assets to return.

  • 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.

...

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 SelectionFactory for folders in the Digizuite.Episerver.Helpers namespace, ready to use in attributes on properties like this: 

[SelectOneSelectMany(SelectionFactoryType = typeof(CropSelectionFactoryFoldersSelectionFactory))]
public virtual string CropName Folders { get; set; }

See a full example further down!

...

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

Image Removed

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:

Code Block
languagec#
protected override IViewComponentResult InvokeComponent(GalleryBlock currentContent)
{
  GalleryBlockViewModel protectedgvm override= IViewComponentResultnew InvokeComponent(GalleryBlock currentContent)GalleryBlockViewModel();
  gvm.CurrentBlock = currentContent;
  AssetQueryParameters aqm = new AssetQueryParameters();            
  aqm.Limit = currentContent.MaxNumberOfAssets;                     

  var facets = new List<FacetRequest>()
  {                   
 GalleryBlockViewModel gvm = new GalleryBlockViewModelFacetRequest();
    {
      FacetMode = gvm.CurrentBlock = currentContent;FacetMode.QueryOnly,
      Recursive = false,
      SearchKey = "assetType",
     AssetQueryParameters aqmValues = new AssetQueryParametersEnums.AssetType.Image.ToString().MakeIntList();
    }
  };

  if  aqm.FoldersToSearch = (!string.IsNullOrEmpty(currentContent.Folders ?? new List<ContentReference>();))
  {
    facets.Add(new FacetRequest()
    {
      FacetMode = aqm.Limit = currentContent.MaxNumberOfAssets;FacetMode.QueryOnly,
      Recursive = false,              aqm.Page = 1;    
      SearchKey  aqm.AssetTypes= _client.Configuration.FolderMetafieldGuid.ToString(),
      Values = GlobalConstantscurrentContent.AssetTypes.Image.MakeIntList();Folders.Split(",").ToList()                   
  aqm.CropName = currentContent.CropName});             aqm.OptionalFilters = new Dictionary<string,
string>();  }
  aqm.Facets = facets;
  
  if (!string.IsNullOrEmpty(currentContent.FreeText)) aqm.FreeText = currentContent.FreeText;
        
   gvm.Images = _client.Search(aqm.CacheFor(TimeSpan.FromMinutes(1)))?.Cast<IDigizuiteImage>()?.ToList();


         
  return View(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

...

. The view is basically just about rendering the gallery, with the addition of rendering the images in the selected media format as described here: DFO 4.0.0 - 4 Referencing and Rendering Assets. Here is what the end result could look like:

Image Removed


...