Magnolia 5.4 reached end of life on November 15, 2018. This branch is no longer supported, see End-of-life policy.

Page tree
Skip to end of metadata
Go to start of metadata

The External DAM app module provides an app that allows you to display content from an external asset provider.

Installing

Maven is the easiest way to install the module. Add the following dependency to your bundle:

<dependency>
  <groupId>info.magnolia.dam</groupId>
  <artifactId>magnolia-dam-external-app</artifactId>
  <version>2.1.11</version>
</dependency>

Pre-built jars are also available for download. See Installing a module for help.

Configuration

The app is based on the content app framework so its configuration is typical of any content app.

It's configuration can be found at /modules/dam-external-app/apps/dam-external-app.

The app is based on Content Connector which retrieves the content through DAM API#AssetProvider. See the documentation for more information on registering new asset provider.

The asset provider can be specified with its provider id at /modules/dam-external-app/apps/dam-external-app/subApps/browser/contentConnector@assetProviderId :

Node nameValue

 modules

 

 external-dam-app

 

 apps

 

 external-dam-app

 

 subApps

 

 browser

 

 contentConnector

 

 assetProviderId

jcr

 class

info.magnolia.dam.external.app.contentconnector.AssetContentConnectorDefinition

Views

The view icons open different views of the assets stored in the DAM:

  • Tree view: Displays a hierarchical tree, including the folder structure. The underlying AssetProvider has to support AssetProviderCapability#hierarchical capability.
  • List view: Displays the items individually. You can sort them alphanumerically by clicking the column headings, if the AssetProvider supports AssetProviderCapability#queryand AssetProviderCapability#queryWithSorting.
  • Thumbnail view: Displays thumbnail images of the assets. There is a zoom control at the top for resizing.
  • Detail: Display details of the asset. The Metadata field displays all registered metadata classes supported by the asset.

Use in dialogs

The AssetLinkField has to be used instead of LinkField.

It is configured the same way as regular LinkField:

Node nameValue

 assetImage

 

 identifierToPathConverter

 

 class

info.magnolia.dam.external.app.field.AssetCompositeIdKeyTranslator

 appName

your-app

 class

info.magnolia.dam.external.app.field.definition.AssetLinkFieldDefinition