The UCCnet XSD defines standards for the item information exchanged
between UCCnet trading partners and for the requirements of the Trading Partner
Interchange (TPI), which enables the exchange of data in the form of XML messages.
Description
The UCCnet XSD defines standards for
the item information exchanged between UCCnet trading partners and for the
requirements of the Trading Partner Interchange (TPI), which enables the exchange
of data in the form of XML messages. The WebSphere® business integration system transforms
UCCnet XML messages into UCCnetTPIXSD_envelope business objects, which are
then mapped to a UCCnetGBO_envelope generic business object and manipulated
in business processes.
The UCCnetTPIXSD_envelope business object is
based on the UCCnet XSD and is typically used to exchange data between the
runtime connector portions of specific IBM® WebSphere Business Integration Adapters and IBM WebSphere Business
Integration for Retail Distribution collaboration objects. The attributes
of the business object cover both the addressing information used by the TPI
server in transmitting XML messages, and the business information types that
are published between trading partners in the UCCnet environment.
Note: You
should be familiar with WebSphere Business Integration system components,
the UCCnet message set, and the UCCnet XML Schema Definition (XSD), and have
access to UCCnet documentation and UCCnet eRoom digital workplaces.
Connector definition
The term "connector" used throughout
refers to the runtime portion of an IBM WebSphere Business Integration Adapter. References
to specific connectors are related to specific adapters, as follows:
- "JTextTPIConnector" refers specifically to the runtime component of an
adapter based on the IBM WebSphere Business Integration Adapter for
JText.
- "TPIConnector" refers specifically to the runtime component of an IBM WebSphere Business
Integration Adapter for Trading Partner Interchange.
If you are using TPI connectivity and are exchanging messages with UCCnet
through an AS2/EDIINT interface protocol, you use a TPIConnector. If you are
using TPI connectivity and are exchanging messages through the UCCnet Command
Line Utility (CLU) or testing your installation, you use a JTextTPIConnector.
Business object structure
The UCCnetTPIXSD_envelope
business object is a hierarchical business object. The following table shows
its structure.
Name |
Type |
Key |
Cardinality |
TPIRouteInfo |
TPIRouteInfo |
|
1 |
XMLDeclaration |
String |
|
|
DocType |
String |
|
|
ROOT |
UCCnetXSD_ROOT_envelope |
x |
1 |
The UCCnetTPIXSD_envelope business object includes attributes
based on the TPIRouteInfo and UCCnetXSD_ROOT_envelope child business objects:
TPIRouteInfo
This child business object is a flat business
object. It contains attributes for routing messages in conformance with TPI,
namely those attributes that the TPIConnector or JTextTPIConnector uses for
creating and sending messages in XML format.
Name |
Type |
Key |
DocumentExt |
String |
x |
DocumentType |
String |
|
BOPrefix |
String |
|
SenderID |
String |
|
ReceiverID |
String |
|
UniqueID |
String |
|
OriginalName |
String |
|
WaitForMDN |
String |
|
BackupRequired |
String |
|
UCCnetXSD_ROOT_envelope
This child business object
is a hierarchical business object. It contains child business objects for
the message header, for the body of the message, and for optional audit information.
The child business object representing the body of the message contains additional
child business objects that represent different types of information used
for items in UCCnet. UCCnetXSD_envelope and its nested child business object
definitions contain exactly the same attributes, sequence, and structure that
are specified in the UCCnet XSD. See UCCnet documentation for more information
on the attributes required by UCCnet.
Supported verbs
The UCCnetTPIXSD_envelope business
object supports the following verbs:
- Request Processing (sending to the destination application): Create
- Event Notification (receiving from the source application): Create
Examining the object
To examine a listing of the
attributes of the UCCnetTPIXSD_envelope business object, use the System Manager
or Business Object Designer.
For more information on related business
objects, see the following: