UCCnet_envelope Business Object

Note:
This document assumes that the reader is familiar with WebSphere(R) Business Integration Express system components, the UCCnet(R) message set, the UCCnet Document Type Definition (DTD), and has access to UCCnet documentation and UCCnet eRoom digital workplaces.

The UCCnet DTD defines standards for the item information exchanged between UCCnet trading partners and for the requirements of the iSoft Peer-to-Peer Agent, which enables the exchange of data in the form of XML messages. The WebSphere Business Integration Express system transforms UCCnet XML messages into UCCnet_envelope business objects, which can then be manipulated in business processes.

The UCCnet_envelope business object is based on the UCCnet DTD and is typically used to exchange data between the connector portions of specific adapters and the Item Synchronization collaboration objects. The attributes of the business object cover both the addressing information used by the iSoft Peer-to-Peer Agent in transmitting XML messages, and the business information types that are published between trading partners in the UCCnet environment.

Note:
In this document, the term "connector" refers to the runtime portion of an adapter. Each of the following connectors specifically references the related adapter: Use an iSoftConnector to exchange messages with UCCnet through an AS2/EDIINT interface protocol. Use a JTextISoftConnector to exchange messages through the UCCnet Command Line Utility (CLU) or to test your installation.

Business object structure

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


Table 1. Attributes for UCCnet_envelope business object
Name Type Key Cardinality
XMLDeclaration String

DocType String

TLO UCCnet_TLO_envelope x 1

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

UCCnet_TLO_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. These 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.


Table 2. Attributes for UCCnet_TLO_envelope child business object
Name Type Key Cardinality
communicationVersion String

messageHeader UCCnet_envelope_messageHeader x 1
body UCCnet_envelope_body
1

Supported verbs

The UCCnet_envelope business object supports the following verbs:

Examining the object

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


Related reference

For more information on related business objects and collaboration templates, see the following documents:

Copyright IBM Corp. 1997, 2003