Configure and running the Data Extract utility

We can configure and run the Data Extract utility from a command-line utility to extract data for a store from the WebSphere Commerce database. We can extract data into an CSV or XML output file. We can then use the Data Load utility to load the output file into stores in other environments, such as for copying data into multiple stores or setting up multiple test environments.

Before beginning

Ensure that you review and follow the Data Extract utility best practices.

Task info

To run the Data Extract utility, you need to configure the utility to identify the environment settings and identify the data to extract. Sample configuration files are provided for you to edit and use to quickly configure the utility to extract the following types of objects:

• Promotions

• Commerce Composer objects, such as widgets, layouts, layout templates, and pages

• Marketing objects, such as activities. e-Marketing Spots, content, campaigns, attachments, and customer segments

These files are in the following directory and subdirectories:

• WCDE_installdir\samples\DataExtract

Notes:

• The sample files for extracting marketing, promotions, and Commerce Composer objects configure the utility to use an SQL-based extraction process.

• The DataExtract directory also includes sample files for extracting catalog and configuration data for use with IBM Product Recommendations. These files cannot be used when you configure the utility to use an SQL-based extraction process. To extract data for use with IBM Product Recommendations, we must use a business logic-based extraction process. See Data extraction utility for dynamic recommendations in IBM Product Recommendations.

• The Data Extract utility extracts data for only a single store during an extract operation. We can specify the identifier for the store to extract data from when you configure the environment configuration file.

Procedure

1. Configure the Data Extract utility environment settings
   We must create an environment configuration file that specifies the environment settings so that the Data Extract utility can extract data objects from the WebSphere Commerce database.

2. Configure the Data Extract utility business object configuration file
   Create a business object configuration file for the Data Extract utility to use to identify business object data to extract. In this file, we must specify the implementation classes for our data reader, business object builder, and business object mediator components.

3. Configure the Data Extract utilityorder configuration file
   Create a data extract order configuration file for the Data Extract utility to use to identify the business objects to extract and the sequence to extract the data. This file must also identify the other configuration files for configuring the utility and identify the CSV or XML output files that the utility is to generate.

4. Running the Data Extract utility command syntax
   The Data Extract utility, which uses the Data Load utility framework, extracts data from the WebSphere Commerce database into an output file.

Related concepts
Overview of the Data Extract utility