Back to main page > XML Standards   
GS1 XML Technical Message Guide to release 2.1
Go To: www.gs1.org
 INTRODUCTION
This documentation published by GS1 Global Office is based on the work initially done by GS1 Germany that kindly made it available to the GS1 Community as a base for further development.

It presents the GS1 XML Standards Version 2.1 issued as an outcome of the GS1 Global Standards Management Process (GSMP). This documentation comprises a subset of detailed XML message descriptions in HTML format. The XML Implementers Packets containing all the working files necessary for the actual implementation of these messages should be downloaded from the GS1 website. The link to the complete message set of the GS1 XML Standards 2.1 issued by GS1 Global Office can be found at the main page of this Guide.

The HTML version has been posted on the GS1 website for an on-line access. The Compressed HTML file in a style of help files, is available for download for the user community - the link can be found at the main page of this Guide. This version cannot be accessed on-line, due to the security issues. The file needs to be downloaded to the user's hard drive and opened from a local drive, it is not possible to use it from the network drive.

Scope

The current Guide covers 53 messages from version 2.1. The documentation for the subsequent releases will be published later.

It should be noted that this Guide is meant only as an informative documentation. The GS1 Business Message Standard documents and the XML Implementers Packets remain the sole source of normative documentation of GS1 XML standards.

The documentation of the XML message types explained in detail is structured as follows:

Report 1 - Message description
This report describes the fundamental functionalities and the use cases of the message type. It is an abstract of the accompanying document "Business Message Standard" (BMS). In some messages it also contains links to additional documentation, such as Implementation Considerations or Example documents, etc. developed as a part of the "Business Requirements Documents" (BRD).
Report 2 - Message Structure
This report shows a message structure including occurrences and status descriptions of the elements and attributes of the message. It contains also links to additional information of Report 3 - Guideline Details.
Report 3 - Guideline Details

The left-hand side of this report visualizes a message tree. The individual components of the message tree can be opened by mouse-clicking on the "+" symbol, so that the underlying structures are displayed. By mouse-clicking on an element or attribute, the associated information will be displayed on the right-hand side, such as the data element definition and additionally - when available - usage rules, dependencies, usage examples, data samples and external references. On the right-hand side also the base type of the element or the attribute is displayed and linked to further information of the underlying data structures.

Note: The definitions come form the Global Data Dictionary (GDD) version 2.1
There are two levels of definitions:

  • Definition of basic component - the common definition developed for the underlying common component.
  • Message-specific definition - refined definition developed for the locally used instance of the basic component.
Report 4 - Components

The left-hand side of this report contains an overview of all components used in the message type. By mouse-clicking on the components, the related information will be shown on the right-hand side of the report. By further mouse-clicking on the related information the underlying data structures will also be shown.


Note: The definitions come form the Global Data Dictionary (GDD) version 2.1.
There are two levels of definitions:

  • Definition of basic component - the common definition developed for the underlying common component.
  • Message-specific definition - refined definition developed for the locally used instance of the basic component.
Report 5 - HTML Sample
This report shows the XML instance document of Report 6 - Instance File in HTML format.
Report 6 -  Instance File

This report contains the XML instance document. It is an example of how the actual business message would look like. All the instance files in this Guide come from the Implementer's Packets, published as a part of the GS1 standard.
Report 7 -  List of XML files in the Implementers Packet with download link
This report lists the associated XML schema declarations of the message type with the hyperlinks to the official XML download zip-file for the respective XML message published on the GS1 website.
Technical Manual
The "GS1 Technical XML User Guide to Release 2.x" covers only technical aspects of the GS1 Business Message Standard Release 2.x. It does not explain the technical details of any earlier releases. It is meant as the user-friendly way of explaining the GS1 XML design rules used in release 2.0 and higher (hence 2.x).
Additional support
If, during analysis or implementation of the GS1 XML standards, either covered in this Guide or not, additional issues arise, please visit our Helpdesk website: www.gs1.org/helpdesk
Disclaimer & Copyright statement
We wish you enjoyment and success in working with the GS1 XML standards.
 
Date of Publication: June 2007