Connector business object structure

The structure of business objects must conform to the requirements of the data handler that converts them. The iSoft connector uses business objects that conform to the requirements of the iSoftNotification data handler, the iSoftMDN data handler, and the data handler that you configure for exchanging business data.

Business objects for notifications

The Peer-to-Peer Agent can be configured to generate notification messages to inform the user of retry attempts being exhausted. The Peer-to-Peer Agent notice record format consists of values delimited primarily by US-ASCII unit-separator character 31 (represented by "US" in the syntax shown below). The syntax of the notice record is as follows:

HTTP/1.0 200 OK
 Content-Type: isoftp2p/command
 Content-Length: 337
 CRLF
 notice 
 CRLF
 notice-id /*format of "YYYYMMDDHHMMSSRRRRRRRR" 
   where "RRRRRRRRR" is a random HEX string*/ US
 op-code /*one of "SEND" or "RECV"*/ US
 sender-AS2-name US
 receiver-AS2-name US
 sender-notify-name US
 message-id US
 message-subject US
 message-digest US
 transaction-begin-date-time US
 transaction-end-date-time US
 agent-role /*one of "A", "R" or "T"*/ US
 batch-number US
 bytes-in-count US
 bytes-out-count US
 result-code US
 file-byte-count US
 source-IP-address US
 destination-IP-address US
 source-IP-port US
 destination-IP-port US
 attempt-count US
 total-attempts US
 original-filename US
 agent-name US
 send-parameters US
 

Since the notice record format is not self-describing, the data-handler simply tokenizes the values and populates the given business object sequentially. This also means that the names used for the attributes in the business object will have no semantic value to the data-handler. As the data-handler reads the values in the notification message, it simply populates the next available attribute in the business object.

The following shows a sample business object structure, with attribute names taken from the notice record syntax shown above. All attributes in the object should be of type String.

Object:
 P2PAgentNotificationMessage
 
Attributes:
 NoticeId
 OpCode
 SenderAS2Name
 . . .
 SendParameters
 

Note that it is mandatory that each of the delimited values of the notice record be included as an attribute in the business object, and in the order shown in the notice record.

Business objects for MDNs

The attributes of the business object for MDN correspond to data fields in the machine-readable message body of an MDN sent from Peer-to-Peer Agent to the connector.

To map fields in the MDN to business object attributes, the data handler looks at name-value pairs in the application-specific info of the attributes of the business object. The name value pairs use this syntax: name=<MDN field name>.

For example, for the following fields from a sample MDN message body:

Reporting-UA: 
 Final-Recipient: 
 Original-Message-Id: 
 Disposition: 
 

The business object would have attributes with the following application-specific info:

You can control which data gets mapped from the MDN to the business object by adding or deleting attributes from the business object. You can use any name you like for the business object attribute, but the Application-Specific Info that you provide for the attribute must specify exactly the name of a field in the MDN message body.

Business objects for exchanging business data

The business data in messages received from Peer-to-Peer Agent can be in virtually any format, and multiple data handlers may be required. The business objects that you define for exchanging business data must conform to the requirements of whichever data handlers you configure.

One common format for business data exchange is the XML document format. For information about creating business objects that conform to data handlers for this and other formats, see the Data Handler Guide.

Copyright IBM Corp. 1997, 2004