Import Configuration Reference
This page describes the elements in the import configuration schema. The import configuration schema (schemaImportConfig.xsd
) is located in the schema
subdirectory of the Import-Export installation directory and can be used to validate your import configuration files.
<importconfiguration>
The importconfiguration
element is the root element in the import configuration XML file.
Attributes: None
Child elements:
note
Child elements are ordered.
xmlvalidation
Number of Occurrences: 1
Specifies whether to validate all the XML files in the import package before importing.
importstrategy
Number of Occurrences: 0..1
Specifies how the Import-Export handles conflicts between the data it is importing and the existing data.
packager
Number of Occurrences: 1
Specifies how the data being imported is packaged.
retrieval
Number of Occurrences: 1
Specifies the location of the data being imported.
transformerschain
Number of Occurrences: 0..1
Specifies a set of transformations to apply to the data before it is imported
<xmlvalidation>
Specifies whether to validate all the XML files in the import package before importing. If set to true, the import operation will not proceed if any of the files are invalid. If set to false, all valid files are imported and errors are logged for all invalid files.
Disabling validation may improve performance when importing large data files, but should not be disabled if the data files have been modified manually.
Possible values are true
(1
) or false
(0
).
Parent element: <importconfiguration>
Attributes: None
Child elements: None
<importstrategy>
Specifies the data to import.
Parent element: <importconfiguration>
Attributes: None
Child elements:
<importer>
Number of Occurrences: 0..*
Specifies the type of data to import
<importer>
Specifies the type of object to import. Dependencies of those objects are also imported (see below).
Parent element: <importstrategy>
Attributes:
type
Specifies the type of objects to be imported. Supported values are:
PRODUCT
Import products (and product bundles) and their associated categories and catalogs. The product data must be stored in the import package in a file named
products.xml
.If importing product bundles, the system always performs a
CLEAR_COLLECTION
.RETAIN_COLLECTION
is not available for product bundles.CATALOG
Import catalogs. The catalog data must be stored in the import package in a file named
catalogs.xml
.CATEGORY
Import categories and their associated catalogs. The category data must be stored in the import package in a file named
categories.xml
.PROMOTION
Import promotions and (optionally) their associated conditions and eligibilities.
The promotion data must be stored in the import package in a file named
promotions.xml
. Condition and eligibility data, if included, must be stored in the import package in a file namedcondition_rules.xml
.SYSTEMCONFIGURATION
Import system configuration settings. The setting data must be stored in the import package in a file named
system_configuration.xml
.PRICELISTDESCRIPTOR
Import price lists and (optionally) their base amounts. The price lists must be stored in the import package in a file named
price_lists.xml
. The base amounts, if included, must be stored in the import package in a file namedbase_amounts.xml
.PAYMENTGATEWAY
Import payment gateways and (optionally) payment gateway properties. The payment gateways must be stored in the import package in a file named payment_gateways.xml.
PRICELISTASSIGNMENT
Import price list assignments. The price list assignments must be stored in a file named
price_list_assignments.xml
.WAREHOUSE
Import warehouses. The warehouses must be stored in a file named
warehouses.xml
.TAXCODE
Import tax codes. The tax codes must be stored in a file named
tax_codes.xml
.TAXJURISDICTION
Import tax jurisdictions. The tax jurisdictions must be stored in a file named
tax_jurisdictions.xml
.STORE
Import stores. The stores must be stored in a file named
stores.xml
.STORE_ASSOCIATION
Import store associations. The store associations must be stored in a file named
store_associations.xml
.CUSTOMERPROFILE_ATTRIBUTE
Import customer profile attributes. The customer profile attributes must be stored in a file named
customerprofile_attributes.xml
.CMUSER
Import CMusers and optionally following:
- The user roles
- Price lists
- Catalogs
- Stores
- Warehouses
- User password histories associated with the CMuser
The CMusers must be stored in a file named
cmusers.xml
USER_ROLE
Import user roles and (optionally) user permissions. User roles must be stored in a file named
user_roles.xml
.CUSTOMER
Import customers. Customers must be stored in a file named
customers.xml
.PROMOTION
Import promotions. Promotions must be stored in a file named
promotions.xml
.COUPONSET
Import coupon sets and (optionally) the coupons in the coupon set. Coupon sets must be stored in a file named
coupon_sets.xml
.GIFT_CERTIFICATE
Import gift certificates. Gift certificates must be stored in a file named
gift_certificates.xml
.SHIPPING_SERVICE_LEVEL
Import shipping service level. Shipping service levels must be stored in a file named
shipping_service_levels.xml
.SHIPPING_REGION
Import shipping regions. Shipping regions must be stored in a file named
shipping_regions.xml
.SAVED_CONDITION
Import saved conditions. Saved conditions must be stored in a file named
saved_conditions.xml
.CM_IMPORT_JOB
Import CM import jobs and (optionally) CM import mappings. CM import jobs must be stored in a file named
cmimportjobs.xml
DATA_POLICY
Import data policies. You must store the data policies with the file name
data_policies.xml
. Only the items that do not exist in the system are imported.CUSTOMER_CONSENT
Import customer consents. You must store the customer consents with the file name
customer_consents.xml
. Only the items that do not exist in the system are imported
Child elements:
note
Child elements are ordered.
<importstrategy>
Number of Occurrences: 0..1
Specifies how the Import-Export tool resolves conflicts between data in the import package and existing data in the destination.
<dependentelements>
Number of Occurrences: 0..1
Specifies how dependencies of each item type are handled
<importstrategy>
Specifies how the Import-Export tool resolves conflicts during an import operation. Conflicts occur if the code of the item in the import package matches the code of an item in the destination system.
Possible values are:
INSERT
: Only import items that do not exist in the systemINSERT_OR_UPDATE
: Import items that do not exist in the system and update items that already existUPDATE
: Only update items that already exist in the system
Parent element: <importer>
Attributes: None
Child elements: None
<dependentelements>
Specifies how the dependencies of each item type are handled.
Parent element: <importer>
Attributes: None
Child elements:
<dependentelement>
Number of Occurrences: 0..*
Specifies how the dependencies of an item type are handled
<dependentelement>
Determines how dependencies of the specified item type are handled. For example, a product has a set of associated attributes. During an import operation, the product being imported may have a different set of associated attributes than the product in the destination system. This setting specifies whether the existing attributes on the product are removed and replaced with the imported attributes, or if the new attributes are added to the existing set of attributes.
note
If the import configuration does not contain a dependentelement for a particular item type, then the default behavior for dependencies of that item type is CLEAR_COLLECTION
.
Supported values are:
CLEAR_COLLECTION
: Remove all existing dependencies of this type before adding new dependencies from the import packageRETAIN_COLLECTION
: Keep existing dependencies of this type and add only new dependencies from the import package, if any
note
The payment_methods
collection element only supports the CLEAR_COLLECTION
value. If any other value is used, the Import-Export tool will return an exception.
Parent element: <dependentelements>
Attributes:
type
Specifies the type of dependency.
For categories (
CATEGORY
), possible values are:CATEGORY_ATTRIBUTES
For products (
PRODUCT
), possible values are:PRODUCT_ASSOCIATIONS
PRODUCT_CATEGORY_ASSIGNMENTS
PRODUCT_ATTRIBUTES
PRODUCT_CATALOG_PRICES
PRODUCT_PRICE_CURRENCIES
PRODUCT_PRICE_TIERS
SKU_CATALOG_PRICES
SKU_PRICE_CURRENCIES
SKU_PRICE_TIERS
PRODUCT_SKUS
PRODUCT_SKU_PRICING
SKU_ATTRIBUTES
For system configuration settings (
SYSTEMCONFIGURATION
), possible values are:SETTING_VALUES
SETTING_METADATA
For price lists (
PRICELISTDESCRIPTOR
), possible values are:BASE_AMOUNTS
For payment gateways (
PAYMENTGATEWAY
), possible values are:PAYMENT_GATEWAY_PROPERTIES
For user roles (
USER_ROLE
), possible values are:USER_PERMISSIONS
For coupon sets (
COUPONSET
), possible values are:COUPONSET
(Represents the individual coupons in the coupon set.)
For CM import jobs (
CM_IMPORT_JOB
), possible values are:CM_IMPORT_MAPPINGS
Child elements: None
<packager>
Specifies how the data being imported is packaged.
Parent element: <importconfiguration>
Attributes:
type
Number of Occurrences: 0..1
Supported values are:
ZIP
: The data being imported is packaged in a zip archiveNONE
: The data being imported is not packaged. The individual data files are stored in uncompressed format on the file system
Child elements: None
<retrieval>
Specifies the location of the data being imported.
Parent element: <importconfiguration>
Attributes: None
Child elements:
note
Child elements are ordered.
<method>
Number of Occurrences: 0..1
Specifies the data import method. The only supported value is
FILE
.<source>
Number of Occurrences: 0..1
Specifies the directory that contains the files to be imported. Can be an absolute path or relative to the Import-Export tool directory
<method>
Specifies the data import method. The only supported value is FILE
.
Parent element: <retrieval>
Attributes: None
Child elements: None
<source>
Specifies the directory that contains the files to be imported. Can be an absolute path or relative to the Import-Export tool directory. If the packager (child of importconfiguration) element’s type
is ZIP
, source must specify a zip file. If type
is NONE
, source must specify a directory.
Parent element: <retrieval>
Attributes: None
Child elements: None
<transformerschain>
Specifies a set of transformations to apply to the data before it is imported.
Parent element: <importconfiguration>
Attributes: None
Child elements:
<transformer>
Number of Occurrences: 0..1
Specifies a transformation to apply to the data before it is imported
<transformer>
Specifies a transformation to apply to the data before it is packaged.
Parent element: <transformerschain>
Attributes: None
Child elements:
<type>
Number of Occurrences: 0..1
The qualified class name of the transformer. The specified class must be on the Import-Export tool’s classpath
<type>
The fully qualified class name of the transformer. The specified class must be on the Import-Export tool’s classpath.
Parent element: <transformer>
Attributes: None
Child elements: None