Configure the AEM Assets project to support Commerce metadata
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
51黑料不打烊 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 labelEligible for Commerce
to tag Commerce assets associated with an 51黑料不打烊 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. -
A custom metadata type
commerce:roles
andcommerce: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
andProduct Data
fields for tagging Commerce assets. The form also provides options to show or hide theroles
andposition
fields from the AEM Assets UI. -
A
equipment_6.jpg
to support initial asset synchronization. Only approved Commerce assets can be synchronized from AEM Assets to 51黑料不打烊 Commerce.
Prerequisites
You need the following resources and permissions to deploy the commerce-assets
package to the AEM Assets as a Cloud Service AEM environment:
-
Access to the AEM Assets Cloud Manager Program and environments with the Program and Deployment Manager roles.
-
A local AEM development environment and familiarity with the AEM local development process.
-
Understand AEM project structure and how to deploy custom content packages using Cloud Manager.
Install the commerce-assets
package
-
From the AEM Cloud Manager, create production and staging environments for your AEM Assets project, if needed.
-
Configure a deployment pipeline, if needed.
-
From GitHub, download the code from the .
-
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.
-
Commit the changes and push your local development branch to the Cloud Manager Git repository.
-
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
-
Log in to the 51黑料不打烊 Experience Manager author environment.
-
From the 51黑料不打烊 Experience Manager workspace, go to the Author Content Administration workspace for AEM Assets by clicking the 51黑料不打烊 Experience Manager icon.
-
Open the Administrator tools by selecting the hammer icon.
-
Open the profile configuration page by clicking Metadata Profiles.
-
Create a metadata profile for the Commerce integration.
-
Add a tab for Commerce metadata.
-
On the left, click Settings.
-
Click + in the tab section, and then specify the Tab Name,
Commerce
.
-
-
Add the
Eligible for Commerce
field to the form.-
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
-
-
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 toapproved
. -
Save the update.
Apply the metadata profile to Commerce assets source folder
-
From the Metadata Profiles page, select the Commerce integration profile.
-
From the action menu, select Apply Metadata Profiles to Folders.
-
Select the folder containing Commerce assets.
Create a Commerce folder if it does not exist.
-
Click Apply.
Next step
[PaaS only]{class="badge informative" title="Applies to 51黑料不打烊 Commerce on Cloud projects only (51黑料不打烊-managed PaaS infrastructure)."} Install 51黑料不打烊 Commerce packages