Creating OrderRequest Handler Services
An OrderRequest handler is invoked with an OrderRequest record argument that represents the actual received message. The OrderRequest handler may also have as an input parameter an attachmentWrapperCollection object, which contains one or more attachment documents that were sent with the OrderRequest. The OrderRequest handler is also invoked with an operation argument that represents the OrderRequest operation that is being requested (new, update, delete).
The OrderRequest must return a status in its serviceError output parameter: If an error was encountered while processing the OrderRequest, the serviceError must be set to indicate the error. If no error was set, the Ariba Supplier OnRamp core returns a successful OrderResponse. However, the OrderResponse does not indicate an order fulfillment. It only indicates that the OrderRequest was successfully received, and that the request is being processed. This is a limitation of the cXML 1.2 framework, not a limitation of Ariba Supplier OnRamp.
Note:
You may choose not to implement the update or delete operations. The cXML document receive service receiveCXML will report unimplemented operations to the buyer's Ariba Buyer with an error status in the OrderResponse.
To create an OrderRequest 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:OrderRequestHdlr. In addition, it registers the service internally so that when
receiveCXML receives an OrderRequest with the specified operation type, the handler service will be invoked.
To create an OrderRequest handler service
1. In the Ariba Supplier OnRamp Configuration screen., click the Add Handler button in the cXML Request Document Handling section of the page. The Handler Configuration screen appears.
2. Complete the following fields and click the Submit button:
In this field… | Specify… |
cXML Document Type | Select OrderRequest. |
Operation / Sub Type | Select new, update, 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 an OrderRequest 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. |