DocumentationCommerceAEM Assets integration Guide

Configure the AEM Assets project to support Commerce metadata

Last update: Wed Jul 09 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

To manage Commerce asset files in AEM Assets, complete the following steps to configure the AEM Assets project with the required boilerplate code and metadata to manage Commerce assets from the AEM authoring environment.

  • Step 1: Install an AEM project template with the boilerplate code to add the Commerce namespace and metadata schema resources to the Experience Manager Assets as a Cloud Service environment configuration.
  • Step 2: Set up the metadata profile to apply to Commerce asset files

Add the boilerplate code to your AEM project

Adobe provides an AEM Commerce boilerplate, assets-commerce, to add Commerce namespace and metadata schema resources to the Experience Manager Assets as a Cloud Service environment configuration. Deploy this code to your environment as a Maven package. Then, configure the Commerce metadata in the AEM Assets authoring environment to complete the setup.

The boilerplate 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 boilerplate.

Prerequisites

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

Install the commerce-assets package

  1. From the AEM Cloud Manager, create production and staging environments for your AEM Assets project, if needed.

  2. Configure a deployment pipeline, if needed.

  3. From GitHub, download the code from the AEM Commerce boilerplate.

  4. From your local AEM development environment, install the custom code into your AEM Assets environment configuration as a Maven package, or by manually copying the code into the existing project configuration.

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

  6. From AEM Cloud Manager, deploy your code to update the AEM environment.

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 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 step

[PaaS only]{class="badge informative" title="Applies to Adobe Commerce on Cloud projects only (Adobe-managed PaaS infrastructure)."} Install Adobe Commerce packages

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