ÃÛ¶¹ÊÓƵ

DocumentationCommerceProduct Visuals Guide

Configure the AEM Assets project to support Commerce metadata

Last update: Wed Jun 18 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

To use Product Visuals 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

ÃÛ¶¹ÊÓƵ 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 , 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 ÃÛ¶¹ÊÓƵ 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 equipment_6.jpg to support initial asset synchronization. Only approved Commerce assets can be synchronized from AEM Assets to ÃÛ¶¹ÊÓƵ Commerce.

NOTE
See the 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 .

  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 ÃÛ¶¹ÊÓƵ Experience Manager author environment.

  2. From the ÃÛ¶¹ÊÓƵ Experience Manager workspace, go to the Author Content Administration workspace for AEM Assets by clicking the ÃÛ¶¹ÊÓƵ Experience Manager icon.