ReportRunner
The Oracle Communications Unified Assurance Report Runner application generates Reports based on templates which reference dashboards and their data.
You can run this application as a scheduled job using the Jobs UI.
Report Runner Setup
-
Add a Report Profile or modify an existing Profile:
-
Add a Report or modify an existing Report:
-
Enable the default Job, unless a specific configuration option is needed:
Default Scheduled Job
The following table shows the settings for the default job. Actual values are in bold, descriptions of values are in plaintext.
| Field | Value |
|---|---|
| Package | presentationProcessing-app |
| Name | Report Runner |
| Program | bin/presentation/ReportRunner |
| Arguments | This field is blank. There is no default value. |
| Description | Generates Reports via schedule or on-demand |
| Failover Type | Standalone (Supported: Standalone, Primary, Redundant/Backup) |
| Status | Disabled |
| Privileged | This option is not selected. |
| Minutes | 59 |
| Hours | * |
| Days | * |
| Months | * |
| WeekDays | * |
See Jobs in Unified Assurance User's Guide for general information about the settings for jobs.
See Using Application Primary/Backup Failover for more information about the different failover types.
Default Configuration
The following table shows the default configurations for the application. Actual values are in bold, descriptions of values are in plaintext.
| Name | Default Value | Possible Values | Notes |
|---|---|---|---|
| LogFile | logs/ReportRunner.log | Text, 255 characters | The relative path to the log file. |
| LogLevel | ERROR | OFF, FATAL, ERROR, WARN, INFO, DEBUG | The logging level for the application. |
| Threads | 3 | An 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 |
Attach report content to the email. | ||
$REPORTCONTENT |
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 you will need for advanced administration of the application:
-
Package: presentationProcessing-app
-
Package:
./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: Multithreaded