Document 440115

eCommerce Integration with Elastic Path
eCommerce Integration with Elastic Path
Overview / CQ / Adobe Experience Manager 5.6.1 / AEM eCommerce /
NOTE
This page contains links to the Elastic Path website. Certain areas need an account for full
access.
Deploying eCommerce with Elastic Path
Deploying the necessary eCommerce packages provides the full functionality of the eCommerce framework,
together with a reference implementation of eCommerce functionality as provided with Elastic Path
implementation (including a demonstration catalog).
This catalog is available under the English (US) branch (/content/geometrixx-outdoors/en_US) of the
Geometrixx Outdoors site.
INSTALLATION OF ECOMMERCE WITH ELASTIC PATH
To install AEM with an Elastic Path integration configuration (using the demonstration catalog, Geometrixx
Outdoors), the basic steps are:
1.
2.
3.
Install AEM.
Install the demonstration content packages using the Package Manager in the following order:
1. cq-commerce-ep-update-content-5.6.2
2. cq-ep-server-6.9.0 (required if Elastic Path is not running on a separate server)
3. cq-geometrixx-ep-content-6.9.0
Author any supplementary pages that you need in AEM.
NOTE
To download the packages, navigate to Package Share.
To be able to find and download those packages, please contact Elastic Path.
If Elastic Path is running on any other machine or server (as recommended for Production):
1.
2.
3.
Navigate to http://localhost:4502/system/console/configMgr.
Open com.elasticpath.web.config.EPConfigurationHandler.
Update the cortex.url to point to that machine in which Elastic Path is running.
CAUTION
Use of the Elastic Path server requires a separate Elastic Path license.
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 1
Created on 2014-11-12
eCommerce Integration with Elastic Path
Concepts of eCommerce with Elastic Path
The integration framework provides the mechanisms and components for:
• connecting to an eCommerce system
• pulling data into AEM
• displaying data and collecting the shopper's responses
• returning transaction details
• searching data from both systems
This means:
• shoppers can instantaneously register and shop
• price changes are immediately visible to shoppers
• products can be added as required
NOTE
The eCommerce framework can be used with any eCommerce solution. Certain specifics and
examples dealt with here will refer to the Elastic Path solution.
AEM and Elastic Path are loosely coupled, which enables the applications to operate independently from
one another. Data transfers between the two systems occur in real time.
The following breakdown shows the applications’ responsibilities:
•
•
AEM:
• Requests:
• Product Information from Elastic Path.
• Provides:
• User views for Product Information, Shopping Cart and Checkout.
• Shopping cart and checkout information to Elastic Path.
• Search Engine Optimization (SEO).
• Community functionality (i.e. Facbook, Twitter).
• Unstructured marketing interactions.
Elastic Path:
• Provides:
• Product Information from the database.
• Product variant management.
• Product price management.
• Promotion management.
• Search within the product information.
• Processes:
• Shopping Carts.
• Checkout.
• Order Fulfillment.
PAGE AND COMPONENTS
The following components and pages can use eCommerce data:
• Landing page
Rendered by AEM (Commerce Category).
This provides primarily static information. For example, an introduction and overview with links to the
underlying product pages.
• Product
Rendered by AEM (Commerce Product).
Dynamic information about individual products. For example, price changes, special offers, and so on.
Updates from live data are reflected instantly on the product detail pages.
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 2
Created on 2014-11-12
eCommerce Integration with Elastic Path
•
•
•
•
The product component can be added to any page where the parent page delivers the required
metadata (i.e. the paths tocartPage and cartObject). In Geometrixx Outdoors this is supplied
by UserInfo.jsp.
Search results / product lists (cached)
See search. This component can be added to any page.
myAccount
Transaction data in Elastic Path is combined with personal information about the shopper. AEM uses
some of this data as profile data. A form's action in AEM writes information back to Elastic Path.
Checkout
Checkout is implemented with standard AEM forms. This allows the marketing manager to customize the
experience with marketing content.
Elastic Path manages the checkout process with inputs from AEM forms.
Shopping cart
Elastic Path provides all relevant data. AEM renders this information using the appropriate components.
ROLES
The integrated system provides the following roles to manage eCommerce data.
•
•
•
Product Information Management (PIM) User maintains:
• Product information.
• Taxonomy, categorization, approval.
• Interacts with digital asset management.
• Pricing.
Author / Marketing Manager maintains:
• Marketing content for all channels.
• Promotions.
• Vouchers.
• Campaigns.
Surfer / Shopper:
• Views your product information.
• Places items into the shopping cart.
• Checks out their orders.
• Expects order fulfillment.
PRODUCTS AND PRODUCT VARIANTS
Products
Product data is maintained in Elastic Path and made available through AEM.
Actual product information imported from Elastic Path or any other source is held in the CRX repository
under:
/etc/commerce/products
The following properties indicate that the products are linked with Elastic Path:
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 3
Created on 2014-11-12
eCommerce Integration with Elastic Path
• commerceProvider
• cq:productSkuCode
This data is synchronized optionally from Elastic Path, but may come from a different source if necessary.
Elastic Path's Cortex API is used to get dynamic product information such as price and inventory.
Product Variants
The AEM Elastic Path integration supports product variants. For example, clothing items with different colors
are supported.
DATA SYNCHRONIZATION
Product data is maintained in Elastic Path, and can be linked to Product marketing data in AEM. AEM will
retrieve highly volatile data such as price information, from the Commerce Engine for each page request.
SHOPPING CART CONTENT OVERVIEW
The shopping cart provides the following capabilities:
• list the cart's items
• link to the item's product pages
• update the cart's quantities
• remove items in the cart
NOTE
An anonymous cart can only be restored on the same browser.
Price changes in Elastic Path and AEM are reflected as they occur.
SEARCH
Search API is fully implemented in the Elastic Path solution, so you can use the eCommerce search
component out-of-the-box.
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 4
Created on 2014-11-12
eCommerce Integration with Elastic Path
PRODUCT CATALOG SECTIONS
The product catalog sections provide you with:
• an introduction (image and/or text) to the category; this can be used for banners and teasers to promote
special offers
• links to products in the category
• links to the other categories
PRODUCT INFORMATION WITH COLOR VARIANTS
A AEM page (for example, using the Commerce Product template) can provide:
• general product information; text and images
• pricing
And allow the shopper to select:
•
•
•
color and size variants
quantity
add to basket
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 5
Created on 2014-11-12
eCommerce Integration with Elastic Path
CUSTOMER REGISTRATION AND ACCOUNTS
When a shopper registers, the account details need to be pushed from AEM to Elastic Path. Sensitive data is
held independently, but profiles are linked.
NOTE
When using Elastic Path, ensure that accounts created for users who log into an AEM instance
are replicated (e.g. via workflows) to any other AEM instances that communicate with Elastic
Path.
Otherwise, these other AEM instances will try to create accounts for these users in Elastic Path.
CUSTOMER-SPECIFIC PRICING
Elastic Path uses the context (essentially the shopper information) to determine an item's price and then
provides the pricing information back to AEM.
PAYMENT SECURITY
Elastic Path manages payment details, including credit card information. AEM sends transactional
information to Elastic Path, which then forwards the payment details to a payment processing service.
ORDER FULFILLMENT AND TRACKING
After placing an order, shoppers often return to:
• Check their order’s status
• Remove products from the order
• Add products to the order
After receiving the order delivery, shoppers may want to view their order history.
Elastic Path manages order fulfillment and tracking. AEM displays order information through the Order
History component, which shows all the relevant details. For example:
ANONYMOUS CUSTOMERS
With Elastic Path, an anonymous customer can:
•
•
•
View different products
Add products to the cart
Place an order
REGISTERED CUSTOMERS
A registered customer can:
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 6
Created on 2014-11-12
eCommerce Integration with Elastic Path
•
•
•
•
•
Login to account
View different products
Add products to the cart
Place an order
Track previous orders
ACCESS TO THE ELASTIC PATH COMMERCE MANAGER
The Elastic Path Commerce Manager administers product information. For more information on the
Commerce Manager, see the Elastic Path documentation.
The local instance included in the demonstration packages can be accessed using:
https://localhost:8080/cmserver
Login is required, the default details are:
• Account name:
admin
• Password:
aem12345
CATALOG IMPORTER
The Elastic Path package comes with a catalog importer for setting up the initial page structure.
This is available from:
http://localhost:4502/etc/importers/elasticpath.html
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 7
Created on 2014-11-12
eCommerce Integration with Elastic Path
The importer requires the following information:
• Base store
The identifier of the base store configured in Elastic Path.
• Catalog
The identifier of the catalog to import.
• Root path
The path where the catalog should import into.
Developing eCommerce with Elastic Path
NOTE
The eCommerce framework can be used with any eCommerce solution. Certain specifics and
examples dealt with here will refer to the Elastic Path solution.
The integration framework includes an integration layer with an API. This allows you to:
• plug in an eCommerce system and pull product data into AEM
• build AEM components for commerce capabilities independent of the specific eCommerce engine
A number of out-of-the-box AEM components are provided to use the integration layer. Currently these are:
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 8
Created on 2014-11-12
eCommerce Integration with Elastic Path
•
•
•
a product display component
a shopping cart
check-out
NOTE
For more information about developing possibilities, see Developing for AEM native eCommerce.
© 2012 Adobe Systems Incorporated.
All rights reserved.
Page 9
Created on 2014-11-12