Content Manager OnDemand server flow

Communication with the Content Manager OnDemand server is established by the successful execution of a LOGON request, either explicitly or as part of the BULK RETRIEV function. A successful explicit logon returns a list of folders that are available to the user; the folder list contains only folder names that the user is authorized to access.

Subsequent function requests made using the API calls allow the user to select among the folder names returned at logon by using the FOLDER OPEN request, build a list of document index entries in the opened folder using the HIT LIST request with optional selection criteria, and RETRIEVE documents reflected in the hit list. Communication with the server is ended by successful execution of a LOGOFF request.

LOGOFF can be called directly (in which case all storage area are released) or the LOGOFF request can optionally be embedded in the RETRIEVE request (in which case the document storage areas will not be released). As storage areas become obsolete, the user must issue the appropriate RELEASE requests to free data areas. For each request sent to the Content Manager OnDemand server by using the common area, the API will receive a return code.

As functions are requested, values from prior requests are retained in the API common area and its associated request structures. Details about the fields required to have input values present for the execution of each server function are given in the following descriptions of each server request.

Reserved fields should never be changed by the application program. Return fields should not be changed unless this document describes when such changes are allowed.

The structures defined in copybook ARSZDCLS should not be changed by the application program.