Configure the integration

Configure the integration by connecting Commerce to the AEM Assets instance and selecting the matching strategy for asset synchronization.

After identifying the AEM Assets project, select the matching rule for synchronizing assets between Adobe Commerce and AEM Assets.

  • Match by product SKU—Default rule that matches the SKU in the asset metadata with the Commerce product SKU to ensure that assets are associated with the correct products.

  • Custom match—Matching rule for more complex scenarios or specific business requirements that require custom matching logic. Implementing custom matching requires developing custom code in Adobe Developer App Builder to define how assets are matched with products. More details coming soon…

For the initial setup, use the default Match by product sku rule.

Requirements

Before configuring the AEM Assets Integration, verify that you have completed the following steps:

IMS and user permissions

To use the Asset Selector and provide a smoother setup in Commerce, the following permissions are required:

ACCS

[SaaS only]{class="badge positive" title="Applies to Adobe Commerce as a Cloud Service and Adobe Commerce Optimizer projects only (Adobe-managed SaaS infrastructure)."}

IMS authentication is enabled by default. Add the user to the AEM Assets DM OpenAPI Users - delivery product profile in the Adobe Admin Console to grant access to the AEM Assets delivery layer.

Admin Console product profile for AEM Assets delivery {width="600" modal="regular"}

PaaS

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

  1. Enable Adobe IMS for Commerce by following the instructions in the Commerce Admin Guide.

  2. Open a Support ticket to request a custom IMS Client ID for the Asset Selector.

  3. Add the user to the AEM Assets DM OpenAPI Users - delivery product profile in the Adobe Admin Console to grant access to the AEM Assets delivery layer.

Configure the connection

  1. From the Commerce Admin, open the AEM Assets Integration configuration.

    1. Go to Store > Configuration > ADOBE SERVICES > AEM Assets Integration.

      AEM Assets Integration enable the integration {width="600" modal="regular"}

INFO
The AEM Assets integration only supports configuration at the global (default) scope. Website-level configuration is not supported. When you attempt to configure the integration at the Website level, the system ignores website-level settings and uses the global configuration values instead.
  1. [PaaS only]{class="badge informative" title="Applies to Adobe Commerce on Cloud projects only (Adobe-managed PaaS infrastructure)."} Enter the Asset Selector IMS Client ID.

    This ID is required to enable the Asset Selector and auto-populate feature for the Program ID and Environment ID fields. See IMS and user permissions to obtain this ID. For details about the Asset Selector, see Manually selecting assets.

  2. Select the AEM Assets environment Program ID and Environment ID from the dropdown menus.

    The dropdowns auto-populate based on the user’s IMS session. To use this feature, ensure you have the right IMS and user permissions.

    If the dropdowns are not available, you can manually enter the IDs from the AEM Cloud Manager URL: https://author-p[Program ID]-e[EnvironmentID].adobeaemcloud.com/

    Edit the configuration values by removing the selection from Use system value.

  3. [PaaS only]{class="badge informative" title="Applies to Adobe Commerce on Cloud projects only (Adobe-managed PaaS infrastructure)."} Select the Commerce integration for authenticating requests between Commerce and the asset matching service.

  4. Set Synchronization enabled to Yes to allow Commerce to accept incoming updates from AEM Assets.

    After enabling the integration, additional configuration options are available to specify asset matching criteria.

  5. Select one of the asset matching rules for asset synchronization from the Asset matching rule dropdown.

  6. Add the AEM Assets metadata field name defined for Commerce product SKUs in the Match by product SKU attribute name field, commerce:skus by default.

  7. Select Save Config to apply updates and initiate asset synchronization.

    The configuration update triggers the initial synchronization process, allowing Commerce to accept incoming updates from AEM Assets. The time required for synchronization depends on the volume of assets and specific configurations. The integration leverages automated processes to minimize the time required for synchronization.

Synchronization SLA

The integration guarantees the following synchronization performance levels:

  • < 5 minutes for 99% of updates

  • < 30 minutes for 99.9% of updates

This ensures that product pages always display the most up-to-date images, keeping storefront content accurate and visually appealing.

Configure the Visualization Owner

The Visualization Owner setting determines which system serves product images in the integration:

  • Adobe Commerce – Uses images hosted in Commerce.

  • AEM Assets – Uses images synchronized from AEM.

The Admin displays the available images for that owner, while the rest of the images are grayed out and displayed with a hidden label.

See the set image details topic for details on image display behavior.

TIP
During a migration from Commerce to AEM Assets, set the Visualization Owner to Commerce to avoid broken image links. After all the products have been successfully synchronized with AEM Assets, switch to the AEM Assets owner to complete the transition. This ensures continuous image availability throughout the process.
  1. Navigate to Store > Configuration > ADOBE SERVICES > AEM Assets Integration.

    AEM Assets Integration visualization owner feature {width="400" modal="regular"}

  2. Select the Visualization Owner source to display the images.

  3. Click Save Config to apply updates and initiate asset synchronization.

Optional. Configure the Custom Domain URL

If the AEM Assets as a Cloud Service project has been configured with a Custom Domain Name, you must add the domain name to the Commerce store configuration so that the AEM Assets integration for Commerce can use it.

  1. Navigate to Store > Configuration > ADOBE SERVICES > AEM Assets Integration.

    AEM Assets Integration enable the integration {width="700" modal="regular"}

  2. Add the Custom Domain URL to the Asset Custom Domain field.

  3. Click Save Config to apply updates and initiate asset synchronization.

Next step

  • Configure your Commerce Storefront—To use AEM Assets with the Commerce Storefront powered by Edge Delivery Services, complete the storefront configuration described in the AEM Assets integration topic in the Adobe Commerce Storefront documentation.

  • Set up matching rules between Adobe Commerce and the AEM Assets integration.

  • Manage Commerce assets.

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