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.
#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))
Module structure
| artifactID | Description |
|---|---|
| Parent reactor. |
| Provides the foundation and the API for integrating with external digital asset management (DAM) solutions. |
| Provides a default implementation to connect to Bynder. |
| Provides a default implementation to connect to Amazon S3. |
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:
aws-credentials | |
| |
|
The magnolia-aws-foundation module handles all Amazon connections from Magnolia. This module is installed automatically by Maven when you install the External DAM module.
Configuring an S3 bucket whitelist
By default, all the buckets in the S3 account you connect to are displayed. If you do not want to display all your buckets, you can configure a whitelist under /dam-s3/config.yaml. Regex is supported.
For example:
whitelistedBuckets: - "^a.*" - a-particular-bucket
Bynder connection configuration
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.
Add the permanent token to your Magnolia instance in the Password manager app and reference the path in the configuration. For example:
bynder-credentials | |
|
Connecting
Add your connection configuration under /dam-bynder/config.yaml.
bynderPortalURL: https://magnoliaintegration.getbynder.com permanentToken: /bynder-credentials/bynder_permanent_token
Connection properties
| Property | Description |
|---|---|
bynderPortalURL | required URL to your Bynder service. |
permanentToken | required A permanent OAuth 2.0 API token from Bynder or the path to the Passwords app where the token is stored. |
Configuring the cache
Magnolia 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. >>>add property once this is done in ADCOM-3
You configure caching through decoration under /<dam-connector>/decorations/addon-commons-cache/config.yaml.
Bynder default configuration
/dam-bynder/decorations/addon-commons-cache/config.yaml
cacheConfigurations:
bynder:
caches:
bynder-media: maximumSize=500, expireAfterAccess=10m
bynder-all: expireAfterAccess=60m
S3 default configuration
/dam-s3/decorations/addon-commons-cache/config.yaml
cacheConfigurations:
s3:
caches:
s3-objects: maximumSize=500, expireAfterAccess=10m
s3-buckets: expireAfterAccess=60m
Cache configuration properties
| Property | Description |
|---|---|
| required Use CaffeineSpec properties to specify the cache behavior such as the maximum size of the cache and when cache entries expire for each cache.
For example:
|
Bynder loading times
Note that the Bynder API may be very slow in some regions. For example, one image upload may take up to 20 seconds in EU regions. This may cause some actions to fail in the Magnolia UI and the cache to be invalidated.
For more information, see https://github.com/Bynder/bynder-js-sdk/issues/43.
Usage
Overview
Content Tools