Requirements for business object definitions

To use the Request-Response data handler, you must create or modify business object definitions so that they provide the structure that the data handler requires. However, unlike other data handlers, you do not need to modify business object definitions so that they contain metadata. This section provides the information you need to create business object definitions to work with the Request-Response data handler. In particular, it provides the following information:

Understanding Request-Response business object structure

The Request-Response data handler uses business object definitions when it receives business object from or sends business objects to its request or response data handler. The Request-Response data handler places specific requirements on the structure of business objects it can process. Business objects passed to the data handler must contain one request child object and one or more response child objects. These child objects must conform to the requirements of the data handler that will process them.

Note:
The Request-Response data handler does not require application-specific information in the business object definitions or their attributes.

Figure 33 shows the structure of the business objects that represent a Request-Response business object.

Figure 33. Business object structure for a request-response business object

To ensure that business object definitions conform to the requirements of the Request-Response data handler, use the guidelines provided for each of the following business objects:

Top-level business object

The Request-Response data handler expects a top-level business object to hold the information it receives from or sends to its calling context. Table 47 describes how the Request-Response data handler interprets the properties of a business object and describes how to set the properties when modifying a business object for use with the Request-Response data handler.

Table 47. Properties for the top-level business object definition

Property name Description
Name Each business object definition must have a unique name. It is recommended that these business object definitions begin with a standard prefix. The name of the top-level business object depends on the message standard, as follows:
BusObj Prefix + Response Business Object
 
Version A constant representing the current version of the business object definition. Current value is 1.0.0.
Application-specific Information No application-specific information is required.

This top-level business object must contain the following attributes:

Request business object

To hold the request information for the request data handler, the Request-Response data handler expects a request business object as the first attribute of the top-level business object. This attribute should be of single cardinality. Table 48 describes how the Request-Response data handler interprets the properties of this business object definition and describes how to set these properties when modifying the business object for use with the Request-Response data handler.

Table 48. Properties for the request business object definition

Property name Description
Name Each business object definition must have a unique name. This name must match the name of the business object definition that the request data handler handles.
Version A constant representing the current version of the business object definition. Current value is 1.0.0.
Application-specific information Depends on the particular request data handler being used.
Note:
For information on the format of the request business object, see the documentation for the data handler that acts as the request data handler.

For example, if you specified RequestDataHandlerMimeType as text/xml, the child object you define as your request business object must be compatible with the XML data handler.

Response business object

To hold the response information for the response data handler, the Request-Response data handler expects a response business object in the attributes starting with the second attribute of the top-level business object. This attribute should be of single cardinality. If the response data handler might return more than one type of business object, the top-level business object has an attribute for each possible type. Table 49 describes how the Request-Response data handler interprets the properties of this business object definition and describes how to set these properties when modifying the business object for use with the Request-Response data handler.

Table 49. Properties for the response business object definition

Property name Description
Name Each business object definition must have a unique name. This name must match the name of the business object definition that the response data handler handles.
Version A constant representing the current version of the business object definition. Current value is 1.0.0.
Application-specific information Depends on the particular request data handler being used.
Note:
For information on the format of the request business object, see the documentation for the data handler that acts as the request data handler.

For example, if you specified ResponseDataHandlerMimeType as text/abc, the child object you define as your request business object must be compatible with a custom data handler that can handle the abc MIME type.

Creating business object definitions for the Request-Response data handler

This section describes how to create business object definitions to represent the structure that the Request-Response data handler expects. Use Business Object Designer Express to add or delete attributes from the business object definition as well as edit attribute properties, as needed.

As described in Understanding Request-Response business object structure, the Request-Response data handler requires that you create the following business object definitions:

Creating the top-level business object definition

To create the top-level business object definition for the Request-Response data handler, you must manually create a business object definition using Business Object Designer Express:

  1. Create the top-level business object definition.

    For information on the structure of this top-level business object, see Top-level business object.

  2. Create the child business objects for the top-level business object. In the top-level business object, create a child object attribute for the business objects shown in Table 50.

    Table 50. Business objects for the Request-Response data handler

    Attribute Notes Business object
    Request business object Contains the information about the request. Request business object
    Response business object Contains the information about the request's response Response business object

Creating other business object definitions

To create the request and response business object definitions, you can use either of the following ways:

Copyright IBM Corp. 2003