XEP-0056: Business Data Interchange

Abstract:This document defines a way to transmit ebXML messages, ANSI X.11, EDIFACT/UN, and SAP iDoc over Jabber/XMPP.
Author:Ulrich Staudinger
Copyright:© 1999 – 2018 XMPP Standards Foundation. SEE LEGAL NOTICES.
Type:Standards Track
Last Updated:2018-11-03

WARNING: This document has been automatically Deferred after 12 months of inactivity in its previous Experimental state. Implementation of the protocol described herein is not recommended for production systems. However, exploratory implementations are encouraged to resume the standards process.

Table of Contents

1. Introduction
2. Transmitting ebXML via XMPP
    2.1. Introduction to ebXML
    2.2. Protocol
    2.3. Examples
3. Transmitting ANSI X.12 via XMPP
    3.1. Introduction
    3.2. Protocol
    3.3. Example
4. Transmitting UN/EDIFACT via XMPP
    4.1. Introduction
    4.2. Protocol
5. Transmitting SAP iDoc via XMPP
    5.1. Introduction
    5.2. Protocol
    5.3. Example

    A: Document Information
    B: Author Information
    C: Legal Notices
    D: Relation to XMPP
    E: Discussion Venue
    F: Requirements Conformance
    G: Notes
    H: Revision History

1. Introduction

ANSI X.12, EDIFACT/UN and ebXML are all standards. This document describes a fundamental approach to transmit messages that conform to these standards.

2. Transmitting ebXML via XMPP

2.1 Introduction to ebXML

EbXML [1], a subset of XML that is defined through OASIS.org, is quickly becoming a de-facto standard for electronic, unified, inter and intra business process communication and for business process specification. The direct adjacency to UN/CEFACT EDIFACT, especially object-oriented EDI, make the widespread use of ebXML for automatic business transaction negotiation, process definition, etc. quite likely.

2.2 Protocol

ebXML Messages SHALL be transmitted within Jabber IQ chunks. The value of the 'type' attribute SHALL be 'set' and the chunk SHALL contain a <query/> child element with the namespace declaration set to 'http://jabber.org/protocol/ebxml'. The query element MUST contain the pure ebXML message. No SOAP envelope SHALL exist around the ebXML message. Reception of an ebXML iqed message must be acknowledged with an iq chunk including an empty query tag of the same namespace, the iq tag SHALL have the same ID.

Example 1. ebXML Envelope

<iq from='a@b.c' to='d@e.f' type='set' id='some'>
  <query xmlns='http://jabber.org/protocol/ebxml'>

EbXML information is always transmitted in this envelope. No transformation of native ebXML tags into native Jabber tags is performed (e.g., ebXML reception receipt into Jabber reception receipt). The business logic, on top of Jabber transport logic, has to parse incoming IQ chunks and forward received ebXML information to the ebXML Messaging Service. The business logic has as well to pack the ebXML messages into IQ chunks and invoke the message delivery.

Although a complex business transaction between two or more Trading Partners might require a payload that contains an array of business documents, binary images, or other related Business Information' [2], only one ebXML message can be (at the moment) transmitted at a time in one message. However, the ebXML Message MAY contain payload in its own payload envelope.

It has to be noted: The karma restriction of XMPP, implied on clients, makes transmission of large amounts of payload (at the moment) to services or other clients from client side nearly impossible. However, components' karma is not restrained.

2.3 Examples

Example 2. ebXML Query from a client to a Gateway

<iq to='ebxml.gateway.com' type='set' id='f0a0f0'>
  <query xmlns='http://jabber.org/protocol/ebxml'>
        objectType EQUAL "CPP" AND status EQUAL "Approved"
          id STARTSWITH "urn:urn:spsc:321118'

The previous example transmits a query to a database with an ebXML interface. A requester searches for all companies dealing with 'Integrated curcuit components', here with UNSPSC code '321118'.

Example 3. ebXML component OK from component to client

<iq to='client@server.com' from='ebxml.gateway.com' type='result' id='f0a0f0'>
  <query xmlns='http://jabber.org/protocol/ebxml'/>

This prior xml code is the result which every recieving unit has to send, after successfully recieving the iq chunk. Note, that this does not mean, the ebxml chunk has been accepted, parsed, or whatever, this is only on jabber level.

3. Transmitting ANSI X.12 via XMPP

3.1 Introduction

ANSI X.12 is a character oriented protocol. X.12 is separated into segments. Segments are separated by an asterisk [3].

3.2 Protocol

ANSI X.12 messages SHALL be delivered in a query tag of an IQ chunk. The IQ chunk's type attribute SHALL be set to 'set'. The query's namespace attribute SHALL be set to 'http://jabber.org/protocol/ansi_x.12'. The query tag shall contain the ANSI X.12 message. The ANSI X.12 message SHALL NOT be Base64 encoded, but SHALL be XML aware.

3.3 Example

Example 4.

<iq type='set' id='ANY' to='ANSI_X12Gate@way.com'>
  <query xmlns='http://jabber.org/protocol/ansi_x.12'>

4. Transmitting UN/EDIFACT via XMPP

4.1 Introduction

EDIFACT/UN is very similar to X.12 and differs only in the meaning of tags and in some syntactical details.

4.2 Protocol

EDIFACT/UN messages SHALL be delivered in a query tag of an IQ chunk. The IQ chunk's type attribute SHALL be set to 'set'. The query's namespace attribute SHALL be set to 'http://jabber.org/protocol/edifact'. The query tag SHALL contain the UN/EDIFACT message. The UN/EDIFACT message SHALL NOT be Base64 encoded.

5. Transmitting SAP iDoc via XMPP

5.1 Introduction

SAP Systems can create IDocs as receipts of transactions. These receipts can be used within other EDI systems, or within the SAP system. Of course transmission of IDocs can take place through XMPP as well.

5.2 Protocol

SAP IDocs SHALL be transmitted in a query tag of an IQ chunk. The IQ chunk's type attribute SHALL be 'set. The query's namespace attribute SHALL be set to 'http://jabber.org/protocol/sap_idoc'. The query tag SHALL contain the iDoc, XML aware.

5.3 Example

Example 5.

<iq type='set' id='ANY' from='sap_idoc_gate@way.com'>
  <query xmlns='http://jabber.org/protocol/sap_idoc'>


Appendix A: Document Information

Series: XEP
Number: 0056
Publisher: XMPP Standards Foundation
Status: Deferred
Type: Standards Track
Version: 0.3.1
Last Updated: 2018-11-03
Approving Body: XMPP Council
Dependencies: None
Supersedes: None
Superseded By: None
Short Name: N/A
Source Control: HTML
This document in other formats: XML  PDF

Appendix B: Author Information

Ulrich Staudinger

Email: chicago5@gmx.de
JabberID: uls@jabber.org

Appendix C: Legal Notices


This XMPP Extension Protocol is copyright © 1999 – 2018 by the XMPP Standards Foundation (XSF).


Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.

Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <http://xmpp.org/about/discuss.shtml> for a complete list.

Errata can be sent to <editor@xmpp.org>.

Appendix F: Requirements Conformance

The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".

Appendix G: Notes

1. http://www.ebxml.org

2. Walsh. 2002. ebXML: The Technical Specifications; p. 69

3. Angeli, Streit, Gonfaloniere. 2000. The SAP R/3 Guide to EDI and interfaces; p. 133

Appendix H: Revision History

Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/

Version 0.3.1 (2018-11-03)

Fix a bunch of typos, batch-style. (pep)

Version 0.3 (2002-11-18)

added SAP iDoc, EDIFACT, changed from Base64 to XML aware, minor changes in wording (uls)

Version 0.2 (2002-11-06)

Changed namespace, improved structure, added ANSI X.12 (uls)

Version 0.1 (2002-11-06)

Initial release. (uls)