Web services tutorials

Web services tutorials introduce the various tasks that are related to creating and customizing web services for WebSphere Commerce applications.


Tutorial	Learning objectives	Description
Tutorial: Creating a WebSphere Commerce web service module (SOI)	After you complete this tutorial, you should be able to complete the following tasks: Use the Java Emitter Template (JET) to generate a WebSphere Commerce service module Create a noun Create a client library and component facade to support operations (verbs) on that noun	In this tutorial you, you are creating a WebSphere Commerce web service module (SOI) with WebSphere Commerce Developer. This tutorial contains two parts: creating a Get TutorialStore web service, and creating a Process TutorialStore web service. You must create the Get TutorialStore web service before you create the Process TutorialStore web service to successfully complete this tutorial.
Tutorial: Creating an inbound Web service using OAGIS	After completing this tutorial, you should be familiar with the following concepts: Web services XML schema OAGIS style Web services After completing this tutorial, you should be able to complete the following tasks: Defining an OAGIS style Web service Calling existing business logic Creating a success confirmation message Creating a custom failure message	In this tutorial, you create an OAGIS style Web service. This Web service creates a customer in WebSphere Commerce with the WebSphere Commerce Web services framework. This tutorial demonstrates the steps involved with defining and registering a new service in WebSphere Commerce and creating the response JSP template for a confirmation response. Note: Creating an inbound Web services with the OAGIS style is supported in WebSphere Commerce Version 7. You are, however, recommended to create your Web services with the SOI style demonstrated in the tutorial: Tutorial: Creating a WebSphere Commerce web service module (SOI).
Tutorial: Creating an outbound web service client	After you complete this tutorial, you should be familiar with the following concepts: Web services XML schema After completed this tutorial, you should be able to complete the following tasks: Create an outbound web service client Integrate an outbound web service with a sample web service which manages users.	In this tutorial, you create the MyCompanyMember outbound web service client. This client integrates WebSphere Commerce with a sample web service which manages users. The MyCompanyMember web service client integrates with the UserRegistrationAdd and UserRegistrationUpdate commands to push new and updated user registration information to the sample system.
Tutorial: Extending an SOI service with UserData	After you complete this tutorial, you should be able to complete the following tasks: Extend nouns by using the `UserData` field to include new information. Use `UserData` to transfer information where it persists to the database. Add support for personalizing products	This tutorial shows you the steps that are involved in extending the OrderItem noun of the Web services architecture to include new information. `UserData` is used to transfer the new Order information from the example Web 2.0 store to WebSphere Commerce where it persists to the database. In this tutorial, you customize the shopping flow to allow the customer the ability to track engraving information for an Order Item. After this customization, a customer can view the options in their shopping cart for any items that can be engraved.
Tutorial: Extending an SOI service with Overlays	After completing this tutorial you should be able to complete the following tasks: Extend nouns using overlays. Use access beans to persist and retrieve data. Add support for personalizing products	In this tutorial you will extend the OrderItem Web services noun to add new information and functionality to your storefront. You will use overlays to transfer order information from your store to your WebSphere Commerce database. This support provides you the functionality of additional input fields for your customers to enter information during the ordering process which you can customize to meet your business needs. Note: Extending BOD services with Overlays is not supported. Instead, you must extend an SOI service with Overlays, as shown in this tutorial.
Tutorial: Creating an Atom feed to display information in a remote widget	After you complete this tutorial, you should be familiar with the following concepts: To understand how to customize the WebSphere Commerce framework that serves Atom feeds from Web services. To understand how your site can use Web service feeds to display store content on external sites, such as social networks.	This tutorial shows you how to customize WebSphere Commerce to use an Atom feed. You can display the information from the feed in a widget that your customers can share to social networks. The widget can contain links to drive traffic from social networks back to your store. By creating this type of Web service feed, you are no longer limited to displaying your information on store pages.
Tutorial: Creating a BOD service module	After completing this tutorial, you should be familiar with the following concepts: The WebSphere Commerce BOD command framework Extension and customization tasks. Logical model definitions. The Java Emitter Template. Service Data Objects. Eclipse Modeling Framework. The Data Service Layer Wizard. The Business Object Mediator. After completing this tutorial, you should be able to perform the following tasks: Create an extended sites store with a custom catalog. Review the Project noun. Customize the physical layer. Generate the base code for your Project service module. Generate Service Data Objects and object-relational metadata. Add language-specific exception messages to the properties files. Import mediators. Configure the data service layer for the Project 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.
Tutorial: Creating a RESTful service and customizing the response format output	In Section 1, you customize the create and test REST services for both the Project and Project Collection nouns. In Section 2, you customize the entity providers to facilitate new custom response formats. This entity provider customization provides you the ability to specify what elements you want returned from each noun and how they appear in the client.	This tutorial demonstrates how to customize and test REST services for Project and Project Collection noun. To customize these REST services, you are also customizing entity providers to facilitate new custom response formats.
Tutorial: Configuring WebSphere Commerce for device detection and redirection to device-specific storefronts	After completing this tutorial, you should be able to perform the following tasks: Update the Struts configuration file to include new actions and new forward mappings to device-specific pages. Create and update SEO patterns. Modify the SEO patterns and parameters of `wcf:url` tags in the storefront, applying the SEO pattern file changes. Propagating SEO pattern changes to storefront customization tasks, including JSP, JSPF, and JavaScript modification.	In this tutorial, you learn how to configure WebSphere Commerce for device detection and redirection to device-specific storefronts.
Tutorial: Customizing outbound order services from WebSphere Commerce to Sterling DOM	After you complete this tutorial, you should be familiar with the following concepts and tasks: This tutorial is designed to show you the steps that are involved in extending the `orderitem` noun part of the web services architecture to include new information. UserData is used to transfer the new Order item information from WebSphere Commerce to Sterling DOM. In this tutorial, you customize the shopping flow to enable the customer to track engraving information for an Order Item, and customize the order integration flow to pass engraving information to Sterling DOM for an order item. After this customization, a customer can see the options in their shopping cart for any items that can be engraved before they check out. After inputting engraving information and submitting the order, a CSR can see the engraving information when you view the order details in Sterling DOM. For example, wine glasses can contain the options for text to be engraved with selected sizes and fonts for the text.	This tutorial demonstrates how to customize the WebSphere Commerce order component to support customization of the OrderItem noun part by using UserData information. This customization enables WebSphere Commerce to capture custom order user data and transfer it to Sterling DOM as part of the transfer order integration flow.
Tutorial: Creating and customizing REST services by using the configuration-based controller command and data bean mapping framework	After completing this tutorial, you should be able to complete the following tasks: Create a REST handler for mapping the custom data bean and controller command Customize an existing configuration-based data bean mapping to return more data The first part of this tutorial uses the sample data bean and controller command that you imported from the sample code. From the sample, create your own mapping configuration files and REST resource handler to make the rest calls to the sample data bean and controller command. The second part of the tutorial takes the default RequisitionListDataBean as an example, and shows how to customize an existing configuration-based data bean mapping to return more data. Note: This tutorial uses the Derby database.	In this tutorial, you use the configuration-based controller command and data bean mapping framework to add support for creating REST services.