eCommerce Integration with Intershop

You are reading the Adobe Experience Manager 5.6.1 version of eCommerce Integration with Intershop.

Note

This page contains links to the Intershop website. For certain pages you might need to request access.

Deploying eCommerce with Intershop

Deploying the necessary eCommerce packages provides the full functionality of the eCommerce framework, together with a reference implementation of eCommerce functionality as provided with Intershop implementation (including a demonstration catalog).

This catalog is available under the English (US) branch (/content/geometrixx-outdoors/en_US) of the Geometrixx Outdoors site.

Setup Geometrixx in Intershop 7

This procedure will initialize the Intershop system with a Geometrixx organization to work with the AEM reference implementation.

Caution

Make sure the 3 Intershop 7 cartridges adobe_app_sf_rest, adobe_app_bo_ch_sales and adobe_init have successfully been deployed to your Intershop 7 instance.

  • Perform a dbinit on adobe_init. Therefore add the cartridge to the dbinit section of the cartridgelist.properties, open an ANT build shell and type in

    dbinit -t=adobe_init -!

  • Check the success by logging into the new Geometrixx organization.

    Login: admin
    Password: intershop7
    Organization: Geometrixx

Installation of eCommerce with Intershop

To install AEM with an Intershop integration configuration (using the demonstration catalog, Geometrixx Outdoors), the basic steps are:

  1. Install the demonstration content packages using the package manager in the following order:

    1. cq-geometrixx-intershop-content-1.0.0
    2. cq-commerce-intershop-1.0.0
  2. Author any supplementary pages that you need in AEM.

Note

To download the packages, navigate to Package Share.

If you have an Intershop license, you should be able to find and download those packages.

Configure the Intershop REST Client:

  1. Open Intershop REST Client.

  2. Update the properties to point to the Intershop instance.

    file

Caution

Use of the Intershop server requires a separate Intershop license.

Concepts of eCommerce with Intershop

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

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 Intershop solution.

AEM and Intershop 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 Intershop.
    • Provides:
      • User views for Product Information, Shopping Cart and Checkout.
      • Shopping cart and checkout information to Intershop.
      • Search Engine Optimization (SEO).
      • Community functionality (i.e. Facbook, Twitter).
      • Unstructured marketing interactions.
  • Intershop:
    • Provides:
      • Product Information from the database.
      • Product variant management.
      • Product price management.
      • Promotion management.
    • 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.
    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.
  • myAccount
    Transaction data in Intershop 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 Intershop.
  • Checkout
    Checkout is implemented with standard AEM forms. This allows the marketing manager to customize the experience with marketing content.
    Intershop manages the checkout process with inputs from AEM forms.
  • Shopping cart
    Intershop provides all relevant data. AEM renders this information using the appropriate components.

Roles

The integrated system provides the following roles to manage eCommerce data.

file
  • 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 Intershop and made available through AEM.

Actual product information imported from Intershop or any other source is held in the CRX repository under:

    /etc/commerce/products

The following properties indicate that the products are linked with Intershop:

  • commerceProvider
  • cq:intershopCatalogId
  • cq:intershopId

This data is synchronized as necessary.

Note

The Intershop implementation (i.e. geometrixx-outdoors/en_US) only stores product IDs and other basic information under /etc/commerce.

The Intershop server is referenced every time information about a product is requested.

Product Variants

The AEM Intershop integration supports product variants. For example, clothing items with different colors are supported.

file

Data Synchronization

Product data is maintained in Intershop, 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.

Note

Items of an anonymous cart will be merged into the cart of a user that just has signed in.

Price changes in Intershop and AEM are reflected as they occur.

file

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
file

Product Information with Color Variants

An 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
file

Customer Registration and Accounts

When a shopper registers, the account details need to be pushed from AEM to Intershop. Sensitive data is held independently, but profiles are linked.

file

Note

When using Intershop, 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 Intershop.

Otherwise, these other AEM instances will try to create accounts for these users in Intershop.

Customer-Specific Pricing

When a shopper registers, the account details need to be pushed from AEM to Intershop. Sensitive data is held independently, but profiles are linked.

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.

Intershop manages order fulfillment and tracking. AEM displays order information through the Order History component, which shows all the relevant details. For example:

file

Anonymous Customers

With Intershop, an anonymous customer can:

  • View different products
  • Add products to the cart

Registered Customers

A registered customer can:

  • Login to account
  • View different products
  • Add products to the cart
  • Place an order
  • Track previous orders

Catalog Importer

There are a variety of ways to import product and catalog data. The product and catalog data can be imported when initially setting up the environment, or after changes have been made in the Intershop data.

The importer supports the following modes:

Full Import

  1. If required, delete all existing product data using CRXDE Lite.

    1. Navigate to the sub-tree holding the product data:
          /etc/commerce/products
      For example:
          http://localhost:4502/crx/de/index.jsp#/etc/commerce/products
    2. Delete the node that holds your product data; for example, outdoors.
    3. Save All to persist the change.

     

  2. Open the Intershop importer in AEM:

    /etc/importers/intershop.html

    For example:

    http://localhost:4502/etc/importers/intershop.html

  3. Configure the required parameters; for example:

    file
  4. 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

     

Incremental Import

  1. Check the information held in AEM for the relevant product(s), in the appropriate sub-tree under:

    /etc/commerce/products

    You can open this in CRXDE Lite; for example:
        http://localhost:4502/crx/de/index.jsp#/etc/commerce/products

  2. In Intershop, update the information held on the relevant product(s).

  3. Open the Intershop importer in AEM:

    /etc/importers/intershop.html

    For example:

    http://localhost:4502/etc/importers/intershop.html

  4. Select the clickbox Incremental Import.

  5. 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.

  1. Check the information held in AEM for the relevant product(s), in the appropriate sub-tree under:

    /etc/commerce/products

    You can open this in CRXDE Lite; for example:
        http://localhost:4502/crx/de/index.jsp#/etc/commerce/products

  2. In Intershop enter a product detail page and use the clickbox "Express Import" to mark a product as to be express-imported:

    file
  3. Open the Intershop importer in AEM:

    /etc/importers/intershop.html

    For example:

    http://localhost:4502/etc/importers/intershop.html

  4. Select the clickbox Express Update.

  5. 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 Intershop catalog can be imported into CQ, using the batch importer for Intershop catalogs, categories and products.

The parameters used by the importer can be configured for:

Intershop Product and Catalog Importer
(com.adobe.cq.commerce.intershop.impl.importer.IntershopImporter)

file

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.

Configure the Product Attributes to Load

The response parser can be configured to define the properties and attributes to be loaded for (variant) products.

The parameters used by the parser can be configured for:

Intershop JSON Parser
(com.adobe.cq.commerce.intershop.impl.IntershopJSONParser)

file

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.

Developing eCommerce with Intershop

Note

The eCommerce framework can be used with any eCommerce solution. Certain specifics and examples dealt with here will refer to the Intershop 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
file

Note

API documentation is also available for download.

A number of out-of-the-box AEM components are provided to use the integration layer. Currently these are:

Note

For more information about developing possibilities, see Developing for AEM native eCommerce.