Skip to content

Assure1 Report Runner

Overview

The Assure1 Report Runner application generates Reports based on templates which reference dashboards and their data.

Report Runner Setup

  1. Add a Report Profile or modify an existing Profile:

    Configuration -> Reports -> Profiles

  2. Add a Report or modify an existing Report:

    Configuration -> Reports -> Reports

  3. Enable the default Job, unless a specific configuration option is needed:

    Configuration -> Broker Control -> Jobs

Default Scheduled Job

Field Value
Package Name presentationProcessing-app
Job Name Report Runner
Job Program bin/presentation/ReportRunner
Job Arguments
Job Description Generates Reports via schedule or on-demand
Failover Type Standalone (Supported: Standalone, Primary/Backup)
Status Disabled
Privileged (Checked)
Minutes 59
Hours *
Days *
Months *
WeekDays *

Default Configuration

Name Value Possible Values Notes
LogFile logs/ReportRunner.log Text, 255 characters Relative path to Log File.
LogLevel ERROR OFF, FATAL, ERROR, WARN, INFO, DEBUG Logging level used by application.
Threads 3 Integer The number of process threads created.

Best Practices

  • It is recommended that administrators create a user account with limited access privileges specifically for generating Reports and set the configuration for Username to this user.

Supported Meta Event Tokens

Keyword Template Types Template Fields Description
$DASHBOARDNAME Email, Syslog, Trap Email, Syslog, Varbind (#) Value Dashboard name the report was generated from.
$DATAFORMAT Email, Syslog, Trap Email, Syslog, Varbind (#) Value Format of report (PDF, excel, etc.)
$REPORTATTACHMENT Email Email Attach report content to the email.
$REPORTCONTENT Email Email Report content inline.
$REPORTFILE Email, Syslog, Trap Email, Syslog, Varbind (#) Value Filename of archived report (Archive option must be enabled).
$REPORTLINK Email, Syslog, Trap Email, Syslog, Varbind (#) Value Link to archived report (Archive option must be enabled).
$REPORTNAME Email, Syslog, Trap Email, Syslog, Varbind (#) Value Report name.
$TIMESTAMP Email, Syslog, Trap Email, Syslog, Varbind (#) Value Local timestamp report generated.
$USERNAME Email, Syslog, Trap Email, Syslog, Varbind (#) Value Username report generated by/as.

Administration Details

The following list shows the technical details needed for advanced administration of the application:

  • Package - presentationProcessing-app

  • Synopsis - ./ReportRunner [OPTIONS]

  • Options:

     -c, --AppConfigID N   Application Config ID (Service, Job, or Request ID)
 -s, --SessionID S     SessionID the Report Runner should use when creating reports
 -r, --ReportID N      ReportID specifying the configuration parameters to be used when creating reports
 -?, -h, --Help        Print usage and exit

  • Threaded - Multi-Threaded