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.
Developing
The topics in the Developing section describe tasks performed by an application developer.
Web services and WebSphere Commerce
A web service is an interface that describes a collection of operations that are accessible through the network by using standardized XML messaging.
WebSphere Commerce Web services with JSP pages
A Web service is an interface that describes a collection of operations that are accessible through the network by using standardized XML messaging. A Web service is described using a standard, formal XML notation, called a service description. The service description includes all the details necessary to interact with the service, including its message formats (that detail the operations), transport protocols, and location. The interface hides the implementation details of the service, allowing it to be used independently of the hardware or software platform on which it is implemented and also independently of the programming language in which it is written. The foundation for Web services are standards such as simple object access protocol (SOAP), the Web Services Description Language (WSDL), and the Universal Description, Discovery, and Integration (UDDI) registry.
Understanding the WebSphere Commerce Web service framework
The goals of the WebSphere Commerce Web service framework are:
WebSphere Commerce as a service consumer
WebSphere Commerce provides features and integration scenarios that enable WebSphere Commerce to act as a service consumer, especially with order management systems (OMS) and enterprise resource planning systems (ERP).
Deprecated feature: Outbound service interfaces
WebSphere Commerce provides the capability of integrating with external systems by calling their web services. Integration code is provided to support integration scenarios with Enterprise Resource Planning (ERP) systems and Order Management Systems (OMS). Each service interface is described in terms of a request, response, message type, task command, and usage scenario:

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
- 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.
  - Functional architecture
    Functional architecture provides both the set of patterns used to implement the business functionality and the frameworks in which these business functions execute.
  - Persistent object model
    WebSphere Commerce deals with a large amount of persistent data. There are numerous tables defined in the current database schema. Even with this extensive schema, however, you might need to extend or customize the database schema for your particular business needs.
  - Presentation layer
    WebSphere Commerce uses Java Server Pages (JSP) to implement the view layer of the Model-View-Controller (MVC) design pattern. The view layer is in charge of retrieving data from the database through the use of data beans and formatting it to meet the display requirements. The view layers determines whether the request is sent to a browser or streamed out as XML. JSP files present a clean separation between data content and presentation.
  - Controller layer
    The Controller layer is the conductor of operations for a request. It controls the transaction scope and manages the session related information for the request. The controller first dispatches to a command and then calls the appropriate view processing logic to render the response.
  - Business logic layer
    The business logic layer is the business components that provide OAGIS services to return data or start business processes. The presentation layer uses these OAGIS services to display data, or to invoke a business process. The business logic provides data required by the presentation layer. The business logic layer exists because more than just fetching and updating data is required by an application; there is also additional business logic independent of the presentation layer.
  - Persistence layer
    The interaction between the business objects and persistence layer is isolated in an object called the Business Object Mediator. Business object document (BOD) commands interact with the Business Object Mediator to handle the interaction with the logical objects and how they are persisted.
  - Business model information model
    A business model, a representation of the business processes used throughout the site, provides a sample commerce solution which includes an organization structure, default user roles and access control policies, one or more starter stores, administration tools, and business processes that demonstrate best practices. A business model can be customized to support business requirements and scenarios. WebSphere Commerce provides sample business models that show some common commerce solutions. These business models are created by setting up an organization hierarchy structure, access control policies, stores, and contracts that help satisfy the necessary business requirements.
  - Business models
    Before starting to develop your site with WebSphere Commerce, you need to determine the business model supported by WebSphere Commerce that best represents the purpose of your site. Usually sites created with WebSphere Commerce will be implemented based on of one of these business models.
  - Store data information model
    Store data is the information that is loaded into the WebSphere Commerce Server database, which allows your store to function. The URL Registry Entries and View Registry Entries packages are included in the diagram, but they are not database assets. These entries are presentation configuration (that is, struts actions and forwards) that must be deployed. URL registry entries are shown in the diagram to illustrate the entire store data information model. To operate properly, a store must have the data in place to support all customer activities. For example, in order for a customer to make a purchase, your store must contain a catalog of goods for sale (catalog data), the data associated with processing orders (tax and shipping data), and the inventory to fulfill the request (inventory and fulfillment data).
  - Customizing WebSphere Commerce
    You can extend the WebSphere Commerce product to fit your business needs. This topic describes the prerequisite skills and required knowledge that you need to customize business logic. After you have the required knowledge, use WebSphere Commerce Developer to take tutorials that guide you step-by-step through various customization scenarios.
  - WebSphere Commerce development environment
    WebSphere Commerce Developer is the development toolkit for customizing a WebSphere Commerce application.
  - Web services and WebSphere Commerce
    A web service is an interface that describes a collection of operations that are accessible through the network by using standardized XML messaging.
    - Working with WebSphere Commerce SOI services
      Working with WebSphere Commerce services involves developing client libraries, new commands, and business logic. The Java Emitter Template (JET) is documented to assist you with these tasks.
    - Creating WebSphere Commerce services
      Creating WebSphere Commerce services involves setting up the development environment, creating and extending client libraries, and setting an EMF genmodel. The Java Emitter Template (JET) is provided and documented to assist you with these tasks.
    - WebSphere Commerce BOD command framework
      Starting in WebSphere Commerce Version 6 Feature Pack 3.0.1, WebSphere Commerce introduces the Business Object Document (BOD) command framework. The BOD command framework is a command framework for the business logic layer, used in WebSphere Commerce Version 6 Feature Pack 3.0.1 and WebSphere Commerce Version 7. The concept of a BOD has been used in prior versions of WebSphere Commerce, but in WebSphere Commerce Version 6 Feature Pack 3.0.1, WebSphere Commerce Version 7, and WebSphere Commerce Version 8, the entire command framework is tailored to using BODs.
    - Developing the business logic layer using the BOD command framework
      Business layer can be designed and programmed using the BOD programming model introduced in WebSphere Commerce Version 6 Feature Pack 3.0.1. This command framework revolves around using Business Object Documents, and the Java representation of those objects, logical service data objects.
    - WebSphere Commerce BOD command framework
      Starting in WebSphere Commerce Version 6 Feature Pack 3.0.1, WebSphere Commerce introduces the Business Object Document (BOD) command framework. The BOD command framework is a command framework for the business logic layer, used in WebSphere Commerce Version 6 Feature Pack 3.0.1 and WebSphere Commerce Version 7. The concept of a BOD has been used in prior versions of WebSphere Commerce, but in WebSphere Commerce Version 6 Feature Pack 3.0.1, WebSphere Commerce Version 7, and WebSphere Commerce Version 8, the entire command framework is tailored to using BODs.
    - Data service layer
      The data service layer (DSL) provides an abstraction layer for data access that is independent of the physical schema.
    - Using the data service layer
      You can customize the data service layer to create and modify schemas and queries.
    - WebSphere Commerce use of Open Applications Group (OAGIS) messaging
      WebSphere Commerce service interfaces are defined using the OAGIS message structure, from The Open Applications Group.
    - WebSphere Commerce Web services with JSP pages
      A Web service is an interface that describes a collection of operations that are accessible through the network by using standardized XML messaging. A Web service is described using a standard, formal XML notation, called a service description. The service description includes all the details necessary to interact with the service, including its message formats (that detail the operations), transport protocols, and location. The interface hides the implementation details of the service, allowing it to be used independently of the hardware or software platform on which it is implemented and also independently of the programming language in which it is written. The foundation for Web services are standards such as simple object access protocol (SOAP), the Web Services Description Language (WSDL), and the Universal Description, Discovery, and Integration (UDDI) registry.
      - Understanding the WebSphere Commerce Web service framework
        The goals of the WebSphere Commerce Web service framework are:
        WebSphere Commerce as a service provider
        When you enable business operations in WebSphere Commerce as Web services that can be accessed by external systems, WebSphere Commerce becomes the service provider.
        WebSphere Commerce as a service consumer
        WebSphere Commerce provides features and integration scenarios that enable WebSphere Commerce to act as a service consumer, especially with order management systems (OMS) and enterprise resource planning systems (ERP).
        Enabling WebSphere Commerce as a service consumer
        WebSphere Commerce can consume a business operation defined by an external system as a Web service. In this scenario, WebSphere Commerce acts as the service consumer to an external system.
        Customizing existing outbound service requests
        With WebSphere Commerce, you can customize the existing outbound service requests, such as extending them to include additional user data.
        Creating a Web service client API for WebSphere Commerce
        For each component that is to consume external Web services, a client API is required to construct different request messages and then call the invocation service. The client API is essentially a Java utility class that contains construction code to create the appropriate message and send it. No business logic is performed in the client API.
        Customizing the Web service client invocation XML file
        When WebSphere Commerce acts as a service consumer, a component client API will be called from your task command. The client API will use the invocation service and the invocation service will require a deployed configuration file to determine how to communicate with the remote component. Each component has a separate configuration file to configure the client API. Each store can also have a version of the configuration file that will take precedence over the default configuration. This allows the store to override some or the entire configuration without changing the default configuration.
        Service-oriented outbound integration points
        Outbound service requests map to message types, and APIs invoked on the service provider.
        Deprecated feature: Outbound service interfaces
        WebSphere Commerce provides the capability of integrating with external systems by calling their web services. Integration code is provided to support integration scenarios with Enterprise Resource Planning (ERP) systems and Order Management Systems (OMS). Each service interface is described in terms of a request, response, message type, task command, and usage scenario:
        Deprecated feature: Check or reserve or cancel order inventory
        The CheckOrderInventory outbound service interface is used to check the inventory availability of an order on an external system if the information is not cached by the local inventory cache. The ReserveOrderInventory outbound service interface is used to update the inventory reservation of an order on an external system. The CancelOrderInventory outbound service interface is used to cancel the inventory reservation of an order on an external system.
        Create/Update Organization
        The CreateOrganization outbound service interface is used to notify an external system of the creation or registration of an organization, whereas the UpdateOrganization outbound service interface is used to notify an external system of the update of an organization.
        Deprecated feature: Get Order
        The GetOrder outbound service interface is used to retrieve order statuses from an external system.
        Get Product Availability
        The GetProductAvailability outbound service interface is used to retrieve the availability of a product from an external system when the information is not cached by the local inventory cache.
        Deprecated feature: Transfer order
        The TransferOrder outbound service interface is used to transfer an order to an external system.
        Enabling JMS for Web services
        JMS support for Web services is not enabled when WebSphere Commerce is installed. This is because the JMS resources are required to be set up or the WebSphere Commerce Server will report errors during start up. Enabling Web service over JMS support involves defining the JMS resources, defining a Messaging Listener Port, and deploying a Message Driven Bean.
        Enabling a JMS router for an existing component
        You can enable a JMS router for an existing WebSphere Commerce component.
        WebSphere Commerce use of Open Applications Group (OAGIS) messaging
        WebSphere Commerce service interfaces are defined using the OAGIS message structure, from The Open Applications Group.
      - Configuring WebSphere Commerce Developer for Web service development
        WebSphere Commerce Developer supports Web service development. The WebSphere Commerce Developer tools handle much of the complexity of Web service development, enabling you to focus on the complexity of the business process.
    - WebSphere Commerce foundation tag library
      The WebSphere Commerce foundation JSTL tag library is a collection of custom tags that are provided to you to support the authoring of WebSphere Commerce JSP files. WebSphere Commerce stater stores use the JavaServer Pages Standard Tag Library (JSTL) to perform logic, instead of Java code. At the same time, business logic is moved into data beans. The combination of these steps allows for less Java code in a JSP page.
    - Workspaces support for BOD service modules
      There are two user interfaces that use workspaces in WebSphere Commerce, WebSphere Commerce Accelerator, and Management Center. The Management Center uses Get services from BOD service modules to retrieve many of its business objects, and along with the business objects, change control metadata is also included in the response. The change control metadata is returned to the Management Center, where it is used to determine whether the object can be modified by the current user.
    - Representational State Transfer (REST) services
      WebSphere Commerce uses Representational State Transfer (REST) services to provide a framework that can be used to develop RESTful applications on several platforms. These platforms can include web, mobile, kiosks, and social applications.
    - Location-based services
      WebSphere Commerce uses location-based services to target customers using Global Positioning System (GPS)-enabled mobile devices.
  - WebSphere Commerce Search
    WebSphere Commerce comes with a powerful and fully integrated search function. The search functions in WebSphere Commerce provide an enriched customer experience, with features such as automatic search term suggestions and spelling correction. Since it is built on open standards, WebSphere Commerce Search is highly flexible and extensible. Starter stores can use the search engine's most sophisticated features without requiring extra customization. A key feature of Search is that sales personnel can create and manage search term associations, and search-based merchandising rules, from within the Management Center and Store view.
- 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

Deprecated feature: Outbound service interfaces

WebSphere Commerce provides the capability of integrating with external systems by calling their web services. Integration code is provided to support integration scenarios with Enterprise Resource Planning (ERP) systems and Order Management Systems (OMS). Each service interface is described in terms of a request, response, message type, task command, and usage scenario:

Deprecated: The integration service interfaces documented in this topic are deprecated. Use the Distributed Order Management (DOM) integration service interfaces.