Installation and Configuration

Last updated on
22 October 2018

Installation

Installation should be done through composer. The first step is to install the module and its dependencies.


composer require drupal/media_acquiadam
composer require drupal/fallback_formatter
composer require drupal/entity_usage 

Note: Entity Usage is only required if you wish to use the Media: Acquia DAM - Reporting module.

Enable the Media: Acquia DAM module and allow the enabling of its dependencies.

Module Configuration

Within Acquia DAM, create a user specifically for background API access. This user and their group should have access to any asset Drupal should be allowed to view. It is used for background synchronization of asset data. The credentials for this user will be specified in Drupal through the Media Acquia DAM Configuration page.

You will also need your Acquia DAM Client ID and Client secret. This information is available from Acquia DAM support.

Once the access codes have been obtained and API user has been created you may go to admin/config/media/acquiadam in order to enter the configuration.

Media Configuration

Quick configuration can be accomplished by enabling the Media: Acquia DAM - Example Configuration module to import configuration and then uninstalling the module once complete.

Step-by-step Media Configuration

  • Create a new "Media type".
  • Set the "Media source" value to "Acquia DAM asset".
    • If the "Media source configuration" section was not automatically filled out:
    • Save the media type.
    • Add a numeric field to the media type. This field will contain the remote asset ID value.
    • Edit the media type and set the source configuration to the asset ID field.
  • Save the media type.
  • Create a new "File" field on the media type.
  • Edit the previously created media type.
  • In the "Field mapping" section set the "File" dropdown to the file field you created.
  • Save the media type.

Mapping metadata to media entities

Create any additional fields needed for syncing desired metadata. For example, "Photographer" or "Description". These fields should be simple data types such as text or number. Complex data types such as entity references or multi-value fields are not currently supported.

After creating the fields needed you can edit the media type and map them to their appropriate values within the "Field mapping" section. This is the same process as was used to configure the File mapping.

Entity Browser Configuration

After the Acquia DAM module and media types have been configured you may create a new (or update an existing) entity browser. This will allow content editors to easily browse Acquia DAM assets from within their editing workflows.

See the Entity Browser documentation for an in-depth explanation on this process. An additional option, "Acquia DAM", will be available when selecting Widgets. Adding this to the entity browser will enable users to access Acquia DAM assets.

Field Configuration

In order to add Acquia DAM assets to content types or other entities you should always use a Media reference field. Using another type of reference field may result in unpredictable behavior or site errors. Configuring file paths and type limits can be done on the previously created media type.

Acquia DAM Screencast

A screencast exists that goes through the configuration process. It should be mentioned that this screencast is for an older version of the module and may not accurately reflect what you experience as you go through the configuration steps.

https://www.youtube.com/watch?v=w9xU2UBVHL4

Topics covered:

  • Configuration of a media entity bundle for Acquia DAM assets
  • Configuration of an entity browser
  • Configuration of a field to use the entity browser
  • Choosing how to render Acquia DAM assets

Help improve this page

Page status: No known problems

You can: