Report template reference

Report templates

Reports are generated from report templates.

Report templates are sets of data retrieval, processing, and formatting rules that can be tested and released for production. Report templates are designed in the RtReports editor.

Report template components

• Report template

  The configured data retrieval, processing, and formatting rules used to generate a report.

• Data template

  The collection of data retrieval and processing rules.

• Format template

  The collection of report formatting rules.

• Journal actions

  The individual data processing rules for the report template. Journal actions define the criteria used to select time series data for a report. Journal actions are always contained within a context element. Journal actions may contain additional rules and data sets defined within action states, action results, and result definitions.

• Context elements

  The set of key events for each particular report, as defined in the element, time, and data templates.

• Data journal

  An XML file of raw data generated by applying journal actions to the context element and contained within a hierarchical tree structure. The data journal is a separate artifact created when a report template is tested against its context.

• Report parameters

  Placeholders for data used at the time reports are generated which define the type of data and how it can be used.