DocumentationCommerceAEM Assets integration Guide

Configure the AEM Assets project to support Commerce metadata

Last update: Mon Dec 22 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

When you use AEM Assets as a Digital Asset Management system (DAM) for Commerce, installing the assets-commerce package allows you to manage images and videos for Commerce products from the AEM authoring environment.

Complete the following steps to configure the AEM Assets project with the required package code and metadata to manage Commerce assets from the AEM authoring environment:

  1. Learn about the assets-commerce package contents

  2. Complete the installation steps to configure the AEM Assets project to support Commerce metadata

AEM Commerce assets-commerce package contents

Adobe provides an AEM Commerce package code assets-commerce to add Commerce namespace and Metadata Schema resources to the Experience Manager Assets as a Cloud Service environment configuration.

This package code adds the following resources to the AEM Assets authoring environment:

  • A custom namespace, Commerce to identify Commerce-related properties.

    • A custom metadata type commerce:isCommerce with the label Eligible for Commerce to tag Commerce assets associated with an Adobe Commerce project.

    • A custom metadata type commerce:skus and a corresponding UI component to add a Product Data property. Product Data includes the metadata properties to associate a Commerce asset with product SKUs.

      Custom Product Data UI Control {width="600" modal="regular"}

    • A custom metadata type commerce:roles and commerce:positions attributes to show how the asset is visualized in Commerce.

  • A metadata schema form with a Commerce tab that includes the Eligible for Commerce and Product Data fields for tagging Commerce assets. The form also provides options to show or hide the roles and position fields from the AEM Assets UI.

    Commerce tab for AEM Assets metadata schema form {width="600" modal="regular"}

  • A sample tagged and approved Commerce asset equipment_6.jpg to support initial asset synchronization. Only approved Commerce assets can be synchronized from AEM Assets to Adobe Commerce.

NOTE
See the readme page for more information about the AEM Commerce package code.

Prerequisites

You need the following resources and permissions to deploy the assets-commerce package code to the AEM Assets as a Cloud Service AEM environment:

Step 1: Install the assets-commerce package

  1. Navigate to the AEM Cloud Manager, select a program, and create production and staging environments that you want to integrate with Adobe Commerce.

  2. Configure a deployment pipeline, or verify that your pipeline can deploy changes to the selected environment.

  3. Clone the Adobe managed git repository for the selected program.

  4. From GitHub, download the package code from the AEM Assets Commerce repository.

  5. From your local AEM development environment, manually copy the downloaded code into the existing Adobe managed repository.

  6. In all filter.xml and pom.xml files for your project, replace all occurrences of <my-app> with your app name.

NOTE
Alternatively, you can install the custom code into your AEM Assets project configuration as a Maven package.

  1. Commit the changes and push your local development branch to the Cloud Manager Git repository.

  2. From AEM Cloud Manager, update the AEM environment by using the pipeline to deploy your code.

  3. Go to any asset and edit its properties to validate the changes:

    • The default Metadata Schema includes the Commerce tab.

    • Product SKUs and the Eligible for Commerce fields are visible.

Commerce tab is not visible in properties

If the Commerce tab does not appear in properties, you must manually create one in the metadata schema editor.

  1. Navigate to the metadata schema editor.

  2. Click Edit to modify the default metadata schema form.

  3. Create a Commerce tab, and select it.

  4. Drag and drop the Product component into the Commerce tab, and map it to the property commerce:skus.

  5. Select the checkbox for show roles and show order.

  6. Drag and drop a checkbox component into the Commerce tab, and map it to the property commerce:isCommerce. Define Yes and No as the options.

If you encounter any other issues, create a support ticket or contact your AEM Assets Integration sales representative for help.

Step 2: Optional. Configure a metadata profile

In the AEM Assets author environment, set default values for Commerce asset metadata by creating a metadata profile. Then, apply the new profile to AEM Asset folders to automatically use these defaults. This configuration streamlines asset processing by reducing manual steps.

When you configure the metadata profile, you only have to configure the following components:

  • Add a Commerce tab. This tab enables Commerce specific configuration settings added by the template.

  • Add the Eligible for Commerce field to the Commerce tab.

The Product Data UI component is added automatically based on the template.

Define the metadata profile

  1. Log in to the Adobe Experience Manager author environment.

  2. From the Adobe Experience Manager workspace, go to the Author Content Administration workspace for AEM Assets by clicking the Adobe Experience Manager icon.

    AEM Assets authoring {width="600" modal="regular"}

  3. Open the Administrator tools by selecting the hammer icon.

    AEM Author Admin manage metadata profiles {width="600" modal="regular"}

  4. Open the profile configuration page by clicking Metadata Profiles.

  5. Create a metadata profile for the Commerce integration.

    AEM Author Admin add metadata profiles {width="600" modal="regular"}

  6. Add a tab for Commerce metadata.

    1. On the left, click Settings.

    2. Click + in the tab section, and then specify the Tab Name, Commerce.

  7. Add the Eligible for Commerce field to the form.

    AEM Author Admin add metadata fields to profile {width="600" modal="regular"}

    • Click Build form.

    • Drag the Single Line text field to the form.

    • Add the Eligible for Commerce text for the label by clicking Field Label.

    • On the Settings tab, add the label text to Field Label.

    • Set the placeholder text to yes.

    • In the Map to Property field, copy and paste the following value

      code language-terminal 
      ./jcr:content/metadata/commerce:isCommerce

  8. Optional. To automatically synchronize approved Commerce assets as they are uploaded to the AEM Assets environment, set the default value for the Review Status field on the Basic tab to approved.

  9. Save the update.

Apply the metadata profile to the Commerce assets source folder

  1. From the Metadata Profiles page, select the Commerce integration profile.

  2. From the action menu, select Apply Metadata Profiles to Folders.

  3. Select the folder containing Commerce assets.

    Create a Commerce folder if it does not exist.

  4. Click Apply.

Next steps

recommendation-more-help
62e3c486-e09f-42bb-be80-2058df1fc0e9