Home
User Guide
The information contained in this section applies to WebSphere Commerce Version 8. The documentation also applies to all subsequent releases and modifications until otherwise indicated in a newer section.WebSphere Commerce is a single, unified e-commerce platform that offers the ability to do business directly with consumers (B2C), directly with businesses (B2B), and indirectly through channel partners (indirect business models). WebSphere Commerce is designed to be a customizable, scalable, and high availability solution that is built to leverage open standards. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels.
Administering
Extracting, transforming, and loading data
WebSphere Commerce provides multiple utilities for preparing and loading data into a WebSphere Commerce database. The loading utilities are flexible and you can continue to use these utilities when you customize the WebSphere Commerce schema.
Data Load utility
The Data Load utility is an enhanced business object based loading utility. This utility provides an efficient solution for loading information into your WebSphere Commerce database. You can also customize the Data Load utility to load other types of data. The Data Load utility is the recommended loading utility.
Samples: Data Load utility
The samples that are provided with the Data Load utility demonstrate best-practice methods for loading data using common loading scenarios. Use the samples as a template for loading your own data to your store.
Catalog samples
The following samples demonstrate how to load catalog data using the Data Load utility.
Loading bundles and kits
This sample demonstrates how to load bundles and kits to the database.

User Guide
The information contained in this section applies to WebSphere Commerce Version 8. The documentation also applies to all subsequent releases and modifications until otherwise indicated in a newer section.WebSphere Commerce is a single, unified e-commerce platform that offers the ability to do business directly with consumers (B2C), directly with businesses (B2B), and indirectly through channel partners (indirect business models). WebSphere Commerce is designed to be a customizable, scalable, and high availability solution that is built to leverage open standards. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels.
- Planning
  Creating a custom implementation of a WebSphere Commerce store requires a significant amount of planning. From gathering client needs, to deploying the live solution, much work is needed to successfully deploy a custom client store. Use the resources in here to help you plan every phase of store creation.
- Installing
  Review the following sections for information about installing the WebSphere Commerce product, associated maintenance, and WebSphere Commerce enhancements.
- Migrating
  Before you migrate to WebSphere Commerce Version 8.0, review this information to help plan and execute your migration.
- Deploying
  The topics in this section describe how to publish stores to either a test or production environment, and how to deploy customized code.
- Operating
- Integrating
  Topics in the Integrating category highlight the tasks that are commonly performed for using WebSphere Commerce in combination with other products.
- Administering
  - Overview of administering a WebSphere Commerce site
    In WebSphere Commerce the person who performs administrative tasks is called a Site Administrator. The Site Administrator installs, configures, and maintains WebSphere Commerce and the associated software and hardware. The administrator responds to system warnings, alerts, and errors, and diagnoses and resolves system problems. Typically, this person controls access and authorization (creating and assigning members to the appropriate role), manages the Web site, monitors performance, and manages load balancing tasks. The Site Administrator might be responsible for establishing and maintaining several server configurations for different stages of development such as testing, staging, and production. The Site Administrator also handles critical system backups and resolves performance problems.
  - WebSphere Commerce instance
    Every WebSphere Commerce installation requires at least one instance to function, and each WebSphere Commerce instance can contain one or more stores.
  - Managing features
    You can administer the features for your store and site, such as attribute, catalog, promotion, marketing, order management features, and more. The administration tasks that you can complete differ depending on the type of feature and the tool that you use to administer your store and site.
  - Logging services
    WebSphere Commerce provides facilities for logging. For existing customers, ECTrace and ECMessage are still supported. For new implementations, use the WebSphere Application Server recommendation for logging and tracing.
  - Business auditing
    Business auditing is the capturing of the business logic and objects during a WebSphere Commerce operation. You may want to audit your business for various reasons: generic, such as to review various tasks performed weekly; or specific, such as to track the steps involved in a particular Customer Service Representative's order. A report on business auditing is available in the Administration Console.
  - Business events
    Each time that a command triggers a business event, a record is added to the BUSEVENT database table to persist data from the event. Event listeners and external systems (such as the Marketing component, a back end order management system, or an external analytics system) can use this data to perform further processing.
  - Staging server
    The WebSphere Commerce staging server is a part of the production environment where business and technical users can update and manage store data and preview changes. The changes can then be propagated to the production server.
  - WebSphere Commerce database
    As a site administrator, maintain the WebSphere Commerce database and ensure that any WebSphere Commerce utilities and processes that load and retrieve data from the database is configured to connect to the database properly.
  - Dynamic caching
    In general, caching improves response time and reduces system load. Caching techniques are used to improve the performance of World Wide Web Internet applications. Most techniques cache static content (content that rarely changes) such as graphic and text files. However, many websites serve dynamic content, containing personalized information or data that changes more frequently. Caching dynamic content requires more sophisticated caching techniques, such as those provided by the WebSphere Application Server dynamic cache, a built-in service for caching and serving dynamic content.
  - Extracting, transforming, and loading data
    WebSphere Commerce provides multiple utilities for preparing and loading data into a WebSphere Commerce database. The loading utilities are flexible and you can continue to use these utilities when you customize the WebSphere Commerce schema.
    - Data Load utility
      The Data Load utility is an enhanced business object based loading utility. This utility provides an efficient solution for loading information into your WebSphere Commerce database. You can also customize the Data Load utility to load other types of data. The Data Load utility is the recommended loading utility.
      - Data Load input file format
        To run the Data Load utility, an input file is required. The input file must be a CSV or XML file. Your input file must follow a particular format for the Data Load to be able to load your file.
      - Business object mediators
        The data load business object mediator converts the business objects into physical objects. Two types of mediators that are provided with the Data Load utility are the component-based mediator and the table-based mediator. Several component-based mediators are available for catalog, inventory, and price components.
      - Data Load utility table-based mediator and builder
        Use the table object builder and table object mediator to load data directly into a table with the Data Load utility when a component-based business object mediator does not exist. You can use the TableObjectMediator and TableObjectBuilder to load your custom data directly into your target database tables. This mediator and builder can ensure that the data is loaded into the correct table and columns. You do not have to create a custom business object mediator and builder or extend an existing mediator or builder.
      - Data Load file difference preprocessing
        You can run a file difference preprocess for routine data loads to improve the Data Load utility performance for loading these files. Running a file difference can reduce the loading time that is required to load your routine updates to your WebSphere Commerce database, reduce server usage time, and improve server performance.
      - Data Load utility best practices
        When you use the Data Load utility, there are some general configuration recommendations to ensure that you take advantage of the full capability of data load. If you are loading catalog, price, member, or inventory-related data with the Data Load utility, review the component-related best practices.
      - Configuring and running the Data Load utility
        To configure and run the Data Load utility, create a file to load, define the data reader, load order, and environment configuration files. Then, enter the data load shell script command with modifying parameters from a command-line interface.
      - Scenarios: Data Load utility
        By reviewing different scenarios for using the Data Load utility, you can learn more about how you can use the utility.
      - Samples: Data Load utility
        The samples that are provided with the Data Load utility demonstrate best-practice methods for loading data using common loading scenarios. Use the samples as a template for loading your own data to your store.
        ***
        Catalog samples
        The following samples demonstrate how to load catalog data using the Data Load utility.
        Loading initial data
        This sample demonstrates how to simultaneously load top categories, subcategories, products, SKUs, attributes, and prices. This data is typically the first data to be loaded to your store.
        Updating SKU inventory
        This sample demonstrates how to update inventory quantities for the SKUs that have already been loaded to your database.
        Loading merchandising associations
        This sample demonstrates how to load merchandising associations for SKUs that have already been loaded to your database.
        Replacing existing products and SKUs
        This sample demonstrates how to use the data load replace mode by replacing products and SKUs previously loaded to the database.
        Loading bundles and kits
        This sample demonstrates how to load bundles and kits to the database.
        Loading attributes, attribute values, and allowed values
        This sample demonstrates how to load attributes together with the associated allowed values and attribute values in a single load operation.
        Loading attribute dictionary data
        This sample demonstrates how to load attributes, attribute values, and predefined (allowed) values to the attribute dictionary.
        Changing the parent of a subcategory
        This sample demonstrates how to use the CatalogGroupRelationshipMediator data load mediator to move a subcategory from one parent to another.
        Loading category descriptions in multiple languages
        This sample demonstrates how to load English and French category descriptions in a single step operation, as well as a multiple step operation.
        Loading attachments for categories and catalog entries
        This sample demonstrates how to load attachments, specifically image attachments, and associate the attachments with categories and catalog entries for a non-ATP store.
        Loading sales catalogs
        This sample demonstrates how to load catalog data with the Data Load utility. The sample demonstrates how to load a sales catalog, how to load sales categories and how to load catalog entries to a sales category.
        Loading data to an extended sites store and catalog asset store
        This sample demonstrates how to load data to your extended sites store and catalog asset store when using the extended sites business model.
        Loading catalog entry description override data
        This sample demonstrates how to load catalog entry description override data to your extended sites store.
        Loading list prices in multiple currencies
        This sample demonstrates how to load list prices in multiple national currencies simultaneously. You can load different national currencies to your store by modifying the source file in the sample. All currency codes are based on the ISO 4217 standard.
        Sample: Loading updates for catalog entry properties and descriptions
        This sample demonstrates how to use the Data Load utility update mode to update catalog entry property and description information. In this sample, the names for existing products and SKUs are changed.
        Sample: Loading updates for catalog entry descriptions
        This sample demonstrates how to use the Data Load utility update mode to update descriptive information for existing catalog entries. In this sample, the short descriptions for existing products and SKUs are changed.
        Commerce Composer samples
        The following samples demonstrate how to load Commerce Composer data with the Data Load utility.
        Inventory samples
        The following samples demonstrates how to load inventory data using the Data Load utility.
        Location samples
        The following sample demonstrate how to load location data by using the Data Load utility.
        Loading marketing data
        This sample demonstrates how to load marketing data into the WebSphere Commerce database with the Data Load utility. After you load the data, Management Center users can view and manage the marketing objects in the Marketing tool. By following this sample, you load data for marketing activities, e-Marketing Spots, customer segments, marketing content, and associated attachments for the marketing objects.
        Member samples
        The following samples demonstrate how to load member data using the Data Load utility.
        Price samples
        The following samples demonstrate how to load price data with the Data Load utility. The samples include configuration and input files for use with the Data Load utility. You can copy and modify the sample files to help you create your own input files and configure the Data Load utility to load your own price data.
        Promotion samples
        The following sample demonstrates how to load promotion data with the Data Load utility. The sample includes configuration and input files for use with the Data Load utility. You can copy and modify the sample files to help you create your own input files and configure the Data Load utility to load your own promotion data.
        Store configuration samples
        You can load configuration properties for a store into your WebSphere Commerce database by using the Data Load utility. This sample demonstrates how to load store configuration name value properties into the STORECONF database table.
        Examples: Mapping data
        The Data Load utility uses three configuration files when you are loading data: a load order configuration file, an environment configuration file, and a business object configuration file. The load order configuration file defines the order in which the data is loaded. The environment configuration file specifies the environment information such as database type, context settings, and global properties. The business object configuration file describes the business objects that are being loaded into the database; the file is specific for each business object. The following examples show you how to map data for an input source file.
      - Initializing the attribute dictionary
        If your store does not have an attribute dictionary, set the initAttributeDictionary property to initialize the attribute dictionary and then use the data load utility to create the attribute dictionary in Management Center.
      - Substituting data load attribute values with variables
        You can substitute the values of most attributes in the wc-dataload.xml data load order configuration file and wc-dataload-env.xml data load environment configuration files. By using variable substitutions, you can change the value of attributes without editing the configuration file. For example, you can substitute the value of the user ID attribute for a variable.
      - Loading data into workspaces using the Data Load utility
        The Data Load utility supports loading data into a workspace. By loading data into a workspace you can make and preview changes to managed assets, without affecting what is running on your site.
      - Loading values for single and multiple value attributes
        You can configure the loading process for Catalog Upload and the Data Load utility to load data separately for both single and multiple value descriptive attributes. By separating these load processes, you can ensure that the values for your single value and multiple value attributes are updated accurately.
      - Reuse attribute assigned values with the Data Load utility
        You can use the Data Load utility to reuse assigned values for attributes when the same value is needed for multiple catalog entries. By reusing attribute assigned values across catalog entries, you can reduce the number of duplicate values that are created in the database.
      - Loading customer segment members by email address
        You can create a customer segment that business users can manage in the Marketing tool by loading a list of email addresses.
      - Loading member group members by email address
        You can load members into member groups by resolving the unique ID for a member with only the member email address. By resolving the unique ID with the email address, you do not need to include the member logon ID or distinguished name in your input file.
      - Loading promotions with the Data Load utility
        You can configure the Data Load utility to load promotion data in an XML input file to create or change promotions in a store. By using the Data Load utility to load promotions, you can quickly create or change multiple promotions in a single operation.
      - Loading marketing objects with the Data Load utility
        You can configure the Data Load utility to load marketing data to create customer segments, e-Marketing Spots, activities, marketing content, and any associated assets. By using the Data Load utility to load this data, you can quickly create multiple marketing objects and types of objects in a single operation.
      - Configuring a Data Load utility scheduler job
        You can use the WebSphere Commerce Administration Console to schedule a Data Load utility job for your site. By using a scheduler job, you can configure the Data Load utility to routinely load an input file, such as for loading frequently updated data.
    - Data Extract utility
      The Data Extract utility is a command-line utility that you can use to extract data from the WebSphere Commerce database into an output file.
    - Catalog Upload feature
      You can configure the Catalog Upload feature in Management Center to change the behavior for how the Catalog Upload feature loads data. You can configure properties for the utility to change validation behavior, invalidate the cache, load SEO information, and more.
    - Mass load utilities
      The mass load utilities provide an efficient way to load large amount of data. The Data Load utility, which is an enhanced business object based loading utility, is the recommended loading utility.
  - Payment plug-ins
    To configure a payment plug-in define payment and refund methods; payment and refund rules; and the payment protocols that you intend to use.
  - WebSphere Commerce Search
    For a fully functioning WebSphere Commerce Search implementation, you must understand and complete the search administration tasks, which include search index management and ongoing maintenance.
  - Deploying a WebSphere Commerce dual cell environment
    Consider deploying a dual cell environment to achieve continuous availability and ensure that shoppers are minimally affected by planned or unplanned outages.
  - IBM Customer Service for WebSphere Commerce
    IBM Customer Service for WebSphere Commerce is a separately purchased product that provides a light-weight customer service solution that is embedded in the Aurora B2C and Aurora B2B storefronts. Even though this solution is a separately purchased product, it is not a separate application. Stores that are enabled with IBM Customer Service for WebSphere Commerce allow a customer service representative (CSR) to act on behalf of guest customers and registered customers. A CSR can manage customer accounts, cancel and reorder orders, and shop as customer. A CSR can also act on behalf of Buyer Administrators to help complete Aurora B2B tasks from the storefront, without having to access the Organization Administration Console.
- Tutorials
  WebSphere Commerce provides many tutorials to help you customize and understand your WebSphere Commerce instance and stores.
- Samples
- Developing
  The topics in the Developing section describe tasks performed by an application developer.
- Compliance
  The following section describes how you can leverage WebSphere Commerce features and functionality to help your site be compliant with different privacy and security standards.
- Securing
  These topics describe the security features of WebSphere Commerce and how to configure these features.
- Performance
- Troubleshooting

Sample: Loading bundles and kits

This sample demonstrates how to load bundles and kits to the database.

About this sample

This sample loads the following catalog entries:

A bundle named 'Gift set - Shirt Pants' (contains the SKUs 'Classic pleated dress pant-Black-29W x 32L' and 'Dress shirt-White-15')
A kit named 'Gift set - Pants' (contains the SKUs 'Classic pleated dress pant-Black-29W x 32L' and 'Cords-Brown-29W x 28L')

Procedure

Before running this sample, ensure that you have loaded the initial data.

Open the command-line interface and go to the following directory:
- WC_installdir/bin
- WCDE_installdir\bin
Enter the following command:
- ./dataload.sh ../samples/DataLoad/Catalog/IntegrateScenario/wc-dataload-kit-bundle.xml
- dataload ..\samples\DataLoad\Catalog\IntegrateScenario\wc-dataload-kit-bundle.xml

Verifying results

The wc-dataload-kit-bundle.xml configuration file loads one kit and one bundle from the KitBundle.csv source file. Verify that the data is loaded by running the following SQL statements:

select * from catentry where partnumber like '%Gift Set%'
select *  from catentdesc where catentry_id in (select catentry_id from catentry where partnumber 
like '%Gift Set%')
select * from catentrel where catentry_id_parent in (select catentry_id from catentry where partnumber
 like '%Gift Set%')
select *  from listprice where catentry_id in (select catentry_id from catentry where partnumber
 like'%Gift Set%')

These SQL statements return details about the kit and bundle, including the list price and offer price.

You can also verify the load by viewing the kit and bundle in the Management Center or in the storefront.

Cleaning up the data

To remove the data loaded in this sample from the database, run the CleanUp.sql file in the /samples/DataLoad/Catalog/IntegrateScenario directory.

Note: After running the CleanUp.sql file, you might see that 0 rows are deleted for certain SQL statements. This result is expected, as not all rows are populated with data in this sample.