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.
Tutorials
WebSphere Commerce provides many tutorials to help you customize and understand your WebSphere Commerce instance and stores.
Web services
Web services tutorials introduce the various tasks that are related to creating and customizing web services for WebSphere Commerce applications.
Creating and customizing REST services by using the configuration-based controller command and data bean mapping framework
In this tutorial, you use the configuration-based controller command and data bean mapping framework to add support for creating REST services.
Summary: Creating and customizing REST services by using the configuration-based controller command and data bean mapping framework
In this tutorial, you created a REST handler for mapping the custom data bean and controller command, and customized an existing configuration-based data bean mapping to return more data.

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.
  - Programming model
    WebSphere Commerce provides tutorials that are designed to introduce the various tasks that are related to creating customized code to develop and enhance WebSphere Commerce applications. The following tutorials provide sample guides to customizing elements of the WebSphere Commerce programming model.
  - Web services
    Web services tutorials introduce the various tasks that are related to creating and customizing web services for WebSphere Commerce applications.
    - Creating and customizing REST services by using the configuration-based controller command and data bean mapping framework
      In this tutorial, you use the configuration-based controller command and data bean mapping framework to add support for creating REST services.
      - Preparing the sample data bean and controller command
        In this lesson, you create a sample table, database, and controller command. These samples act a placeholder for your own data beans and controller commands, and serve as an illustration of the REST mapping method.
      - Generating the configuration-based mapping files by using the REST mapping command
        In this lesson, you use a utility to generate the XML mapping files for your sample data bean and controller command.
      - Creating custom REST resource handler to perform mapping
        In this lesson, you learn how to create your own REST resource handler for your sample data bean and controller command. A REST call requires the creation of a resource handler. The resource handler represents the entry point for resource requests and is annotated with the @Path, context, and other information that is required to handle a request. Handlers are responsible for coordinating the client request. Handlers intercept calls, run required actions, and convert responses to a form consumable by the client by using standard HTTP protocol elements.
      - Verifying your new REST service call by using the Poster browser plug-in
        In this lesson, you verify the new REST calls to the sample data beans and controller commands with the Poster browser plug-in.
      - Customizing an existing configuration-based data bean mapping to return more data
        In this lesson, you customize an existing configuration-based data bean mapping to return extra requisition list data. By default, WebSphere Commerce uses REST calls for some beans and commands. Configured with mapping profiles, REST calls map REST input parameters to bean or command setter-methods, and bean/command getter-methods to REST output parameters. In some situations, customers might want to use the default REST beans or commands, but want an augmented set of response data. The configuration-based command and data bean mapping framework allows customizations where one REST mapping profile can extend another. For example, RequisitionListDataBean can be customized to return extra data and to install customizations.
      - Verifying your customized REST service call by using the Poster browser plug-in
        In this lesson, you verify the customized REST calls to the sample data beans and controller commands with the Poster browser plug-in.
      - Customizing the store widget to use the additional data
        In this lesson, you learn how to customize the store widget to use the new data that is returned by the custom profile that you created in the previous lesson.
      - Verifying the store widget customization in the storefront
        In this lesson, you verify the customization that you made to the widget in the storefront in the previous lesson.
      - Annotating your REST resource handler API to use the Swagger user interface
        In this lesson, you learn how to annotate your custom REST handler (created in the previous lesson) to expose the API documentation through the Swagger user interface (UI).
      - Verify your custom REST resource handler API through the Swagger user interface
        In this lesson, you use the Swagger user interface to view interactive documentation of your REST API.
      - Summary: Creating and customizing REST services by using the configuration-based controller command and data bean mapping framework
        In this tutorial, you created a REST handler for mapping the custom data bean and controller command, and customized an existing configuration-based data bean mapping to return more data.
    - Creating a BOD service module
      In this tutorial, you develop a project service module. The services that are provided by the module are: Get, Change, and Process. As part of creating the service module, you design the logical model (noun) and physical model (database schema) based on the business requirement.
  - Management Center
    WebSphere Commerce provides tutorials that are designed to introduce the various tasks that are related to customizing Management Center.
  - WebSphere Commerce search
    WebSphere Commerce provides tutorials that are designed to describe how to customize WebSphere Commerce search.
  - Starter stores
    WebSphere Commerce provides tutorials that are designed to introduce the various tasks that are related to customizing the storefront.
- 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

Summary: Creating and customizing REST services by using the configuration-based controller command and data bean mapping framework

In this tutorial, you created a REST handler for mapping the custom data bean and controller command, and customized an existing configuration-based data bean mapping to return more data.

Summary

In the first part of this tutorial, by using the sample data bean and controller command, you created your own mapping configuration files and REST resource handler. The REST resource handler makes the REST calls to the sample data bean and controller command. In the second part of the tutorial, by using the example of the default RequisitionListDataBean, you customized an existing configuration-based data bean mapping to return more data.

In the final section of the tutorial, you annotated your custom REST handler, which enabled Swagger to display the available REST API.

Lessons Learned

You learned about the following concepts and tasks:

Web service
REST service
Widgets definition
SQL
XML
XPath
Rational Application Developer
JSP/JSPF
Java
REST mapping command (restClassicSampleGen.bat)