Sample: Loading Commerce Composer layout templates

This sample demonstrates how to load Commerce Composer layout templates for use in creating layouts with the Commerce Composer tool.

Before you begin

This sample requires a published store that is based on the Aurora starter store and the Commerce Composer tool. Ensure that the following tasks are complete:

Review the Commerce Composer data load best practices. Follow these best practices when you load Commerce Composer assets with the Data Load utility.

About this sample

A layout template is a reusable starting point that can be used when you are creating a layout. A layout template is a wireframe that includes a specific arrangement of slots. When a user creates a layout in the Commerce Composer tool, widgets are assigned to these slots.

When you load the sample CSV input files for this sample, you create the following layout templates in the Commerce Composer tool

Sample any page, five slots, right sidebar
Sample any page, single slot
Sample department
Sample home page

You can load the information for this sample in both CSV or XML formatted input files. The following procedure, however, loads only the CSV input files. If you prefer to work with the data within the XML formatted files, you can edit the sample configuration files to use the XML files. The sample input files are located within the following directory:

utilities_root/samples/DataLoad/CommerceComposer/template
WCDE_installdir\samples\DataLoad\CommerceComposer\template

If you are using this sample to help you create Commerce Composer layout templates that exist in another instance, you can use the Data Extract utility to generate the input files for loading your template data. You can use the Data Extract utility to extract the existing template data. Then, you can edit configuration files for this sample to load the files that are generated by the Data Extract utility. For a sample that demonstrates how to use the Data Extract utility to extract template data, see Sample: Extracting Commerce Composer layout templates.

Input source files for loading Commerce Composer layout templates. This table also lists the business object mediators that are used by the Data Load utility to load the template data.
Sample input file	Description
CSV registerWidgetdef.csv XML registerWidgetdef.xml For more information about the data that is included in this file, see registerWidgetdef input file	The Data Load utility uses this input file to register a template container for use in creating the template. The Data Load utility loads the information within the input file into the PLWIDGETDEF, and PLWIDGETDEFDESC database tables. The Data Load utility uses the following business object mediator and business object configuration file to load the data within this input file: Business object mediator com.ibm.commerce.pagelayout.dataload.mediator.registerWidgetdefMediator Sample business object configuration file for loading this information: `utilities_root/samples/DataLoad/CommerceComposer/wc-loader-registerWidgetdef.xml` `WCDE_installdir\samples\DataLoad\CommerceComposer\wc-loader-registerWidgetdef.xml`
CSV slotDefinition.csv XML slotDefinition.xml For more information about the data that is included in this file, see slotDefinition input file	This sample input file loads information to define the slots within a container for a template. Each slot is defined with x and y coordinates. The Data Load utility loads the information within the input file into the PLWIDGETSLOT database table. The Data Load utility uses the following business object mediator and business object configuration file to load the data within this input file: Business object mediator com.ibm.commerce.pagelayout.dataload.mediator.WidgetSlotsMediator Business object configuration file `utilities_root/samples/DataLoad/CommerceComposer/wc-loader-widgetslot.xml` `WCDE_installdir\samples\DataLoad\CommerceComposer\wc-loader-widgetslot.xml`
CSV subscribeWidgetdef.csv XML subscribeWidgetdef.xml For more information about the data that is included in this file, see subscribeWidgetdef input file	This sample input file loads information to subscribe a template container to a store. The Data Load utility loads the information within the input file into the PLSTOREWIDGET database table. The Data Load utility uses the following business object mediator and business object configuration file to load the data within this input file: Business object mediator com.ibm.commerce.pagelayout.dataload.mediator.SubscribeWidgetDefinitionMediator Business object configuration file `utilities_root/samples/DataLoad/CommerceComposer/wc-loader-subscribeWidgetdef.xml` `WCDE_installdir\samples\DataLoad\CommerceComposer\wc-loader-subscribeWidgetdef.xml`
CSV template.csv XML template.xml For more information about the data that is included in this file, see template input file	This sample input file loads information that defines the template. The Data Load utility loads the information within the input file into the PAGELAYOUT database table. The Data Load utility uses the following business object mediator and business object configuration file to load the data within this input file: Business object mediator com.ibm.commerce.pagelayout.dataload.mediator.WidgetMediator Business object configuration file `utilities_root/samples/DataLoad/CommerceComposer/wc-loader-template.xml` `WCDE_installdir\samples\DataLoad\CommerceComposer\wc-loader-template.xml`

Procedure

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 load order file for a Commerce Composer layout template and load the information for this sample:
- ./dataload.sh ../samples/DataLoad/CommerceComposer/template/wc-dataload-template.xml
- dataload ..\samples\DataLoad\CommerceComposer\template\wc-dataload-template.xml
The load order configuration file identifies the order that the Data Load utility loads the sample CSV files. The load order file also identifies the appropriate business object configuration file to use to load each input file. For more information about load order configuration files, Configuring the data load order.
For more information about configuring and running the Data Load utility, see Configuring and running the Data Load utility.

Verifying results

Verify that the Commerce Composer tool page information is loaded by reviewing the data load summary report. For more information about the location and contents of this summary report, see Verifying the results of the data load.

You can also verify that the sample data is loaded by running the following SQL statements against your HCL Commerce database:

select * from PLWIDGET where PAGELAYOUT_ID in (select PAGELAYOUT_ID from PAGELAYOUT where name like 'Sample%');
select * from PLWIDGETDEF where IDENTIFIER like 'Sample%';
select * from PLWIDGETDEFDESC where PLWIDGETDEF_ID in (select PLWIDGETDEF_ID from PLWIDGETDEF where IDENTIFIER like
'Sample%');
select * from PLSTOREWIDGET where PLWIDGETDEF_ID in (select PLWIDGETDEF_ID from PLWIDGETDEF where IDENTIFIER like
'Sample%');
select * from PAGELAYOUT where name like 'Sample%';
select * from PLWIDGETREL where PLWIDGET_ID_CHILD in (select PLWIDGET_ID 
 from PLWIDGET where PAGELAYOUT_ID in (select PAGELAYOUT_ID from PAGELAYOUT where name like 'Sample%'));
select * from PLWIDGETSLOT where PAGELAYOUT_ID in (select PAGELAYOUT_ID from PAGELAYOUT where name like 'Sample%');

Ensure that the data within the sample input files exists within the appropriate database tables.

In Management Center, verify that users can use the layout template in the Commerce Composer tool by Creating a layout for a page. When you are creating the layout, select a template to use for your layout. Ensure that the templates you loaded are in the New Layout Template Selection window. The following image shows the new layout templates within the New Layout Template Selection window.

Removing the sample data from the HCL Commerce database

To remove the sample data from your database, run the sample again but with the value for the delete column for all entries within the files set to 1. By setting the value for this column to 1, the Data Load utility deletes the data that is identified in the CSV file from your database.

Alternatively, you can run the Cleanup.sql file for this data load sample. The Cleanup.sql file is located within the following directory:

utilities_root/samples/DataLoad/CommerceComposer/template
WCDE_installdir\samples\DataLoad\CommerceComposer\template

From a command prompt, connect to the database with your user ID and password. Run the following command:

db2 -tvf ../samples/DataLoad/CommerceComposer/template/Cleanup.sql

sqlplus user_name/password@ database_name@ ../samples/DataLoad/CommerceComposer/template/Cleanup.sql