Documentation

How to upload custom models

Article author
Admin
  • Updated

All EDI transaction set models are represented as OpenAPI Schema objects. EdiNation supports two types of models:

  • System models - the standard models that we have prebuilt and are ready for use
  • Custom models - the models that you can create yourselves.

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

OpenAPI EDI Custom Models

Once you had created your custom model and exported it to either OpenAPI 3 YAML or JSON file, you need to upload it before using it. 

  1. Navigate to Import SEF or OpenAPI

  2. Upload the custom model file (in .sef, .yaml, or .json format. EdiFabric .dll is also supported).

    import-sef.png

  3. The uploaded model will be automatically selected and you'll be able to view the transaction sets and verify that the upload was successful.

    import-sef-openapi.png

  4. The custom model is now ready for use by both the API and Web EDI. 

    Copy the model name:

    import-sef-openapi-copy-name.png

    Navigate to Web EDI Translator settings and paste the model name in the "Read model" field:

    import-sef-openapi-paste-name.png

    Click "Save" to save the setting. All EDI files translated in Web EDI will try to use this model for translation.

The custom model can be used only by you and is visible only within your subscription.

To update the same model, you can upload it with the same file you used originally.

To delete the model, click on the "cogs" icon and select "Delete model".

Share this:

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.