Show TOC

Function documentationQuery Groups: Default PDF Page Layout for a List or Report Locate this document in the navigation structure

 

When a report or list page is exported to PDF format, information is added to page header and footer fields. Each header and footer has three sections: left, center, and right. There are hard-coded defaults for the source of the data that is put in these fields on each page, but the defaults can be overridden.

One set of system properties can override the defaults for all reports. Another set of properties can override the list page defaults. As indicated in Reports, a report's page layout can be tailored for a single report by editing that report's Page Layout tab, overriding both the hard-coded defaults and the report pages' system properties.

Any of the following system properties can be defined. The current hard-coded defaults are shown, so there is no need to define these. Only define those properties whose hard-coded defaults you want to change.

The defaults for logo_url and conf_url require some explanation. The value of each of these properties is a classpath-relative pathname to an image file. In the case of the logo URL, there is no hard-coded default, but the company logo that is associated with the user running the report is used. In the case of the confidentiality statement logo, there is no default, but nothing is displayed for this item unless an override is provided. Like logo_url, a value for conf_url is a path name to an image file, such as /images/confStmt.gif.

report_page.logo_url=

report_page.conf_url=

report_page.orientation=LANDSCAPE

report_page.header_left=LOGO_URL

report_page.header_center=REPORT_DISPLAY_NAME

report_page.header_right= report_page.footer_left=CONFIDENTIALITY_STMT_URL

report_page.footer_center=CURRENT_USER_AND_DATE_TIME

report_page.footer_right=PAGE_NUMBER

list_page.logo_url=

list_page.conf_url=

list_page.orientation=LANDSCAPE

list_page.header_left=LOGO_URL

list_page.header_center=

list_page.header_right=QUERY_DISPLAY_NAME

list_page.footer_left=CONFIDENTIALITY_STMT_URL

list_page.footer_center=CURRENT_USER_AND_DATE_TIME

list_page.footer_right=PAGE_NUMBER

The orientation enum has possible values of PORTRAIT or LANDSCAPE (the default value).

The full set of possible values for the header/footer fields is as follows:

LOGO_URL

CONFIDENTIALITY_STMT_URL

REPORT_DISPLAY_NAME

QUERY_DISPLAY_NAME

REPORT_DESCRIPTION

QUERY_DESCRIPTION

CURRENT_DATE

CURRENT_DATE_TIME

PAGE_NUMBER

CURRENT_USER

CURRENT_USER_AND_DATE_TIME