Tailoring the Banner Page

This appendix describes how to tailor the banner page on CA IDMS reports.

Specifying a Banner Page

Reports printed by CA IDMS optionally can begin with a banner page. You use the BANNER/NOBANNER parameter of the system generation LTERM statement to specify whether reports printed on a given printer have a banner page. The LTERM statement is described in LTERM Statement.

RHDCBANR Module

The text of the banner page is determined by the RHDCBANR module. The print program calls RHDCBANR repeatedly to obtain each line of the banner page.

You can tailor the banner page to meet site-specific needs. To do this, you modify the RHDCBANR source module. Then you assemble the source module and link edit the resulting module into the load (core-image) library.

To assemble and link-edit RHDCBANR, you must use SMP/E (z/OS) or MSHP (z/VSE). For instructions on using SMP/E and MSHP, see the CA IDMS Installation and Maintenance Guide—z/OS or the CA IDMS Installation and Maintenance Guide—z/VSE.

How the Banner Page is Built

When the print program calls RHDCBANR:

Register 1 points to the logical terminal element (LTE) of the printer on which the report is to be printed.
LTEQBUFA contains the address of a 180-byte buffer.
LTERPEA contains the address of the report element (RPE) for the report being printed.
RPEBCTR contains the number of the banner page line that RHDCBANR is to supply. For each report, the print program sets RPEBCTR to zero before the first call to RHDCBANR.

RHDCBANR must build the next line of the banner page in the buffer identified by LTEQBUFA. Each banner page line should contain only the data to be printed. RHDCBANR should not place device-dependent line control characters in the buffer.

Additionally, RHDCBANR must set:

LTEPRLEN to the length of the banner page line.
LTEPROPT to X'00' for normal line spacing or to X'01' to cause a page eject before the line is printed.

RPEBCTR to the number of the banner page line to be built the next time the print program calls RHDCBANR. If no more banner page lines are to be printed, RPEBCTR should be set to 255.