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 > Enterprise Content Management > Overview of WebSphere Adapter for Enterprise Content Management > Technical overview > Outbound processing > Outbound operations
Retrieve operation
The Retrieve operation extracts the document content or folder properties based on the request from the SCA component. For Document types, the Retrieve operation retrieves the content and also the properties from the document. For Folders, the Retrieve operation retrieves the properties of the folder.
Document Types
The adapter receives the request to retrieve a document along with the document location. The TargetFolder and cmisU58name properties must be populated with appropriate values pointing to the document path. Alternately, the cmisU58objectId property in the request can be populated with the Object ID of the document. The adapter processes the request and extracts the content of the document from the Content Management Repository.
When both Object ID and document path are provided as input to the operation, the Object ID takes a precedence over the document path value to perform the operation.
The following figure shows the structure of a request EmailDocumentProperties business object.
Figure 1. Structure of a request business object
After the content of the document is retrieved in the form of a byte array, it is sent back as the response to the calling component. The response has the top-level business object containing the content of the document and the document properties. The attributes in the business object include information about the retrieved document.
Figure 2. Structure of a response business object
Folders
The adapter receives a request in the form of a business object to retrieve properties of a Folder in the CMIS Repository. The field cmisU58path properties must be populated with appropriate values pointing to the folder.
The path must be the absolute path to the folder starting from the root. Alternately, the cmisU58objectId property in the request can be populated with the Object ID of the folder. The adapter processes the request and extracts the properties of the folder from the Content Management Repository.
An example of a request business object for Folders is modeled as below:
Figure 3. Structure of a request business object for Folders
After the Folder is retrieved, the Properties business object is sent back to the calling component as a response.
Figure 4. Structure of a response business object for Folders
When there is a processing error, the Retrieve operation might return the InvalidRequestFault or the DocumentNotFoundFault fault. For more information about these business faults, see Fault business objects.
Related reference: