Integrate Acquia DAM with LinkIt

Integrate Acquia DAM with LinkIt

Link Acquia DAM (Widen) assets directly in rich text fields through the LinkIt plugin in CKEditor. When this integration is configured, content authors can use the Link option in CKEditor to search and select Acquia DAM (Widen) media entities and insert links to them in body fields, long text fields, and other WYSIWYG components.

This guide describes how to configure LinkIt profiles and text formats so that CKEditor can use Acquia DAM (Widen) media types through the LinkIt plugin.

Prerequisites

Before you begin, make sure that:

• The Acquia DAM (Widen) module is active and configured.
• The LinkIt module is enabled and functional.
• Acquia DAM (Widen) media types and fields are configured as described in the main Acquia DAM (Widen) integration page.
• You have a user role with permission to:
  • Administer text formats and editors.
  • Administer LinkIt profiles.
  • Access Acquia DAM (Widen) media types.

Configure a LinkIt profile for Acquia DAM (Widen) media

Step 1: Create a LinkIt profile

1. In the admin toolbar, go to Administration → Configuration → Content authoring → Linkit.
2. Click + Add profile.
3. Enter a 
   Profile
   name and  to identify this profile as the one that supports media links.

Step 2: Add a media matcher for Acquia DAM (Widen)

1. On the profile page, select Add matcher.
2. Select Media as the matcher type, then click Save and continue.
3. On the media matcher configuration page:
   1. Under Bundle restrictions, select the Acquia DAM (Widen) media bundles you want to link.
      Such as:
      • Acquia DAM (Widen) image
      • Acquia DAM (Widen) video
      • Any custom Acquia DAM (Widen) media type
   2. Under URL substitution, select the appropriate substitution plugin for media entities.
      This controls the URL format LinkIt inserts for Acquia DAM (Widen) media, such as entity URL, canonical path, or a custom substitution plugin that your site defines.

   3. Configure additional field or label settings to improve the search experience.

      
4. Click Save changes.

Your LinkIt profile now includes a matcher that allows LinkIt to search and link Acquia DAM (Widen) media.

Configure text formats to link Acquia DAM (Widen) media

You must configure each text format that enables authors to create links to Acquia DAM (Widen) media through LinkIt. Typical formats include basic HTML, full HTML, or any custom text format in use.

Step 1: Open text formats and editors

1. In the admin toolbar, go to Administration → Configuration → Content authoring → Text formats and editors.

2. Review the list of text formats, such as plain text, basic HTML, and full HTML.

Step 2: Configure a text format for LinkIt

Repeat these steps for each text format that should support links to Acquia DAM (Widen) media.

1. On the Text formats and editors page, locate the desired text format, such as Full HTML.
2. In the Operations column, select Configure.
3. On the configuration page, confirm that Editor is set to CKEditor (CKEditor or CKEditor 5, depending on your Drupal version).
4. In the Toolbar configuration section, ensure that the Link button is present in the Active toolbar:

   • If necessary, drag the link from Available buttons into the Active toolbar.

     
5. In the Enabled filters section, check the Linkit URL converter filter.
6. Go to the CKEditor 5 plugin settings section.
7. Find the Linkit subsection.
8. From the Linkit profile list, choose the LinkIt profile that you configured for Acquia DAM (Widen) media.
9. Go to the Filter settings section.
10. Find the Linkit URL converter subsection.
11. Under Media entity URL substitution, select the appropriate substitution plugin that should apply to Acquia DAM (Widen) media entities.
12. Click Save configuration.

Repeat these steps for any additional text formats, such as basic HTML, that should allow links to Acquia DAM (Widen) media.

Use LinkIt with Acquia DAM (Widen) in CKEditor

After configuration, authors can create links to Acquia DAM (Widen) media directly from CKEditor:

1. Edit content that uses a text field with CKEditor and a text format configured for LinkIt.
2. Select the text that should become a link.
3. Select the link in the toolbar.
4. In the LinkIt dialog, search for Acquia DAM (Widen) media by name or other metadata.
5. Select the desired media entity from the results.
6. Apply the link and save the content.

On display, the link uses the URL format defined by your LinkIt profile and the configured substitution plugin.

Configure a LinkIt profile for Acquia DAM (Widen) media

Step 1: Create a LinkIt profile

1. In the admin toolbar, go to Administration → Configuration → Content authoring → Linkit.
2. Click + Add profile.
3. Enter a 
   Profile
   name and Description to identify this profile as the one that supports Acquia DAM (Widen) media links.
4. Click Save and manage matchers.

Step 2: Add a media matcher for Acquia DAM (Widen)

1. On the profile page, select Add matcher.
2. Select Media as the matcher type, then click Save and continue.
3. On the media matcher configuration page:
   1. Under Bundle restrictions, select the Acquia DAM (Widen) media bundles you want to link.
      Such as:
      • Acquia DAM (Widen) image
      • Acquia DAM (Widen) video
      • Any custom Acquia DAM (Widen) media type
   2. Under URL substitution, select the appropriate substitution plugin for media entities.
      This controls the URL format LinkIt inserts for Acquia DAM (Widen) media, such as entity URL, canonical path, or a custom substitution plugin that your site defines.

   3. Configure additional field or label settings to improve the search experience.

      
4. Click Save changes.

Your LinkIt profile now includes a matcher that allows LinkIt to search and link Acquia DAM (Widen) media.

Configure text formats to link Acquia DAM (Widen) media

You must configure each text format that enables authors to create links to Acquia DAM (Widen) media through LinkIt. Typical formats include basic HTML, full HTML, or any custom text format in use.

Step 1: Open text formats and editors

1. In the admin toolbar, go to Administration → Configuration → Content authoring → Text formats and editors.

2. Review the list of text formats, such as plain text, basic HTML, and full HTML.

Step 2: Configure a text format for LinkIt

Repeat these steps for each text format that should support links to Acquia DAM (Widen) media.

1. On the Text formats and editors page, locate the desired text format, such as Full HTML.
2. In the Operations column, select Configure.
3. On the configuration page, confirm that Editor is set to CKEditor (CKEditor or CKEditor 5, depending on your Drupal version).
4. In the Toolbar configuration section, ensure that the Link button is present in the Active toolbar:

   • If necessary, drag the link from Available buttons into the Active toolbar.

     
5. In the Enabled filters section, check the Linkit URL converter filter.
6. Go to the CKEditor 5 plugin settings section.
7. Find the Linkit subsection.
8. From the Linkit profile list, choose the LinkIt profile that you configured for Acquia DAM (Widen) media.
9. Go to the Filter settings section.
10. Find the Linkit URL converter subsection.
11. Under Media entity URL substitution, select the appropriate substitution plugin that should apply to Acquia DAM (Widen) media entities.
12. Click Save configuration.

Repeat these steps for any additional text formats, such as basic HTML, that should allow links to Acquia DAM (Widen) media.

Use LinkIt with Acquia DAM (Widen) in CKEditor

After configuration, authors can create links to Acquia DAM (Widen) media directly from CKEditor:

1. Edit content that uses a text field with CKEditor and a text format configured for LinkIt.
2. Select the text that should become a link.
3. Select the link in the toolbar.
4. In the LinkIt dialog, search for Acquia DAM (Widen) media by name or other metadata.
5. Select the desired media entity from the results.
6. Apply the link and save the content.

On display, the link uses the URL format defined by your LinkIt profile and the configured substitution plugin.