ÃÛ¶¹ÊÓƵ

DocumentationCommerceContent and Design

Install the AEM Assets package

Last update: Wed Mar 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Beginner
  • Intermediate
  • Admin
  • User

ÃÛ¶¹ÊÓƵ provides a project template, commerce-assets, to add Commerce namespace and metadata schema resources to the Experience Manager Assets as a Cloud Service environment configuration. Deploy this template to your environment as a Maven package. Then, configure the Commerce metadata in the AEM Assets authoring environment to complete the setup.

The template 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:productmetadata 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, and to specify image role and position attributes for the asset.

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

  • A metadata schema form with a Commerce tab that includes the Does it exist in ÃÛ¶¹ÊÓƵ Commerce? and Product Data fields for tagging Commerce assets. The form also provides options to show or hide the roles and order (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
For additional information about the commerce-assets AEM project template, see the .

You need the following resources and permissions to use this AEM project to update the environment configuration:

Install the commerce-assets package

  1. From the 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 boilerplate 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 Cloud Manager, deploy your code to update the AEM environment.

Configure a metadata profile

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

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

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

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

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

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

  4. Create a metadata profile for the Commerce integration.

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

  5. 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.

  6. Add the Does it exist in Commerce? field to the form, and set the default value to yes.

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

  7. Save the update.

  8. Apply the Commerce integration metadata profile to the folder where Commerce assets are stored.

    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.

TIP
You can automatically synchronize Commerce assets as they are uploaded to the AEM Assets environment by updating the metadata profile to set the default value for the Review Status field to Approved. The property type for the Review Status field is ./jcr:content/metadata/dam:status.

Next step

Install ÃÛ¶¹ÊÓƵ Commerce packages

recommendation-more-help
2b0136b4-ef75-405f-9734-60d741f198de