EDI settings in Jitterbit EDI¶
Introduction¶
The EDI settings tab is where you define the EDI settings for transactions made with a trading partner. To open it, use the Harmony portal menu to select EDI > Admin, add or select a trading partner, then select the EDI settings tab:
Settings are grouped into horizontal tabs. Use the and icons to open and close a tab.
Important
The available settings depend on the Map Processing and EDI standard settings for the first configured workflow in the selected partner's workflow list. You can override these settings by explicitly including the values in the XML, or by using variables or other methods available in Integration Studio.
For EDIXml (EDIFACT, Tradacoms, and X12) and XCBL workflows, the Preferred IDs, Control Number, and Advanced tabs are the same. If there are no workflows, only these tabs are shown. When workflows are configured, the following additional tabs are shown:
-
EDIXml (EDIFACT), EDIXml (X12), and XCBL workflows: Interchange, Functional Group, and Separators tabs.
-
EDIXml (Tradacoms) and XCBL workflows: Interchange, and Separators tabs.
If you change any values on this page, click the Save button.
Note
The EDI settings are designed to include all essential elements for creating the EDI document. Additional mandatory elements may be required according to the implementation guide provided by your trading partner. These elements must be explicitly mapped in the XML.
Preferred ID¶
Use this tab to set which company ID (GS ID) to use with each partner:
-
Partner ID: Choose the partner's ID (GS ID).
-
Company ID: Choose the company ID (GS ID) to use with this partner.
-
Add New Partner ID: Enter a new partner ID, click Add, then select the new ID from the Partner ID list.
-
Add New Company ID: Enter a new company ID, click Add, then select the new ID from the Company ID list. (You cannot delete added company IDs.)
Interchange¶
EDIXml (EDIFACT)¶
-
Syntax Identifier (UNB01.1): Address for reverse routing.
-
Syntax Version Number (UNB01.2): Version of address for reverse routing.
-
Sender Address for Reverse Routing (UNB02.3): Unique reference assigned by Sender.
-
Receiver Address for Reverse Routing (UNB03.3): Identifies a particular application or business process that is relevant to the interchange. It helps to link the interchange to a specific business context or workflow.
-
Recipient's Reference (UNB06.1): Optionally message identification if the interchange contains only one type of message.
-
Recipient's Reference Qualifier (UNB06.2): Code indicating how the recipient identifies or categorizes the message.
-
Application Reference (UNB07): Set to 1 if sender requests acknowledgement, i.e. UNB and UNZ segments received and identified.
-
Processing Priority Code (UNB08): If used, to identify type of communication agreement controlling the interchange, e.g. Customs or ECE agreement. Code or name as specified in IA.
-
Acknowledgment Requested (UNB09): Identifies the syntax used in the message. This includes the syntax version number and the agency responsible for the syntax.
-
Communication Agreement ID (UNB10): Specifies the version of the syntax being used.
-
Test Indicator (UNB11): Set to 1 if the interchange is a test.
EDIXml (Tradacoms)¶
-
Syntax Identifier (STX01.1): This code signifies the beginning of a new EDI message or envelope. It marks the start of the envelope segment, which contains the metadata and control information necessary for processing the EDI transaction.
-
Syntax Version Number (STX01.2): This code provides additional details or specifications related to the start of the envelope. It might include further identifiers or settings that complement the primary start of the envelope code.
-
Sender Name (STX02.2): This code may include supplementary data or extended information that complements the primary envelope header. It can contain additional administrative or reference details.
-
Receiver Name (STX03.2): This code could represent supplementary data or segments within the body of the envelope. It may include additional details or attachments related to the primary body content.
-
Control Number (STX05): This segment signifies the end of the entire EDI envelope, marking the conclusion of the message. It helps in defining where the envelope finishes and assists in proper message parsing and processing.
-
Recipients Reference (STX06): This code might be used for additional closure or finalization details related to the end of the envelope. It ensures that all required segments are properly completed.
-
Application Reference (STX07): This segment could be used for any extra or supplementary information that doesn’t fit into the main envelope segments but is still relevant for processing the EDI message.
-
Priority Code (STX08): This code represents any special segments or codes that might be used for specific purposes, such as industry-specific requirements or additional processing needs.
EDIXml (X12), XCBL¶
-
Authorization Information Qualifier (ISA01): Identifies the type of authorization information that follows in ISA02. Common values include
00
for no authorization information, or01
for a password. -
Authorization Information (ISA02): Contains the authorization information specified by ISA01. It can be used for security or authentication purposes, though it is often left empty.
-
Security Information Qualifier (ISA03): Identifies the type of security information that follows in ISA04. Common values include
00
for no security information, or01
for a password. -
Security Information (ISA04): Contains the security information specified by ISA03. As with ISA02, this is used for additional security, but is often left empty.
-
Control Standard Identifier (ISA11): Identifies the standards version being used. Typically, this is
U
for X12. -
Control Version Number (ISA12): Indicates the version of the X12 standard used. For example,
00401
is for X12 4010. -
Acknowledgment Requested (ISA14): Indicates whether an acknowledgment is requested. Common values are
0
for no acknowledgment, or1
for acknowledgment required. -
Usage Indicator (ISA15): Identifies the type of data in the interchange. For example,
P
for production data, orT
for test data.
Functional Group¶
EDIXml (EDIFACT)¶
-
Association Assigned Code (UNG07.3): A code assigned by the association responsible for the design and maintenance of the type of message concerned.
-
Application Password (UNG08): Password to recepient's division, department or sectional system (if required).
EDIXml (X12), XCBL¶
-
Responsible Agency Code (GS07): Identifies the issuer of the standard. (
X
is for X12.) -
GS Document Version Code (GS08): The GS version that indicates the beginning of a functional group for control information.
Separators¶
EDIXml (EDIFACT)¶
-
Component Element Separator (UNA01.1): Specifies the character used to separate components within data elements.
-
Element Separator (UNA01.2): Specifies the character used to separate individual data elements within a segment.
-
Decimal Notation (UNA01.3): Specifies the character used for decimal notation.
-
Release Indicator (UNA01.4): Specifies the character used to indicate that the next character is to be treated as a literal rather than a separator or delimiter.
-
Repetition Separator (UNA01.5): Specifies the character used to terminate a segment.
-
Segment Terminator (UNA01.6): The character that indicates the end of a segment in the document.
EDIXml (Tradacoms)¶
-
Element Separator: The character that separates individual data elements in the document.
-
Component Separator: The character that separates elements within a composite data structure in the document.
-
Segment Terminator: The character that indicates the end of a segment in the document.
-
Release Indicator: The character that releases (escapes) the next character, overriding its usual meaning. This allows reserved characters to appear as data within documents, as long as they are preceded by the Release Char.
EDIXml (X12), XCBL¶
-
Component Element Separator (ISA16): The character used to separate components within an element. Commonly used values include
~
or^
. -
Element Separator (ISA17): The character used in segments to mark the start of a data element.
-
Segment Separator (ISA18): The character that separates segments.
Control number¶
- Control Number: The number used in the header of an EDI document to validate exchanged documents.
Advanced¶
- Send 997: Enable to automatically send a functional acknowledgment (997) for every message received.