Create and Send a New EDI
To create a new EDI, start by selecting the document/transaction type you need (e.g. ASN, Invoice, Load Tender Response) from the side menu. Then choose the partner, and the corresponding editor will load if that partner has an EDI definition configured for that document/transaction type.
The document/transaction types available on the side menu will depend on the EDI Domain(s) and additional types you have selected under your account settings.
In the loaded editor, icon represents a segment, and represents a loop. Each row shows the maximum number of occurrences or iterations allowed for that segment/loop along with an indicator of whether that segment/loop is specified as Mandatory or Optional.
Add Segment
Once you click on a segment, it opens in a tabular view. Each row of the table represents an instance/occurrence of the segment. The Add Segment Iteration button on the segment header or the Add Row button in the top left corner of the table can be used to add more occurrences of the segment until the maximum limit (if any) is reached.
Add Loop
To add a loop, there are 2 options as Basic mode and Advanced mode.
Basic Mode
The Basic mode is optimized for widely used loops such as IT1, PO1, and N1. Instead of displaying a complex hierarchy of all nested segments and loops, it presents a flattened representation of the loop in a simple tabular format.
Each row in the table represents one loop iteration, and the commonly used elements of the sub-segments are displayed as table columns. The Add Loop Iteration button on the loop header or the Add Row button in the top left corner of the table can be used to add more iterations to the loop until the maximum limit (if any) is reached.
Advanced Mode
The Advanced mode presents the complete hierarchy of each loop iteration including all the nested loops and segments of that loop iteration. This mode includes two sub-views as
- List View where all loop iterations are shown at once in a single list and,
- Paginated View where only one loop iteration is shown at a time, with navigation controls to move between iterations.
In advanced mode, the Add Loop Iteration button on the loop header or on a loop iteration header can be used to add more iterations to the loop until the maximum limit (if any) is reached.
Validate and Save
Once all the details are added, click Validate and Save button in the top right corner to save it to the database. After saving the EDI, EDI Generator will automatically validate the content of the generated EDI against the hierarchical, syntax and data rules specified in the corresponding EDI definition.
If there are no validation errors, you can click Send button to send the EDI file to your partner.
Validation Errors
If the EDI Generator encountered any validation errors for the generated EDI, they will be list in a popup window as below. Each line on that list will provide a clear description of the validation failure and the segment number corresponding to that error. In addition, it provides the capability to copy individual errors or all errors to the clipboard and also to locate the segment or loop corresponding to the error within the editor.
When the error is corresponding to a top level segment, the locate error operation will highlight that segment on the editor with a red outline, and then scroll the editor to that segment. Once the error is corrected, user can mark the error as resolved to remove the highlight.
If the error is corresponding to a segment within a loop iteration, the outcome of the locate error operation will depend on the editor mode of the parent loop. If the parent loop is in Basic Mode, the operation will highlight the entire row corresponding to the loop iteration which contains the erroneous segment, by changing its background color to red. Also the editor will be scrolled to the parent loop.
If the parent loop is in Advanced Mode, the operation will highlight the exact erroneous segment within the loop iteration hierarchy with a red outline, and then scroll the editor to that segment.
