Sample: Extracting Commerce Composer layout templates

This sample demonstrates how to extract Commerce Composer layout templates for a store with the Data Extract utility. You can then use the Data Load utility to load the extracted data into another HCL Commerce instance or store to quickly copy templates between instances or stores.

A layout template is a reusable starting point that can be used for creating a layout. A layout template is a wireframe that includes a specific arrangement of slots. To create a layout, widgets are assigned to these slots. For more information about layout templates, see Layouts, layout templates, and default layouts.

Before you begin

Ensure that you complete the following tasks:

Verify that the store that you want to extract data from includes Commerce Composer layout template data to extract.

Note: If you plan to load the extracted data into another instance, the store that you want to load data into must have the Commerce Composer tool enabled. The Aurora starter store is enabled to use the Commerce Composer tool.

About this sample

When you run this sample, the Data Extract utility is configured to extract the layout templates for only the store that you specify. You can specify the store in the environment configuration file or directly in the command line when you run the utility.

The sample configuration files that are used to configure the Data Extract utility are in the following directory and the template subdirectory:

utilities_root/samples/DataExtract/CommerceComposer
WCDE_installdir\samples\DataExtract\CommerceComposer

Sample configuration files

The following configuration files are used to configure the Data Extract utility to extract data into CSV output files.

wc-dataextract-env.xml

The environment configuration file. This file includes the environment variables for your HCL Commerce instance. These variables include the following information:

Business context variables, including the store identifier, catalog identifier, and the default language and currency for your store.
Database environment settings, including the database type, name, and schema.

wc-dataextract-template.xml

The data extract order configuration file. This file specifies the paths to the environment configuration file and to the business object configuration files for extracting the data for each type of object. The order configuration file also identifies the order that the Data Extract utility extracts data and identifies the output files that the utility generates to include the extracted data.

wc-extract-business-object.xml

The business object configuration file. This file defines how the utility identifies the data to extract and defines the business object mediator for the utility to use to transform the extracted data. In this sample, all of the business object configuration files configure the utility to use the following business object mediator:

com.ibm.commerce.foundation.dataload.businessobjectmediator.AssociationObjectMediator

The following business object configuration files are used to configure the Data Extract utility for this sample:

wc-extract-registerWidgetdef.xml

This file is used to configure the utility to extract layout template container registration data. The utility extracts this data from the following database tables:

The utility generates the registerWidgetdef.csv file to include the extracted data. This file can then be used to load data for registering a new layout template container within the Commerce Composer tool. For more information about the data that can be included in this file, see registerWidgetdef input file

wc-extract-subscribeWidgetdef.xml

This file is used to configure the utility to extract layout template container subscription data. The utility extracts this data from the following database table:

PLSTOREWIDGET

The utility generates the subscribeWidgetdef.csv output file to include this extracted data. This file can then be used to load the data for subscribing layout template containers to a store. For more information about the data that can be included in this file, see subscribeWidgetdef input file.

wc-extract-template.xml

This file is used to configure the utility to extract basic layout template data. The utility extracts this data from the following database table:

PAGELAYOUT

The utility generates the template.csv output file to include this extracted data. This file can then be used to load the data to create layout templates in the Commerce Composer tool. For more information about the data that can be included in this file, see template input file.

wc-extract-slotDefinition.xml

This file is used to configure the utility to extract the wireframe slot definitions for layout templates. Each wireframe slot is defined with X and Y coordinates and is used to organize widgets within a layout. The utility extracts this data from the following database table:

PLWIDGETSLOT

The utility generates the slotdefinition.csv output file to include the extracted data. This file can then be used to load the data to assign the wireframe coordinates to a template. For more information about the data that can be in this file, see slotDefinition input file

Procedure

Copy the sample configuration files and directories to a local directory.
Edit your copy of the sample environment configuration file to set the configuration variables for your environment. The sample configuration file that is used in this sample includes values for a default HCL Commerce Developer environment that uses an Apache Derby database. If your environment settings are different, you must change the configured values in your environment configuration file to match your environment. For more information about updating an environment configuration file, see Configuring the data load environment settings.
On a command line, go to the WCDE_installdir\bin directory.
Open a command line in the . Change the directory to utilities_root/bin directory. For information about entering and leaving containers, see Running utilities from the Utility server Docker container.
Enter the following command to run the sample data extract order configuration for extracting the template data into CSV output files:
- ./dataextract.sh ../samples/DataExtract/CommerceComposer/wc-dataextract-template.xml
- dataextract ..\samples\DataExtract\CommerceComposer\wc-dataextract-template.xml

When the utility completes the extraction process, the utility generates the CSV output files within the configured output directory and subdirectories. These files include data for all layout templates that exist for the configured store ID. By default, the files are generated in the following output directory and subdirectories:

utilities_root/samples/DataExtract/CommerceComposer/output
WCDE_installdir\samples\DataExtract\CommerceComposer\output

Verifying results

Go to the directory that you configured as the output directory. If you did not configure an output directory, go to the following directory:
- utilities_root/samples/DataExtract/CommerceComposer/output
- WCDE_installdir\samples\DataExtract\CommerceComposer\output
Verify that the following CSV output files are generated:
- template/registerWidgetdef.csv
- template/subscribeWidgetdef.csv
- template/template.csv
- template/slotDefinition.csv
Open the output CSV files to review the file contents.
Verify that the file contents match the data in the database for the templates that belong to the specified store.

What to do next

You can load your extracted data into another HCL Commerce instance with the Data Load utility. For a sample that demonstrates how to load template data, see Sample: Loading Commerce Composer layout templates. When you follow this sample, edit the load order configuration file to specify the CSV files that were generated by the Data Extract utility.