Test and Go Live as a Follower

Generating an example payload with Integration Assistance

The Integration Assistance page can help you generate the correct payload structure according to your Trading Partner guideline for a particular Relationship.

If you go to this page and select

  1. A Transaction Type corresponding to an existing Relationship
  2. A Direction: "In" or "Out"
  3. A Data Format: "JSON" or "X12"
  4. A Version e.g. "1" or "4010"

You will see a list of Trading Partners that you have this Relationship with. When you select one of these Trading Partners, a valid payload will be generated below. You can click on Copy to copy the payload contents.

🚧

Although the structure of the payload corresponds to the Relationship's Guideline, the value of the element (in X12) or property (in JSON) is only a placeholder. Ensure that the values are valid before using this example payload. Click on the placeholder value to see the requirement of the values on the right side.

Create a Transaction

In most instances, EDI transactions will be created by your System of Record (SOR) and then passed on to Orderful. However there are situations where you may want to enter a transactiontransaction - Every EDI document that is traded in a Relationship is a “transaction”. An example of a transaction would be an 850 Purchase Order sent from you to a Trading Partner as part of an outbound Relationship. directly into Orderful, for example for testing purposes.

The transaction must correspond to an existing, configured Relationship in Orderful. This means that, in order to send a test transaction, you must have at least one outbound Relationship configured.

To create a Transaction you can:

Upload a file

To upload a transaction in a file:

  1. Go to the Transactions page
  2. Click on Create Transaction
  3. Select Upload transaction
  4. Choose the file you want to upload.

Transaction files in X12 format can use .txt, .x12 or .edi extensions, files in JSON format can use the .json extension. For more information about how the file contents must be structured see format information below.

File format for JSON

Files containing JSON must use the following structure. The contents of your transaction should be entered into the message object.

To see the possible Transaction Type values, see Available Transaction Types.

{
    "type": {
        "name": "TRANSACTION_TYPE_NAME"
    },
    "stream": "test",
    "message": {
        [...] // Enter your data here
    },
    "sender": {
        "isaId": "ISA_ID_SENDER"
    },
    "receiver": {
        "isaId": "ISA_ID_RECEIVER"
    }
}

File format for X12

For files in the X12 format must:

  • Start with an ISA segment.
  • Have at least one interchange envelope (ISA/IEA segments).
  • Have at least one functional group inside each interchange envelope (GS/GE segments).
  • Have at least one transaction set inside each functional group (ST/SE segments).
  • Respect the presence and order of loops, segments, and elements defined by the X12 standards for each transaction type inside each transaction set.

Make an API call

You can create a Transaction by sending an HTTP POST to the Orderful API's /transactions endpoint.

📘

You can send the Transaction data in either JSON or X12 format.

For help generating the content of the transaction, see Generating an example payload below. For a full description of this endpoint, please see Create a Transaction.

curl --location --request POST 'https://api.orderful.com/v3/transactions' \
--header 'Content-Type: application/json' \
--header 'orderful-api-key: YOUR_API_KEY' \
--data-raw '{
    "stream": "test",
    "sender": {
        "isaId": "YOUR ISA ID HERE"
    },
    "receiver": {
        "isaId": "AMAZONIADEMO"
    },
    "type": {
        "name": "850_PURCHASE_ORDER"
    },
    "message": {
  "transactionSets": [
    {
      "transactionSetHeader": [
        {
          "transactionSetIdentifierCode": "850",
          "transactionSetControlNumber": "0001"
        }
      ],
      "beginningSegmentForPurchaseOrder": [
        {
          "transactionSetPurposeCode": "00",
          "purchaseOrderTypeCode": "SA",
          "purchaseOrderNumber": "PO123456789",
          "date": "20200828"
        }
      ],
      "referenceInformation": [
        {
          "referenceIdentificationQualifier": "DP",
          "referenceIdentification": "210"
        }
      ],
      "dateTimeReference": [
        {
          "dateTimeQualifier": "002",
          "date": "20200910"
        },
        {
          "dateTimeQualifier": "010",
          "date": "20200905"
        }
      ],
      "N1_loop": [
        {
          "partyIdentification": [
            {
              "entityIdentifierCode": "BT",
              "name": "ODF Buyer HQ"
            }
          ],
          "partyLocation": [
            {
              "addressInformation": "1119 BUSH STREET"
            }
          ],
          "geographicLocation": [
            {
              "cityName": "SAN FRANCISCO",
              "stateOrProvinceCode": "CA",
              "postalCode": "94101"
            }
          ]
        },
        {
          "partyIdentification": [
            {
              "entityIdentifierCode": "ST",
              "name": "ODF BUYER MAIN STORE"
            }
          ],
          "partyLocation": [
            {
              "addressInformation": "1207 WASHINGTON RD"
            }
          ],
          "geographicLocation": [
            {
              "cityName": "SEATTLE",
              "stateOrProvinceCode": "WA",
              "postalCode": "98101"
            }
          ]
        }
      ],
      "PO1_loop": [
        {
          "baselineItemData": [
            {
              "assignedIdentification": "1",
              "quantity": "48",
              "unitOrBasisForMeasurementCode": "CA",
              "unitPrice": "26.25",
              "productServiceIDQualifier": "UP",
              "productServiceID": "711719100246",
              "productServiceIDQualifier1": "VN",
              "productServiceID1": "009"
            }
          ],
          "PID_loop": [
            {
              "productItemDescription": [
                {
                  "itemDescriptionTypeCode": "F",
                  "description": "SUNGLASSES VERMILLION (E16249)"
                }
              ]
            }
          ]
        },
        {
          "baselineItemData": [
            {
              "assignedIdentification": "2",
              "quantity": "120",
              "unitOrBasisForMeasurementCode": "CA",
              "unitPrice": "27.45",
              "productServiceIDQualifier": "UP",
              "productServiceID": "611719100245",
              "productServiceIDQualifier1": "VN",
              "productServiceID1": "009A"
            }
          ],
          "PID_loop": [
            {
              "productItemDescription": [
                {
                  "itemDescriptionTypeCode": "F",
                  "description": "SUNGLASSES YELLOW (F8C729)"
                }
              ]
            }
          ]
        }
      ],
      "CTT_loop": [
        {
          "transactionTotals": [
            {
              "numberOfLineItems": "2"
            }
          ]
        }
      ],
      "transactionSetTrailer": [
        {
          "numberOfIncludedSegments": "17",
          "transactionSetControlNumber": "0001"
        }
      ]
    }
  ]
}
}
'

Send a file to your outbound Communication Channel

If you are using an outbound Communication Channel like AS2, FTP, or VAN, you can send the file using this system. The details of how this is done will depend on your implementation.

Transaction validation

After you have sent your transaction, you can check its transaction status by going to your Transactions page.

If there are any issues, please refer to the Transaction Statuses Overview.

Scenario Testing for Followers

Prerequisites

At this stage, you should have:

  • Set up your Orderful org
  • Set up a Trading Partnership with your Leader

At this point, you are ready to try out sending and receiving some transactions. We call this try-out phase Scenario Testing.

How you perform Scenario Testing depends on whether your Leader is Claimed or Unclaimed. Scenario Testing with Claimed Leaders can take place within Orderful, while testing with Unclaimed Leaders can be started within Orderful but will have to be completed in your Leader's trading portal. See Testing outside Orderful for more information.

Scenario Testing with Claimed Leaders

When you accepted the Trade Request from your Leader it included one or more Scenarios. If you go to your Scenario Testing page you will find one or more Scenario Checklists organized by EDI Account.

If you click on the Scenario Checklist, this will open up a side panel on the right with further information, including the list of Scenario Checklist Steps.

Each Scenario Checklist Step includes instructions for sending or receiving a test transaction. Instructions include:

  • The test transaction's Transaction Type
  • The partner that must send the test transaction
  • A description that indicates what business information must be included in the test transaction

If a Scenario Checklist assigns you as the sender of the first test transaction, you must create that test transaction and then link it to the Scenario Checklist by clicking Transaction ID and finding your transaction under "Most recent test transactions", and clicking Save. Then, send the transaction to your Trading Partner. Once your Trading Partner accepts the test transaction, the Scenario Checklist Step will turn green and a checkmark will appear beside it. You can now move on to the next step, or, if applicable, wait for your Trading Partner to perform their step.

If a Scenario Checklist assigns your Trading Partner as the sender of the first test transaction, you must wait for them to send you that test transaction. After they send the test transaction, ingest it through your inbound Communication Channel. Once you have successfully ingested the transaction, make sure to mark it as accepted by sending an Acknowledgment. Once you accept the test transaction, the Scenario Checklist Step will turn green and a checkmark will appear beside it. You can now move on to the next step, or, if applicable, wait for your Trading Partner to perform another step.
When your Scenario Checklist is completed it will automatically be moved to the Completed Testing tab.

Testing outside Orderful

If you are a Follower using Orderful, and you trade with a Leader who doesn’t use Orderful you will need to follow a similar testing process, but outside of the Orderful platform. In this section we will give you two examples of common testing steps your Leader may ask you to perform and how Orderful can help.

Retrieve transaction data from Orderful

You may have to pass the content of a transaction to your leader. To get this data:

  1. Go to your Organization's Transactions page.
  2. Find an outbound transaction (i.e. a Transaction whose "Direction" is "Out") then select it by clicking on it.
  3. Click on Data View.
  4. Click the Icon beside Copy. This opens a "Data Format" menu, where you can select your Leader’s name. This ensures that the data is in your Leader's required format.
  5. Click Copy.

You can now paste the transaction contents wherever you need, such as an email or file.

Upload transaction data to Orderful

You may have a test transaction from your leader that you need to upload to Orderful.

📘

Files you upload to Orderful must be in one of the following formats: .edi, .json, .x12, or .txt and be less than 1 MB in size.

  1. Go to your Organization's Transactions page.
  2. Click Create Transaction > Upload transaction then select the file.
  3. Click on the transaction that you just created to go to the Transaction Details page.
  4. On this page you can check its state and, if applicable, send it to an inbound Communication Channel.

Go Live

You and your Trading Partner should agree on a time to go live. This communication will happen outside of Orderful. Once you’ve passed scenario testing you should email your Trading Partner and schedule a go-live time that is appropriate for both parties.

Once you are ready, going live is as simple as going to your Relationships page and toggling the "Status" from "Go live ready" to "Live".


Did this page help you?