9.572 Report-Generator

The Report-Generator logical device collects a user defined set of parameters and generates formatted reports on a regular basis. Reports are stored as PDF files for printout and in parallel as semicolon separated text files (CSV) for further machine based processing. The Report-Generator device is available as of version 3.0 of the software.

Report types

The Report-Generator provides a number of report types. Each type implements a certain report generation timing. The following table shows the available report types:

• SIMPLE --- The simple report type provides a freely definable update interval. It produces a single column report every n days. Additionally, this report type is the only one which allows to set the time of day when the report shall be created.
• WEEKLY --- The weekly report creates report sheets with 7 columns. The report sheet gets updated every day at midnight, a new report file is started every Monday 00:00 UTC
• MONTHLY --- The monthly report creates a 31-column table. Each report file starts at the 1st of a month at 00:00 UTC, the table gets updated on a daily basis. A 31-column table on a single page would lead to very narrow columns and a very small font size. The table therefore is spread over two pages, one for the 1st .. 16th of the month, the second for the 17th to the end of month. Page and table headers are repeated accordingly.
• QUARTERLY --- The quarterly report collects the data for one quarter on a report sheet, updated once a month (three columns)
• YEARLY --- The yearly report collects the data over one year, arranged on 12 columns, one for each month.

The report timing (the report type and for simple reports also the interval and the time of day) is set at the device window of the Report-Generator device. Please note that changing the report timing voids all temporary data collected for the actual report interval.

Report contents

The contents of a report produced by the Report-Generator device is defined in a text based configuration file. The file defines which parameters are to be recorded and also some information about the layout of the report sheets.

The configuration file defines one report property or report item per line. Empty lines and lines starting with a hash character ('#') are ignored. Each line starts with a keyword, followed by a (item specific) number of parameters.

• VAL --- Adds a standard item to the report. The report contains the parameter value at the end of the recorded interval. VAL must be followed by the parameter identifier to record and a (mandatory) description.
  • Example:VAL DEVICE-1.param2 This is the descriptive text
• MAX --- Adds a 'maximum' item to the report. The report contains the maximum value found over the recorded interval. MAX must be followed by the parameter identifier to record and a (mandatory) description.
  • Example:MAX DEVICE-1.param2 This records a maximum value Using MAX with non-numeric parameters gives no meaningful results.
• MIN --- Adds a 'minimum' item to the report. The report contains the minimum value found over the recorded interval. MIN must be followed by the parameter identifier to record and a (mandatory) description.
  • Example:MIN DEVICE-1.param2 This records a minimum value Using MIN with non-numeric parameters gives no meaningful results.
• AVG --- Adds an 'average' item to the report. The report contains the average computed over the recorded interval. AVG must be followed by the parameter identifier to record and a (mandatory) description.
  • Example:AVG DEVICE-1.param2 This records an average value Using AVG with non-numeric parameters gives no meaningful results.
• EQU --- Adds an 'equ' item to the report. This item collects the time while the given parameter equals a reference value. EQU must be followed by the parameter identifier to record, the reference value and a (mandatory) description.
  • Example:EQU DEVICE-1.param2 REFVAL Records the time while param2 equals REFVAL
• NEQ --- Adds an 'neq' item to the report. This item collects the time while the given parameter does not equal a reference value. NEQ must be followed by the parameter identifier to record, the reference value and a (mandatory) description.
  • Example:NEQ DEVICE-1.param2 REFVAL Records the time while param2 does not equal REFVAL
• LML --- Adds a low limit item to the report. This item collects the time while the given parameter falls below a limit value. LML must be followed by the parameter identifier to record, the limit value and a (mandatory) description.
  • Example:LML DEVICE-1.param2 -77.5 Records the time while param2 is below the limitUsing LML with non-numeric parameters gives no meaningful results.
• LMH --- Adds a high limit item to the report. This item collects the time while the given parameter is above a limit value. LMH must be followed by the parameter identifier to record, the limit value and a (mandatory) description.
  • Example:LMH DEVICE-1.param2 45 Records the time while param2 is above the limitUsing LMH with non-numeric parameters gives no meaningful results.
• PAUSED --- Adds a special item to the report which records the time while the Report-Generator was in PAUSED state. PAUSED is followed by descriptive text.
  • Example:PAUSED Maintenance time / recording paused
• SPACE --- Adds an empty line to the report. There are no parameters following this keyword.
• TEXT --- Adds a report line with only the description column filled. TEXT is followed by the descriptive text to print.
  • Example:TEXT Example text
• HEADING --- Heading works similar to TEXT, but the text is bold printed and may cover the whole report line.
  • Example:HEADING Bold printed text
• LEFT-TITLE --- Each report sheet contains a caption/title at it's top. LEFT-TITLE supplies the text for the left title field.
  • Example:LEFT-TITLE title text
• MID-TITLE --- MID-TITLE supplies the text for the center title field.
  • Example:MID-TITLE title text
• RIGHT-TITLE --- RIGHT-TITLE supplies the text for the right title field.
  • Example:RIGHT-TITLE title text

The sequence of item definitions in the configuration file defines the sequence of lines in the report. The global TITLE definitions may appear anywhere in the file.

When using non-ASCII characters in the description texts, the file must be ISO8859 encoded that these characters are correctly shown in the report.

Snapshot reports

The Report-Generator device is capable to produce snapshot reports on a button press. The snapshot report prints the actual values of the recorded parameters. Report items which record time intervals are omitted in this report. Minimum/maximum/average items print the actual parameter value rather than the value computer over a certain time interval.

Pausing the data recording

The device allows to pause data recording by setting the appropriate parameter at the device window's main page. While paused, the device does not recognize any changes of parameter values. This may be helpful during maintenance of the station: Faults of incorrect parameter readings produced during the exchange of a device do not falsify the report statistics if the Report-Generator is set to PAUSED during the maintenance operation.

In order to remind the operator of re-enabling the device, the Report-Generator shows a fault while it is PAUSED.

Report file names

The device uses a fixed pattern to generate the names of the report files. Each file name starts with the name of the Report-Generator device, followed by a single letter for the report type and the description of the recorded time interval. Examples:

• FOO-W-14-2010.pdf --- A weekly report for week 12 in 2010, generated by the device FOO
• FOO-M-05-2010.pdf --- A monthly report for May 2010, generated by the device FOO
• FOO-Q-03-2010.pdf --- A quarterly report for the third quarter 2010 (July - September), generated by the device FOO
• FOO-Y-2010.pdf --- A yearly report for 2010, generated by the device FOO
• FOO-S-2010-04-22.pdf --- A simple report, starting on April, 22th 2010, generated by the device FOO

Snapshot reports do not include a type letter, their file names consists of the device name and a full time stamp of the report creation.

CSV report files

Beside the PDF formatted reports, the device automatically produces CSV files for further machine based processing of the reported data. The files contain a semicolon separated table with the same layout as in the corresponding PDF report, except for TEXT, SPACE and HEADING items which are omitted in the CSV file. Also the CSV files are not page-formatted and do not contain page headers.

Device window pages

The following table shows which device window pages are available with this individual device type. Tool-bar functions not mentioned here are described at the general description of device windows .

• --- The settings page shows and defines the timing parameters for the report.
• --- The state page shows a summary of the data, the device actually watches.
• --- The device faults page. The device rises a fault if it could not read the configuration file and also while data recording is paused.
• --- The device info page.
• --- The maintenance page. The configuration parameters from this page are described below.

Configuration parameters

At the maintenance page of the device window there are a couple of configuration parameters which must be set to make the device work properly.

Additional remarks

The Report-Generator device stores all temporary data needed to collect the data for a report - including the timing settings for the report - in a file called XXX.dat, where XXX is substituted by the name of the device. This backup file is updated once an hour. The file is located in the base installation directory of the sat-nms software. Deleting this file resets the Report-Generator device to a daily SIMPLE report type and voids all cached report data.

The configuration file defining the report contents may be changed "on the fly", e.g. to add new parameters. After changing the file, press "RESET" on the maintenance page at the Report-Generator device window. This makes the device re-read the file. The collected data of all item which match in item type and parameter identifier is retained. New or changed report items are newly initialized.

Variables defined by this device driver