The UCCnet DTD 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 DTD 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 UCCnetTPIDTD_envelope business objects, which are
then mapped to a UCCnetGBO_envelope generic business object and manipulated
in business processes.
The UCCnetTPIDTD_envelope business object is
based on the UCCnet DTD 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: The
reader should be familiar with WebSphere business integration system components,
the UCCnet message set, and the UCCnet Document Type Definition (DTD), and
have access to UCCnet documentation and UCCnet eRoom digital workplaces.
Terminology
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 UCCnetTPIDTD_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 |
|
|
TLO |
UCCnetDTD_TLO_envelope |
x |
1 |
The UCCnetTPIDTD_envelope business object includes attributes
based on TPIRouteInfo and UCCnetDTD_TLO_envelope child business objects:
TPIRouteInfo child business object
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 |
|
UCCnetDTD_TLO_envelope child business object
This child
business object is a hierarchical business object. It contains child business
objects for the message header and 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. UCCnetDTD_TLO_envelope and
its nested child business object definitions contain exactly the same attributes,
sequence, and structure that are specified in the UCCnet DTD. See UCCnet documentation
for more information on the attributes required by UCCnet.
Supported verbs
The UCCnetTPIDTD_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 UCCnetTPIDTD_envelope business object, use the System Manager
or Business Object Designer.
For more information on related business
objects, see the following: