Kofax DM API - Manual (Page 32)

12 C HAPTER 1
DM Search Transactions
3 The DM Server does the following:
— Captures search criteria, and immediately returns a “no
results” message to the client.
— Performs the search on requested databases and full-text
repositories.
— Collects the results set and sorts it as user specified.
— Caches the results of the search and returns them to the client
when requested.
The cached results can be deleted by the client using the ReleaseResults
method. Also, results may time out based on administration settings.
The following sections describe various ways to execute search
transactions in a DM environment.
General Steps to
Performing a
Search
The following are the general steps in performing a search in the DM
environment:
1 Create the search object.
2 Set the DST.
3 Add a search library (or multiple libraries).
4 Set the search object to the name of the search form.
5 Add return properties. Properties refer to the field names in the
form. You need to specify the fields to return in the results set.
Alternately, you can set an entire collection of properties using
SetReturnProperties .
6 Add search criteria, specifying a field name in the form and its
value.
7 Add a property by which the return properties are to be ordered.
8 Set the maximum number of rows to return in the results set.
9 Optionally, set a chunk factor, which is the number of rows to
return from the server results set into the local cache in one