The 5.7 branch of Magnolia reached End-of-Life on December 31, 2023, as specified in our End-of-life policy. This means the 5.7 branch is no longer maintained or supported. Please upgrade to the latest Magnolia release. By upgrading, you will get the latest release of Magnolia featuring significant improvements to the author and developer experience. For a successful upgrade, please consult our Magnolia 6.2 documentation. If you need help, please contact info@magnolia-cms.com.

This module is deprecated. See Deprecations.

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 to your bundle. The parent POM of your webapp project should set the latest version of the module automatically. Should you need to use a specific module version, you can define it using the <version/> in the dependency.

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

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 AssetProvider. See the documentation for more information on registering new asset providers.

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