The EDI generator helper (file definition rules – version 2) is an advanced field editor, a powerful tool, available in your EDI import form that enables you to view the generator capability or troubleshoot any errors in the EDI file. It works based on the import configurations you provide. The EDI generator helper provides automated, accurate data ingestion into ERPs or backend applications, reducing manual errors and accelerating transaction processing.
You can use the EDI generator helper and edit details in any of the following scenarios:
|
No. |
Launch the EDI generator helper to... |
|---|---|
|
1. |
Check the output generated in your import based on the sample/existing flow data & configurations. |
|
2. |
Review and troubleshoot any errors that occur in your import preview, before you run the flow. |
|
3. |
Review and troubleshoot any import errors that occur during a flow run, before you re-run the flow. |
Visual, intuitive design: – The EDI generator helper has a modern user interface with easy-to-use sections for reviewing EDI details or troubleshooting EDI issues. The intuitive design provides several features that facilitate quick and efficient rule-based generation of EDI files for imports.
The EDI generator helper offers the following studio features that help to visualize and validate data for successful EDI transactions:
-
Sample flow data for validations – It provides the sample flow data depending on your import configurations to enable rule-based processing and generate a valid EDI file.
-
Views of file definition rules – It offers two views
-
JSON view – This view is helpful if you're a coder and familiar with the EDI standards and definition rules.
-
Tree view – This view is helpful if you're a non-coder and would like to examine details slowly and carefully in the UI. This view consists of nested sections with clear section labels making it easy for you to understand the hierarchy and view the rules.
-
-
Errors – Errors are shown in red at the top in the Tree view and also at the bottom of the page. The messages provide a warning about non-conformance with the standard parsing definition rules making it easy for to find and troubleshoot errors. See also, EDI generator helper for troubleshooting errors
-
Section placement – It places sections so that it's easy to visualize the flow of the EDI data – before and after parsing. Each section has clear headings that provide a context, and you can collapse and expand sections to examine and check any details.
-
Search – All sections have a search capability to enable you to find data easily and quickly and examine or edit, where possible, any details. In the Tree view to quickly find a specific segment or detail, provide unique search keywords rather than standard segment or element headings, especially for large files. For example, instead of "ISA" enter "ISA01"
-
Generating an EDI file – It generates an EDI file based on standard EDI rules & trading partner requirements..
The EDI generator helper consists of the following three sections:
-
Sample flow data (for generating the EDI file)
-
File definition rules, also referred to as FDRs, version 2
-
Generated EDI file (to send to the trading partner)
These sections are useful to understand the EDI file generation capability and troubleshoot errors before you send the EDI files. If you notice any errors, you can edit details to fix them and then preview the data.
If you'd like to troubleshoot errors:
-
Review the EDI X12/EDIFACT standards and your trading partner documentation for compliance rules or guidelines.
-
Check the error count and errors shown. For example, use either of the views to review errors.
-
Tree view – Click the count in red at the top of the File definition rules section to view the list of errors detected. Carefully read the message of a specific error, and click the message to go to the exact error location.
-
JSON view – View the message at the bottom of the page that also indicates the error number. In the JSON view using the line number to quickly find the error, which will be highlighted for visibility.
-
-
Make any edits to resolve the errors as required in the sections below. The File definition rules and Sample EDI file are shown based on the EDI file type and profile you configured in the import.
-
File definition rules
-
Tree view – You can edit, clone, or delete segments or elements using the Actions (...) menu as shown.
-
JSON view – If you're familiar with JSON, you can make any changes as required in the code view.
-
-
Sample flow data
-
It initially shows sample data as a baseline for generating the EDI file. You can check whether the flow data is acceptable and correct.
-
Then shows the real data for generating the file when previewing the import or running the import in a flow.
(Make changes or tweaks accordingly in the real data in the source application you're exporting data from.)
-
-
-
Click Preview in the Generated EDI file section to confirm if all the errors are resolved and the EDI file can be sent to the destination application. If there are errors, the data will not be sent to the destination application.