EDI Syntax Sets

Syntax is the term associated with the "enveloping" of EDI messages into interchanges. Items included in Syntax Set maintenance include: "Delimiters" which separate individual elements and segments within the interchange; "Envelope segments" which denote the beginning and ending of messages, functional groups, and interchanges; and "Permitted  Characters" which define the values allowed for a particular syntax set. Syntax set related information is a key component to establishing Trading Partner relationships within ECS/integrated email. 

To create/maintain a syntax set, perform the following:

• From the main "ECS/integrated email" panel click on the drop down menu "e-commerce",  select "EDI" then select "Syntax Set Maintenance" .

• The "Syntax Set Maintenance" window will now be displayed, listing any previously defined Syntax Sets..

       

• Click to select a Syntax Set from the list and click  the "Edit" command button. 

• The "Syntax Set  Maintenance" window will now be displayed with the details of the selected Syntax Set. 

The following describes the Syntax Set configuration: 

• The Syntax Set Id is the logical name for the Syntax Set, standard Syntax Sets are normally named by the governing body that maintains the Standard. A Syntax Set Id can be up to 10 characters long. 

• Syntax Sets can be updated and multiple versions can be supported. The Version is normally required whenever a reference is made to the Syntax Set on the Interchange Header Envelope Segment. 

• The Syntax Set Description contains free format descriptive text. A description of up to 50 Characters is allowed. 

• Delimiters are used to separate individual elements and segments within the interchange. Reserved characters defined as syntax Set Delimiters are used to separate the following: 

• Segment Id Separator is used to separate the Segment Id Tag from the data, in this example the Segment Id Separator is the + character displayed in Red:  NAD+SU+BBB Supplies Ltd+++Alphabet House:1 The Loop:Circle Street+Birmingham++B19 1DS'

• Segment Separator is used to denote the end of Segment and so separating the individual Segments. In this example the Segment Separator is the ' character displayed in Red:   NAD+SU+BBB Supplies Ltd+++Alphabet House:1 The Loop:Circle Street+Birmingham++B19 1DS'

• Element Separator is used to separate simple elements, in the following example the Element Separators are the + characters displayed in Red:   NAD+SU+BBB Supplies Ltd+++Alphabet House:1 The Loop:Circle Street+Birmingham++B19 1DS'

• Composite Element Separator is used to separate elements within a composite element, in the following example the Composite Element Separators are the : characters displayed in Red:   NAD+SU+BBB Supplies Ltd+++Alphabet House:1 The Loop:Circle Street+Birmingham++B19 1DS'

• Release Character is used to prefix a delimiter to so that the EDI Processor will treat the character immediately following the release character as a text character and not a delimiter: In the following example the release character is ? displayed in Red:   NAD+SU+BBB Supplie?'s Ltd+++Alphabet House:1 The Loop:Circle Street+Birmingham++B19 1DS'

• Decimal Point  is used to denote which character is used as the decimal point, normally,  period (.) or comma(,) 

• The Permitted Character Set consists of a list of individual characters that are allowed to be used within data elements. If the character is not listed then the EDI Message validation will fail. This list should only be maintained if the changes have been agreed with the respective Trading Partners, who should also make the same changes to their system. The Outbound Character Replacement functionality should be used to replace any characters used in the business application system, which are not permitted in the EDI Syntax Set.

• The Outbound Character Replacement list should be maintained to include any characters that are regularly used in the business application system and not included as a Permitted Character. Individual characters can be replaced with multiple characters. To add a new Outbound Character Replacement, add the character to be replaced followed by the replacement character, ensuring there is space between each character. In the above example the following character replacements will be performed during Outbound Message Pack:

  • Underscore "_"  replaced with dash "-" 

  • The at symbol "@" replaced with "at" 

  • The Dollar symbol "$" replaced with "S"

• Checking the Convert to Upper Case box causes the ECS/EDI Processor to convert all lower case characters to UPPER CASE. Designed for use where the Syntax Set does not allow lower case characters.  

• The Envelope Segment Tags are used by the ECS/EDI Processor during Packing and Unpacking of EDI Interchanges. The Envelope Segments are added to the Outbound Messages and Interchanges containing control data. The Envelope Segment Tags are normally named by the governing body that maintains the EDI Standard. 

• The Interchange, Functional Group and Message Default Outbound Envelope Values buttons enables the configuration and maintenance of the default Envelope Segments, inserted at the time the ECS/EDI Processor creates the Interchange. These Default Envelope Segments are defined for this Syntax Set and automatically added when a new Trading Partner Event Id is created with this Syntax Set. 

• Click OK to update the Syntax Set or Cancel to return to the EDI Syntax Set list without updating  the record. 

<<<<< Back to ECS/EDI Menu <<<<< 

Copyright © 1998-2003 Electronic Commerce Solutions All rights reserved.

ECS/integrated email & ECS/ie are trademarks of Electronic Commerce Solutions, Ltd. Other brand names and product names used in this document are the trademarks and trade names of their respective holders and may be registered.