UCCnetGBO_envelope business object

Note:
The reader should be familiar with WebSphere(R) business integration system components, the UCCnet(R) message set, the UCCnet Document Type Definition (DTD), and the UCCnet XML Schema Definition (XSD), and have access to UCCnet documentation and UCCnet eRoom digital workplaces.

The UCCnet DTD and XSD define standards for the item information exchanged between UCCnet trading partners and for the requirements of the iSoft Peer-to-Peer Agent or Trading Partner Interchange (TPI), which enable the exchange of data in the form of XML messages. Depending upon the XML definition type (DTD or XSD) and the AS2 channel server (TPI or iSoft) used, the WebSphere business integration system does the following:

These maps insert default values for the XMLDeclaration and DocType attributes, so these values are in place when the resulting UCCnetGBO_envelope business object is processed by collaboration objects.

The UCCnetGBO_envelope business object is based on the UCCnet XSD and is typically used to exchange data between the runtime connector portions of specific IBM(R) WebSphere Business Integration Adapters and IBM WebSphere Business Integration for Retail Distribution collaboration objects. The attributes of the business object cover the business information types that are published between trading partners in the UCCnet environment, as well as the addressing information used by a TPI server in transmitting XML messages in systems using TPI connectivity.

Note:
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: If you are exchanging messages with UCCnet through an AS2/EDIINT interface protocol, you use a TPIConnector or iSoftConnector, depending on the connectivity type used. If you are exchanging messages through the UCCnet Command Line Utility (CLU) or testing your installation, you use a JTextTPIConnector or JTextISoftConnector, depending on the connectivity type used.

Business object structure

The UCCnetGBO_envelope business object is a hierarchical business object. The following table shows its structure.


Table 1. Attributes for UCCnetGBO_envelope business object

Name Type Key Cardinality
TPIRouteInfo TPIRouteInfo
1
XMLDeclaration String

DocType String

ROOT UCCnetXSD_ROOT_envelope x 1

The UCCnetGBO_envelope business object includes attributes based on the following child business objects:

TPIRouteInfo
This child business object is a flat business object used for TPI connectivity only. 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.


Table 2. Attributes for TPIRouteInfo child business object

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 and for the body of the message. 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 UCCnetGBO_envelope business object supports the following verbs:

Examining the object

To examine a listing of the attributes of the UCCnetGBO_envelope business object, use the System Manager or Business Object Designer.



Related reference

For more information on related business objects, see the following:

Copyright IBM Corp. 2002, 2004