Clickable Business Models eBusiness Education Acronyms Cross References
B2B Content Standards EC Technology Standards Glossary Implementation Guidelines
Implementation Options General Recommendations References Methodology/Legends
 Home | Copyright Notice and Legal Disclaimers | Navigation Help | Tour! | Downloads | Contact Us | Site Index | Search
Methodology | Legends | Conventions Used in EIDX Documentation | EIDX's Use of UML Class Diagrams | Procedures and Templates

Conventions used in EIDX Documentation

On this Page:


Also Recommended:


Standards Versions used in Supporting Documentation

Data segment and element positions referred in most supporting documentation are particular to ASC X12 Version 003020 or 004010, UN EDIFACT Version/Release 92.1 or D97A, or OAGIS version 8.0. Users of these documents may need to adapt information when applying these recommendations to other standards versions or directories.  For RosettaNet, the version is assigned at the PIP level, so not all PIPs are on the same version.  Reasonable attempts will be made to identify the version being described in the EIDX supporting documentation.  

Abbreviations and Conventions used when describing  X12 and EDIFACT

Abbreviation Description


Means that data elements are skipped in example segments.

DEnnn or DEnnnn

Data Element number nnn from the ASC X12 data dictionary or Data Element number nnnn from the UN EDIFACT data dictionary


Any segment which contains the data elements noted in the example


nn means the nth position within a segment, e.g., LIN06 is the sixth element in the LIN segment


Segment indicator is the first three alpha-numeric characters, nn is the data element or composite position with the segment, then Cnnnnn is the Composite number.

Loop and Segment Group

ASC X12 loop are indicated with the word ‘loop’ after is first segment name. EDIFACT segment groups are indicated by the code SG followed by the segment group number.


  1. Part, product, product identification, product ID are usually used interchangeably in these documents.
  2. The terms ‘code’ and ‘identifier’ are used synonymously.
  3. X12/UN refers to the ASC X12 standard and the UN EDIFACT standard. UN is often used since it is a shorter notation than EDIFACT.
Word or Symbol in MARGIN ATTRIBUTE Data Element NOTE MEANING
>> M (Mandatory) N/A If a segment, composite, or stand alone data element is mandatory according to the standard, EIDX/CompTIA cannot change the mandatory status on that component.

A data element within a composite is mandatory only if the composite is used.
X or 'Not Used' C or X (Conditional) or
O (Optional)
No note or
EIDX has determined no value in supplying the composite or data element; hence, it need not be generated.
Blank C or X (Conditional) or
O (Optional)
REQUIRED EIDX members agree that the data concerned must be sent.
Blank C or X (Conditional) or
O (Optional)
No note Indicates that EIDX makes no recommendation regarding usage. The trading partners must agree on usage.
Blank C or X (Conditional) or
O (Optional)
ADVISED EIDX has determined value in supplying the data element; hence, it should be generated.
Blank C or X (Conditional) or
O (Optional)
DEPENDING Data must be sent if a particular defined condition or set of conditions exist. The associated conditions must be explained at the appropriate level of detail.

Abbreviations and Conventions used when describing OAGIS

Abbreviation Description


Means that data elements are skipped in examples.


Open Applications Group, Inc.  The Official Airlines Guide has claimed rights to the acronym "OAG" but some older references for OAGI or OAGIS may still say "OAG".


Open Applications Group Integration Specification.  When we refer to the organization, we use "OAGI", when we refer to the specifications for the standard, we use OAGIS.

Abbreviations and Conventions used when describing  RosettaNet

Abbreviation Description


Means that data elements are skipped in examples.

RN or RNet

Abbreviation for RosettaNet


e.g. 3A4 - refers to Cluster-Segment-PIP number.  See Understanding What a PIP Number Represents.


Message Guideline - currently the ".html" file included in the PIP package.

0..1, 1..n, etc.

UML notation is used to specify cardinality.


UML notation for multiplicity (a/k/a cardinality)

Notation Description


Optional - zero or one occurrences permitted
0..n Optional - zero or more occurrences permitted
1 or 1..1 Mandatory - one occurrence permitted
1..n Mandatory - at least one occurrence required and multiple occurrences are permitted
Exact number, e.g. '3' Mandatory - specified number of occurrences must be present.
Range, e.g. 0..3 Optional - No more occurrences than the specified upper range may be present.
Range, e.g. 2..4 Mandatory - at least the number of occurrences specified in the lower range limit must be present; no more occurrences than the specified upper range limit may be present.

More about EIDX's UML notation here.


References to Data Groups, Segments and Elements


The UN/EDIFACT segments listed below are referenced on this web site and in downloadable documents. Their three character code is referenced without a description of the segment. Readers who are not familiar with the UN EDIFACT standard can reference this table as needed.




Allowance or Charge

To identify allowance or charge details.


Beginning of Message

To indicate the type and function of a message and to transmit the identifying number.


Contact Information

To identify a person or department to whom communication should be directed.


Communications Contact

To identify a communication number of a department or person to whom communication should be directed.



To specify currencies used in the transaction and relevant details for the rate of exchange.


Date/Time Reference

To specify date, and/or time, or period.


Line Item

To identify a line item and configuration.


Place/Location Identification

To identify a country/place/location/related location one/related location two.


Name and Address

To specify the name/address and their related function.



To describe the number and type of packages/physical units.


Additional Product ID

To specify additional or substitutional item identification and codes.



To specify a reference.


Details of Transport

To specify the transportation details such as mode of transport, its conveyance reference number and the identification of the means of transport.

ASC X12 Segments

The ASC X12 segments listed below are referenced on this web site and in downloadable documents. These are segments which are used in many transactions or have commonly used elements. For example, the N1 Name segment is used in most ASC X12 transactions to convey "Name". The PO1, POC, LIN and others, which are used in different transactions, have a similar function to convey line item information. They all contain DE235/234 pairings which are used to convey product identification information. Their two or three character codes are referenced without a description of the segment. Readers who are not familiar with the ASC X12 standard can reference this table as needed.




Line Item Acknowledgment To acknowledge ordered quantities and specify the ready date for a specific line item.


Beginning Segment for Purchase Order To indicate the beginning of the purchase order transaction and transmit identifying numbers and dates.


Currency To specify the currency (dollars, pounds, francs, etc.) used in a transaction.


Date/Time Reference To specify pertinent dates and times.


Forecast Schedule To specify the forecasted dates and quantities


Baseline Item Data (Invoice) To specify the basic and most frequently used line item data for the invoice and related transactions.


Allowance, Charge or Service To specify allowances, charges or services.


Item Identification To specify basic item identification data.


Name To identify a party by type of organization, name and code.


Additional Name Information To specify additional names or those longer than 35 characters in length.


Address Information To specify the location of the named party.


Geographic Location To specify the geographic place of the named party.


Administrative Communications Contact To identify a person or office to whom administrative communications should be directed.


Purchase Order Baseline Item Data To specify basic and most frequently used purchase order line item data.


Item Physical Details To specify the physical qualities, packaging, weights and dimensions relating to the item.


Line Item Change To specify changes to a line item.


Reference Numbers To specify identifying numbers.


Line Item Schedule To specify the data for scheduling a specific line item.


Destination Quantity To specify destination and quantity detail.


Sub-line Item Detail To specify product sub-line detail item data.


Carrier Details (Routing Sequence/Transit Time) To specify the carrier, sequence of routing and to provide transit time information

ASC X12 Data Elements are often referenced on this web site and in downloadable documents. The reference to its number may be used without its description.




Product/Service ID Identify number for a product or service


Product/Service ID Qualifier Code identifying the type/source of the descriptive number used in Product/Service ID (234).

Sample Segment Table:

seg_table.jpg (31218 bytes)

Sample Segment Detail:

seg_detail.jpg (48936 bytes)



References to Response Transactions/Messages

One transaction initiates an entire process between trading partners. The original receiving party often responds with another transaction.   The appropriate response transaction/message depends on context - the business process scenario and/or the results of processing. 

  • For example, the response to a purchase order is usually a purchase order acknowledgment.  However, if the item ordered is being shipped immediately, a ship notice saying that the item has shipped means the order is legally accepted, and the buyer knows the ship date.  In this context, the PO acknowledgment is redundant.

 Few transactions/messages use the same response regardless of context.   When the term ‘Response Transaction’ is used in this document, it is referring to the type of transactions/message below.



Forecast Response to Forecast, Release
Invoice Payment Advice, Remittance Advice
Price/Sales Catalog Request for Quote
Purchase Order Acknowledgment, Change Order, Release, Ship Notice, Receipt Advice, Invoice, Forecast
Request for Quote Response to Quote


Last updated 06 February 2003