|
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 |
|
...
|
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 that
contains the data elements noted in the example. |
|
(SEG)nn
|
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. |
- 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; 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 determined a value in
supplying the data element and 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 |
|
...
|
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 use "OAG." |
|
OAGIS
|
Open Applications
Group Integration Specification. Use OAGI to refer to
the group and OAGIS to refer to the specifications for a standard. |
Abbreviations
and Conventions Used When Describing RosettaNet
|
Abbreviation |
Description |
|
...
|
Data elements
are skipped in examples. |
|
RN or RNet
|
Abbreviation for
RosettaNet |
|
number-alpha-number
|
e.g. 3A4 - refers
to Cluster-Segment-PIP number. |
|
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. |
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 |
Identify allowance or charge
details.
|
|
BGM
|
Beginning of Message |
Indicate the type and function
of a message and to transmit the identifying number.
|
|
CTA
|
Contact Information |
Identify a person or department
to whom communication should be directed.
|
|
COM
|
Communications Contact |
Identify a communication number
of a department or person to whom communication should be
directed.
|
|
CUX
|
Currencies |
Specify currencies used in
the transaction and relevant details for the rate of exchange.
|
|
DTM
|
Date/Time Reference |
Specify date, and/or time,
or period.
|
|
LIN
|
Line Item |
Identify a line item and configuration.
|
|
LOC
|
Place/Location Identification |
Identify a country/place/location/related
location one/related location two.
|
|
NAD
|
Name and Address |
Specify the name/address and
their related function.
|
|
PAC
|
Package |
Describe the number and type
of packages/physical units.
|
|
PIA
|
Additional Product ID |
Specify additional or substitutional
item identification and codes.
|
|
RFF
|
Reference |
Specify a reference.
|
|
TDT
|
Details of Transport |
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 that
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 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.
|
SEGMENT
|
DESCRIPTION |
PURPOSE |
|
ACK
|
Line Item Acknowledgment |
Acknowledge ordered quantities
and specify the ready date for a specific line item. |
|
BEG
|
Beginning Segment for Purchase
Order |
Indicate the beginning of the
purchase order transaction and transmit identifying numbers
and dates. |
|
CUR
|
Currency |
Specify the currency (dollars,
pounds, francs, etc.) used in a transaction. |
|
DTM
|
Date/Time Reference |
Specify pertinent dates and
times. |
|
FST
|
Forecast Schedule |
Specify the forecasted dates
and quantities |
|
IT1
|
Baseline Item Data (Invoice) |
Specify the basic and most frequently
used line item data for the invoice and related transactions. |
|
ITA
|
Allowance, Charge or Service |
Specify allowances, charges
or services. |
|
LIN
|
Item Identification |
Specify basic item identification
data. |
|
N1
|
Name |
Identify a party by type of
organization, name and code. |
|
N2
|
Additional Name Information |
Specify additional names or
those longer than 35 characters in length. |
|
N3
|
Address Information |
Specify the location of the
named party. |
|
N4
|
Geographic Location |
Specify the geographic place
of the named party. |
|
PER
|
Administrative Communications
Contact |
Identify a person or office
to whom administrative communications should be directed. |
|
PO1
|
Purchase Order Baseline Item
Data |
Specify basic and most frequently
used purchase order line item data. |
|
PO4
|
Item Physical Details |
Specify the physical qualities,
packaging, weights and dimensions relating to the item. |
|
POC
|
Line Item Change |
Specify changes to a line item. |
|
REF
|
Reference Numbers |
Specify identifying numbers. |
|
SCH
|
Line Item Schedule |
Sspecify the data for scheduling
a specific line item. |
|
SDQ
|
Destination Quantity |
Specify destination and quantity
detail. |
|
SLN
|
Sub-line Item Detail |
Specify product sub-line detail
item data. |
|
TD5
|
Carrier Details (Routing Sequence/Transit
Time) |
Specify the carrier, sequence
of routing and to provide transit time information |
ASC X12 Data Elements are often referenced on
this Website 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 |
|