Documentation

Generate EDI Definition

First, go to the EDI Definition list using the Transaction Sets menu item on the EDI sub menu of the left navigation menu. There, you have three options to generate EDI definitions.

  • Option 1 - Generating a new EDI definition from scratch.
  • Option 2 - Uploading an existing EDI definition.
  • Option 3 - Selecting a predefined EDI definition.

If you are new to creating EDI definitions, we recommend you to go with Option 3 until you are familiar with the concepts.

Option 1 - Generating a new EDI definition from scratch:

Click ‘+’ in EDI Definitions UI.

EDI Definitions

A Pop up window will open with the title New EDI Definition

New EDI Definition

  1. Here, select your prefered X12 EDI standard version.
  2. Select the EDI Document Type
  3. Specify a document name. This is just a textual identifier for you to easily distinguish this definition from others in the EDI Definitions list; it will not actually be used in EDI communication.
  4. The ID of the Segment or Loop according to the specification.
  5. Select whether it’s a Segment or a Loop.
  6. Specify how many times the Loop could be repeated within the definition.
  7. Select whether the Segment is Mandatory or Optional according to the specification.
  8. Specify the maximum usage of the segment within the definition.
  9. Specify whether the Segment must be used according to your trading partner’s specifications.

Option 2 - Uploading an existing EDI definition

  1. Click the Import Definition button.
  2. Browse and select an EDI definition in the correct JSON format according to the EDI specification.
  3. Once uploaded, you can make any changes before persisting.

Option 3 - Selecting a predefined EDI definition:

  1. Select your preferred X12 EDI standard version from the Version dropdown list.
  2. Select the EDI Document Type from the Transaction Set dropdown list.
  3. Click the Create Definition button next to the Transaction Set dropdown list.
  4. Once created, you can customize it before persisting.

Finally, click the Submit button to persist the definition. Once it is listed in the EDI Definitions list, you can Edit, Download, Copy or Delete the definition.

EDI Definition List

Now that you have generated an EDI definition, the next step would be to create a trading partner so that we can start communicating.