•  IBM webMethods Adapter for Ariba Supplier OnRamp Documentation
  •  About This Help
    • Document Conventions
  •  webMethods Ariba Supplier OnRamp Installation and User’s Documentation
    •  Concepts
      •  What is IBM webMethods Adapter for Ariba Supplier OnRamp?
        • What is cXML?
        •  What does Ariba Supplier OnRamp Adapter Provide?
          • IBM webMethods B2B Trading Networks Support
          • Logging Support
          • Document Storage Support
          • Message Testing Support
          • Transaction Authentication
      • Ariba Supplier OnRamp Adapter Packages
      •  Architecture and Components
        •  The Document Receiver Service: receiveCXML
          • Parsing cXML Documents
          • Parsing Multipart MIME Messages
          • Initiating Request Message Processing
        • The Message Module
        • The Configuration Module
        • The Logging/Document Store Module
        • The Event Module
        • The Error Module
        • The Test Module
      •  cXML Document Processing without Trading Networks
        •  PunchOutSetupRequest Processing
          • The PunchOutSetupRequest Handler
        •  OrderRequest Processing
          • The OrderRequest Handler
        •  ProfileRequest Processing
          • The ProfileRequest Handler
        •  MasterAgreementRequest Processing
          • The MasterAgreementRequest Handler
        • InvoiceDetailRequest Processing
        • Configuring the URL for InvoiceDetailRequest
      • cXML Document Processing with Trading Networks
      •  Configuring Ariba Supplier Network
        • Configuring Punchout Catalog Links on Ariba SN
        • Configuring cXML OrderRouting on Ariba SN
    •  Installing Ariba Supplier OnRamp Adapter
      • Overview
      • Requirements
      • Installing Ariba Supplier OnRamp Adapter
      • Upgrading to Ariba Supplier OnRamp Adapter 7.1
      • Uninstalling Ariba Supplier OnRamp Adapter 7.1
    •  Implementing a Punchout Ordering System with Trading Networks
      • Introduction
      • Opening the Ariba Supplier OnRamp Adapter Configuration Screen
      • Accessing the Trading Networks Configuration Page
      • Adding Default ProfileRequest Processing Rules
      •  Installing cXML Document Attributes and Document Types in Trading Networks
        • Initializing the cXML Document Attributes and Document Types
      • Creating PunchOutSetupRequest Processing Rules
      • Creating OrderRequest Processing Rules
      • Creating MasterAgreementRequest Processing Rules
      • Creating InvoiceDetailRequest Processing Rules
      •  Mapping PunchOutOrderMessages
        • Methods of Mapping PunchOutOrderMessages
        •  Passing Shopping Cart Data Using the Client API
          • Creating PunchOutOrderMessage Mapping Services
          • Using Generated PunchOutOrderMessage Handler Services with the Client API
          • Passing in an HTML Template
        •  Passing Shopping Cart Data Using HTTP Form Posting
          • Using Generated Mapping Services with the HTTP Form Post
          • Passing in an HTML Template
        • Correlating OrderRequests with PunchOutOrderMessages
      • Configuring cXML Document Receive Service Parameters
      •  Configuring cXML Message Parameters
        • Specifying Services for Generating PayloadIDs
    •  Implementing a Punchout Ordering System without Trading Networks
      • Introduction
      • Opening the Ariba Supplier OnRamp Adapter Configuration Screen
      • Configuring cXML Document Receive Service Parameters
      • Configuring cXML InvoiceDetailRequest Parameters
      •  Creating PunchOutSetupRequest Handlers
        • Creating PunchOutSetupRequest Handler Services
        • Implementing PunchOutSetupRequest Handler Services
      •  Creating OrderRequest Handlers
        • Creating OrderRequest Handler Services
        • Implementing OrderRequest Handler Services
      •  Creating MasterAgreementRequest Handlers
        • Creating MasterAgreementRequest Handler Services
        • Implementing MasterAgreementRequest Handler Services
      • Setting the Default ProfileRequest Handler
      •  Mapping PunchOutOrderMessages
        • Methods of Mapping PunchOutOrderMessages
        •  Passing Shopping Cart Data Using the Client API
          • Creating PunchOutOrderMessage Mapping Services
          • Using Generated PunchOutOrderMessage Handler Services with the Client API
          • Passing in an HTML Template
        •  Passing Shopping Cart Data Using HTTP Form Posting
          • Using Generated Mapping Services with the HTTP Form Post
          • Passing in an HTML Template
        • Correlating OrderRequests with PunchOutOrderMessages
      •  Configuring cXML Message Parameters
        • Specifying Services for Generating PayloadIDs
    •  Listening to and Processing Punchout Process Events
      • Overview
      • Creating Custom Event Services for Punchout Processing
    •  Using the Logging Facility
      •  Introduction
        • Message Categories and Log Entry Types
        • Log Messages Created by Ariba Supplier OnRamp Adapter
        • Additional Log Entries
        • Log Message Storage
      • Enabling Logging
      • Using the Logging APIs
      • Viewing Log Entries
      •  Storing OrderRequest Messages
        • Configuring the Document Store for NonTrading Networks-Enabled Systems
        • Configuring the Document Store for Trading Networks-Enabled Systems
    •  Using the Test Module
      • Overview
      • Testing Messages Stored in Files
      • Testing ProfileRequests
      • Testing PunchOutSetupRequests
      • Testing OrderRequests
      • Testing MasterAgreementRequests
      • Testing InvoiceDetailRequests
    •  Development Utilities
      • Using the Error Utility
      •  Using the Persistence Utility
        • Storing Data in the webMethods Server Session Object
        • Storing Data in External Data Stores
      •  Using the Attachment Utility
        •  Working with the attachmentWrapperCollection Object
          • To Get the Number of Attachments in the Collection
          • To Get a Specific attachmentWrapper from the Collection
          • To Retrieve the attachmentWrapper from the Collection by ID
          • To Loop Through the attachmentWrapperCollection
        • Working with the attachmentWrapper Object
    •  Using Transaction Authentication
      • Overview
      •  Configuring Digital Signature Validation
        • Disabling Digital Signature Validation
      • Configuring Shared Secret Validation
      • Removing the Identity for Shared Secret Validation
      • Disabling Default Shared Secret Validation
    •  Running the Example Punchout Site
      • Overview
      •  Simulated Behaviors
        • The Simulated Shopping Cart System
        • wm.b2b.cxml.example.snowboardSupplier.messageHandlers: shoppingCartToCXMLItemList
        • wm.b2b.cxml.example.snowboardSupplier.shoppingcart:additem
        • wm.b2b.cxml.example.snowboardSupplier.shoppingcart: clearShoppingCart
        • wm.b2b.cxml.example.snowboardSupplier.shoppingcart: computeCartTotalCost
        • wm.b2b.cxml.example.snowboardSupplier.shoppingcart: computeCartTotalTax
        • wm.b2b.cxml.example.snowboardSupplier.shoppingcart: getPunchOutOrderMessageFromCart
        • wm.b2b.cxml.example.snowboardSupplier.shoppingcart: getShoppingCart
        • The Simulated Web Pages
        • wm.b2b.cxml.example.snowboardSupplier:checkout
        • wm.b2b.cxml.example.snowboardSupplier:startpage
        • wm.b2b.cxml.example.snowboardSupplier.catalog:listItems
      •  The Configuration of the Example Punchout Site
        • The PunchOutSetupRequest Handler
        • The Registration of the PunchOutSetupRequest Handler
        • The OrderRequest Handler
        • The Registration of the OrderRequest Handler
        • The PunchOutOrderMessage Mapping Service
      • Running the Example Site Using the Simulated Order Management System
      • Running the Example Site Using a Test Ariba Buyer
    •  The pub.ariba.supplier Folder in the WmAribaSupplier Package
      • Overview
      •  pub.ariba.supplier.attachment
        • pub.ariba.supplier.attachment:AttachmentInfo
        • pub.ariba.supplier.attachment:getContentFromWrapper
        • pub.ariba.supplier.attachment:getIDFromComment
        • pub.ariba.supplier.attachment:getInfoFromWrapper
      •  pub.ariba.supplier.attachment.collection
        • pub.ariba.supplier.attachment.collection:getCollectionSize
        • pub.ariba.supplier.attachment.collection:getWrapperFromCollection
        • pub.ariba.supplier.attachment.collection:getWrapperList
      •  pub.ariba.supplier.attachment.collection.iterator
        • pub.ariba.supplier.attachment.collection.iterator:getIterator
        • pub.ariba.supplier.attachment.iterator:getNextWrapperFromIterator
        • pub.ariba.supplier.attachment.collection.iterator:iteratorHasMoreWrappers
      •  pub.ariba.supplier.cxml
        • pub.ariba.supplier.cxml:checkCredentialDigitalSignature
        • pub.ariba.supplier.cxml:checkCredentialSharedSecret
        • pub.ariba.supplier.cxml:checkDocumentDigitalSignature
        • pub.ariba.supplier.cxml:checkDocumentSharedSecret
        • pub.ariba.supplier.cxml:createNewPayloadID
        • pub.ariba.supplier.cxml.spec:createPayloadIDSpec
      •  pub.ariba.supplier.docstore
        • pub.ariba.supplier.docstore:removeOrder
        • pub.ariba.supplier.docstore:retrieveAllAttachments
        • pub.ariba.supplier.docstore:retrieveAttachment
        • pub.ariba.supplier.docstore:retrieveOrder
        • pub.ariba.supplier.docstore:saveOrder
      •  pub.ariba.supplier.docstore.spec
        • pub.ariba.supplier.docstore.spec:removeOrderSpec
        • pub.ariba.supplier.docstore.spec:retrieveAllAttachmentsSpec
        • pub.ariba.supplier.docstore.spec:retrieveAttachmentSpec
        • pub.ariba.supplier.docstore.spec:retrieveOrderSpec
        • pub.ariba.supplier.docstore.spec:saveOrderSpec
      •  pub.ariba.supplier.events.spec
        • pub.ariba.supplier.events.spec:InvoiceDetailResponseReceivedSpec
        • pub.ariba.supplier.events.spec:MasterAgreementRequestFailureSpec
        • pub.ariba.supplier.events.spec:MasterAgreementRequestReceivedSpec
        • pub.ariba.supplier.events.spec:OrderRequestFailureSpec
        • pub.ariba.supplier.events.spec:OrderRequestReceivedSpec
        • pub.ariba.supplier.events.spec:OrderResponseSentSpec
        • pub.ariba.supplier.events.spec:SetupRequestFailureSpec
        • pub.ariba.supplier.events.spec:SetupRequestReceivedSpec
        • pub.ariba.supplier.events.spec:SetupResponseSentSpec
      •  pub.ariba.supplier.handlerImpl
        • pub.ariba.supplier.handlerImpl:defaultProfileRequestHandler
      •  pub.ariba.supplier.log.spec
        • pub.ariba.supplier.log.spec:GetLogEntriesSpec
        • pub.ariba.supplier.log.spec:GetLogFilesSpec
        • pub.ariba.supplier.log.spec:LogEventSpec
        • pub.ariba.supplier.log.spec:LogInvoiceDetailEventSpec
        • pub.ariba.supplier.log.spec:LogMasterAgreementEventSpec
        • pub.ariba.supplier.log.spec:LogOrderEventSpec
        • pub.ariba.supplier.log.spec:LogPunchOutSetupEventSpec
        • pub.ariba.supplier.log.spec:InvoiceLogEntry
        • pub.ariba.supplier.log.spec:LogEntry
        • pub.ariba.supplier.log.spec:MasterAgreementLogEntry
        • pub.ariba.supplier.log.spec:OrderLogEntry
        • pub.ariba.supplier.log.spec:SetupLogEntry
      •  pub.ariba.supplier.log.utils
        • pub.ariba.supplier.log.utils:copyLogFieldsToLogEntry
        • pub.ariba.supplier.log.utils:CreateInvoiceLogEntryRecord
        • pub.ariba.supplier.log.utils:createLogEntryRecord
        • pub.ariba.supplier.log.utils:CreateMasterAgreementLogEntryRecord
        • pub.ariba.supplier.log.utils:createOrderLogEntryRecord
        • pub.ariba.supplier.log.utils:createSetupLogEntryRecord
        • pub.ariba.supplier.log.utils:getCXMLEnvelopeFieldsForLog
      •  pub.ariba.supplier.log
        • pub.ariba.supplier.log:logEvent
        • pub.ariba.supplier.log:logInvoiceDetailEvent
        • pub.ariba.supplier.log:logMasterAgreementEvent
        • pub.ariba.supplier.log:logOrderEvent
        • pub.ariba.supplier.log:logPunchOutSetupEvent
      •  pub.ariba.supplier.utils
        • pub.ariba.supplier.utils:getInvokerHost
        • pub.ariba.supplier.utils:getLocalizedMessage
        • pub.ariba.supplier.utils:getRequestTypes
    •  The wm.b2b.cxml Folder in the WmAribaSupplier Package
      • Overview
      •  wm.b2b.cxml
        • wm.b2b.cxml:receiveCXML
      •  wm.b2b.cxml.config
        • wm.b2b.cxml.config:getCXMLVersion
      •  wm.b2b.cxml.guidelines
        • wm.b2b.cxml.guidelines:OrderMessageFormat
        • wm.b2b.cxml.guidelines:OrderRequestHdlr
        • wm.b2b.cxml.guidelines:ProfileRequestHdlr
        • wm.b2b.cxml.guidelines:PunchOutSetupRqstHdlr
      •  wm.b2b.cxml.messages
        • wm.b2b.cxml.messages:createCancelPunchOutOrderMessage
        • wm.b2b.cxml.messages:createcXMLEnvelope
        • wm.b2b.cxml.messages:createcXMLInvoiceDetailEnvelope
        • wm.b2b.cxml.messages:createErrorResponse
        • wm.b2b.cxml.messages:createInvoiceDetailResponse
        • wm.b2b.cxml.messages:createMasterAgreementResponse
        • wm.b2b.cxml.messages:createOrderResponse
        • wm.b2b.cxml.messages:createOrderResponse10
        • wm.b2b.cxml.messages:createProfileResponse
        • wm.b2b.cxml.messages:createPunchOutSetupResponse
        • wm.b2b.cxml.messages:formatPunchOutOrderMessage
        • wm.b2b.cxml.messages:sendCXMLResponse
        • wm.b2b.cxml.messages:sendErrorResponse
        • wm.b2b.cxml.messages:sendMasterAgreementResponse
        • wm.b2b.cxml.messages:sendOrderResponse
        • wm.b2b.cxml.messages:sendOrderResponse10
        • wm.b2b.cxml.messages:sendProfileResponse
        • wm.b2b.cxml.messages:sendPunchOutOrderMessage
        • wm.b2b.cxml.messages:sendPunchOutSetupResponse
      • wm.b2b.cxml.shared
      •  wm.b2b.cxml.shared.session
        • wm.b2b.cxml.shared.session:endSession
        • wm.b2b.cxml.shared.session:getSession
        • wm.b2b.cxml.shared.session:getSessionData
        • wm.b2b.cxml.shared.session:getSessionID
        • wm.b2b.cxml.shared.session:sessionExist
        • wm.b2b.cxml.shared.session:setSessionData
        • wm.b2b.cxml.shared.session:setSessionTimeout
        • wm.b2b.cxml.shared.session:startSession
      •  wm.b2b.cxml.utils
        • wm.b2b.cxml.utils:invokeAndCatchErrors
      •  wm.b2b.cxml.utils.errors
        • wm.b2b.cxml.utils.errors:clearError
        • wm.b2b.cxml.utils.errors:getErrorDetail
        • wm.b2b.cxml.utils.errors:getErrorMessage
        • wm.b2b.cxml.utils.errors:setError
        • wm.b2b.cxml.utils.errors:serviceError
      •  wm.b2b.cxml.utils.persistence
        • wm.b2b.cxml.utils.persistence:BuyerSession
      •  wm.b2b.cxml.utils.persistence.memory
        • wm.b2b.cxml.utils.persistence.memory:clearAllBuyerSessions
        • wm.b2b.cxml.utils.persistence.memory:getBuyerSession
        • wm.b2b.cxml.utils.persistence.memory:listBuyerSessions
        • wm.b2b.cxml.utils.persistence.memory:removeBuyerSession
        • wm.b2b.cxml.utils.persistence.memory:saveBuyerSession
      •  wm.b2b.cxml.utils.persistence.session
        • wm.b2b.cxml.utils.persistence.session:getBuyerSessionData
        • wm.b2b.cxml.utils.persistence.session:removeBuyerSessionData
        • wm.b2b.cxml.utils.persistence.session:saveBuyerSessionData
      •  wm.b2b.cxml.utils.persistence.spec
        • wm.b2b.cxml.utils.persistence.spec:getBuyerSessionDataSpec
        • wm.b2b.cxml.utils.persistence.spec:removeBuyerSessionDataSpec
        • wm.b2b.cxml.utils.persistence.spec:saveBuyerSessionDataSpec
    •  The wm.b2b.cxml Folder in the WmcXML12 Package
      • Overview
      •  wm.b2b.cxml.admin
        • wm.b2b.cxml.admin.startup:startResources
      •  wm.b2b.cxml.rec
        • wm.b2b.cxml.rec.profile:createProfileRequest
      •  wm.b2b.cxml.shared
        • wm.b2b.cxml.shared:base64ToRecord
        • wm.b2b.cxml.shared:createPayloadID
        • wm.b2b.cxml.shared:createRandomID
        • wm.b2b.cxml.shared:cXMLDocumentToRecord
        • wm.b2b.cxml.shared:datetimeISO8601
        • wm.b2b.cxml.shared:getServerAddress
        • wm.b2b.cxml.shared:recordlistAppend
        • wm.b2b.cxml.shared:recordToHTML
        • wm.b2b.cxml.shared:recordToXML
        • wm.b2b.cxml.shared:recordToXMLForInvoice
        • wm.b2b.cxml.shared:recordToXMLForInvoiceORIG
        • wm.b2b.cxml.shared:urlencodedToRecord
      •  wm.b2b.cxml.shared.data
        • wm.b2b.cxml.shared.data:computeTotal
        • wm.b2b.cxml.shared.data:httpNameValuePairsToRecordList
        • wm.b2b.cxml.shared.data:recordListToHTTPNameValuePairs
      •  wm.b2b.cxml.utils
        • wm.b2b.cxml.utils:areEqualStrings
        • wm.b2b.cxml.utils:getCXMLDocType
        • wm.b2b.cxml.utils:getStringListLength
        • wm.b2b.cxml.utils:hasElements
        • wm.b2b.cxml.utils:isCXMLDoc
        • wm.b2b.cxml.utils:isValidURL
      •  wm.b2b.cxml.utils.properties
        • wm.b2b.cxml.utils.properties:getCXMLProperties
        • wm.b2b.cxml.utils.properties:getInvoiceCXMLProperties
        • wm.b2b.cxml.utils.properties:CXMLProperties
      •  wm.b2b.cxml.utils.status
        • wm.b2b.cxml.utils.status:getDefaultResponseMessage
        • wm.b2b.cxml.utils.status:isValidStatusCode
      •  wm.b2b.cxml.utils.protocol
        • wm.b2b.cxml.utils.protocol:credentialToRecordList
        • wm.b2b.cxml.utils.protocol:descriptionToRecordList
        • wm.b2b.cxml.utils.protocol:getBuyerCookie
        • wm.b2b.cxml.utils.protocol:getCredential
        • wm.b2b.cxml.utils.protocol:getCredentialIdentity
        • wm.b2b.cxml.utils.protocol:getExtrinsic
        • wm.b2b.cxml.utils.protocol:getFrom
        • wm.b2b.cxml.utils.protocol:getPunchOutURL
        • wm.b2b.cxml.utils.protocol:getStartPageURL
        • wm.b2b.cxml.utils.protocol:IsAffiliatedWith
        • wm.b2b.cxml.utils.protocol:setPunchOrderMessageToCancel
    •  Useful Services in the WmMarketplace Package
      • Overview
      •  wm.marketplace.util.record
        • wm.marketplace.util.record:appendToRecordList
        • wm.marketplace.util.record:createRecord
        • wm.marketplace.util.record:removeRecordItem
        • wm.marketplace.util.record:setRecordItem
    •  The Trading Networks related API
      • Overview
      •  pub.ariba.supplier.tn.guidelines
        • pub.ariba.supplier.tn.guidelines:InvoiceDetailRequestHdlr
        • pub.ariba.supplier.tn.guidelines:MasterAgreementRequestHdlr
        • pub.ariba.supplier.tn.guidelines:OrderRequestHdlr
        • pub.ariba.supplier.tn.guidelines:ProfileRequestHdlr
        • pub.ariba.supplier.tn.guidelines:PunchOutSetupRequestHdlr
      •  pub.ariba.supplier.tn.handlerImpl
        • pub.ariba.supplier.tn.handlerImpl:defaultProfileRequestHandler
      •  pub.ariba.supplier.tn.log.spec
        • pub.ariba.supplier.tn.log.spec:LogEventSpec
        • pub.ariba.supplier.tn.log.spec:LogOrderEventSpec
        • pub.ariba.supplier.tn.log.spec:LogPunchOutSetupEventSpec
      •  pub.ariba.supplier.tn.utils
        • pub.ariba.supplier.tn.utils:getAttributeValue
        • pub.ariba.supplier.tn.utils:getCXMLRecord
    •  Mapping Data Between cXML and Net.Commerce
      • Data Elements
      • Extension Tables
    •  Administering Ariba Supplier OnRamp Adapter in a Cluster
      • What is IBM webMethods Integration Server Clustering?
      •  Ariba Supplier OnRamp Adapter in a Clustered Environment
        •  Clustering Considerations and Requirements
          • Requirements for Each Integration Server in a Cluster
          • Requirements When Installing Ariba Supplier OnRamp Adapter Packages
        •  Configuring Ariba Supplier OnRamp Adapter in a Clustered Environment
          • Replicating Packages and Configuration Information to Integration Servers
      •  Clustering Implementation Considerations
        •  Document Handler Services in a Cluster
          • PunchOutSetupRequest Handler
          • OrderRequest Handler
          • ProfileRequest Handler
          • MasterAgreementRequest Handler
          • InvoiceDetailRequest Handler
        • Punchout Process Data Storage
        • Logging
        • Example Punchout Site

IBM webMethods Adapter for Ariba Supplier OnRamp Documentation

Example Punchout Site