Configure the Catalog Version
The Catalog version ( hybris.catalog.version
) that is imported can be configured for the OSGi service:
Day CQ Commerce Hybris Configuration
( com.adobe.cq.commerce.hybris.common.DefaultHybrisConfigurationService
)
Catalog version is set to either Online
or Staged
(the default).
The log output provides feedback on the created pages and components and reports potential errors.
Configure the Import Structure
The following listing shows a sample structure (of assets, pages and components) that is created by default:
+ /content/dam/path/to/images
+ 12345.jpg (dam:Asset)
+ ...
+ ...
+ /content/site/en
- cq:commerceProvider = "hybris"
- cq:hybrisBaseStore = "basestore"
- cq:hybrisCatalogId = "catalog"
+ category1 (cq:Page)
+ jcr:content (cq:PageContent)
- jcr:title = "Category 1"
+ category11 (cq:Page)
+ jcr:content (cq:PageContent)
- jcr:title = "Category 1.1"
+ 12345 (cq:Page)
+ jcr:content (cq:PageContent)
+ par
+ product (nt:unstructured)
- cq:hybrisProductId = "12345"
- sling:resourceType = "commerce/components/product"
+ image (nt:unstructured)
- sling:resourceType = "commerce/components/product/image"
- fileReference = "/content/dam/path/to/images/12345.jpg"
+ 12345.1-S (nt:unstructured)
- cq:hybrisProductId = "12345.1-S"
- sling:resourceType = "commerce/components/product"
+ image (nt:unstructured)
- sling:resourceType = "commerce/components/product/image"
- fileReference = "/content/dam/path/to/images/12345.1-S.jpg"
+ ...
Such a structure is created by the OSGi service DefaultImportHandler
that implements the ImportHandler
interface. An import handler is called by the actual importer to create products, product variations, categories, asset, and so on.
The structure to be generated when importing can be configured for:
``Day CQ Commerce Hybris Default Import Handler(com.adobe.cq.commerce.hybris.importer.DefaultImportHandler
)
When working with AEM, there are several methods of managing the configuration settings for such services; see Configuring OSGi for full details. Also see the console for a full list of configurable parameters and their defaults.
Configure the Product Attributes to Load
The response parser can be configured to define the properties and attributes to be loaded for (variant) products:
-
Configure the OSGi bundle:
Day CQ Commerce Hybris Default Response Parser
(com.adobe.cq.commerce.hybris.impl.importer.DefaultResponseParser
)Here you can define various options and attributes needed for loading and mapping.
NOTE
When working with AEM, there are several methods of managing the configuration settings for such services; see Configuring OSGi for full details. Also see the console for a full list of configurable parameters and their defaults.
Importing the Product Data
There are various ways to import the product data. The product data can be imported when initially setting up the environment, or after changes have been made in the hybris data:
Actual product information imported from hybris is held in the repository under:
/etc/commerce/products
The following properties indicate the link with hybris:
commerceProvider
cq:hybrisCatalogId
cq:hybrisProductID
geometrixx-outdoors/en_US
) only stores product IDs and other basic information under /etc/commerce
.Full Import
-
If necessary, delete all existing product data using CRXDE Lite.
-
Navigate to the subtree holding the product data:
/etc/commerce/products
For example:
http://localhost:4502/crx/de/index.jsp#/etc/commerce/products
-
Delete the node that holds your product data; for example,
outdoors
. -
Save All to persist the change.
-
-
Open the hybris importer in AEM:
/etc/importers/hybris.html
For example:
-
Configure the required parameters; for example:
-
Click Import Catalog to start the import.
When complete, you can verify the data imported at:
/etc/commerce/products/outdoors
You can open this in CRXDE Lite; for example:
[http://localhost:4502/crx/de/index.jsp#/etc/commerce/products](http://localhost:4502/crx/de/index.jsp#/etc/commerce/products)
Incremental Import
-
Check the information held in AEM for the relevant products, in the appropriate subtree under:
/etc/commerce/products
You can open this in CRXDE Lite; for example:
http://localhost:4502/crx/de/index.jsp#/etc/commerce/products
-
In hybris, update the information held on the relevant products.
-
Open the hybris importer in AEM:
/etc/importers/hybris.html
For example:
-
Select the checkbox Incremental Import.
-
Click Import Catalog to start the import.
When complete, you can verify the data updated in AEM under:
/etc/commerce/products
Express Update
The import process can take a long time, so as an extension to the Product Synchronization you can select specific areas of the catalog for an express update that is triggered manually. This uses the export feed together with the standard attributes configuration.
-
Check the information held in AEM for the relevant products, in the appropriate subtree under:
/etc/commerce/products
You can open this in CRXDE Lite; for example:
http://localhost:4502/crx/de/index.jsp#/etc/commerce/products
-
In hybris, update the information held on the relevant products.
-
In hybris, add one or more products to the Express Queue; for example:
-
Open the hybris importer in AEM:
/etc/importers/hybris.html
For example:
-
Select the checkbox Express Update.
-
Click Import Catalog to start the import.
When complete, you can verify the data updated in AEM under:
/etc/commerce/products
Configure the Catalog Importer
The hybris catalog can be imported into AEM, using the batch importer for hybris catalogs, categories, and products.
The parameters used by the importer can be configured for:
Day CQ Commerce Hybris Catalog Importer
( com.adobe.cq.commerce.hybris.impl.importer.DefaultHybrisImporter
)
When working with AEM, there are several methods of managing the configuration settings for such services; see Configuring OSGi for full details. Also see the console for a full list of configurable parameters and their defaults.
Catalog Import
The hybris package comes with a catalog importer for setting up the initial page structure.
This is available from:
http://localhost:4502/etc/importers/hybris.html
The following information must be provided:
-
Base store
The identifier of the base store configured in hybris. -
Catalog
The identifier of the catalog to import. -
Root path
The path where the catalog should be imported into.
Removing a Product from the Catalog
To remove one, or more, products from the catalog:
-
Configure the for OSGi service Day CQ Commerce Hybris Catalog Importer; see also Configure the Catalog Importer.
Activate the following properties:
- Enable product removal
- Enable product asset removal
NOTE
When working with AEM, there are several methods of managing the configuration settings for such services; see Configuring OSGi for full details. Also see the console for a full list of configurable parameters and their defaults. -
Initialize the importer by performing two incremental updates (see Catalog Import):
- The first-time run result in a set of changed products - indicated in the log list.
- For the second time, no products should be updated.
NOTE
The first import is to initialize the product information. The second import verifies that everything worked and the is product set is ready. -
Check the category page that contains the product you want to remove. The product details should be visible.
For example, the following category shows details of the Cajamara product:
http://localhost:4502/editor.html/content/geometrixx-outdoors/en_US/equipment/biking.html
-
Remove the product in the hybris console. Use the option Change approval status to set the status to
unapproved
. The product is removed from the live-feed.For example:
- Open the page http://localhost:9001/productcockpit
- Select the catalog
Outdoors Staged
- Search for
Cajamara
- Select this product and change the approval status to
unapproved
-
Perform another incremental update (see Catalog Import). The log lists the deleted product.
-
Rollout the appropriate catalog. The product and product page have been removed from within AEM.
For example:
-
Open:
http://localhost:4502/aem/catalogs.html/content/catalogs/geometrixx-outdoors-hybris
-
Rollout the
Hybris Base
catalog -
Open:
http://localhost:4502/editor.html/content/geometrixx-outdoors/en_US/equipment/biking.html
-
The
Cajamara
product is removed from theBike
category
-
-
To reinstate the product:
-
In hybris, set the approval status back to approved
-
In AEM:
- perform an incremental update
- rollout the appropriate catalog again
- refresh the appropriate category page
-
Add Order History Trait to the Client Context
To add order history to the client context:
-
Open the client context design page, by either:
- Open a page for editing, then open the client context using Ctrl-Alt-c (windows) or control-option-c (Mac). Use the pencil icon in the top-left corner of the client context to Open the ClientContext design page.
- Navigate directly to http://localhost:4502/etc/clientcontext/default/content.html
-
Add the Order History component to the Shopping Car t component of the client context.
-
You can confirm that the client context is showing details of your order history. For example:
-
Open the client context.
-
Add an item to the cart.
-
Complete the checkout.
-
Check the client context.
-
Add another item to the cart.
-
Navigate to the checkout page:
- The client context shows a summary of the order history.
- The message “You’re a returning customer” is shown.
NOTE
The message is realized by:-
Navigate to http://localhost:4502/content/campaigns/geometrixx-outdoors/hybris-returning-customer.html
The campaign consists of one experience.
-
Click the segment (http://localhost:4502/etc/segmentation/geometrixx-outdoors/returning-customer.html)
-
The segment is built using the Order History Property trait.
-
Experience Manager
Put the Customer at the Center and Build Relationships That Last a Lifetime
First impressions last a lifetime. Great first impressions feel personal, connected, and relevant right from the start. From the first...
Wed, Mar 19, 2:30 PM PDT (9:30 PM UTC)
The True Cost of a Failed Implementation
A failed implementation isn’t just an inconvenience — it costs real revenue. Poor execution and misaligned tools disrupt pipelines,...
Wed, Mar 19, 2:00 PM PDT (9:00 PM UTC)
Connect with Experience League at Summit!
Get front-row access to top sessions, hands-on activities, and networking—wherever you are!
Learn more