Upload Custom Models

All EDI transaction set models are represented as OpenAPI Schema objects. We support two types of models: system, the standard models that we have prebuilt and are ready for use, and custom, 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.

  Learn how to create custom models:

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 Custom Models

    Paste/type in your API key or it will be populated automatically if you had previously saved it in the Webpad settings.

  2. Paste/type in your API key

    It will be populated automatically if you had previously saved it in the Webpad settings.

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

    mceclip0.png

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

    mceclip2.png

  5. The custom model is now ready for use by both the API and EDI Webpad. For translation from EDI operations, or reading EDI, you need to set the format property in EDI Webpad settings.

    Copy the model name:

    mceclip3.png

    Navigate to EDI Webpad settings and paste the model name in the format field:

    mceclip4.png

    For all other operations, you can set the "Model" property within each message:

    mceclip5.png

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 when selected and hit "Delete model".

Was this article helpful?
0 out of 0 found this helpful