Export Configuration Reference

This page describes the XML elements in the export configuration schema. The export configuration schema (schemaExportConfig.xsd) is located in the schema subdirectory of the Import-Export installation directory and can be used to validate your export configuration files.

<exportconfiguration>

The root element in the export configuration XML file.

Attributes: None

Child elements:

note

Child elements are ordered.

• exporter

  Number of Occurrences: 1

  Specifies what type of data to export.

• packager

  Number of Occurrences: 1

  Specifies how the exported data is packaged.

• delivery

  Number of Occurrences: 1

  Specifies where the exported data package is located.

• transformerschain

  Number of Occurrences: 0...1

  Specifies a set of transformations to apply to the data before it is packaged

<exporter>

Specifies what type of data to export.

Parent element: <exportconfiguration>

Attributes:

• type

  Specifies the type of data to export. Supported values are:

  • PRODUCT

    Export products that match the search criteria.

    Exported product data is stored in a file named products.xml. The associated category and catalog data is exported as well. This attribute also exports product bundles and their constituents.

  • CATALOG

    Export catalogs that match the search criteria.

    Exported catalog data is stored in a file named catalogs.xml.

  • CATEGORY

    Export categories that match the search criteria.

    Exported category data is stored in a file named categories.xml. The associated catalog data is exported as well.

  • PROMOTION

    Export promotions that match the search criteria.

    Exported promotion data is stored in a file named promotions.xml.

  • SYSTEMCONFIGURATION

    Exports the system configuration settings that match the search criteria.

    Configuration setting data is stored in a file named system_configuration.xml.

  • PRICELISTDESCRIPTOR

    Exports the price lists that match the search criteria.

    Exported price list data is stored in a file named price_lists.xml.

  • PRICELISTASSIGNMENT

    Exports the price list assignments that match the search criteria.

    Exported price list assignment data is stored in a file named price_list_assignments.xml

  • PAYMENT_PROVIDERS

    Exports the configurations saved in the Elastic Path Commerce database for payment providers and the store.

    Exports data is stored in a file name payment_providers.xml.

  • TAXJURISDICTION

    Exports the tax jurisdictions that match the search criteria.

    Exported tax jurisdiction data is stored in a file named tax_jurisdictions.xml.

  • TAXCODE

    Exports the tax codes that match the search criteria.

    Exported tax codes are stored in a file named tax_codes.xml.

  • WAREHOUSE

    Exports the warehouses that match the search criteria.

    Exported warehouses are stored in a file named warehouses.xml.

  • CUSTOMER

    Exports customers that match the search criteria.

    Exported customers are stored in a file named customers.xml.

  • CUSTOMERPROFILE_ATTRIBUTE

    Exports the customer’s profile attributes that match the search criteria.

    Exported customer profile attributes are stored in a file named customerprofile_attributes.xml.

  • STORE

    Exports the stores that match the search criteria.

    Exported stores are stored in a file named stores.xml.

  • STORE_ASSOCIATION

    Exports the store associations that match the search criteria.

    Exported store associations are stored in a file named store_associations.xml.

  • CMUSER

    Exports the CMusers that match the search criteria.

    Exported CMusers are stored in a file named cmusers.xml.

  • USER_ROLE

    Exports the user roles that match the search criteria.

    Exported user roles are stored in a file named user_roles.xml.

  • GIFT_CERTIFICATE

    Exports the gift certificates that match the search criteria.

    Exported gift certificates are stored in a file named gift_certificates.xml.

  • SHIPPING_REGION

    Exports the shipping regions that match the search criteria.

    Exported shipping regions are stored in a file named shipping_regions.xml.

  • SHIPPING_SERVICE_LEVEL

    Exports the shipping service levels that match the search criteria.

    Exported shipping service levels are stored in a file named shipping_service_levels.xml.

  • SAVED_CONDITION

    Exports the saved conditions that match the search criteria.

    Exported saved conditions are stored in a file named saved_conditions.xml.

  • CM_IMPORT_JOB

    Exports the CM import jobs that match the search criteria.

    Exported CM import jobs are stored in a file named cmimportjobs.xml.

  • DATA_POLICY

    Exports the data policies that are in the system.

    The exported data policies are stored in data_policies.xml.

  • CUSTOMER_CONSENT

    Exports the customer consents that are in the system.

    The exported customer consents are stored in the customer_consents.xml

Child elements:

• <include>

  Number of Occurrences: 0...1

<include>

Specifies an optional data subtype to include in the export.

Parent element: <exporter>

Attributes:

• type

  Number of Occurrences: 1.

  Specifies the optional object types. Supported values are:

  • INVENTORY

    Inventory information by SKU and warehouse.

    The exported inventory data is stored in a file named inventory.xml. This type is only supported when the exporter type is set to PRODUCT.

  • PRODUCTASSOCIATION

    Merchandising associations, such as cross-sells, up-sells, warranties, and recommendations.

    The exported product association data is stored in a file named productassociations.xml. This type is only supported when the exporter type is set to PRODUCT.

  • CONDITIONRULE

    Eligibilities and conditions for promotions.

    The exported rule data is stored in a file named condition_rules.xml.

    This type is only supported when the exporter type is set to PROMOTION.

  • COUPONSET

    A collection of coupon codes.

    The exported coupon set is stored in a file named coupon_sets.xml.

  • BASEAMOUNT

    The base amounts for price lists.

    Base amounts are stored in a file named base_amounts.xml

Child elements:

• <option>

  Number of Occurrences: 1.

  Sets an export option specific to the object type

<option>

The option element specifies which optional object types to include in the export.

Parent element: include

Attributes:

• key
• value

If the parent element <include> type is CUSTOMER:

• The value of key attribute is CARD_NUMBER_FILTER

• The value of value attribute is EMPTY or STATIC

  For security purposes, credit cards cannot be exported; however, you can export default credit card data for customers.

  EMPTY does not export customer’s credit card data.

  STATIC exports the name of the customer’s credit card and sets the card number to a default number, ie Master Card 1111 1111 1111 1111

If the parent element <include> type is PRODUCTASSOCIATION:

• The value of key attribute is DIRECT_ONLY

• The value of value attribute is true or false

  true - only exports the product associations that are directly related to the product.

  false - all the associated products are exported along with the product.

  Setting DIRECT_ONLY to false creates a product.xml that may be too large for your system to handle

Child elements: None

<packager>

Specifies where the exported data package is stored.

Parent element: <exportconfiguration>

Attributes:

• type

  Specifies how the exported files are packaged. Supported values are:

  • ZIP: The exported files are packaged in a zip archive
  • NONE: The exported files are not packaged

• packagename

  Specifies the name of the destination zip file.

  Not required if type is set to NONE

Child elements: None

<delivery>

Specifies where the exported data package is stored.

Parent element: <exportconfiguration>

Attributes: None

Child elements:

• <method>

  Specifies the data export method. The only supported value is FILE.

• <target>

  Specifies the directory where exported files will be located.

  Can be an absolute path or relative to the Import-Export tool directory. If the directory does not exist, it is created automatically

<transformerschain>

Specifies a set of transformations to apply to the data before it is packaged.

Parent element: <exportconfiguration>

Attributes: None

Child elements:

• <transformer>

  Specifies a transformation to apply to the data

<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 fully qualified class name of the transformer. The specified class must be on the Import-Export tool’s classpath

<searchconfiguration>

The root element of the search configuration file.

Parent element: None

Attributes: None

Child elements:

• <epql>

  Number of Occurrences: 1

  Contains the query that will be used to select the products and categories to export

<epql>

Contains the query that will be used to select the products and categories to export. For more information, see the query language.

Parent element: <searchconfiguration>

Attributes: None

Child elements: None