Ariba Supplier OnRamp 7.1 | webMethods Ariba Supplier OnRamp Documentation | webMethods Ariba Supplier OnRamp Installation and User’s Documentation | The Trading Networks related API | pub.ariba.supplier.tn.guidelines | pub.ariba.supplier.tn.guidelines:MasterAgreementRequestHdlr
 
pub.ariba.supplier.tn.guidelines:MasterAgreementRequestHdlr
WmAribaSupplier. Specification for a MasterAgreementRequest handler service that is invoked by a Trading Networks processing rule.
Input Parameters
bizdoc
Trading Networks document envelope.
sender
Trading Networks sender profile.
receiver
Trading Networks receiver profile.
attachmentWrapperCollection
Collection of attachments attached to OrderRequest.
Output Parameters
cXMLResponse
A cXML OrderResponse or an ErrorResponse that Trading Networks will return.
Usage Notes
When you use Ariba Supplier OnRampto create a MasterAgreementRequest processing rule, a service stub is created with this signature. The service stub will perform some preliminary processing to extract specific MasterAgreementRequest data fields. These fields include all data fields available when you implement a MasterAgreementRequest Handler in the non-Trading Networks package.
The following fields are available for the handler implementation.
Field
Description
MasterAgreementRequest
A record representing the MasterAgreementRequest.
operation
The MasterAgreementRequest operation type.
language
The language encoding specified in the request.
attachmentWrapperCollection
If one or more attachments were sent with this MasterAgreementRequest, the collection object will be present in the pipeline.
Note:Trading Networks does not do anything special with the attachmentWrapperCollection. It is created by the Ariba Supplier OnRamp package and inserted into the pipeline before the Trading Networks service is invoked.
The following data fields are available for your convenience.
Field
Description
ReceiverID
The To credential Identity of the request.
SenderID
The From credential Identity of the request.
cXML_ReceiverIDDomain
The To credential Identity domain.
cXML_SenderIDDomain
The From credential Identity domain.
cXML_MarketplaceSenderID
If specified in the cXML Header, the From credential Identity with type marketplace.
cXML_MarketplaceSenderDomain
If specified in the cXML Header, the From credential Identity domain with type marketplace.
cXML_RoutingAgentID
The Sender credential Identity.
cXML_RoutingAgentDomain
The Sender credential Identity domain.
cXML_AgreementID
The ID of the cXML MasterAgreementRequest.
cXML_AgreementType
The type of the agreement, whether it refers to a value or a quantity.
cXML_AgreementDate
The date on which the agreement is created.
cXML_EffectiveDate
Specifies the date the agreement is available for ordering or releases.
cXML_ExpirationDate
Specifies the date the agreement is no longer available.
bizdoc
The Trading Networks document envelope. Advanced users can use the Trading Networks API to extract data from the bizdoc envelope that is not already extracted for you.
sender
The Trading Networks sender profile. Advanced users can use the Trading Networks API to extract data from the sender profile that is not already extracted for you.
receiver
The Trading Networks receiver profile. Advanced users can use the Trading Networks API to extract data from the receiver profile that is not already extracted for you.
In addition, if you customize the Processing Rule to extract additional fields, those fields will also be available in the pipeline.
In your implementation, you must return a "serviceError" record with a localized error message if there was an error.
The service stub's post processing will create the OrderResponse or ErrorResponse accordingly.
The service stub will also perform all logging functions, if enabled.