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.
- Document business data: When you specify document business data in the business object, the adapter reads all the valid data from the business object. The data are represented as items in the Domino document. The adapter searches the database for documents that match these valid data. All the matching documents that can be represented using the business object are returned as response to the calling component.
- ParentDocumentUNID: When you specify a valid ParentDocumentUNID in the business object, the adapter retrieves all the child documents to this parent document. All the matching documents that can be represented using the business object are returned as response to the calling component.
- No data set: When you do not provide a data set in the business object, the adapter retrieves all the documents that can be represented using the business object. The adapter matches the fields in the documents with the stored values in the business object.
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 methodThe RetrieveAll operation supports searching of documents based on the following types of search criteria that you can specify during the run time:
- Single values: You can specify a single value in the search criteria.
For example, the adapter can retrieve documents based on the single word, number, or date specified in the search field. You can find more information about the search values that can be specified in the Number and Date type fields in the following points.
- Numbers: You can specify a double digit number or an integer value as the search criteria in the Numbers type field. You can use this search function to retrieve documents where a Number type field equals to a certain value.
For example, to retrieve documents where employee salary equals to "1234.56", enter the value "1234.56" in the EmployeeSalary field.
- Date and time: You can specify a date as the search criteria in any Date type field in the "YYYY/MM/DD" format.
For example, to retrieve documents where birthday equals to "1982/11/22", enter the value "1982/11/22" in the Birthday field. You can also specify combinations of date and time in the Date type field, if you enabled the date and time mapping to String type during the outbound configuration. This configuration supports the following date and time formats.
- Date in the "MM/dd/yyyy" format.
- Time in the "HH:mm:ss" format. Specify the time in the 24-hour format.
- Date and Time in the "MM/dd/yyyy HH:mm:ss" format.
For example, you can specify both date and time in the Date type field as "11/22/1982 22:10:40".
The Date format depends on the client that starts WebSphere Adapter for Lotus Domino. The client can be JavaServer Pages (JSP), a Java™ program, or a IBM Integration Designer test component.
- Multiple values: You can specify multiple values as the search criteria for any Lotus Domino field types. This feature can be used to find the documents with the specified values at run time.
For example, you can configure the adapter to retrieve documents that match any one of the words from the multiple words specified in the search criteria.
- Text search for rich text contents: You can specify the text to search documents that have rich text contents at run time. The adapter conducts a search by using the text specified in the RichText field of a document during the run time. During the RetrieveAll operation, all matching documents are retrieved by the adapter. The adapter supports both single and multiple text content searches for the RichText field.
You can also provide wildcard suffixes, such as "*" for searching documents in the RichText field.
- 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, RichText, or ParentDocumentUNID in different fields. The adapter returns only that search content that matches all the specified criteria.
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:
- When the database is fully indexed, the indexed search method is faster compared to the database search method.
- The accuracy of the results returned by the indexed search depends on the updated database indexes.
- The database search returns only the exact matches; whereas indexed search returns exact matches first up in the searched list and then the close matches.
Faults occurrence during the RetrieveAll operationWhen 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.
Related reference: