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.
Integrating
Topics in the Integrating category highlight the tasks that are commonly performed for using WebSphere Commerce in combination with other products.
Sterling Order Management integration
The integration between WebSphere Commerce and Sterling Order Management combines the industry-leading front-end capabilities of WebSphere Commerce with the proven, back-end order and inventory management features of Sterling Order Management.
Reference
To understand how Sterling Order Management integrates with WebSphere Commerce, review mappings between the two systems and integration flows.
Mappings and integration flows
You should review the mappings between WebSphere Commerce and Sterling Order Management.
Integration flows
Integration flows provide mappings between WebSphere Commerce and Sterling Order Management.
validateCouponUE
The validateCouponUE mappings allow for validation of coupons between Sterling Order Management and WebSphere Commerce. When a shopper adds a manual coupon from Sterling Call Center, validateCouponUE is implemented to call WebSphere Commerce for validation of entered coupons against their definitions in WebSphere Commerce.

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.
  - Integrating with back-end systems and external applications
    External systems integration is a key feature of the WebSphere Commerce solution. In WebSphere Commerce business logic is enabled for integration and built-in adapters and interfaces are provided for common integration points. Additionally, the WebSphere Commerce integration solution leverages integration standards by using various IBM connectivity solutions.
  - IBM Watson Campaign Automation integration
    You can integrate IBM Watson Campaign Automation with WebSphere Commerce so that transactional emails are sent by IBM Watson Campaign Automation.
  - Sterling Order Management integration
    The integration between WebSphere Commerce and Sterling Order Management combines the industry-leading front-end capabilities of WebSphere Commerce with the proven, back-end order and inventory management features of Sterling Order Management.
    - Solution Overview
      The integration of WebSphere Commerce and IBM Sterling Order Management delivers the strengths of both products.
    - Prerequisites
      For the Sterling Order Management integration with WebSphere Commerce, some prerequisites, system requirements, assumptions, and limitations apply.
    - Sample configuration for integrating with Aurora starter store
      The sample configuration for integrating with the Aurora starter store provides a preconfigured order management-to-storefront environment that you can test to understand the significant features of the WebSphere Commerce integration with Sterling Order Management.
    - Integrating Sterling Order Management with WebSphere Commerce
      Configuring and deploying WebSphere Commerce and Sterling Order Management for integration includes running provided activation scripts, defining properties for your implementation, granting permissions, and triggering agent and integration servers.
    - Troubleshooting and status codes
      To troubleshoot integration issues, review status codes.
    - Reference
      To understand how Sterling Order Management integrates with WebSphere Commerce, review mappings between the two systems and integration flows.
      - Creating static kits and prebuilt kits in the integration
        You can create a kit to attract customers. Kits are groupings of catalog entries that can be used when creating promotions.
      - Mappings and integration flows
        You should review the mappings between WebSphere Commerce and Sterling Order Management.
        General mapping rules
        Each installation of WebSphere Commerce and Sterling Order Management is different. Some assumptions are made about the mapping between the two systems, and these assumptions are reflected in the ValueMaps.xml file, which you can change to suit your particular environment.
        Integration flows
        Integration flows provide mappings between WebSphere Commerce and Sterling Order Management.
        GetCartListToGetOrder request mappings
        The GetCartListToGetCartOrder communication uses the Customer ID (or member ID) from Sterling Call Center to retrieve a list of the customer's active carts in WebSphere Commerce. The SCWC_SDF_GetCartList service fetches the list of active carts, and if there are multiple active carts, the SCWC_SDF_GetCartList_Internal service calls the WCGetCartListToSterlingOrderList xsl component to transform the WebSphere Commerce response to the Sterling Order Management getOrderList output format.
        GetCartDetailsToGetOrder request mappings
        The GetCartDetailsToGetOrder communication uses the cart ID in WebSphere Commerce to fetch details about the cart. The SCWC_SDF_GetCartDetails service fetches the cart details and calls the SCWC_SDF_GetCartList_Internal service, which transforms the WebSphere Commerce response to Sterling Order Management getCompleteOrderDetails API output format.
        LockCartToProcessOrder request mappings
        The LockCartToProcessOrder communication checks the cart ID in the order details in WebSphere Commerce to verify that a draft order is created. Draft orders are created and the CREATE_DRAFT_ORDER.ON_SUCCESS event is triggered when the CSR pulls the cart. The event invokes the SCWC_SDF_LockWCShoppingCart service. The service locks the cart in WebSphere Commerce and calls the SCWC_SDF_LockWCShoppingCart_Internal service, which transforms the WebSphere Commerce message into Sterling Order Management format. When a CSR locks a cart, the CSR can work on the cart for the shopper and create an order for the shopper. The shopper cannot work on the cart.
        UnlockCartToProcessOrder request mappings
        The UnlockCartToProcessOrder communication checks the cart ID in the order details in WebSphere Commerce to verify that draft order is canceled or deleted by the CSR. The ORDER_CHANGE.DELETE_ORDER event is invoked when a CSR cancels or deletes a draft order. The event triggers the SCWC_SDF_UnlockWCShoppingCart service, which unlocks the shopper's cart and calls the SCWC_SDF_UnlockWCShoppingCart_Internal service. After the cart is unlocked, the shopper can update the cart. The internal services transforms the WebSphere Commerce message into Sterling Order Management format.
        ChangeOrderOnCancel request mappings
        The changeOrderOnCancel communication maps the cancellation of an order in Sterling Order Management to WebSphere Commerce . When an order is canceled from Sterling Order Management or Sterling Call Center, ChangeOrderOnCancel also updates promotion usage statistics in the WebSphere Commerce Promotion Engine through a call to the CancelPromotionCalUsage service.
        CreateOrderOnSuccess request mappings
        The CreateOrderOnSuccess communication maps the successful creation of an order in Sterling Order Management with WebSphere Commerce. When a shopper submits an order, the order is created in Sterling Order Management through a call to the CreateOrder API. Upon successful creation, the SCWC_SDF_createOrderOnSuccess service creates a message that is then transferred back to WebSphere Commerce. WebSphere Commerce receives the acknowledgment and updates the order status to "Successfully Transferred". This also updates the WebSphere Commerce promotion usage statistics through the FinalizePromotionCalUsage service.
        ChangeOrderOnSuccess request mappings
        When an order is changed from Sterling Order Management or Sterling Call Center, order price and promotion information is retrieved from WebSphere Commerce. The changeOrderOnSuccess event is used to update promotion usage statistics in the WebSphere Commerce Promotion Engine by calling CancelPromotionCalUsage or UpdatePromotionCalUsage.
        ConfirmDraftOrderOnSuccess request mappings
        The ConfirmDraftOrderOnSuccess communication maps a successful draft order creation in Sterling Order Management or Sterling Call Center to WebSphere Commerce. This service is also used to update promotion usage statistics in the WebSphere Commerce Promotion Engine through a call to the FinalizePromotionCalUsage service.
        getCompleteOrderDetails
        The getCompleteOrderDetails communication maps historical order information between Sterling Order Management and WebSphere Commerce. When a shopper wants to view the details of an order that exists in Sterling Order Management, the getCompleteOrderDetails API is called. If the shopper wants to reorder and create a cart that is based on these order details, WebSphere Commerce calls the same API.
        Get inventory availability
        The get inventory availability communication maps the WebSphere Commerce GetInventoryAvailability request to the Sterling Order Management monitorItemAvailability (for an online store call) or findInventory (for a physical store call). It is possible to cache the result, which eliminates a real time call to Sterling Order Management for each inventory check and drastically increases performance.
        getItemPriceUE
        The GetItemPriceUE mappings allow for a Customer Service Representative (CSR) using the Sterling Call Center, the Sterling Store, or other Order Management channel to interface with WebSphere Commerce for pricing requests, coupon validation, or order creation.
        getOrderList
        The GetOrderList mappings allow WebSphere Commerce to return historical order information from Sterling Order Management. When a shopper wants to view a history of orders in the My Account section, WebSphere Commerce returns a consolidated order history list to the shopper. The list includes both orders that were successfully created in Sterling Order Management, and orders that were not successfully created, but whose records are available locally in WebSphere Commerce. WebSphere Commerce uses the Sterling Order Management GetOrderList API to retrieve an order history.
        getOrderPriceUE
        The GetOrderPriceUE mappings allow for orders created in Sterling Order Management or Sterling Call Center to retrieve unit prices, promotion discounts, free gifts, and shipping promotion discount information from WebSphere Commerce.
        getPricingRuleDetailsUE
        The GetPricingRuleDetailsUE mappings are used for Sterling Order Management to retrieve specific promotion details from WebSphere Commerce .
        REAL_TIME_AVAILABILITY_CHANGE event
        The Sterling Order Management Real-Time Availability Monitor (RTAM) uses a time-triggered transaction to detect inventory changes beyond specified levels and triggers a REALTIME_AVAILABILITY_CHANGE event (in and later, the REALTIME_AVAILABILITY_CHANGE_LIST event). This event starts a service that publishes inventory information to the WebSphere Commerce Inventory Cache.
        REAL_TIME_AVAILABILITY_CHANGE_LIST event
        The Sterling Order Management Real-Time Availability Monitor (RTAM) uses a time-triggered transaction to detect inventory changes beyond specified levels and triggers a REALTIME_AVAILABILITY_CHANGE_LIST event. This event starts a service that publishes inventory information to the WebSphere Commerce Inventory Cache.
        Reserve inventory
        The Reserve Inventory communication maps the WebSphere Commerce ProcessInventoryRequirement request to the Sterling Order Management reserveAvailableInventory API call. As both WebSphere Commerce and Sterling Order Management are customizable, assumptions are made with the mapping from one system to the other.
        syncInventory
        If RTAM triggers a REALTIME_AVAILABILITY_CHANGE_LIST event and the inventory push is triggered in Monitor Option 1 or Monitor Option 3 mode, the availability change message from Sterling Order Management is routed to the SyncInventoryAvailability Service and sent to the WebSphere Commerce Inventory service.
        Transfer order
        The transfer order communication maps the WebSphere Commerce ProcessOrder request to the Sterling Order Management createOrder API call. As both WebSphere Commerce and Sterling Order Management are customizable, assumptions are made with the mapping from one system to the other.
        validateCouponUE
        The validateCouponUE mappings allow for validation of coupons between Sterling Order Management and WebSphere Commerce. When a shopper adds a manual coupon from Sterling Call Center, validateCouponUE is implemented to call WebSphere Commerce for validation of entered coupons against their definitions in WebSphere Commerce.
  - IBM MQ
    WebSphere Commerce provides a listener for IBM MQ for inbound requests, and an adapter for IBM MQ for outbound requests, to integrate back-end, and external systems with WebSphere Commerce.
  - Content management integration
    You can integrate WebSphere Commerce with an external content management system through a punch-out window from Management Center and through the web feed utility. You can integrate WebSphere Commerce with IBM Web Content Manager to provide Management Center users the ability to associate IBM Web Content Manager content with WebSphere Commerce objects.
  - Mobile applications that use IBM Worklight
    IBM Worklight is a mobile application platform that you can use to develop cross-platform hybrid applications for the Aurora starter store.
  - Facebook integration
    Facebook integration relies on several Facebook plugins to add the Connect to Facebook, Like, and Send buttons to the Aurora starter store.
  - Analytics for IBM WebSphere Commerce
    WebSphere Commerce provides a framework that you can configure to integrate your store with an external Web analytics solution. This framework includes a tag library that you can use in store page JSP files to provide appropriate analytics information to the external analytics system.
  - IBM Product Recommendations and WebSphere Commerce
    IBM Product Recommendations is an IBM Digital Analytics solution that you can subscribe to that automatically generates personalized product recommendations on the storefront. The recommendations are based on the browsing, shopping, and purchasing behavior of individual customers. If your site is integrated with IBM Digital Analytics, you can display recommendations from IBM Product Recommendations on your store pages.
  - IBM Marketing Center integration
    You can integrate Management Center with IBM Marketing Center, a cloud-based, all-in-one solution that combines customer analytics with real-time marketing. To integrate with IBM Marketing Center, you must configure the WebSphere Commerce biConfig.xml file to enable the integration. You can also configure single-sign on between Management Center and IBM Marketing Center.
  - IBM Digital Data Exchange integration
    To simplify the process of collecting and sending customer shopping behavior data to analytics providers, integrate WebSphere Commerce with IBM Digital Data Exchange (DDX). IBM Digital Data Exchange (DDX) is offered as part of the IBM Digital Analytics solution.
  - Administering IBM Enterprise Marketing Management
    If your site is integrated with IBM Enterprise Marketing Management applications, such IBM Digital Analytics, IBM Product Recommendations, or IBM Marketing Center, you can administer the application features that your site uses. For example, you can administer IBM Digital Analytics based customer segments and import recommendations for IBM Product Recommendations.
  - IBM Dynamic Pricing
    Dynamic Pricing 16.4 is a cloud-based pricing system that analyzes real-time market data to provide suggestions on how merchandisers can react to competitor pricing and shifts in market conditions. Data can be fed to Dynamic Pricing from multiple sources, including WebSphere Commerce. You can configure WebSphere Commerce to export pricing data to Dynamic Pricing for pricing analysis and adjustment. The adjusted pricing data can then be imported from Dynamic Pricing to WebSphere Commerce, so the prices can be propagated to your live store front.
  - Universal Behavior Exchange (UBX) integration
    You can integrate Universal Behavior Exchange (UBX) with WebSphere Commerce so that you can import and export WebSphere Commerce customer segments as UBX audiences between third-party applications.
  - Watson Content Hub integration
    You can integrate Watson Content Hub with WebSphere Commerce, so that you can manage content in Watson Content Hub and then use the content in the Management Center Catalogs tool.
  - Integrating IBM WebSphere ILOG JRules BRMS with WebSphere Commerce for pricing
    IBM WebSphere ILOG JRules BRMS is a business rule management system that allows developers to easily build and deploy rule-based applications that automate fine-grained, variable decisions used by business systems. You can use WebSphere ILOG JRules to build pricing rulesets, and then reference those rulesets from WebSphere Commerce price rules you create in Management Center.
- Administering
- 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

validateCouponUE

The validateCouponUE mappings allow for validation of coupons between Sterling Order Management and WebSphere Commerce. When a shopper adds a manual coupon from Sterling Call Center, validateCouponUE is implemented to call WebSphere Commerce for validation of entered coupons against their definitions in WebSphere Commerce.

**validateCouponUE Request**
validateCouponUE request mapping to ValidatePromoCodeBOD
Sterling Order Management API Path	WebSphere Commerce Path
Coupon / @CouponID	PromoCode / Code
Coupon /@BuyerUserId	PromoCode / BuyerIdentifier / ExternalIdentifier/ Identifier
Coupon /@OrganizationCode	Use ValueMap.xml to convert it to storeId, then put the storeId in the service context data
Coupon / @PricingDate	PromoCode / PricingDate

**validateCouponUE Response**
ValidatePromoCodeBOD response mapping to validateCouponUE
WebSphere Commerce Path	Sterling Order Management API Path
PromoCode / Code	Coupon /@CouponID
PromoCode/ Reason / Valid (true/false)	Coupon /@Valid (Y/N)
PromoCode / Reason / ReasonCode	Use ValueMap.xml to convert it to Coupon / @CouponStatusMsgCode