Retrieval preview user exit

The retrieval preview user exit allows for the modification of document data prior to the data being retrieved from the server. The retrieval preview user exit allows you to run a user-written program to process documents that belong to a specified application.

The user-written program is activated by selecting the Use Preview Exit option on the Miscellaneous Options page of an application. When the option is selected, the user-written program will be called any time that a request is made to retrieve a document. Any information that is specified in the Parameters field will be passed to the user-written program.

The retrieval preview user exit allows an installation to process document data before the document is presented to the client. The retrieval 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.