e-business Board for European Standardisation
Expert Group 6
Statistics
Address :Eurostat
Secretariate eBES/EG6
c/o Wolfgang Knüppel
Joseph Bech Building, A3/158
L-2920 Luxembourg
Phone :(+352) 4301 33221, (+352) 4301 35373 (Secretariat)
Fax :(+352) 4301 32139
Internet:
Date of issue: / December 1, 1997Last updated: / July 30, 2003
Reference to be quoted : / EG6/WG3MigEdifact_02
Status : / Draft/1
Author : WG 3
CLASET
Edifact Message Implementation Guide
Mail: Bâtiment Jean Monnet, Rue Alcide de Gasperi, L-2920 Luxembourg
Offices: Bâtiment Joseph Bech, 5 Rue Alphonse Weicker, L-2721 Luxembourg
Telephone: switchboard 43011 Telex: COMEU B 21877. Telegraphic address: COMEUR Luxembourg
EDIFACT Message Implementation Guide
CLASET : Classification Information Set Message
Table of Contents
Introduction------
Section One: Explanation of Segment Group and Segment Type Definitions------
Documenting the Rules------
Section Two: Message Specification------
Message Specification------
Functions Supported------
Branching Diagram------
Section Three: General Segment Rules------
Segment Type: DTM------
Segment Type: STS------
Segment Type: DTM------
Segment Type: ATT------
Segment Type: ELM------
Segment Type: CAV------
Segment Type: FTX------
Section Four: Detailed Segment Rules------
Introduction------
Interchange and Message Envelope Segments------
Segment Type: UNA------
Segment Type: UNB------
Segment Type: UNH------
Message Administration Segments------
Segment Type: BGM------
Segment Type: DTM------
Segment Group: Group 1 (RFF-DTM)------
Segment Type: RFF------
Segment Type: DTM------
Segment Group: Group 2 (PNA-ADR-Gr 3)------
Segment Type: PNA------
Segment Type: ADR------
Segment Group: Group 3 (CTA-COM)------
Segment Type: CTA------
Segment Type: COM------
Classification Segments------
Segment Group: Group 4 (VLI-DTM-EQN-Gr 5-Gr 7-Gr 8-Gr 11)------
Segment Type: VLI------
Segment Structures DTM------
Segment Type: EQN------
Segment Group: Group 5 (PNA-LAN-Gr 6)------
Segment Type: PNA------
Segment Type: LAN------
Segment Group: Group 6 (CTA-ADR-COM)------
Segment Type: CTA------
Segment Type: ADR------
Segment Type: COM------
Segment Group Gr. 7 (STS-DTM)------
Segment Structures Gr 8 (ATT-DTM-ELM-Gr 9-Gr 10)------
Segment Group Gr. 9 (CAV-FTX)------
Segment Group Gr. 10 (STS-DTM)------
Segment Group: Gr 11 (SCD-DTM-EQN-Gr 12-Gr 13-Gr 16)------
Segment Type: SCD------
Segment Structures DTM------
Segment Type: EQN------
Segment Group Gr. 12 (STS-DTM)------
Segment Structures Gr 13 (ATT-DTM-ELM-Gr 14-Gr 15)------
Segment Group Gr. 14 (CAV-FTX)------
Segment Group Gr. 15 (STS-DTM)------
Segment Group: Gr 16 (IDE-DTM-EQN-Gr 17-Gr 18)------
Segment Type: IDE------
Segment Structures DTM------
Segment Type: EQN------
Segment Group Gr. 17 (STS-DTM)------
Segment Structures Gr 18 (ATT-DTM-ELM-Gr 19-Gr 20)------
Segment Group Gr. 19 (CAV-FTX)------
Segment Group Gr. 20 (STS-DTM)------
Segment Type: UNT------
Segment Type: UNZ------
Section Five: Examples------
Classification------
Link Set------
Section Six: Summary of Code Values------
Code Values by Attribute------
Code Values by Segment and Data Element------
Appendix One: Message Specification------
Message Definitions------
Branching Diagram------
Appendix Two: Segments Directory------
Summary of Segment Format------
Segment Structure Definition------
Version 1.01: DecemberMay 22 1997CLASET EDIFACT Implementation Guide
EG6/WG3MigEdifact_021
Introduction
This guide is intended for people who are implementing the Classification Information Set (CLASET) message in the EDIFACT format.
The general information about the CLASET implementation is described in the CLASET General Implementation Guide (document reference: EG6/WG3/MigGeneral_02). This document details the entities, the attributes, the code values and explains how to send sequentially the elements of a classification.
The CLASET data model is described in Merise notation in the document called “CLASET Merise conceptual data model” (reference: EG6/WG3/ModMerise_09) and in UML notation in the document “CLASET UML model” (reference: EG6/WG3/CLASETUMLModel_02).
CLASET is also implemented in SGML format (see document EG6/WG3/MigSGML_02), and in XML format (see document EG6/WG3/MigXML_01).
The CLASET toolbox, available on the WEB, allow the translation from one format to another and the generation of HTML files from a CLASET message.
Version 1.01: DecemberMay 22 1997CLASET EDIFACT Implementation Guide
EG6/WG3MigEdifact_021
Section One: Explanation of Segment Group and Segment Type Definitions
Documenting the Rules
The Edifact structures used to define the various objects of a classification (i.e. classification, level, item) are identical and the only difference in their use is the code values allowed. For instance a property is always defined by means of the STS-DTM. This segment pair appears many times in message - once for each of classification, property of classification, level, property of level, item, property of item. The only difference in the rules for the use of this segment pair is in the types of status event allowed for a particular object, and the type of validity date allowed.
For this reason the documentation of the rules comprises a section on the rules for each of the general segments, followed by a section which documents the rules for each segment group and segment in the sequence in which the segment group and segment type appears in the message.
The following information is given for each segment group and segment type:
Segment Type
This is the three-character identification of the segment type.
Segment Type Name
This is the name of the segment type.
Max. Number of Occurrences
This is the maximum number of occurrences allowed in the CLASET message (e.g. 9 indicates that 9 occurrences are allowed in CLASET). Note that for the trigger segment this number will always be 1, as the trigger segment can occur once only in each occurrence of the segment group.
Status
This gives the status of the segment type (i.e. mandatory, conditional).
Segment Group/Max. Number of Occurrences/Status
This information is the same as that given for the segment type.
Content and General Usage Rules
This describes the purpose of the segment group or segment type, and gives general rules applicable to the whole of the segment group or segment type.
Segment Structure
This is defined in a table using the following headings:
TAG / Edifact Name / Status / Format / Usage / Local Name(Attributes)
TAGthis is the four character data element identifier
Edifact Namethis is the Edifact name for the data element
composite elements are shown in UPPER CASE and component data elements are shown in lower case
Statusthis is the status of the data element in the segment as it appears in the Edifact segments directory: it is either M (mandatory) or C (conditional)
Formatthis is the format of the data element in the Edifact data elements directory: the notation used is as follows:
aalphabetic characters
nnumeric characters
analphanumeric characters
examples
a33 alphabetic characters, fixed length
n33 numeric characters, fixed length
a..3up to 3 alphabetic characters
n..3up to 3 numeric characters
an..3up to 3 alphanumeric characters
Usagethis is the usage status of the data element in this message
it is either R (required), A (advised), D (dependent), or X (not used) as defined below:
RRequired
indicates that the data concerned must be sent
DDependent
indicates that the data concerned must be sent if a particular condition or set of conditions exists. The associated conditions are specified in the guidelines for the data element (e.g. the value of another data element in the same segment)
AAdvised (Recommended)
indicates that the exchange of this information will enable users to build generic systems
XNot used
indicates that the data concerned are NOT to be sent
Local Namethis is the name given to the data element in this implementation guide: this name reflects the use of the data element in CLASET and is often similar to the name of the attribute it implements
(Attribute)this is a list of the attribute names from the data model that this data element implements; names starting with xxxx depict a number of attributes of the same purpose (e.g. xxxx_start_valid_period represents all attributes with a name ending in start_valid_period)
Data Element Sequence
This defines the sequence of the data elements in the segment type, in terms of the local names.
Data Element Usage Rules
This gives the rules for the use of the data element in a table using the following headings:
local name / group / usage rules / code valuesor
local name / usage rules / code valueslocal namethis is the local name defined in the segment structure
group this column appears in the table for the rules for the general segments and identifies the group
usage rulesthis contains the rules for the use of the data element
code-valuesthis is a list of valid code values for use in this message; see Section 6 for the meaning of codes in square brackets [] and codes in wavy brackets {}.
Example
At least one example of the use of the segment is shown.
Version 1.01: DecemberMay 22 1997CLASET EDIFACT Implementation Guide
EG6/WG3MigEdifact_021
Section Two: Message Specification
Message Specification
The full message specification is given in appendix one. This specification is extracted from the UN/EDIFACT message directory.
Functions Supported
The following functions are supported by the CLASET message:
- Requesting/Sending general information on classifications
- Requesting/Sending all objects of a classification or a classification sub-set, including events and properties for each object of the classification or sub-set.
- Requesting/Sending an update to a classification or a classification sub-set.
- Requesting/Sending a set of links between two classifications, the source and target levels and items, and including events and properties for the link.
- Requesting/Sending a complete description of a classification.
These functions are explained in the “CLASET data model” (document reference: EG6/WG3/mda/95003).
Version 1.01: DecemberMay 22 1997CLASET EDIFACT Implementation Guide
EG6/WG3MigEdifact_021
Branching Diagram
Version 1.01: DecemberMay 22 1997CLASET EDIFACT Implementation Guide
EG6/WG3MigEdifact_021
Section Three: General Segment Rules
The following segments have similar rules wherever they appear in the message structure.
- DTM - when used to define an interval of validity
- STS-DTM - to define a status event or confidentiality code
- ATT - to define a property type and coded property value
- ELM - to define a property data format
- CAV - FTX - to define a textual property value
Version 1.01: DecemberMay 22 1997CLASET EDIFACT Implementation Guide
EG6/WG3MigEdifact_02DTM1
Segment Type:DTM
Segment Type Name:Date/Time/Period
Content and General Rules
This contains the start and, possibly, the end period of validity. There is one occurrence of the segment for each of the start and end period.
Segment Structure
TAG / Edifact Name / Status / Format / Usage / Local Name(Attributes)
C507 / DATE/TIME/PERIOD / M / R
2005 / Date/time/period qualifier / M / an..3 / R / date-time-type
2380 / Date/time/period / C / an..35 / R / date-time
(xxxx_start_valid_period)
(xxxx_end_valid_period)
2379 / Date/time/period format qualifier / C / an..3 / R / date-time-format
Data Element Sequence
DTM+date-time-type:date-time:date-time-format’
Data Element Usage Rules
local name / group / usage rules / code valuesdate-time-type / all / 7 - effective date
36 - expiry date
date-time / all / the format of the date is defined by date-time-format
date-time-format / all / 101 - YYMMDD
102 - CCYYMMDD
Example
the validity period is 08.11.1994 to 12.12.96
DTM+7:19941108:102’
DTM+36:19961212:102’
Version 1.01: DecemberMay 22 1997CLASET EDIFACT Implementation Guide
EG6/WG3MigEdifact_02STS1
Segment Type:STS
Segment Type Name:Status Report
Content and General Usage Rules
This is used to specify an event log, a visibility criteria (data privacy), a function to perform (maintenance operation) or an item or property status (data elaboration).
Segment Structure
TAG / Edifact Name / Status / Format / Usage / Local Name(Attributes)
C601 / STATUS TYPE / C / R
9015 / Status type, coded / M / an..3 / R / status-type
(event_life_cycle_step)
1131 / Code list qualifier / C / an..3 / R / list-qualifier
3055 / Code list responsible agency, coded / C / an..3 / A / code-list-agency
C555 / STATUS EVENT / C / R
9011 / Status event, coded / M / an..3 / R / status code
(event_operation)
(xxxx_visibility-criteria)
(xxxx_function)
(xxxx_status)
1131 / Code list qualifier / C / an..3 / R / list-qualifier
3055 / Code list responsible agency, coded / C / an..3 / A / code-list-agency
C556 / STATUS REASON / C / X
C556 / STATUS REASON / C / X
C556 / STATUS REASON / C / X
C556 / STATUS REASON / C / X
C556 / STATUS REASON / C / X
Data Element Sequence
STS+status-type:list-qualifier:code-list-agency+status-code:list-qualifier:code-list-agency’
Data Element Usage Rules
local name / group / usage rules / code valuesstatus-type / all / this specifies the type of status-code used / {1} - visibility criteria
{2} - object status
{3} - function to perform
{5} - data compilation
{6} - data maintenance
{7} - data reference
{8} - data dissemination
list-qualifier
code-list-agency / all
all / {S03} - status type
142
status-code / all / this specifies the status identified by status-type / 1131 is S01 - data privacy
{1} - restricted
{2} - unrestricted
1131 is S02 - maintenance operation
{6} - delete
{7} - add and replace
{8} - replace
{9} - new
{10} - freeze
1131 is S04 - data elaboration
{2} - updated
{3} - provisional
{4} - revised
{5} - final
1131 is S05 - life cycle operation
{1} - created
{2} - updated
{3} - deleted
{4} - rectified
list-qualifier
code-list-agency / all
/ {S01} - data privacy
{S02} - maintenance operation
{S04} - data elaboration
{S05} - life cycle event
142
Examples
Visibility Criteria: Object has confidentiality “restricted”
STS+1:S03:142+1:S014:142’
Event log: Object created during the compilation step
STS+5:S03:142+1:S05:142’
Function: Object is to be added or replaced
STS+3:S03:142+7:S02:142’
Status: Object is revised
STS+2:S03:142+4:S04:142’
Version 1.01: DecemberMay 22 1997CLASET EDIFACT Implementation Guide
EG6/WG3MigEdifact_02DTM1
Segment Type:DTM
Segment Type Name:Date/Time/Period
Content and General Rules
This contains dates and times relevant to event log.
Segment Structure
TAG / Edifact Name / Status / Format / Usage / Local Name(Attributes)
C507 / DATE/TIME/PERIOD / M / R
2005 / Date/time/period qualifier / M / an..3 / R / date-time-type
2380 / Date/time/period / C / an..35 / R / date-time
(event_date)
2379 / Date/time/period format qualifier / C / an..3 / R / date-time-format
Data Element Sequence
DTM+date-time-type:date-time:date-time-format’
Data Element Usage Rules
local name / group / usage rules / code valuesdate-time-type / 7, 10, 12, 15, 17, 20 / 7 - effective date
date-time / 7, 10, 12, 15, 17, 20 / the format of the date is defined by date-time-format
date-time-format / 7, 10, 12, 15, 17, 20 / 101 - YYMMDD
102 - CCYYMMDD
Example
the effective date is 23.06.93
DTM+7:19930623:102’
Version 1.01: DecemberMay 22 1997CLASET EDIFACT Implementation Guide
EG6/WG3MigEdifact_02ATT1
Segment Type:ATT
Segment Type Name:Attribute
Content and General Usage Rules
This specifies the name of a property and, for coded properties, the property code. A textual property is contained either in FTX segment.
Segment Structure
TAG / Edifact Name / Status / Format / Usage / Local Name(Attributes)
9017 / ATTRIBUTE FUNCTION QUALIFIER / M / an..3 / R / attribute-domain
C955 / ATTRIBUTE TYPE / C / R
9021 / Attribute type, coded / C / an..3 / R / attribute-type
(property_name)
1131 / Code list qualifier / C / an..3 / R / list-qualifier
3055 / Code list responsible agency, coded / C / an..3 / A / code-list-agency
C956 / ATTRIBUTE DETAILS / C / D
9019 / Attribute, coded / C / an..3 / D / attribute-code
(property_value)
1131 / Code list qualifier / C / an..3 / D / list-qualifier
3055 / Code list responsible agency, coded / C / an..3 / D / code-list-agency
9018 / Attribute / C / an..35 / D / attribute
Data Element Sequence
ATT+attribute-domain+attribute-type:list-qualifier:code-list-agency+attribute-code:list-qualifier:code-list-agency:attribute’
Data Element Usage Rules
See Section Six for the definitive list of valid code combinations for each attribute.
local name / group / usage rules / code valuesattribute-domain / all / [7] - structure attribute
attribute-type / all / this is used to identify the type of attribute / {21} - label
{22} - footnote
{23} - explanatory note
{24} - note
{25} - comment
{26} - generic
{27} - structure sub-set type
{28} - weight
{29} - coding structure of components
{31} - identifier qualifier
{32} - object link type
{33} - link set type
{34} - structure item type
{35} - structure level type
list-qualifier
code-list-agency / all
all / {S06} - attribute type
142
attribute-code / this is present only for the following values of attribute-type
2733
this is present only for the following values of attribute-type
32
this is present only for the following values of attribute-type
33 / 1131 is S07 - scope
{21} - domain
{22} - field
{23} - area
1131 is S09 - object relationship
{1} - normal
{2} - hierarchic
{4} - correspondence
{5} - dependency
{6} - successor
{7} - predecessor
{9} - simple
{10} - multiple
1131 is S09 - object relationship
{2} - hierarchic
{4} - correspondence
{8} - overlapping
{11} - group link
{12} - de-group link
{13} - historic
local name / group / usage rules / code values
attribute-code / all / this is present only for the following values of attribute-type
34
attribute-type 28 / 1131 is S10 - classification grouping type
{1} - dummy grouping
{2} - dummy de-grouping
{4} - official (normal) grouping
{5} - uncoded position
none defined
all / this is present only for the following values of attribute-type
35 / 1131 is S30 - structure level type
{1} - dummy level
{2} - uncoded position
all / this is present only for the following values of attribute-type
21, 22, 23, 24, 25, 28 / 1131 is S31 - Property type
{1} - official value
{2} - unofficial value
attribute / all / this is present only for the following values of attribute-type
29 / use COBOL notation
e.g. Z9.!A.?O
where:
O = optional digit
9 = mandatory digit
A = optional letter
Z = mandatory letter
? = optional digit or letter
! = mandatory digit or letter
all / this is present only for the following values of attribute-type
28 / value of the weight
e.g. 0,30
all / this is present only for the following values of attribute-type
31 / qualifier of the identifier
e.g. section
all / this is present only for the following values of attribute-type
26 / name of the generic property
e.g. norm reference
Example
A property value “label” with an “official value” is identified (note that the text of the title is in the FTX segment)
ATT+7+21:S06:142+1:S31:142'
A classification sub-set of “area” is defined
ATT+7+27:S06:142+232:S07:142'
The qualifier of the object identifier is “section”
ATT+7+31:S06:142+:::section'
Version 1.01: DecemberMay 22 1997CLASET EDIFACT Implementation Guide
EG6/WG3MigEdifact_02ELM1
Segment Type:ELM
Segment Type Name:Simple Data Element
Content and General Usage Rules
This segment is used to define the format of an attribute.
Segment Structure
TAG / Edifact Name / Status / Format / Usage / Local Name(Attributes)
9150 / SIMPLE DATA ELEMENT TAG / M / an..4 / R / element-id
9153 / SIMPLE DATA ELEMENT CHARACTER REPRESENTATION, CODED / C / an..3 / D / data-type-code
(property_data_type_
code)
9155 / SIMPLE DATA ELEMENT LENGTH TYPE, CODED / C / an..3 / X
9156 / SIMPLE DATA ELEMENT MAXIMUM LENGTH / C / n..3 / D / maximum-length
9156 / SIMPLE DATA ELEMENT MINIMUM LENGTH / C / n..3 / D / minimum length
9161 / CODE SET INDICATOR, CODED / C / an..3 / X
1507 / CLASS DESIGNATOR, CODED / C / an..3 / X
4513 / MAINTENANCE OPERATION, CODED / C / an..3 / X
Data Element Sequence