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 > Outbound processing > Outbound operations

RetrieveAll operation

The RetrieveAll operation is used to retrieve the documents from the database in the Lotus Domino server that matches the values specified in the search fields.

You can specify one or more of the following criteria in the business object sent with the outbound request.

The retrieved documents are populated in a container business object and sent back to the calling component. The container business object has the following structure:

<DatabaseName><FormName>Container --> <DatabaseName><FormName> []


Search implementation using database search method

The RetrieveAll operation supports searching of documents based on the following types of search criteria that you can specify during the run time:


Search implementation using indexed search method


Indexed search: You can specify index-based search to enable faster text searching, if the target Domino database is full-text indexed. The adapter uses the FTSearch function provided by the Lotus Domino client API. The FTSearch method searches for documents using the full text-index in a database that matches a queried text. The adapter returns exact matches of the search string followed by closer matches.

The indexed search method does not work for RichText, Attachments, and Date fields.

The indexed search method also supports search using multiple fields. You can specify search values in more than one field. In this configuration, the adapter uses the logical AND operator to group the search strings. For instance, you can specify a single value, multiple values, or ParentDocumentUNID in different fields. The adapter returns a logical AND operation of all the specified search criteria, returning exact and close matches for string type fields and exact matches for numeric type fields.

The following are the differences between indexed search and database search methods:


Faults occurrence during the RetrieveAll operation

When there is a processing error, the RetrieveAll operation might throw the InvalidParentDocumentFault or the MatchesExceededLimitFault fault. The InvalidParentDocumentFault fault can occur when an invalid ParentDocumentUNID is specified in the interaction specification. The MatchesExceededLimitFault fault can occur when the matching documents exceed the specified MaxRecords value. For more information about these business faults, see Fault business objects.

Outbound operations


Related reference:

Fault business objects

Interaction specification properties