Documentation

How to create and import EDI specs?

Article author
Admin
  • Updated

The OpenAPI EDI format

All EDI messages in EdiNation are represented as EDI models that match the official EDI guidelines and can be downloaded in our proprietary OpenAPI EDI format.

The OpenAPI EDI format is based on the Schema object in OpenAPI 3 and is used to represent EDI messages across all available EDI standards in EdiNation.

 

The EDI SEF format

EdiNation supports the SEF format (the Standard Exchange Format) and specifications in SEF format can be imported into EdiNation. The end result of a SEF file import operation is a new EDI model in our OpenAPI EDI format, e.g., the SEF file is converted into our proprietary format.

The level of support for SEF is detailed in the How to migrate from SEF? article.

 

How to create custom EDI models?

The purpose of the custom EDI models is that you will have partners whose specification might differ from the standard and requires modification. 

You can either obtain a new specification as a SEF file, or download an existing EDI model, and modify it according to the rules of the OpenAPI EDI format.

Let's assume that we are making a change to the X12 4010 850 model (X12's purchase order).

edi-custom.png

  • Select Message ID 850 to display the spec. Then navigate to the JSON tab.

edi-custom2.png

  • Click the download button. The EDI spec will be downloaded as a JSON file, prefixed with EN_
  • Navigate to Build EDI Specs
  • Click the import button and select the JSON file that you downloaded two steps earlier

edi-custom3.png

  • After the EDI spec was imported, a notification of a successful import will be displayed and the imported EDI spec will be loaded in the editor below.

edi-custom4.png

When the import was not successful, a model dialog listing all issues will be shown instead.

  • Following the rules of the OpenAPI EDI format, modify the OpenAPI according to the partner-specific requirements. Let's assume that a partner needs the CUR segment to be mandatory instead of optional. Apply this change in the OpenAPI.

edi-custom5.png

To finalize the creation of the new model, select Update model from the Edit menu

edi-custom6.png

  • A notification will be displayed when your new EDI model is successfully uploaded and is ready for use.

 

How to use the custom EDI models?

Once you create a custom EDI model, either via SEF file import, or EDI model creation, that model won't be used automatically. You have to explicitly configure the Web EDI Analyzer to use it when:

  • Analyzing EDI files
  • Converting between EDI and JSON

To configure the EN_850 custom model to be used when analyzing X12 4010 850 files, do the following:

  • Navigate to Analyze EDI Files
  • Click on the setting button (the wrench button in the top-right corner)
  • Click the Load custom models button. This will populate the dropdown with all custom models available in your subscription.

edi-custom7.png

  • Select the EN_850 model and click the Save button.

edi-custom8.png

Now, every time you upload a file for analysis, this custom model will be used instead of the standard one

edi-custom9.png

Share this:

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.