The EDI parser helper (file definition rules – version 2) is an advanced field editor, a powerful tool, available in your EDI listener/export form that enables you to view the parsing capability or troubleshoot any errors in your EDI file. It works based on the export configurations you provide to validate and parse files. The EDI parser helper provides automated, accurate data ingestion from ERPs or backend applications, reducing manual errors and accelerating transaction processing.
You can use the EDI parser helper and edit any details in any of the following scenarios:
|
No. |
Launch the EDI parser helper to... |
|---|---|
|
1. |
Check the parsed JSON output that's based on your existing export data & configurations. |
|
2. |
Review and troubleshoot any errors that occur in your export preview, before you run the flow. |
|
3. |
Review and troubleshoot any export errors that occur in a flow run, before you re-run the flow. |
Visual, intuitive design – The EDI parser 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 parsing of EDI files that are exported.
The EDI parser helper offers the following studio features that help to visualize and validate data for successful EDI transactions:
-
Sample EDI data for validations – It provides an EDI file with sample or real data based on your export configurations to enable rule-based processing and create a parsed output.
-
Views of file definition rules – It offers the following 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 parser 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"
-
Parsing of EDI data to canonical JSON output – Based on standard EDI rules & trading partner requirements, it provides the parsed JSON output that can be successfully moved to the next step in the flow.
The EDI parser helper consists of the following three sections:
-
Sample EDI file (for parsing)
-
File definition rules, also referred to as FDRs, version 2
-
Parsed output (for the next step in the flow)
These sections are useful to understand the EDI file parsing capability and troubleshoot validation errors before the EDI data is parsed to canonical JSON data for the next flow step. 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 errors. For example, use either of the views to review errors.
-
Tree view: Click the error count or the warning icon for errors at the top of the File definition rules section to view the list of errors. 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, and use the line number 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 export.)
-
File definition rules
-
Tree view: You can edit, clone, or delete segments or elements using the Actions (...) menu as shown.
Click the plus (+) sign if you want to add a segment.
-
JSON view: If you're familiar with JSON, you can make any changes as required in the code view.
-
-
Sample EDI file
You can edit the file, if required.
-
It initially shows sample data for the EDI file. You can check whether the file data is acceptable and correct.
-
Then, it shows the real data for the file when previewing the export or running the export in a flow.
-
(Make changes or tweaks accordingly in the real data in the source application you're exporting data from.)
-
-
Click Preview to confirm if all the errors are resolved and the parsed output data can move to the next step. If there are errors, the data will not move to the next step in the flow.