Administering Generic eCommerce
- Topics:
- Commerce Integration Framework
CREATED FOR:
- Admin
The AEM generic solution provides methods of managing the commerce information held within the repository (as opposed to using an external ecommerce engine). This includes:
Products and Product Variations
Before creating products you need to define a scaffold. This specifies the fields you need to define the products and how they are edited.
A scaffold is needed for each distinct product type. The appropriate scaffold is associated with the products by either:
- path
- the product can reference the scaffold
/etc/scaffolding/geometrixx-outdoors
/etc/commerce/products/geometrixx-outdoors
Importing Products
Importing Products - Touch-optimized UI
-
Navigate to the Products console, via Commerce.
-
Using the Products console navigate to the required location.
-
Use the Import Products icon to open the wizard.
-
Specify:
-
Importer
The importer for the specific commerce provider, by default
Geometrixx
. -
Source
The file you want imported; you can use the browser to select a file.
-
Incremental Import
Indicate whether this is an incremental import (as opposed to full).
NOTE
The incremental import (of the sample geometrixx-outdoor importer) operates at the product level.A customized importer can be defined to operate as required. -
-
Select Next to import the products, a log of the actions taken will be shown.
NOTE
The products will be imported to, or relative to, the current location.NOTE
Repeatedly using Next and Back will repeatedly import the product definitions. However, as they have the same SKUs the information existing in the repository will simply be overwritten. -
Select Done to close the wizard.
Importing Products - Classic UI
-
Using the Tools console open the Commerce folder.
-
Double-click to open the Product Importer:
-
Specify:
-
Store Name
Products will be imported to:
/etc/commerce/products/<*store name*>/
-
Commerce Provider
The importer for your commerce provider; by default Geometrixx.
-
Source File
The location in the repository of the file you want imported.
-
Incremental Import
Indicate whether this is an incremental import (as opposed to full).
-
-
Click Import Products.
Creating Product Information
Creating Product Information - Touch-optimized UI
-
Using the Products console (via Commerce) navigate to the required location.
-
Use the Create icon to select either (depending on the structure and location):
- Create Product
- Create Product Variation
-
The wizard will open. Use the Basic and Product Tabs to enter the product attributes for the new product or product variant.
NOTE
Title and SKU are the minimum required to create a product or variant. -
Select Create to save the information.
Editing Product Information
/etc/commerce/products/...
Editing Product Information - Touch-optimized UI
-
Using the Products console (via Commerce) navigate to your product information.
-
Using either:
Select the View Product Data icon:
-
The product attributes will be shown. Use Edit and Done to make any changes.
Showing Product References
Showing Product References - Touch-optimized UI
-
Using the Products console (via Commerce) navigate to your product information.
-
Open the secondary rail for References with the icon:
-
Select your required product - the secondary rail will update to show the reference types available:
-
Click/tap on the reference type (e.g. Product Pages) to expand the list.
-
Select a specific reference to show the options:
- Navigate to Product Page
- Edit Product Page
Search for Products
-
Navigate to the Products console, via Commerce.
-
Open the secondary rail for Search with the icon:
-
Several facets are available for you to search for products. You can use only one or several facets for a search. The products found will appear:
-
Clicking/tapping a product opens it. You can also publish it or view the product data.
Extending Search
You can modify an existing facet or add new ones, using CRXDE Lite:
-
Navigate to:
http://localhost:4502/crx/de/index.jsp#/libs/commerce/gui/content/products/aside/items/search/items/searchpanel/facets
-
You can modify for example the sizes that will appear on the product search page. Click the
sizegroup
node. -
Click
items
node, then clickpropertypredicate
node. -
You can modify the
propertyValues
. For example you could add XS, or XXL, or remove a size. -
Click Save All and navigate to the products search page. Your changes should appear.
Multiple Assets
You can add multiple assets in the product component, then specify the asset that will appear on the product page.
Adding Multiple Assets
-
Navigate to the Products console, via Commerce.
-
Using the Products console, navigate to the required product.
NOTE
You have to be at the product level, not at the variant level. -
Tap/click View Product Data icon with selection mode or quick actions.
-
Tap/click Edit icon.
-
Scroll to Add.
-
Tap/click Add. A new asset placeholder appears.
-
Tapping/clicking **Change **opens a dialog which allows you to choose an asset.
-
Select the asset you want to add.
NOTE
The assets you can select are from Assets. -
Tap/click Done icon.
Two assets are now stored in your product component. You can configure which one will appear on the product page. This works with a category system. First you need to add a category to the individual assets:
-
Tap/click View Product Data.
-
Type an Asset Category under the assets, for example
cat1
andcat2
.NOTE
You can also use tags for categories. -
Tap/click Done icon. You now have to rollout your changes.
Now your assets in the product component have a category. You can configure which category will be displayed at three different levels:
The mechanism to select the image to be displayed is as follows:
- Verifiy if a category is set for the Product Page.
- If not, verifiy if a category is set for the Catalog.
- If not, verify if a category is set for the Products Console.
Product Page
- Navigate to your product page.
- Edit the product component.
- Type the Image Category you chose (
cat1
for example). - Tap/click Done. The page refreshes and the correct asset should be displayed.
Catalog
- Navigate to your catalog.
- Tap/click View Properties.
- Tap/click Edit.
- Tap/click the Assets tab.
- Type the required Product Asset Category.
- Tap/click Done.
- Rollout your changes.
Products Console
- Using the Products console, navigate to the required Product.
- Tap/click View Product Data.
- Tap/click Edit.
- Type a Default Asset Category.
- Tap/click Done.
- Rollout your changes.
Publishing/Unpublishing Product Information
Publishing/Unpublishing Product Information - Touch-optimized UI
-
Using the Products console (via Commerce) navigate to your product information.
-
Using either:
Select the Publish or Unpublish icon as required:
The product information will be published or unpublished as appropriate.
Event Handler for Product Updates
There is a Event Handler which logs an event when a product is added, modified or deleted and when a product page is added, modified or deleted. There are the following OSGi events:
com/adobe/cq/commerce/pim/PRODUCT_ADDED
com/adobe/cq/commerce/pim/PRODUCT_MODIFIED
com/adobe/cq/commerce/pim/PRODUCT_DELETED
com/adobe/cq/commerce/pim/PRODUCT_PAGE_ADDED
com/adobe/cq/commerce/pim/PRODUCT_PAGE_MODIFIED
com/adobe/cq/commerce/pim/PRODUCT_PAGE_DELETED
For the PRODUCT_*
events, the path points to the base product in /etc/commerce/products
. For the PRODUCT_PAGE_*
events, the path points to the cq:Page
node.
You can look at them in the Web Console in OSGI events ( /system/console/events
), for example:
Image with Add to Cart Links
The Image with Add to Cart Links component allows you to quickly add a product to the cart by creating a hotspot linked with a product on an image.
Clicking the hotspot opens a dialog which let you choose the size and quantity of the product.
-
Navigate to the page where you want to add the component.
-
Drag and drop the component in the page.
-
Drag and drop an image in the component from the assets browser.
-
You can either:
- click the component and then click Edit icon
- make a slow double click
-
Click the fullscreen icon.
-
Click the Launch Map icon.
-
Click one of the shape icons.
-
Modify and move the shape as required.
-
Click the shape.
-
Clicking the browse icon opens the Asset selector.
NOTE
Alternatively, you can type directly the product path which has to be at the product level, not the variant level. -
Click the confirm icon twice then click exit fullscreen.
-
Click somewhere on the page next to the component. The page should refresh and you should see the following symbol on your image:
-
Switch to preview mode.
-
Click the + hotspot. A dialog opens where you can choose the size and quantity of the product you entered in Path.
-
Enter a size and a quantity.
-
Click the Add to cart button. The dialog closes.
-
Navigate to your cart. The product should be here.
Configuration Options
You can configure how the dialog looks like when you click the hotspot:
-
Click the component and click the configure icon.
-
Scroll down. There is a ADD TO CART tab.
-
Click ADD TO CART. There are 3 configuration options that you can use.
-
Click the Done icon.
Catalogs
Generating a Catalog
Generating a Catalog - Touch-optimized UI
To generate a Catalog:
-
Open the Sites console (for example, http://localhost:4502/sites.html/content).
-
Navigate to the location where you want to create the new page.
-
To open the option list, use the Create icon:
-
From the list select Create Catalog, the Create Catalog wizard will open.
-
Navigate to the required Catalog Blueprint.
-
Tap/click Select button and tap/click the required Catalog Blueprint.
-
Tap/click Next.
-
Type a Title and a Name.
-
Tap/click the Create button. The catalog is created and a dialog opens.
-
Tapping/clicking Done button brings you back to the Sites console where you’ll be able to see you catalog.
Tapping/clicking Open Catalog button opens your catalog (for example
http://localhost:4502/editor.html/content/test-catalog.html
).
Generating a Catalog - Classic UI
-
Using the Websites console, navigate to your Catalog Blueprint, then the Base Catalog.
For example:
http://localhost:4502/siteadmin#/content/catalogs/geometrixx-outdoors/base-catalog
-
Create a new page using the Section Blueprint template.
For example,
Swimwear
. -
Open the new
Swimwear
page, then click Edit Blueprint to open the Properties dialog, where you can set up the Products selection.For example, open the Tags/Keywords field to select Activity, then Swimming from the Geometrixx-Outdoors section.
-
Click OK to save your properties; example products will be shown under the Product Selection Criteria on the blueprint page.
-
Click on Rollout Changes…, select Rollout page and all sub pages, then click Next then Rollout. Once the rollout is completed successfully the Status indicator will be shown as green.
-
You can now click Close and check the new catalog section; for example, on and under:
http://localhost:4502/cf#/content/geometrixx-outdoors/en/swimwear.html
-
Again from the blueprints page click Edit Blueprint and in the Properties dialog open the Generated Page tab. In the Banner list field select the image you want to show; for example,
summer.jpg
-
Click OK to save your properties; banner information will be shown under the Product Selection Criteria on the blueprint page.
-
Rollout these new changes.
Rolling Out a Catalog
Rolling out a Catalog - Touch-optimized UI
To rollout a catalog:
-
Navigate to the Catalogs console, via Commerce.
-
Navigate to the catalog you want to rollout.
-
Using either:
Select the Rollout Changes icon:
-
In the wizard, set the rollout as needed and then tap/click Rollout Changes.
-
A dialog opens. Tap/click **Done **when the process is finished.
Rolling out a Catalog - Classic UI
To rollout a catalog:
-
Navigate to the Catalog you want to rollout. For example:
http://localhost:4502/cf#/content/catalogs/geometrixx-outdoors/base-catalog.html
-
Click Rollout Changes…
-
Set the rollout as needed.
-
Click Rollout.
Blueprint Importer
Blueprint Importer - Touch-optimized UI
-
Navigate to the Catalogs console, via Commerce.
-
Navigate to the location where you want to import the catalog blueprint.
-
Tap/click the Import Blueprints icon.
-
In the wizard, select the Source as required and tap/click Next.
-
Tap/click Done once the import is finished.
Blueprint Importer - Classic UI
-
Using the Tools console, navigate to Commerce.
For example:
http://localhost:4502/miscadmin#/etc/commerce
-
Open the Catalog Bluprint Importer.
-
Set the import as needed.
-
Click Import Catalog Blueprints.
Promotions
Creating a Promotion
Creating a Promotion - Classic UI
-
Open the Websites console of your author instance.
-
In the left-hand pane select your required Campaign.
-
Click on New, select the Promotion template, then specify a Title (and Name if required) for your new voucher.
-
Click Create. The new promotion page will be shown in the right-hand pane.
-
Edit the Properties by either:
- opening the page, then clicking the Edit button to open the Properties dialog
- selecting the page in the Websites console, then using the context menu (usually the right mouse button) to select Properties… and open the properties dialog
Specify the Promotion Type, Discount Type, Discount Value and any other fields as required.
-
Click OK to save.
-
You can now activate your promotion, so that shoppers will see it on the publish instance.
Vouchers
Creating a Voucher
Creating a Voucher - Classic UI
-
Open the Websites console of your author instance.
-
In the left-hand pane select your required Campaign.
-
Click on New, select the Voucher template, then specify a Title (and Name if required) for your new voucher.
-
Click Create. The new voucher page will be shown in the right-hand pane.
-
Open your new voucher page with a double-click, then click on Edit to configure the information as required.
-
Click OK to save.
-
You can now activate your voucher, so that shoppers can use it in their carts on the publish instance.
Removing Vouchers
Removing Vouchers - Classic UI
In order to make a voucher unavailable to customers, you can either:
- Deactivate the voucher - it will remain available on the author environment so you can re-activate it at a later time.
- Delete it completely.
Both actions can be done from the Websites console.
Modifying Vouchers
Modifying Vouchers - Classic UI
To change the properties of a voucher or promotion, you can double-click on it on the Websites console and click Edit. After saving it, you should activate it so that the changes get pushed to the publish instance(s).
Adding Vouchers to a Cart
To allow users to add vouchers to their carts, you can use the built-in Vouchers component (Commerce category). You need to add this to the same page as where the cart is displayed (but is not mandatory). The vouchers component is merely a form in which the user can enter a voucher code, it is the shopping cart component that actually shows the list of applied vouchers and their discount.
In the demo site (Geometrixx Outdoors - English) you can see the voucher form on the cart page, under the actual shopping cart.
Orders
/etc/scaffolding/geometrixx-outdoors/order/jcr:content/cq:dialog
Creating Order Information
Creating Order Information - Touch-optimized UI
-
Using the Orders console navigate to the required location.
-
Use the Create icon to select Create Order.
-
The wizard will open. Use the Basic, Content, Payment and Fulfilment tabs to enter the information about the new order.
-
Select Create to save the information.
Editing Order Information
Editing Order Information - Touch-optimized UI
-
Using the Orders console navigate to the order.
-
Using either:
Select the View Order Data icon:
-
The order information will be shown. Use Edit and Done to make any changes.
Experience Manager
- Administering User Guide overview
- Sites Features
- Website Administration
- Reusing Content: Multi Site Manager and Live Copy
- Live Copy Overview Console
- Configuring Live Copy Synchronization
- Creating and Synchronizing Live Copies
- MSM Rollout Conflicts
- MSM Best Practices
- Translating Content for Multilingual Sites
- Managing Translation Projects
- Identifying Content to Translate
- Preparing Content for Translation
- Creating a Language Root Using the Classic UI
- Connecting to Microsoft Translator
- Configuring the Translation Integration Framework
- Language Copy Wizard
- Translation Enhancements
- Translation Best Practices
- Configurations and the Configuration Browser
- AEM FAQs
- Operations
- Dashboards
- Operations Dashboard
- Backup and Restore
- Data Store Garbage Collection
- Monitoring Server Resources Using the JMX Console
- Working with Logs
- Configure the Rich Text Editor
- Configure the Video component
- The Bulk Editor
- Configuring Email Notification
- Configuring RTE for Producing Accessible Sites
- The Link Checker
- Troubleshooting AEM
- Audit Log Maintenance in AEM 6
- Editor
- Managing Access to Workflows
- Using cURL with AEM
- Configuring Undo for Page Editing
- Proxy Server Tool (proxy.jar)
- Configuring for AEM Apps
- Administering Workflows
- Configuring Search Forms
- Tools Consoles
- Reporting
- Administering Workflow Instances
- Configuring Layout Container and Layout Mode
- Enabling Access to Classic UI
- Starting Workflows
- Configure the Rich Text Editor plug-ins
- Admin Consoles
- Security
- User Administration and Security
- User, Group and Access Rights Administration
- Security Checklist
- OWASP Top 10
- Running AEM in Production Ready Mode
- Identity Management
- Adobe IMS Authentication and Admin Console Support for AEM Managed Services
- Creating a Closed User Group
- Mitigating serialization issues in AEM
- User Synchronization
- Encapsulated Token Support
- Single Sign On
- How to Audit User Management Operations in AEM
- SSL By Default
- SAML 2.0 Authentication Handler
- Closed User Groups in AEM
- Granite Operations - User and Group Administration
- Enabling CRXDE Lite in AEM
- Configuring LDAP with AEM 6
- Configure the Admin Password on Installation
- Service Users in AEM
- Encryption Support for Configuration Properties
- Handling GDPR Requests for the AEM Foundation
- Content Disposition Filter
- Personalization
- eCommerce
- Integration
- Integrating with Third-Party Services
- Integrating with Salesforce
- Integrating with Adobe Target
- Integrating with Adobe Analytics
- Connecting to Adobe Analytics and Creating Frameworks
- Configuring Link Tracking for Adobe Analytics
- Mapping Component Data with Adobe Analytics Properties
- Configuring Video Tracking for Adobe Analytics
- HTTP2 Delivery of Content FAQ
- Troubleshooting your Adobe Campaign Integration
- SharePoint Connector Licenses, Copyright Notices, and Disclaimers
- SharePoint Connector
- DHTML Viewer End-of-Life FAQs
- Integrating with Adobe Campaign Classic
- Related Community Articles
- Integrating with Adobe Campaign Standard
- Flash Viewers End-of-Life Notice
- Integrating with Adobe Creative Cloud
- Integrating with Adobe Dynamic Tag Management
- Opting Into Adobe Analytics and Adobe Target
- AEM Portals and Portlets
- Integrating with Dynamic Media Classic
- Troubleshooting Integration Issues
- Integrating with BrightEdge Content Optimizer
- Best Practices for Email Templates
- Catalog Producer
- Integrating with Silverpop Engage
- Integrating with Adobe Campaign
- Integrating with ExactTarget
- Analytics with External Providers
- Integrating with the Adobe Marketing Cloud
- Manually Configuring the Integration with Adobe Target
- Prerequisites for Integrating with Adobe Target
- Adobe Classifications
- Solutions Integration
- Target Integration with Experience Fragments
- Best Practices
- Content Management