The Content Manager OnDemand client
preview exit allows an installation to process document data before
the document is presented to the client. The following figure shows
an overview of the client preview exit.
Figure 1. Overview of the
client preview exit
The client preview exit can be used to add, remove, or reformat
data before the document is presented to the client. For example: - Remove pages from the document, such as banner pages, title pages, all pages but the summary page, and so on.
- Remove specific words, columns of data, or other information from the document. That is, omit ("white out") sensitive information such as salaries, social security numbers, and birth dates.
- Add information to the document, for example, a summary page, data analysis information, and Confidential or Copy statements.
- Reformat data contained in the document, for example, reorder the columns of data.
Note:
- The client preview exit is not called for all document retrievals. In particular, it is not called for functions that use the so-called Bulk Retrieval method of retrieving documents or for server printing. For example, running the ARSDOC GET function without specifying the -n parameter performs a bulk retrieval, and documents retrieved will not be presented to the client preview exit.
- The client preview exit is not called for server printing.
- If a request is made to retrieve a large object document, care should be taken to make certain that the client preview exit does not remove any pages from the document. The large object segment size and page navigation information are based on the number of pages that existed when the document was loaded on the server. Unexpected results may occur if this information is changed.
- The client preview exit is enabled at the application level. The exit is invoked only for the specified applications.