Tutorial: Creating an inbound Web service using OAGIS

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).

In this tutorial, you are creating a sample Web service, called SyncCustomer. This service follows the XML schema conventions set by OAGIS (http://www.openapplications.org) but does not use the OAGIS schema elements for simplicity. This service defines an XML schema that represents an existing business logic operation of registering a new user (UserRegistrationAdd). At the end of this tutorial, you have a Web service that can be used by external applications to create users in WebSphere Commerce.

Learning objectives

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

Time required

Expect this tutorial to take about 3 hours to complete. The tutorial takes longer if you explore concepts related to this tutorial.

Skill level

This tutorial is intended for WebSphere Commerce developers who is responsible for developing Web services. To complete this tutorial, ensure that you are familiar with the following terms and concepts:

System requirements

Before beginning this tutorial, ensure that you complete the following tasks:

Tutorial resources

To complete this tutorial, the following resources are used. Ensure that you download and extract the following compressed file. This file contains the code you use to test your customization. Download and extract this file to a temporary directory, such as C:\Temp before beginning this tutorial: