Creating PunchOutSetupRequest Handler Services
A PunchOutSetupRequest handler service is invoked with a PunchOutSetupRequest record argument that represents the actual received message. The PunchOutSetupRequest handler is also invoked with an operation argument that represents the PunchOutSetupRequest operation that is being requested (create, inspect, or edit). Depending on the operation being requested, the PunchOutSetupRequest handler must return a catalogURL that represents one of the following:
For the create operation: a URL to the supplier's catalog, where the buyer can begin shopping for the first time.
For the inspect operation: a URL to the supplier's catalog, where the buyer can view his or her existing shopping selections.
For the edit operation: a URL to the supplier's catalog, where the buyer can edit his or her shopping selections.
Note:
You may choose not to implement inspect and edit operations. The document receive service receiveCXML reports unimplemented operations to the buyer's Ariba Buyer with an error status in the PunchOutSetupResponse.
The detailed implementation of a PunchOutSetupRequest handler depends on the supplier's systems and resources. Each supplier may have different shopping cart systems, application servers, web servers, and ordering systems. The handler must set up resources for a shopping session and return a URL for a buyer to shop online.
To create a PunchOutSetupRequest handler service, you specify a service name for the handler and the operation for which the handler is used.
Ariba Supplier OnRamp automatically generates a service template for you, with the specification specified in
wm.b2b.cxml.guidelines:PunchOutSetupRqstHdlr. In addition,
Ariba Supplier OnRamp registers the service internally so that when
receiveCXML receives a PunchOutSetupRequest with the specified operation type, the handler service will be invoked.
To create a PunchOutSetupRequest handler service
1. In the Ariba Supplier OnRamp Configuration screen, click the Add Handler button in the cXML Request Document Handlingsection of the page. The Handler Configurationscreen appears.
2. Complete the following fields and click the Submit button:
In this field… | Specify… |
cXML Document Type | Select PunchOutSetupRequest. |
Operation / Sub Type | Select create, edit, or inspect. Select any if you want the handler to apply to all operations. If you select the operation type any, the handler behaves like a default handler. That is, the handler is invoked only if a PunchOutSetupRequest arrives with an operation type for which no handler is registered. If a handler is registered for a specific operation type, that handler is invoked instead of the default handler. |
Service Name | The name of the service to be created for the handler. Type the name in the following format: folderName:serviceName
If the service name already exists, the existing service will not be overwritten. Ariba Supplier OnRamp will register the existing service internally to handle the selected operation type. |
Package Name | The name of the package in which the service is created. |