Configure the AEM Assets project

This topic describes how to configure your AEM Assets project so that the Commerce namespace, metadata schema, and Commerce tab are available in the AEM authoring environment. For background on these resources, see Commerce metadata in AEM Assets.

You have two options to configure the AEM Assets project:

  • [Recommended]{class="badge positive"} Self-service onboarding — On AEM releases 2026.5.26309 and later, enable the integration in Cloud Manager by setting an environment variable and activating Dynamic Media with OpenAPI capabilities. No custom code deployment is required. See Enable the Commerce integration (self-service).

  • Manual configuration — Deploy the assets-commerce package through a Cloud Manager pipeline. Use these manual steps when you must deploy custom package code, or if you are on an AEM release earlier than 2026.5.26309. See Install the assets-commerce package manually.

TIP
You can check the current AEM version from the top right menu: Help > About AEM.

Enable the Commerce integration (self-service) enable-aem-commerce-self-service

[Supported]{class="badge informative" title="Supported"} AEM release 2026.5.26309 and later.

On supported AEM releases, you enable the Commerce integration from Cloud Manager without deploying any custom code. The Commerce namespace, metadata schema, and Commerce tab are provisioned automatically when you enable the integration on the Author service.

Self-service prerequisites

  • Access to the AEM Cloud Manager Program and environments with the Program and Deployment Manager roles.

  • An AEM program on release 2026.5.26309 or later.

  • The IMS Org ID for your Commerce instance.

    Both your Commerce instance and AEM Assets authoring environment must be in the same IMS organization.

Step 1: Create the program and environments

Creating a program in Cloud Manager is a single wizard process — the program and its environments are configured across multiple steps and saved together at the end.

  1. In Cloud Manager, select Add Program.

  2. Choose Set up for production, enter a program name, then select Continue.

  3. On the Solutions & Add-ons step, select the solutions and add-ons that your project requires, including Dynamic Media, then select Continue.

    Cloud Manager Solutions and Add-ons step with Dynamic Media selected {width="600" modal="regular"}

  4. On the Add Environment step, enter names for the Production and Staging environments, then select a region.

    Cloud Manager Add environment dialog with Production and Stage details {width="600" modal="regular"}

  5. Select Save to create the program with its environments.

Step 2: Enable the Commerce integration variable

In Cloud Manager, open the environment you created in Step 1, then:

  1. Select the Configuration tab.

  2. Add an environment variable with the following values, then select Add and Save:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
    Field Value
    Name COMMERCE_INTEGRATION_ENABLED
    Value true
    Service applied Author
    Type Variable

    Cloud Manager environment configuration with the COMMERCEINTEGRATIONENABLED variable applied to the Author service {width="600" modal="regular"}

    The environment updates to apply the configuration. Wait until the environment status returns to Running.

Step 3: Activate Dynamic Media with OpenAPI capabilities

  1. On the environment General tab, locate Dynamic Media.

  2. Next to OpenAPI capabilities are available, select Click to activate.

    Environment General tab showing the Dynamic Media OpenAPI activation link {width="600" modal="regular"}

    Activation runs in the background. When it completes, the environment is ready for the Commerce integration.

    note
    NOTE
    If Click to activate is not available, open a support ticket to enable Dynamic Media with OpenAPI capabilities.

Step 4: Validate the configuration

Switch to the AEM Assets author environment and open any asset. Edit its properties and confirm that the default metadata schema includes the Commerce tab and that the Product Data and Eligible for Commerce fields are visible.

Install the assets-commerce package manually

NOTE
Use this manual method to deploy custom package code or if you are on AEM releases earlier than 2026.5.26309. On supported releases, use Enable the Commerce integration (self-service) instead.

Prerequisites

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

Product Visuals

[SaaS only]{class="badge positive" title="Applies to Adobe Commerce as a Cloud Service and Adobe Commerce Optimizer projects only (Adobe-managed SaaS infrastructure)."} Dynamic Media with OpenAPI capabilities is self-service for Product Visuals powered by AEM Assets.

  1. Navigate to your Cloud Manager.

  2. Select the desired environment.

  3. Enable Dynamic Media with OpenAPI capabilities.

    If the Dynamic Media with OpenAPI capabilities button is not active, open a support ticket.

AEM Assets

[PaaS only]{class="badge informative" title="Applies to Adobe Commerce on Cloud projects only (Adobe-managed PaaS infrastructure)."} On AEM as a Cloud Service, submit an Adobe support ticket with this information:

  • Title: Enable Dynamic Media OpenAPI to integrate Adobe Commerce fully with AEM Assets

    • Content of the support ticket:

      • AEM Program ID
      • Adobe Commerce URL
      • AEM Environment ID
      • IMS Org ID

Once you submit the support ticket, Adobe enables Dynamic Media with OpenAPI capabilities on your Cloud Services environment and shares the details, such as IMS Client ID, for you to proceed with the integration.

Installation steps

  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. Clone the Adobe managed git repository for the selected program.

    Cloud Manager repository credentials and clone command {width="600" modal="regular"}

    In Cloud Manager Pipelines, select Access Repo Info to open Repository Info. Copy the URL or Git command line value, generate an access password if needed, then clone locally with your Git client.

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

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

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

    note
    NOTE
    Alternatively, you can install the custom code into your AEM Assets project configuration as a Maven package.
  6. Commit the changes and push your local development branch to the Cloud Manager Git repository.

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

    Cloud Manager Pipelines {width="600" modal="regular"}

    When the pipeline exists, open the actions menu () to Run, Edit, View/Edit variables, or other actions—see the Cloud Manager pipeline documentation linked above.

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

  9. 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 complete the following steps in the metadata schema editor:

  1. Navigate to the metadata schema editor.

  2. Select 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.

Configure a metadata profile (optional)

In the AEM Assets author environment, set default values for Commerce asset metadata by creating a metadata profile. To use these defaults automatically, apply the new profile to AEM Asset folders. 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 synchronize approved Commerce assets automatically 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. Select Apply.

Next steps

recommendation-more-help
commerce-help-aem-assets-integration