Format template settings

You edit settings for the format template in the Report Edit window, which has four tabs: Format Root, Print Setup, Criteria, and Effective Dates.

To open the Report Edit window, right-click on the format template tree root node and click Property.

Format Root

You specify the root attributes for the report template in the Format Root tab.

• Report Template Attributes

  Control the name and description of the report template.

• Verification

  Controls whether or not users can verify sections and add comments.

• Font

  Determines the font settings.

  Note: Font settings are applied to all format template nodes beneath the node where they are defined, unless the child nodes have explicit font settings defined. This feature is useful if you want to specify a common font size and style for all the formatted elements of your report.

• Background

  Determines the background color.

• Time Zone

  Determines the time zone of the report template. If any AF Server is specified, then that server will always be used to specify the time zone for the report template. If None Selected is selected for the time zone, then RtReports attempts to use the data server time zone for the report template. However, if no data server is detected, an error will result.

Print Setup

You specify how the report is printed in the Print Setup tab.

• Page Orientation

  Controls whether the report will be printed in Landscape or Portrait mode.

• Page Numbering

  Controls whether cover page, page headers and page footers show on the first printed page.

  Skip First Page prints page numbers on all pages except the first.

  Number All Pages prints page numbers on all pages.

• Page Numbering Limitations

  In RtReports 4.0, by default, the cover sheet page is not included in the total page count for a report if you enable skip first page for numbering. Numbering starts at page 1 after the cover sheet page. To replicate this behavior, add the following config setting o your OSISoft.RtReports.Editor.exe and OSISoft.RtReports.RtRemotingHost.exe.config files:

  <add key="SkipCoverSheetPage"value="true"/>

  By default, the cover sheet page is always included in the total page count for a report if it exists. This will exclude counting the cover sheet page even if skip first page is enabled.

  Page numbers placed inside the content of the cover sheet are assumed to be on the first page of the cover sheet. They will always be displayed as page 1. This may conflict with page numbers in page headers/footers if your cover sheet is more than 1 page. The headers/footers will always have the correct page numbering. Page numbers are not valid inside the content body of the report. Any page numbers outside of the header/footer will not be displayed. The only exception is the special case with cover sheets and skip first page numbering as explained above.

• Paper Size

  Controls the paper size for the printed report.

• Margins

  Controls the width measurements for the top, bottom, left, and right margins.

• Units

  Defines the Margins settings in either inches or millimeters.

• Official Mark

  Text to be shown as the official mark on an official print.

PDF Settings

• Output Directory

  Controls the destination directory of reports printed to Adobe PDF.

• Official Output Directory

  Controls the destination directory of reports officially printed to Adobe PDF.

File Name

You can select report properties to include in the file name of the generated Adobe PDF file. The options vary for batch or time report templates.

• Report Name

  Name of the report template. This must be included in the file name.

• Report Version

  Version of the report template. This must be included in the file name.

• Report Type

  Type of the report, either Batch or Time.

• Data Server

  The PI Server supplying the data for the report.

• Start Time

  Start time of the data context.

• End Time

  End time of the data context.

• BatchID

  For batch reports, the Batch ID of the data context.

• Product

  For batch reports, the product of the data context.

• Recipe

  For batch reports, the recipe of the data context.

Criteria

Report criteria define the relationship between the data context and the Format template.

• Batch Report Criteria

  You can add new Recipe, Product, Equipment, and SubBatch items, and select the Unit Class value to associate the report template with these items.

• Time Report Criteria

  You can set a recurrence pattern for automatic, repeating report generation.

  Require Data Server require a user to select a data server before generating a time report. Not all Event Frame reports will require a data server, so this provides an option for selecting one per report template. By default, this checkbox is checked for all new time reports. For existing time reports upon upgrade of RtReports, this flag will be set to true automatically.

  Require AF Server requires the user to select an AF Server and AF Database before generating a time report. This can be unchecked if the user is not reporting against AF contexts. By default, this checkbox is checked for all new time reports. For existing time reports upon upgrade of RtReports, this flag will be set to false.

Effective Dates

Effective dates specify the validity of a report over a specific time range.

• Disable Effective Dates

  Uses default effective dates, which are determined by the report version.

• Effective Start Time

  Uses either the Beginning of Time or a manually entered valid start date and time.

• Effective End Time

  Uses either the End of Time or a manually entered valid end date and time.