The following sections describe the exchange of information between
a customer application program issuing structured API calls and the Content Manager OnDemand server.
The customer application program must be modified to issue specific
Content Manager OnDemand function requests, in the
form of structured API calls, to the
Content Manager OnDemand server. The
Content Manager OnDemand functions supported by the
structured API calls are:
- LOGON
- Logs on to the Content Manager OnDemand server
and returns a folder list.
- FOLDER OPEN
- Retrieves folder criteria.
- HIT LIST
- Builds a list of folder items (search).
- RETRIEVE
- Retrieves a document.
- BULK RTRIEV
- Retrieves multiple documents in a single call to the API.
- ANNOTATIONS
- Retrieves the annotations associated with a document.
- LOGOFF
- Logs off of the Content Manager OnDemand server,
and performs an implicit RELEASE request.
- RELEASE
- Frees all memory acquired by the various APIs.
- RELEASEA
- Frees the Annotations List Structure created by ANNOTATIONS.
- RELEASEC
- Frees the FolderCriteriaStructure created by FOLDER OPEN.
- RELEASED
- Frees the DocumentStructure created by RETRIEVE.
- RELEASEH
- Frees the HitListStructure created by HIT LIST.
- RELEASEL
- Frees the FolderListStructure created by LOGON.
At a minimum, the customer application program must perform these
tasks:
- Control the flow of Content Manager OnDemand server
requests/responses for each API user
- Include IBM-supplied copybooks that contain the layout of the Content Manager OnDemand server interface structures
- Build a request structure for each Content Manager OnDemand server function
- Issue API call to the Content Manager OnDemand server
- Process the Content Manager OnDemand server
response
- Manage storage areas allocated to hold Content Manager OnDemand server response. Storage
areas should be freed at the appropriate times during program execution.
If you do not free storage, memory usage will continue to increase
and it will appear as if the program is suffering from "memory creep."