UCCnetJMSDTD_envelope business object

The UCCnet DTD defines standards for the item information exchanged between UCCnet trading partners and for the requirements for WebSphere® Business Integration Connect, which enables the exchange of data in the form of XML messages.

Description of UCCnetJMSDTD_envelope business object

The WebSphere business integration system transforms UCCnet XML messages into UCCnetJMSDTD_envelope business objects, which are then mapped to a UCCnetGBO_envelope generic business object and manipulated in business processes.

The UCCnetJMSDTD_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 WebSphere Business Integration Connect 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 Document Type Definition (DTD), and have access to UCCnet documentation and UCCnet eRoom digital workplaces.

Connectors and adapters 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: If you are exchanging messages with UCCnet through an AS2/EDIINT interface protocol using WebSphere Business Integration Connect, you use a JMSConnector. If you are using JMS connectivity and are exchanging messages through the UCCnet Command Line Utility (CLU) or testing your installation, you use a JTextJMSConnector.

Business object structure

The UCCnetJMSDTD_envelope business object is a hierarchical business object. The following table shows its structure.
Name Type Key Cardinality
JMSDynMO JMSDynMO   1
XMLDeclaration String    
DocType String    
TLO UCCnetDTD_TLO_envelope x 1
The UCCnetJMSDTD_envelope business object includes attributes based on the JMSDynMO, JMSProperties, and UCCnetDTD_TLO_envelope child business objects.

JMSDynMO

This child business object is a hierarchical business object. It contains a child business objects that contains attributes for routing messages in conformance with WebSphere Business Integration Connect. In particular, they contain the attributes that the JMSConnector and JTextJMSConnector use for creating and sending messages in XML format.
Name Type Key Cardinality
Default String x  
JMSProperties JMSProperties   1

JMSProperties

This child business object is a flat business object.. This business object contains attributes for routing messages in conformance with WebSphere Business Integration Connect, specifically those attributes that the JMSConnector and JTextJMSConnector use for creating and sending messages in XML format.
Name Type Key Cardinality
X_aux_sender_id String x  
X_aux_receiver_id String    
X_aux_process_version String    
X_aux_protocol String    
X_aux_process_type String    
X_aux_msg_id String    
X_aux_protocol_version String    

UCCnetDTD_TLO_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. 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 UCCnetJMSDTD_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 UCCnetJMSDTD_envelope business object, use the System Manager or Business Object Designer.

Parent topic: PIMR business objects