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

RetrieveAll operation

The RetrieveAll operation extracts the properties of all documents along with the Document URLs to the content of the documents or folders which match a search criteria specified in the request from the SCA component.


Document Types

The adapter receives the request to retrieve document which matches a specified search criteria. The search query resembles a standard SQL statement and contains a Select Clause and a Where Clause. The From Clause is a business object level annotation of the RetrieveCriteria Business Object. The SelectClause and WhereClause can be specified in the request business object but the FromClause is fixed.

For example:

Figure 1. Example

In this example,

The adapter processes the request and extracts the properties of all documents along with the Document URL that references the document content matching the search query from the Content Management Repository.

The following figure shows the structure of a request business object for the Email Document Type:

Figure 2. Structure of a request business object

You can specify the SelectClause and WhereClause in the RetrieveCriteria child business object inside the CommonProperties business object for the Document Type. The default value for SelectClause is * and the default value for the WhereClause is "".

Figure 3. RetrieveCriteria

After the properties and Document URL of the documents are retrieved, it is sent back as the response to the calling component. The response has the top-level business object called Container, which contains the document properties business object. The attributes in the business object include information and the Document URL of the retrieved document.

Figure 4. Structure of a response business object


Folders

The adapter receives the request to retrieve folders which matches a specified search criteria. The search query resembles a standard SQL statement and contains a Select Clause and a Where Clause. The From Clause is a business object level annotation of the RetrieveCriteria business object. The SelectClause and WhereClause can be specified in the request business object but the FromClause is fixed.

For example:

Figure 5. Example

In this example,

The adapter processes the request and extracts the properties of all folders matching the search query from the Content Management Repository.

The following figure shows the structure of a request business object for the folder titled Folder:

Figure 6. Example of the structure of request business object

You can specify the SelectClause and WhereClause in the RetrieveCriteria child business object inside the top-level business object for the Folder. The default value for SelectClause is * and the default value for the WhereClause is "".

Figure 7. RetrieveCriteria

After the properties of the folders are retrieved, it is sent back as the response to the calling component. The response has the top-level business object called Container, which contains the folder properties business object.

When there is a processing error, the RetrieveAll operation returns the InvalidRequestFault, MissingDataFault, or the MatchesExceededLimitFault faults. For more information about fault business objects, see Fault business objects.

Outbound operations