Title: Representation of X12 Data Elements and Structures in XML

Preliminary Findings and Recommendations on XML-X12 Version 1.0

X12C Ad Hoc Task Group on the use of XML with X12 EDIPreliminary Findings and Recommendations on the

Representation of X12 Data Elements and Structures in XML

Sponsored by

CommerceNet Consortium, ANSI ASC X12, and the XML/EDI Group

Version 1.0

August 31, 1998

Editors:

Bob Crowley, Rik Drummond, and David Webber

Contributors:

Martin Bryan, Dan Codman, Betty Harvey, John Hathaway, Denis Hill, William Kammerer, John Kevlin, Robert Miller, Peter Pruyne, Mike Rawlins

Table of Contents

4Introduction

1.Document Status4

2.Objectives4

3.Rationale for Using X12 Semantics in XML/EDI5

4.The Vision of EDI Representations in XML5

5.Environments for XML/EDI Usage6

5.1.XML Receivers6

5.2.XML Senders7

5.3.Environments7

6.General Definitions8

7.Assumptions and Determinations9

7.1.Additions to the X12 Code and Elements Dictionary9

7.2.Alignment with Other Repository Type Efforts9

8.Data Element Name Generation from the X12 Syntax Databases9

9.NameSpaces10

9.1.NameSpaces Allow Redefinition of Data Elements10

9.2.NameSpaces Allow References to External Code Lists10

10.Open Issues at the Writing of this Draft13

11.Requirements13

11.1.The Basic Requirements13

11.2.Discussion on the Requirements14

12.Loops, Loop Counts and Datatypes in XML15

13.Implementing XML DTDs using X12 Unique IDs, Tag Names and PSDEs15

13.1.Understanding Tables 2a and 2b15

13.2.Issues and Descriptions of Tables 2a and 2b18

13.3.Steps for Creating an X12/XML DTD from an XML DTD using Tables 2a and 2b20

14.XML Names Discussion21

14.1.Unique ID Generation21

14.2.Human-readable XML Tag Generation22

14.3.Well-formed Purchase Order Example24

14.4.DTD Name Definition Example for a Purchase Order24

15.XML/EDI Semantics and the X12 868 Electronic Form Structure25

16.Repositories and their Purpose26

17.XML and Object Technology26

Appendix A Full List of Requirements27

Appendix B Partial List of Data Element Name Extensions29

Appendix C Example DTD Naming for an 850 Purchase Order41

Appendix D Scenario44

Appendix E Sample Programming for XML Interactions45

Appendix F Example Use Case49

F.1. Describing the Scenario49

F.2. Step 1 The Output from the E-Commerce System is Received in XML Format51

F.3. Step 2 Additional Information is Now Required for EDI Compliance51

F.4. Step 3 The Delivery Phase51

Introduction

The purpose of this document is to make a recommendation on the direction of the Joint CommerceNet - ANSI ASC X12 - XML/EDI Group Ad Hoc Task Group on XML as a basis for continuing formal work on the use of XML by X12 itself.

Included in this document are algorithms that can be used to generate XML segment names and data element names from the existing X12 syntax tables. Because many people reading this document will not have ready access to the X12 tables, the algorithms are shown by example. Additionally, an example of a generated Document Type Definition (DTD) is given in Appendix C to show what a generated XML DTD for a Purchase Order would look like.

The further intent is to publish these results for general comment. Publishing these results will allow XML developers to give us feedback suggesting further enhancements to the specification. The results from the use of these names and structures in the broader XML domain can then be considered in the subsequent formal work within ANSI Subcommittee X12C.

1. Document Status

This document is a joint effort produced by the three sponsoring organizations, but is not binding on any or all. Following this initial adhoc effort, both ANSI Subcommittee X12C and CommercNet are planning to initiate formal working groups to further develop XML and X12. Each of these organizations has specific approval processes that must be followed.

The X12 community is a major contributor to the document. However, this draft should not be construed to be a formal X12 recommendation at this time. The final status of this effort has yet to be determined within X12 itself.

This document will be used by CommerceNet, the XML/EDI Group and others to promote the use of XML/EDI to the XML electronic commerce developer community. Other EDI organizations are also free to review and apply the techniques and ideas expressed in this document.

2. Objectives

The broad objectives of this AdHoc Task Group include the following:

move the X12 EDI data dictionary and structures into XML in a manner that retains the one-to-one semantic mapping between the X12 and XML data elements

construct XML data element names in a manner that allows X12 electronic commerce experts to use their process acumen in XML/EDI

support both the application-to-application and human-to-application interface requirements

3. Rationale for Using X12 Semantics in XML/EDI

XML (eXtensible Markup Language) may be the means to bridge EDI into Internet Electronic Commerce (EC) by making the existing EDI knowledge base more readily usable to the Internet EC developers.

In order to take advantage of the Internets speed, convenience and global user base, the EDI community is investigating how to map X12 data elements, segments and transaction structures into XML. The process has been divided into two phases.

Phase 1 This paper is focused on the first set of basic XML syntax deliverables. These include such items as datatypes syntax, XML/EDI DTDs, Loop definition syntax and XML/EDI structures.

Phase 2 Phase 2 will extend Phase 1 by recommending XML features for use in the EDI arena such as XSL (the style sheet language for XML), NameSpace definitions, and XML based definition repositories. Phase 2 will begin at the completion of the Phase 1 effort.

XML/EDI is being developed based on the expectation that many application software vendors will soon incorporate within their products the abilities to generate and process XML.

4. The Vision of EDI Representations in XML

In X12, an instance of a transaction, such as a purchase order to ABC Tools, contains data to be interpreted by a translator program. The translator program knows the proper syntax and semantics of the data. Because the X12 syntax and data are specifically designed to be read by machine, it can be difficult for humans to interpret transaction data without either the transaction table text documents or a translator application to show the semantic and syntactical meaning. XML offers a mechanism that allows data to be transmitted with human-readable semantics that we believe will facilitate use in application integration for Small and Medium Enterprises (SMEs). If SMEs receive data in a format that shows the meaning of the data, this should make it easier for them to integrate and understand the contents.

For example, in an X12 transaction instance, the discount price, such as *9.99*, would be represented at a predetermined place in the transaction. The same transaction instance, in XML, would show the discount price as 9.99, making the data more understandable to the end user. Additionally, if these pre-existing X12 business semantics are transferred into XML, then electronic commerce developers will not need to define semantics unique to their applications. They will be able to use well-defined terms that are already heavily used across the business community. This use of a common semantic will facilitate the flow of data across new innovative EC applications because this common semantic is already used in well-defined processes that are supported by existing X12 semantics. The use of the common semantic will facilitate the integration of applications because data may be readily moved between like data elements in each application and may require very little conversion or human intervention to determine the source and destination of the data being moved.

5. Environments for XML/EDI Usage

We envision many business scenarios for the use of XML linked to X12. Primarily these scenarios involve Internet-based systems in organizations that are looking to link the synergy of three functions:

delivery of XML formatted messages using HTTP and SMTP protocols and other products via the Internet or proprietary means

direct integration of EDI-based processes with desktop software tools such as Web browsers and office suite products such as spreadsheets, word processors, form flow products, and business application databases

ability to provide formal business process underpinning (based on existing EDI transactions) to Internet commerce environments

The direct corresponding business benefits of these are for those organizations to:

develop one set of document and transaction formats that will work with a broad range of applications, resulting in cost savings in development, deployment and maintenance of EDI-related software

take advantage of twenty years of process development knowledge represented in the existing EDI processes, providing the ability for a broader business audience to integrate with existing EDI implementations

take advantage of cheap, widely available communications systems and products, with the ability to immediately take advantage of enhancements and innovations to mainstream technologies (additionally, the direct support for complex compound objects is built-in, including multi-lingua