Sample: Loading Commerce Composer widgets

Before you begin

• 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

When you are creating a Commerce Composer widget, in addition to the storefront assets that you must create, you must use the Data Load utility to load and register the definition information for the widget. You must also load the relationship between the widget and a store to subscribe the store to use the widget. A store must subscribe to a widget for that widget to be available for users to include on a page for that store. The following sample loads the information that is needed to register a widget and have a store subscribe to the widget. When you load this information, you create two widgets, a Sample site widget and a Sample store widget. This sample, however, does not create the storefront or Management Center definition for the widget. For more information about creating a widget, see Creating Commerce Composer widgets.

If you are using this sample to help you create Commerce Composer widgets that exist in another instance, you can use the Data Extract utility to generate the input files for loading your widget data. You can use the Data Extract utility to extract the existing widget registration and subscription 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 widget data, see Sample: Extracting Commerce Composer widgets.

This sample loads widget information for a single language. For more information about loading widget descriptive information in multiple languages, see Sample: Loading Commerce Composer widget descriptive information in multiple languages.

Procedure

1. On a command line, go to the WCDE_installdir\bin directory.
2. 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.
3. Enter the following command to run the sample data load order file for a Commerce Composer widget and load the information for this sample:
   • ./dataload.sh ../samples/DataLoad/CommerceComposer/widget/wc-dataload-widget.xml
   • dataload ..\samples\DataLoad\CommerceComposer\widget\wc-dataload-widget.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, see 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 widget 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.

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%'); 

In Management Center, verify that users can use the widget in the Commerce Composer tool by Creating a layout for a page. When you are creating the layout, select a template slot to add a widget to the slot. Ensure that the widgets you loaded are in the Add Widgets to Slots window. The following image shows the Sample site widget and the Sample store widget within the Add Widgets to Slots 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.

• db2 -tvf ../samples/DataLoad/CommerceComposer/widget/Cleanup.sql

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