Guide - AEM Catalog and Product Import

1 Introduction

This guide describes how to import product and catalog data from INTERSHOP into AEM.

1.1 Software Version Information

The content of the present document is valid for the following combinations of software versions:

IntershopIntershop Commerce Pro for AdobeAdobe Experience Manager
7.5.12.06.0.1
  • IS7.5 initialized with the Intershop 7 Extension for Adobe integration Database Initialization (adobe_init)
  • AEM 6.0 with installed AEM Plugin for Intershop 7 integration

1.2 Glossary

Term / AbbrevationDescription
AEMAdobe Experience Manager (Version 6.0.1)
TagsThe AEM uses tags to annotate and organize the objects in its content repository. In this case tags are used to specify the category to products assignments.
SectionAn AEM term. In this case a section represents a catalog category.

1.3 References

Cookbook - AEM Catalog and Product Import

2 Geometrixx Demo Scenario Data

Note

The Geometrixx demo scenario is already set up with the installation of the content packages. You only need to run the steps below if data has changed on IS7 side that should be imported into the AEM.

2.1 IS7 Data Feeds

There are pre-configured data feeds on the IS7 side to export the product and catalog data into files. These data feeds will later be imported into the AEM.

  1. Log in to IS7 (admin/intershop7, Organization: Geometrixx).
  2. Select the channel Geometrixx Outdoors.
  3. Go to Catalog - Data Feeds.
  4. The feeds are organized into two groups depending on weather they export product or catalog data. Select an Adobe Data Feed and click Run.

  5. Wait until the data feed has finished and download the data file. Press refresh to reload the contents of the page with the current feed status.

If the installation is on your local computer: The data files are generated at: <IS_HOME>\share\sites\Geometrixx-GeometrixxOutdoors-Site\units\Geometrixx-GeometrixxOutdoors\syndication\export.

These data feeds have been created via dbinit steps in the adobe_init cartridge. Specific configuration of these feeds has to be done via dbinit configuration files if necessary. See the according subsections of the data feeds for more detailed information.

2.1.1 Product Data Feed

2.1.1.1 General Info and Configuration

The product data feed exports basic product data that is needed in the AEM. The pre-configured data feed transfers:

  • SKU
  • Product name
  • Short description
  • Long description as summary attribute
  • Variation names
  • Values
  • Price (list price)
  • An image reference
  • Category assignments

as AEM tags and no additional custom attributes as it is currently configured. In order to export additional custom attributes of the selected products, the data feed needs to be configured via dbinit when it is created. See the Recipe: Configure the Product Data Feed Properties to Export Additional Custom Attributes for details. The following list shows the properties that can be applied to configure the feed.

PropertyDefault ValueDescription
localeIDen_USThe locale for localizable data of the product, e.g., the product name and the product attribute values to the feed
imageTypeIDdefault:3XLThe image view (optional) ID and the image type ID that is used to create an image reference for the product
imageTargetBasePath/content/dam/geometrixx-outdoors/products/importThe image target path determines the location where images are stored in the AEM.
customAttributeIDs<empty>Additional attributes to be transferred to AEM specified as a comma separated list of IDs, e.g., longDescription,MaxOrderQuantity

Product attributes that have a data type are converted into property values with a data type in AEM. The IS7 specific data types Money and Quantity are exported and imported as decimal value only. The currency mnemonic and unit is not kept. IS7 Integer attributes are transferred as Long.

Native product attributes that can also be specified in the customAttributeIDs list:

Native Product Attribute NameDescriptionDataType (AEM)

MinOrderQuantity

Minimum Order QuantityDecimal

MaxOrderQuantity

Maximum Order QuantityDecimal

StepQuantity   

Order Step QuantityDecimal

Unit

 unitString

Image

Image (deprecated)String

Thumbnail 

Thumbnail (deprecated)String

Taxclass

Tax ClassString

Online

 The online flag of the product.Boolean

Available

The in-stock flag of the product.Boolean

LastModified

The last modified dateDate

LastOrderDate

last order dateDate

EndOfLifeDate

end of life dateDate

TypeCode

type codeLong
Template  template (unused)String

2.1.1.2 Select Products for Export

Which products have to be exported is determined using the standard functionality of product data feeds to select products. In the data feed details:

  1. Click the data feed name in the list and
  2. Navigate to the Products tab.
    The products can either be assigned by Search or by Browse.

2.1.2 Express Update Product Data Feed

2.1.2.1 General Info and Configuration

The express update product data feed 'AdobeProductCSVExpressUpdate' is pre-configured to export the products that have been marked for express update since the last run of this data feed. Products can be marked for express update on the product details page.

2.1.2.2 Select Products for Express Update Export

As said before products can be marked for express update on the product details page. Only these product are processed by the feed. The configuration of the feed is identical to the Product Data Feed. The difference is that the Commerce Management application user has no UI to configure the assigned products.

After the export the express update flag will be reset. If the feed runs twice in a sequence the second run produces an empty CSV.

2.1.3 Incremental Product Data Feed

2.1.3.1 General Info and Configuration

The incremental data feed 'AdobeProductDeltaCSV' is pre-configured to export the products that have changed since the last run of this data feed. The resulting CSV data can be used to update the product data at AEM side. In addition to the properties of the Product Data Feed exists an additional property that switches this data feed into the 'lastModified'-Mode to select the products that have been modified.

PropertyDefault ValueDescription
lastModifiedProductsundefinedIf the lastModifiedProducts is set at the data feed and LastModifiedFromDate is set as search criterion in the advanced search for the selected products only 'touched' products are exported by this feed.

2.1.3.2 Select Products for Incremental Export

To enable the selection of last modified products you have to select the products with the Advanced Search and set a arbitrary Last Modified From Date. This Last Modified From Date will be automatically replaced by the execution date and time of the last execution of this feed.

Note

This feed shows only changed and new products in the product tab. If there are no changed or new products the list shows 'No products assigned'.

Deleted products are not handled by this feed yet. If there are deleted products you need to execute a full import or delete it manually in AEM. 

2.1.4 Product Image Zip Data Feed

2.1.4.1 General Info and Configuration

The product image zip data feed produces an image zip-file of product images for a specified type.

PropertyDefault ValueDescription
imageTypeID3XLThe image view (optional) ID and the image type ID that is used to create an image reference for the product. Image View ID and Image Type ID are separated by the colon (:), e.g., front:1XL.
imageTargetBasePath/content/dam/geometrixx-outdoors/products/import

The image target path determines the location where images are stored in the AEM.

2.1.4.2 Select Product Images for Export

Which product images have to be  exported is determined using the standard functionality of product data feeds to select products. In the data feed details:

  1. Click the data feed name in the list and
  2. Navigate to the Products tab.
    The products for which the images should be exported can either be assigned by Search or by Browse.

2.1.5 Catalog Data Feed

2.1.5.1 General Info and Configuration

The catalog data feed exports category data. The data feed might be configured to export all categories of a given catalog into a CSV file. The configured data feed currently exports the following data:

  • Category display name
  • Path to this category (the hierarchy)
  • A tag that is used to link the products to category sections in the AEM

The values of the properties in the next table are exported on the second line of the resulting CSV data feed. There default values are given in the table. If non-defaults are required the properties can be changed using the feed configuration file.

PropertyDefault ValueDescription
basePath/etc/commerce/products/+"baseCatalogID"This is the path in the content repository that points to root node where the products are stored/imported.
catalogTemplate/content/catalogs/ish-geometrixx-outdoors/template-pages/catalog-page-template-intershopThe path to an AEM catalog template to be used at the intershop base catalog
sectionTemplate/content/catalogs/geometrixx-outdoors/template-pages/section-page-templateThe path to an AEM section template to be used at the intershop base catalog
productTemplate/content/catalogs/geometrixx-outdoors/template-pages/product-page-templateThe path to an AEM product template to be used at the intershop base catalog
design/etc/designs/geometrixx-outdoorsThe path to an AEM design that is used at the intershop base catalog
baseCatalogIDThe ID of the exported catalog in lower case.The base catalog ID (all IS7 catalogs are imported into that base catalog)
baseCatalogNameThe ID of the exported catalog in lower case.A descriptive name for the base catalog

2.1.5.2 Selecting a Catalog for Export

Which catalog has to be exported is determined using the 'Catalog' tab in the feed configuration. The user may select only one catalog per feed. To configure a catalog data feed do the following:

  1. Click the data feed name in the list.
  2. Navigate to the Catalog tab.
  3. Select the radio button of the catalog that has to be exported and click Apply.

2.2 AEM Data Import

2.2.1 Import Modes

The import supports both, full import and incremental import. A full import assumes an import of complete product or catalog data. Therefore, the full import deletes all existing data in the selected area and re-creates all the products or catalogs from the given input data file. The incremental import keeps the existing product or catalog data and updates this data with the contents in the given input data file.

2.2.2 Product Data Import

  1. Log in to the AEM.
  2. Go to Commerce - Products.
  3. Select the geometrixx-outdoors-intershop folder.
  4. Click the Import Products icon.
  5. To run full import mode uncheck all checkboxes Incremental Import of all importers.
  6. Select the Intershop importer.
  7. Select the products.csv data feed and the image.zip.
  8. Click on Next to start the import.

2.2.3 Catalog Data Import

  1. Log in to AEM.
  2. Go to Commerce - Catalogs.
  3. Select the Geometrixx Outdoors Intershop blueprint.
  4. Click on the Import Blueprints icon.
  5. To run full import mode uncheck all checkboxes Incremental Import of all importers.
  6. Select the Intershop importer.
  7. Select the catalogs.csv produced from the data feed.
  8. Click Next to start the import.

2.2.4 Automated Product Import

There is a product import job that can import product data automatically into AEM. The job is disabled per default. To enable the job you need to configure it in the AEM Web Console Configuration http://localhost:4502/system/console/configMgr Look for the name 'Intershop Product Import Job' and click on the name to change the configuration. Edit the 'Product CSV Path' to point to the location of the export files of the intershop location and check the 'Job Enabled' checkbox to enable the job.

The other default values will match the default feed configuration and must only be changed if you have set up different feeds or a different store. By default the job runs every 30 seconds to check if one of the given files in the list is changed. The schedule expression uses a quartz cron expression. See Quarz Scheduler Documentation for more information. If a changed file is detected the product import is started immediately. The first file in the list is assumed to be a full import file. If this file changes the import runs as a full import. Other files in the list of 'Product CSV File Names' are assumed to contain incremental product data and an incremental import is run if one of these files are changed.

Currently only product data and no catalog import CSVs are supported for automated import.

2.2.5 Product & Catalog Import (REST) (Obsolete)

There is an additional importer that calls the importer of version 1.1 for product and image import via REST interface.

  1. Log in to AEM.
  2. Go to Commerce - Products.
  3. Select the geometrixx-outdoors-intershop folder.
  4. Click the Import Products icon.
  5. Select the Intershop importer.
  6. Fill in the information as shown below.

  7. Click Next to start the import.

2.3  Roll-out Changes into Sites

To make changes in the catalog structure and product assignments to categories visible to the site it is necessary to roll-out these changes from the blueprint into the actual site.

  1. Log in to AEM.
  2. Go to Commerce - Catalog.
  3. Select the Geometrixx Outdoors Intershop blueprint.
  4. Click on the Rollout icon to start the Roll-out Wizard.

  5. Click Rollout Changes.

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets