Browses in QAD .NET UI > Creating Browse Operational Metrics > Operational Metrics History
  
Operational Metrics History
With the QAD Operational Metrics History, you can view changes in operational metrics over time. The system stores the history of operational metric activity and then generates charts of the data for you.
You can then explore the chart data further, change the time range, scroll right and left or zoom in and out of particular areas of interest, and export the chart data to Excel for further analysis.
When you open an operational metric page, the system uses the most recent history data to display the initial view of the metric page if the data is less than 24 hours old. This allows the page to be displayed more quickly than if the underlying metric browses were queried to retrieve the data.
The system saves history data whenever the browse queries for the metrics are run. In addition to the history data, a pie chart that summarizes the metric results is also saved so that the Operational Metrics View process map can show the most recently generated results.
The system queries the metric browses (and saves history data) in the following situations:
When you click an operational metric’s Refresh button.
When you open an operational metric and the history data is more than 24 hours old. (Note that 24 hours is the default; the interval is configurable and applies to all metrics in the system.)
When the QAD_OpMetricsAutoRun report is run. Typically, this report is run when metrics are scheduled for periodic running, but if a report administrator runs this report from the report designer, it will also run the metric and its processes.
The history data is never deleted from the system.
A new “as of” label next to the metric name indicates the date and time of the metric data being displayed. If the browse queries are currently running, “loading...” is displayed next to the metric name; when they finish running, the “as of” time will show the current time.
Metric history data contains at most one history record per day for a given metric. If the metric’s browses run more than once in a given day, the history reflects the most recent run.
Configuring Operational Metrics History
Operational Metrics History Update Interval
By default, if operational metric history data is more than 24 hours old, the system updates the data (by running the metric browses) when you launch a metric collection; otherwise, the most recent history data is used to display the metric more quickly.
You can change the time interval by adding (and modifying) the following to the client-session.xml configuration file:
<Metrics>
...
<StaleDataAllowedHours>24</StaleDataAllowedHours>
...
</Metrics>
The time interval applies to all metrics in the system.
Operational Metrics History and the QAD Reporting Framework
Operational Metrics History uses the QAD Reporting Framework report server’s scheduled batch mode to auto-run a special report that runs the desired metric and generates and stores metric history data. The new QAD-supplied report, QAD_OpMetricsAutoRun, is used for auto-running the metrics in scheduled batch mode.
Your system must be configured to run scheduled reports in scheduled batch mode (see the Scheduled Batch Mode section in the Reporting Framework User Guide’s Administering Reports chapter).
Additionally, the Set Up a Scheduled Batch section in the Reporting Framework User Guide’s Administering Reports chapter describes how to create a parameter file to contain command line parameters with fixed values, using a params.pf file as an example. In that file, you must add the following line in order for the metric report to run properly:
-enable:qad.plugin.opmetrics
Using Operational Metrics History
With the QAD Operational Metrics History, you can view changes in operational metrics over time. The system stores the history of operational metric activity and then generates graphs of the data for you.
For example, in the Sales Orders metric collection, open the Sales Orders Past Due metric. Notice the thumbnail images to the right of the displays for Past Due Orders and Past Due Cost. Click the thumbnail image for Past Due Orders:
When you click the chart thumbnail, a metric history chart displays:
Navigating the History Chart
Under the thumbnail image of the chart, click the icons that allow you to:
Change the time range of the display (1 week, 1 month, 3 months, 6 months, 1 year, 2 years, 3 years).
Toggle the Zoom control to:
Zoom in
Zoom out
Zoom horizontally
Zoom vertically
Export the history data to Excel for further analysis.
Detach the chart to a separate window to enlarge the view.
You can also click-drag to navigate the metric history chart.
If you mouse over a data point, the system displays its value. The color of the dot on a given day corresponds to the metric result for that day. Boundaries for the result ranges (where red indicates an error, yellow indicates a warning, and green indicates good) are also displayed on the chart as colored dotted lines.
Click the chart thumbnail again to hide the metric history chart.
Scheduling Batch Processes for Operational Metrics History
Although metric history gets generated whenever a user manually refreshes a metric (or opens a metric that does not have recent history data), you can schedule metrics to be run at regular intervals to guarantee the regular creation of history data. For example, you might want to schedule a certain metric to be auto-run daily and a different metric to be auto-run weekly.
Operational Metrics History uses the QAD Reporting Framework report server’s scheduled batch mode to auto-run a special report that runs the desired metric and generates and stores metric history data.
Scheduling and Running Batch Processes
You can schedule and edit these batch processes directly from a metric display.
From the toolbar, choose Schedule to schedule batch processes:
The Schedule pull-down options include:
New — schedule a new batch process. Enter a valid batch ID.
Note: Batch IDs must first be defined by an administrator using Batch ID Maintenance. It can be useful to name the batches according to the time interval at which the report server is configured to run that batch. For example, you might define a batch called “daily” that is configured to run every day and another batch called “weekly” that is configured to run once a week. When a batch ID is specified by the user, the metric auto-running only occurs if a report server is configured to process that batch ID.
View Schedule — view currently scheduled batch processes in a browse. You can view further details and modify the batch process by right-clicking on the ID and chooosing Scheduled Report History, Parameters, and Scheduled Report Maintenance. Use Scheduled Report Maintenance to modify batch details. (See the Reporting Framework User Guide’s Maintaining Scheduled Reports section for further information.)
View History — view previously run batch processes in a browse that includes their status, such as New, Waiting, Running, Complete, or Error. (See the Reporting Framework User Guide’s Viewing Report History section for further information.)