Page History

The DAM Connector Pack modules allow you to connect to your external DAM and make your existing assets, including videos, PDFs and images, available directly within Magnolia. 

Module structure

Installing

Maven is the easiest way to install the modules. Add the following dependencies to your webapp. All the other necessary dependencies will be brought in automatically:

Configuration

This section explains how to configure the connection between the External DAM module and your external asset management solution. Essentially, you:

• Provide connection credentials for your external solution.
• Configure the cache if necessary.

You can create or edit the configuration in the JCR or the File System (YAML) under <module-name>/external-dams/<definition-name>.

Before you configure the connection, make sure you know:

• Which solution you want to connect to. Default implementations are provided for:
  • AWS S3
  • Bynder
• Connection credentials for your solution.

AWS S3 connection configuration

To use AWS S3 assets in Magnolia, you must have a working AWS account.

Credentials

You need AWS S3 credentials to connect your S3 buckets and display their content in Magnolia. Credentials consist of two parts: 

• AWS access key ID
• AWS secret access key

Add these credentials to your Magnolia instance in the Password manager app. For example:

whitelistedBuckets:
- "^a.*"
- a-particular-bucket

To use Bynder assets in Magnolia, you must have a working Bynder account.

API token

You need a permanent OAuth 2.0 API token from Bynder to access the assets.

To generate a token, see this Bynder documentation: https://help.bynder.com/system/oauth2-permanent-tokens.htm. 

You can use the token value directly in the yaml configuration or add the permanent token to your Magnolia instance in the Password manager app and reference the path in the configuration. For example:

Connecting

Add your connection configuration under /dam-bynder/config.yaml.

bynderPortalURL: https://magnoliaintegration.getbynder.com
permanentToken: <client_secret_or_path_to_password_manager>

Connection properties

Configuring the cache

This connector pack uses Caffeine, a high-performance Java cache library, to manage caching for external assets via a Magnolia helper module called magnolia-addon-commons-cache.

For Bynder and S3 caching, you can specify the behavior of the caches. Essentially, you can configure all the parameters available in CaffeineSpec. For example:

• Set a maximum cache size.
• Define how often the cache expires.

Additionally, you can:

• Enable or disable the cache. 

You configure caching through decoration under /<dam-connector>/decorations/addon-commons-cache/config.yaml.

Bynder default configuration

cacheConfigurations:
  bynder:
    caches:
      bynder-media: maximumSize=500, expireAfterAccess=10m
      bynder-all: expireAfterAccess=60m
      bynder-size: expireAfterAccess=60m
    enabled: true

S3 default configuration

cacheConfigurations:
  s3:
    caches:
      s3-objects: maximumSize=500, expireAfterAccess=10m
      s3-buckets: expireAfterAccess=60m
      s3-count: maximumSize=500, expireAfterAccess=10m
      s3-pages: maximumSize=500, expireAfterAccess=10m

Cache configuration properties

Manually flushing the cache

If you want to flush the cache, you can either set the cache expiry to a very short time (see above) or configure a script in the Groovy app to flush the cache manually. For example:

import info.magnolia.objectfactory.Components
 
cacheManager = Components.getComponent(info.magnolia.addon.commons.cache.CacheManager)
cacheManager.evictCache("s3-objects")

Configuring the maximum search time for S3

You can configure the maximum time the system spends searching for S3 assets to be displayed in the Magnolia interface.

maxSearchTimeInMilis: 10000

pageSize: 100

Usage

The  magnolia-external-dam submodule provides a sample Text and external image page component so that editors and marketers can select and use external assets in the Pages app. See DAM Connector Pack for an example.