BG_* variables

When creating reports using the Report (template) form type, the system makes use of a number of background "constant" variables. This table lists and describes these variables and their use:

Variable Description
BG_COMPANYNAME This variable is replaced by the value of a parms.company field, if one exists. Otherwise, this variable remains blank.
BG_CURPAGE This variable is replaced by the number of the current page within the current paging group of a report. This value can be reset by FlexLayout regions, by setting the Reset Page Number attribute value to True.
BG_EXECUTIONTIME This variable is replaced by the date and time that the report was generated.
BG_OVERALLCURPAGE This variable is replaced by the number of the current page in the entire report. This value cannot be reset within the report.
BG_OVERALLTOTALPAGES This variable is replaced by the total number of pages in the entire report. This value cannot be reset within the report.
BG_SESSIONID This variable is replaced by the background task session ID.
BG_SITEID This variable is replaced by the site identifier as provided in the Sites form, Site field.
BG_TOTALPAGES This variable is replaced by the number of pages within the current paging group. This value can be reset by FlexLayout regions by setting the Reset Page Number attribute value to True.
BG_USERID This variable is replaced by the user name of the user who submitted the report.