IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > Lotus Domino > Overview of WebSphere Adapter for Lotus Domino > Technical overview
Business object structures
A business object is a structure that consists of data and additional instructions, if any, for processing the data. The adapter supports the form-based business object structure. A form-based type is a content-specific business object that supports specific business object structures (such as, create and retrieve business objects).
Depending on the custom form types and operations when you create an external service, the adapter generates the corresponding business object definition.
For example, if you select RetrieveAll operation, the adapter generates a container business object. The container business object contains the matching business objects. The following graphic illustrates this relationship:
Figure 1. RetrieveAll container business object
Form-based business object structure
The form-based business object structure consists of attributes that directly relate to the fields in a document. By selecting the form document in the external service wizard, you can use the Integration Designer to generate form-based business object structure at run time. Optionally, if you choose, it can also contain child business objects for a container business object and attachments. The following illustration shows an example of a form-based business object generated from the form document in the sample Domino database.
Figure 2. Retrieve business object
The following attributes are common for all parent business objects:
- Universal ID
- ParentDocumentUNID
- If ID
- CommonProperties
If a form contains fields with attributes that have identical names as the standard attributes present in the top-level business object, then when the business object is generated for this form, the attributes of this form field is named as FormItemFormFieldName>.
For example, for CommonProperties business object, the name changes to FormItemCommonProperties.
In Figure 2, CommonProperties and RichText are the two child business objects. The CommonProperties business object stores the metadata information for the parent business object. The RichText business object contains information for managing attachments. The attachment data is stored in an Attachment business object.
RichText business object structure
The adapter generates RichText business objects for both the Domino Rich Text or Rich Text Lite item types. For information about the rich text attributes see, Business object attributes for Rich Text data type. The following illustration shows the structure of a RichText business object.
Figure 3. RichText business object
RichTextComplexItem business object structure
For complex objects, the RichTextComplexItem business object is generated as a child business object of the RichText or RichText Lite business objects. For information about the rich text complex item attributes see, Business object attributes for Rich Text complex item data type.
The following illustration shows the structure of a RichTextComplexItem business object.
Figure 4. RichTextComplexItem business object
DeleteResponse business object structure
During the Delete operation, the status of the operation is checked using the DocumentDeleted attribute in the DeleteResponse business object. The following illustration shows the structure of the DeleteResponse business object.
Figure 5. DeleteResponse business object
ExistsResponse business object structure
During the Exists operation, the status of the operation is checked using the DocumentExists attribute in the ExistsResponse business object. The following illustration shows the structure of the ExistsResponse business object.
Figure 6. ExistsResponse business object
Technical overview of WebSphere Adapter for Lotus Domino
Related reference: