Using the Test Module

Overview

Ariba Supplier OnRamp Adapter provides a Test Module that enables you to test your punchout implementation. You access the Test Module from the Test menu selection in the Integration Server Administrator.

You can send test messages (PunchOutSetupRequests, OrderRequests, ProfileRequests, and MasterAgreementRequest) to the receiveCXML service as if they were sent from Ariba Supplier Network. You can view the status of the punchout using the Logs Module. You also can send the InvoiceDetailRequest test message to an URL specified on Config Module as if it was buyer's URL.

A set of records is provided in the wm.cxml.rec folder in the WmcXML12 package to represent the cXML documents that can be used for testing purpose.

The test messages can reside in files, or you can create messages using Test.

Testing Messages Stored in Files

About this task

You can read files on the server that contain PunchOutSetupRequests, OrderRequests, ProfileRequests, MasterAgreementRequests, or Multipart MIME messages containing OrderRequests with attachments.

To test a message stored in a file

Procedure

  1. Start Integration Server Administrator.
  2. In the IBM webMethods Adapter for Ariba Supplier OnRamp menu, select Test. The Test page appears.
  3. Select the test type From File.
  4. Type a file name in the Sample Message Filename field (or click the Browse button to select a file) and click the Submit button.

    The request contents are displayed.

  5. You can modify the request contents by entering additional CXML message fields in the text box.
    Note: Be careful when modifying cXML request documents. Be sure you adhere to XML syntax (ensure that all opening tags have closing tags, special characters are escaped correctly, and so on).

    In addition, be extremely careful if you edit a MIME message in the text box. MIME messages are particularly sensitive to whitespace characters. Be sure not to modify the MIME headers. Modifying a MIME document in the text box is not recommended.

    Note: If you have enabled Shared Secret validation (Configuring Shared Secret Validation), make sure that you enter the supplier's Shared Secret in the Shared Secret field in Request Header's Sender credential.
  6. After you modify the request contents, click the Send cXML Request button.
  7. View the cXML response that is returned, and view the log files if needed.

Testing ProfileRequests

About this task

You can test the ProfileRequestHandler by creating and sending test ProfileRequest messages.

To create and send a test ProfileRequest message

Procedure

  1. Start Integration Server Administrator.
  2. In the Ariba OnRampmenu, select Test. The Test page appears.
  3. Select the test type ProfileRequest.

    The Test cXML Request Processing screen appears.

  4. Complete the following fields to specify the credentials of the sender and receiver of the document. (To send empty values, click the check boxes next to the fields.) The credentials correspond to the From, To, and Sender credential fields of a cXML Request message, as defined in the cXML User's Guide Version 1.2.
    In this field... Specify...
    Identity An ID string representing the entity.
    Domain Select one of the following values:
    • DUNS. If the ID is a DUNS number.
    • NetworkId. If the ID is an Ariba SN ID.
    Shared Secret For the Sender credential, this must be the supplier's SharedSecret, which is configured on both Ariba SN and the cXML of Ariba Supplier OnRamp Adapter.
    Digital Signature Optional.
    Signature Type Optional. The Digital Signature Type.
    Signature Encoding Optional. The Digital Signature Encoding.
    User Agent For Sender Credential Only. The sending system's User Agent Identity.
    Note: If you have enabled Shared Secret validation (as described Configuring Shared Secret Validation), make sure that you enter the supplier's Shared Secret in the Shared Secret field in Request Header's Sender credential.
  5. Click the Create Profile Request button. The request content appears.
  6. You can modify the request contents by entering additional CXML message fields in the text box.
    Note: Be careful when modifying cXML request documents. Be sure you adhere to XML syntax. (For example, ensure that all opening tags have closing tags and that special characters are escaped correctly.)
  7. Click the Send cXML Request button. The response content appears.

Testing PunchOutSetupRequests

About this task

You can test the PunchOutSetupRequestHandler by creating and sending test PunchOutSetupRequest messages.

To create and send a test PunchOutSetupRequest message

Procedure

  1. Start Integration Server Administrator.
  2. In the IBM webMethods Adapter for Ariba Supplier OnRamp menu, select Test. The Test page appears.
  3. Select the test type PunchOutSetupRequest.

    The Test cXML Request Processing screen appears.

  4. Complete the following fields to specify the credentials of the sender and receiver of the document. (To send empty values, click the check boxes next to the fields.)
    In this field… Specify…
    Identity An ID string representing the entity.
    Domain Select one of the following values:
    • DUNS. If the ID is a DUNS number.
    • NetworkId. If the ID is an Ariba SN ID.
    Shared Secret For the Sender credential, this must be the supplier's SharedSecret, which is configured on both Ariba SN and on the cXML of Ariba Supplier OnRamp Adapter.
    Digital Signature Optional.
    Signature Type Optional. The Digital Signature Type.
    Signature Encoding Optional. The Digital Signature Encoding.
    User Agent For Sender Credential Only. The sending system's User Agent Identity.
    PunchOutSetupRequest Operation The operation of the message to test is automatically displayed.
    BrowserFormPost URL The URL to which a PunchOutOrderMessage should eventually be posted.
    BuyerCookie A unique identifier representing the buying session.
    Note: If you have enabled SharedSecret validation (as described in Configuring Shared Secret Validation, make sure that you enter the supplier's SharedSecret in the SharedSecret field in Request Header's Sender credential.
  5. Click the Create PunchOutSetup Request button. The request content appears.
  6. You can modify the request contents by entering additional CXML message fields in the text box.
    Note: Be careful when modifying cXML request documents. Be sure you adhere to XML syntax. (For example, ensure that all opening tags have closing tags and special characters are escaped correctly.)
  7. Click the Send cXML Request button. The response content appears.

Testing OrderRequests

About this task

You can test the OrderRequestHandler by creating and sending simple OrderRequest messages, or MIME messages containing OrderRequests and attachments.

To create and send a test OrderRequest message

Procedure

  1. Start Integration Server Administrator.
  2. In the IBM webMethods Adapter for Ariba Supplier OnRamp menu, select Test. The Test page appears.
  3. Select the test type OrderRequest.

    The Test cXML Request Processing screen appears.

  4. Set the cXML From, To, and Sender credentials by clicking the Set Credentials button and completing the following fields to specify the credentials of the sender and receiver of the document. (To send empty values, click the check boxes next to the fields.)
    In this field… Specify…
    Identity An ID string representing the entity.
    Domain Select one of the following values:
    • DUNS. If the ID is a DUNS number.
    • NetworkId. If the ID is an Ariba SN ID.
    Shared Secret For the Sender credential, this must be the supplier's SharedSecret, which is configured on both Ariba SN and on the cXML of Ariba Supplier OnRamp Adapter.
    Digital Signature Optional.
    Signature Type Optional. The Digital Signature Type.
    Signature Encoding Optional. The Digital Signature Encoding.
    User Agent For Sender Credential Only. The sending system's User Agent Identity.
    Note: If you have enabled SharedSecret validation (as described in Configuring Shared Secret Validation, make sure that you enter the supplier's SharedSecret in the SharedSecret field in Request Header's Sender credential.
  5. Click the Add Line Item button to add Order Line Items and perform the following steps:
    1. Wait for the browser page to fully load. The web page is a form containing fields representing the cXML Item Out Record, as defined in the cXML Users Guide. All fields in italics are optional.
    2. Be sure that you enter the following fields:
      Field Name Value
      @quantity The number of items to buyer.
      ItemID/SupplierPartID The ID used by this supplier to represent the product.
      ItemDetail/UnitPrice/Money/*body The price of this item.
      ItemDetail/Tax/.Money/*body The tax of this item.
    3. Click the Submit button. You should see the line item in the Line Items table.
  6. Click the Submit button. You should see the line item in the Line Items table.
    1. Enter the following values for each of the fields:
      Field Name Value
      Filename The name of a file on the server to include as an attachment.
      Type The content type designation of the attachment in the form of type/subtype. For example: text/html, text/plain, and so on.
      Description (Optional) A description of the attachment contents.
      Disposition (Optional) The MIME disposition of this attachment. See your MIME specification.
    2. Click the Submit button. You should see the attachment entry in the Attachments table.
  7. In the OrderRequestHeader table perform the following steps:
    1. Set the total amount for the tax and for the order or click the Compute Tax and Total button to compute the tax and total, based on the line items selected.
    2. Select the OrderRequest operation type (new, update, or delete).
    3. Enter a unique OrderID to identify this order.
    4. Enter the date for this order.
    5. Click the Set Header button.
  8. Click the Create OrderRequest Message button.
  9. If you included attachments in your message, a MIME message will be shown in a text box in the next screen. The MIME message will contain the OrderRequest and its attachments.

    Otherwise, the OrderRequest content will be shown in the text box.

    Note: Be careful when modifying cXML request documents. Be sure you adhere to XML syntax (ensure that all opening tags have closing tags, special characters are escaped correctly, and so on).

    In addition, be extremely careful if you edit a MIME message in the text box. MIME messages are particularly sensitive to whitespace characters. Be sure not to modify the MIME headers. Modifying a MIME document in the text box is not recommended.

  10. Click the Send cXML Request button. The response content is displayed.

Testing MasterAgreementRequests

About this task

You can test the MasterAgreementRequestHandler by creating and sending simple MasterAgreementRequest messages.

To create and send MasterAgreementRequest test message

Procedure

  1. Start Integration Server Administrator.
  2. In the IBM webMethods Adapter for Ariba Supplier OnRamp menu, select Test. The Test page appears.
  3. Select the test type MasterAgreementRequest. The Test cXML Request Processing screen appears.
  4. Set the cXML From, To, and Sender credentials by clicking the Set Credentials button and completing the following fields to specify the credentials of the sender and receiver of the document. (To send empty values, click the check boxes next to the fields.)
    Field Value
    Identity An ID string representing the entity.
    Domain Select one of the following values:
    • DUNS. If the ID is a DUNS number.
    • NetworkId. If the ID is an Ariba SN ID.
    • AribaNetworkUserId. If the ID is an Ariba SN user ID.
    Shared Secret For the Sender's Credential, this must be the supplier's Shared Secret, which is configured on both Ariba SN and on the cXML of Ariba Supplier OnRamp Adapter.
    Digital Signature Optional. For Sender's Credential only.
    Signature Type Optional. For Sender's Credential only. The Digital Signature Type.
    Signature Encoding Optional. For Sender's Credential only. The Digital Signature Encoding.
    User Agent For Sender's Credential only. The sending system's User Agent Identity.
    1. Set MasterAgreementRequest Header fields. Specify the following fields:
      Field Value
      Operation Specifies the type of the agreement request. Select one of the following:
      • new (Default)
      • update
      • delete. Used to cancel an existing agreement. The delete request should be an exact replica of the original request.
      Agreement Date The date and time the agreement request was created. This is different from the effective and expiration date of the agreement.
      Expiration Date Specifies the date the agreement is no longer available.
      Agreement ID The procurement system agreementID for this request.
      Agreement Type Specifies whether the agreement refers to a value or quantity.
      Effective Date Specifies the date the agreement is available for ordering or releases.
      Parent Agreement Payload ID Optional. PayloadID for the corresponding parent document from which this agreement is derived.
  5. Set MasterAgreementRequest Header fields. Specify the following fields:
    Field Value
    Operation Specifies the type of the agreement request. Select one of the following:
    • new (Default)
    • update
    • delete Used to cancel an existing agreement. The delete request should be an exact replica of the original request.
    Agreement Date The date and time the agreement request was created. This is different from the effective and expiration date of the agreement.
    Expiration Date Specifies the date the agreement is no longer available.
    Agreement ID The procurement system agreementID for this request.
    Agreement Type Specifies whether the agreement refers to a value or quantity.
    Effective Date Specifies the date the agreement is available for ordering or releases.
    Parent Agreement Payload ID Optional. PayloadID for the corresponding parent document from which this agreement is derived.
  6. To add detail records, click the Add Agreement Item and perform the following steps:
    1. Wait for the browser page to fully load. The page is a form containing fields representing the cXML AgreementItemOut Record, as defined in the cXML User's Guide Version 1.2. At a minimum, you should enter the ItemOut field.
    2. AgreementItemOut can contain the following child elements:
      Field Value
      MaxAmount Optional. Contains the maximum amount for the line item.
      MinAmount Optional. Contains the minimum amount for the line item.
      MaxReleaseAmount Optional. Indicates the item level maximum amount per release.
      ItemOut Required. A line item that is part of the Master Agreement. The lineNumber attribute in the ItemOut specifies the corresponding lineNumber on the Master Agreement in the Procurement Application. The quantity attribute in the ItemOut should be set to "one" and ignored at the Master Agreement implementation processing stage.
    3. Click the Submit button. You should see the line item in the Agreement Items table.
  7. Click the Create MasterAgreementRequest Message button.
  8. Click the Send cXML Request button. The response content is displayed.

Testing InvoiceDetailRequests

About this task

You can test InvoiceDetailRequest transaction by sending a test message to the URL specified on the Config screen.

To create and send InvoiceDetailRequest test message

Procedure

  1. Start Integration Server Administrator.
  2. In the IBM webMethods Adapter for Ariba Supplier OnRamp menu, select Test. The Test page appears.
  3. Select the test type InvoiceDetailRequest. The Test cXML Request Processing screen appears.
  4. Set the cXML From, To, and Sender credentials by clicking the Set Credentials button and completing the following fields to specify the credentials of the sender and receiver of the document. (To send empty values, click the check boxes next to the fields.)
    Field Value
    Identity An ID string representing the entity.
    Domain Select one of the following values:
    • DUNS. If the ID is a DUNS number.
    • NetworkId. If the ID is an Ariba SN ID.
    • AribaNetworkUserId. If the ID is an Ariba SN user ID.
    Shared Secret For the Sender's credential, this must be the supplier's Shared Secret, which is configured on both Ariba SN and on the cXML of Ariba Supplier OnRamp Adapter.
    Digital Signature Optional. For Sender's Credential only.
    Signature Type Optional. For Sender's Credential only. The Digital Signature Type.
    Signature Encoding Optional. For Sender's Credential only. The Digital Signature Encoding.
    User Agent For Sender's Credential only. The sending system's User Agent Identity.
  5. Set Invoice Detail Request Header fields. Specify the following fields:
    Field Value
    Invoice ID A supplier-generated identifier for the Invoice. Identical to the Invoice Number that appears at the top of a physical Invoice.
    Is Information Only? Indicates whether the buying organization needs to take action. Select one of the following:
    • yes. Invoice is for the buying organization's information only (no action needs to be taken by the buying organization).
    • Not specified. (Default) Invoice is functional. The buying organization needs to take action upon receiving this document (submit payment or accept credit).
    Purpose Purpose of the invoice. Select one of the following:
    • standard. (Default) A standard billing statement from the supplier to the buying organization.
    • creditMemo. A credit memo for issuing credit to the buying organization. isHeaderInvoice must be yes. Also, the elementInvoiceDetailSummary/DueAmount must be a negative amount.
    • debitMemo. A debit memo for billing a balance owed by the buying organization. isHeaderInvoice must be yes. Also, the element InvoiceDetailSummary/DueAmount must be a positive amount.
    Operation How this document is acting on the invoice. Select one of the following:
    • new. (Default) Creates a new invoice.
    • delete. Cancels an existing invoice. The PayloadID of the existing invoice must be specified in a Document Reference.
    Invoice Date Date and time that the Invoice was created (should be earlier than the cXML timestamp).
  6. Set Invoice Detail Header Indicator fields. By default all indicators are set to no.
    Field Value
    Is Header Invoice? Select one of the following:
    • yes. Header invoice. Invoice uses InvoiceDetailHeaderOrder, which contains header level invoice information without item details.
    • Not specified. Detail invoice. Invoice uses InvoiceDetailOrder, which contains item details.
    Is VatRecoverable? Select one of the following:
    • yes. The entire invoice is VAT (Value Added Tax)-recoverable.
    • no. The entire invoice is not VAT - recoverable.
  7. Set Invoice Detail Line Indicator. This record indicates that invoicing details exist at invoice line level.
    Field Value
    Is Tax Inline? Select one of the following:
    • yes. Tax is provided at invoice line level.
    • no. Tax is not provided at invoice line level.
    Is Shipping Inline? Select one of the following:
    • yes. Shipping (InvoiceDetailLineShipping) is provided at invoice line level.
    • no. Shipping is not provided at invoice line level.
    Is Accounting Inline? Select one of the following:
    • yes. Accounting distribution (Distribution) is provided at invoice line level. If isHeaderInvoice is true, this indicator must not be specified, because Distribution is available only at item level.
    • no. Accounting distribution is not provided at invoice line level.
    Is Special Handling Inline? Select one of the following:
    • yes. Special handling (InvoiceDetailLineSpecialHandling) is provided at invoice line level.
    • no. Special handling is not provided at invoice line level.
    Is Discount Inline? Select one of the following:
    • yes. Discount (InvoiceDetailDiscount) is provided at invoice line level.
    • no. Discount is not provided at invoice line level.
  8. To add detail records, click the following buttons:
    • Invoice Partner. Party involved in invoicing, including the issuer of the invoice and the person sold to.
    • Invoice Detail Orders. The invoice information of an order with item details, used only when isHeaderInvoice is false (not specified).
    • Invoice Detail Header Orders. The header invoice information of a purchase order, without item details, used only when isHeaderInvoice = "yes".
    • Invoice Detail Summary. The summary information of an invoice. For details about these detail records, see the cXML User's Guide Version 1.2.
  9. Click the Create InvoiceDetailRequest Message button.
  10. Click the Send cXML Request button. The request will be sent to the URL specified on the Config screen.