| Conventions Used in CompTIA
EIDX Documentation
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 |
|
(SEG)
|
Any segment which
contains the data elements noted in the example |
|
(SEG)nn
|
nn means the nth
position within a segment, e.g., LIN06 is the sixth element
in the LIN segment |
|
(SEG)nn.Cnnnnn
|
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. |
Note:
- Part, product, product identification, product
ID are usually used interchangeably in these documents.
- The terms code and identifier
are used synonymously.
- 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.
DATA ELEMENT within a COMPOSITE:
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
NOT USED |
EIDX has determined
no value in supplying the composite or data element; 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; 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. |
|
OAGI
|
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". |
|
OAGIS
|
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 |
|
Number-alpha-number
|
e.g. 3A4 - refers
to Cluster-Segment-PIP number. See Understanding
what a PIP Number Represents. |
|
MG
|
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 |
|
0..1
|
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
UN/EDIFACT Segments
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.
|
SEGMENT
|
DESCRIPTION |
PURPOSE |
|
ALC
|
Allowance or Charge |
To identify allowance or
charge details.
|
|
BGM
|
Beginning of Message |
To indicate the type and
function of a message and to transmit the identifying number.
|
|
CTA
|
Contact Information |
To identify a person or
department to whom communication should be directed.
|
|
COM
|
Communications Contact |
To identify a communication
number of a department or person to whom communication should
be directed.
|
|
CUX
|
Currencies |
To specify currencies used
in the transaction and relevant details for the rate of exchange.
|
|
DTM
|
Date/Time Reference |
To specify date, and/or
time, or period.
|
|
LIN
|
Line Item |
To identify a line item
and configuration.
|
|
LOC
|
Place/Location Identification |
To identify a country/place/location/related
location one/related location two.
|
|
NAD
|
Name and Address |
To specify the name/address
and their related function.
|
|
PAC
|
Package |
To describe the number
and type of packages/physical units.
|
|
PIA
|
Additional Product
ID |
To specify additional or
substitutional item identification and codes.
|
|
RFF
|
Reference |
To specify a reference.
|
|
TDT
|
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 that 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.
|
SEGMENT
|
DESCRIPTION |
PURPOSE |
|
ACK
|
Line Item Acknowledgment |
To acknowledge ordered
quantities and specify the ready date for a specific line item. |
|
BEG
|
Beginning Segment
for Purchase Order |
To indicate the
beginning of the purchase order transaction and transmit identifying
numbers and dates. |
|
CUR
|
Currency |
To specify the currency
(dollars, pounds, francs, etc.) used in a transaction. |
|
DTM
|
Date/Time Reference |
To specify pertinent
dates and times. |
|
FST
|
Forecast Schedule |
To specify the forecasted
dates and quantities |
|
IT1
|
Baseline Item Data
(Invoice) |
To specify the basic
and most frequently used line item data for the invoice and
related transactions. |
|
ITA
|
Allowance, Charge
or Service |
To specify allowances,
charges or services. |
|
LIN
|
Item Identification |
To specify basic
item identification data. |
|
N1
|
Name |
To identify a party
by type of organization, name and code. |
|
N2
|
Additional Name
Information |
To specify additional
names or those longer than 35 characters in length. |
|
N3
|
Address Information |
To specify the location
of the named party. |
|
N4
|
Geographic Location |
To specify the geographic
place of the named party. |
|
PER
|
Administrative Communications
Contact |
To identify a person
or office to whom administrative communications should be directed. |
|
PO1
|
Purchase Order Baseline
Item Data |
To specify basic
and most frequently used purchase order line item data. |
|
PO4
|
Item Physical Details |
To specify the physical
qualities, packaging, weights and dimensions relating to the
item. |
|
POC
|
Line Item Change |
To specify changes
to a line item. |
|
REF
|
Reference Numbers |
To specify identifying
numbers. |
|
SCH
|
Line Item Schedule |
To specify the data
for scheduling a specific line item. |
|
SDQ
|
Destination Quantity |
To specify destination
and quantity detail. |
|
SLN
|
Sub-line Item Detail |
To specify product
sub-line detail item data. |
|
TD5
|
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.
|
Element
|
DESCRIPTION |
PURPOSE |
|
DE234
|
Product/Service
ID |
Identify number
for a product or service |
|
DE235
|
Product/Service
ID Qualifier |
Code identifying
the type/source of the descriptive number used in Product/Service
ID (234) |
Sample Segment Table:

Click here to view a larger image.
Sample Segment Detail:

Click here to view a larger image.
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.
|
INITIATING TRANSACTIONS |
SUBSEQUENT TRANSACTIONS
|
| 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 |
|