Adding Banner Definitions
Reports can be printed with additional banners, which can be called dynamically by referring to the .BANNER property in the report code.
The banner information can be customized by editing the banner file. The banner file to use can be set by using the comscript commands AddBannerIdFile or AddDefaultBanner of the Job Interface.
| Note |
|---|
| The functions AddDefaultBanner, GetDefaultBanner, and SetDefaultPrintBanner must be configured together for a banner to display. |
When no banner file is set, the default banner file should be named Banner.dat and placed in the root of the Print Output folder set in Control Center. If Banner.dat is not available, the banner is populated through the default banner settings.
To create a custom banner file, use one of the options listed in the table below.
In the file, every print definition must be preceded by one of the following specifications:
- H: in case the text has to be added in the heading of the print output.
- F: in case the text has to be added in the footing of the print output.
- B: in case the text has to be added in both the footing and the heading.
The letter specification (H/F/B) must be followed by the text to add, in the following format:
H:Header text with <Option1> and <Option2> included in the text.
The following options are available:
| Option | Description | Default availability |
|---|---|---|
| AMTVERSION | Adds the AMT version number. | * |
| APPLICATION | Adds the name of the application. | * |
| BANNERID | Text will be printed as normal characters on the banner page. | |
| BANNERTEXT | Text is printed in large characters on the banner page. | |
| CR | Adds a Carriage Return. | * |
| DESCRIPTION | Adds a description for the report. | * |
| ENDTIME | Adds the time when the Print File is closed using FREEOUTPUT. | |
| FF | Adds a Form Feed. | * |
| INITIATOR | Adds a specification for the station or session through which the report was started. | * |
| JOBTEXT | Adds extra information for the job. | |
| LF | Adds a Line Feed. | * |
| MAXLINES | Adds the maximum number of lines that can be printed per page according to the paper setting for the printer. | * |
| ONPRINTER | Adds the name of the printer that is used. | * |
| PAPERKIND | Adds the kind of paper that is specified for the printer. | * |
| PRINTBACKUP | Adds the name and location of the print backup file. | * |
| PRINTOUTPUT | Adds the print output specification. | * |
| PROCESS_ID | Adds the process ID assigned to the print task. | * |
| REPORTNAME | Adds the name of the report. | * |
| STARTTIME | Adds the start time of the job. | * |
| USER | Adds the name of the user account under which the job was started. | * |