Batch Statistic Utility

This section provides information on how to use the Batch Statistics Utility tool, which is designed to help you monitor the progress and performance of the Client Reporting’s batches.

This utility provides an easy way to monitor the health and performance of your system. It is not meant to replace the current batch status user interface or Eagle PACE engine logs, but is designed to provide a general overview of the client reporting life cycle.

Getting Started

This application is written using the EAGLE TCP/IP API to connect to the Eagle PACE Application Server and the Advanced Reporting Interface to generate the printable reports. To operate this utility, install the EAGLE TCP/IP API and either the Eagle PACE Server or the Advanced Reporting Add-In to obtain the necessary components to run the reports.

Consult your system administrator to obtain the network installation directory. No additional ODBC configurations are required on the client desktop.

On this page

Log In and Configure a Shortcut

To login to the application server, enter your Eagle PACE user ID, Application Server Password, Application server location (by name or IP address) and the Port Number the application server is using for communication. Click OK to have your user information authenticated.

There are several command-line options you can use to automatically input your credentials. These may be included with the shortcut used to launch this utility. The options should be separated by a command and may appear in any order. The option values are listed in the following table:

Option	Description
-U	User ID
-P	Password
-S	Server Name or IP Address
-N	Port Number

Separate the command line parameters with a comma, for example: F:\AdvancedReporting\Batch Statistics\BatchStatUtil.exe" -U PACE_Login,-P Password, -S PACE_appserver, -N 800

This information is placed in the target parameter of the shortcut. All of the input parameters appear on the login form. This saves a few keystrokes when you launch the application.

View Batch Information and Reports

The Client Reporting Batch Statistics Utility provides several snapshots of your data. When you login to the application, a list of all the batches that are currently in the cr_batch table appears. You can expand each of the batches listed to view batch details including batch id, effective date, and create date. There is a status bar at the bottom of the window to identify the current environment you are connected to and provide status information when retrieving data from the Eagle PACE database.

Client Reporting Batch Statistics Utility Window

There are two options for selecting data for retrieval. First, you may click on the batches individually to have detail and statistics information provided in the various tabs. Or you may select the check box titled Query By Filter Only. If this is selected, then clicking the various batches does not retrieve any data. Rather, data is retrieved only when the Retrieve Data command or menu item is selected, and then only for the batch_ids in the Filter Criteria list.

Additionally, data retrieval may be further limited by selecting the check box Retrieve Data only for the selected tab. If this check box is selected then only data for the particular tab is retrieved. Data for the other tabs is not updated. This is useful in a case where you have a large number of batch records and you only wish to update information for one window at a time. When this check box is not selected data is retrieved for all tabs when the Retrieve Data command is executed. The first window to receive data is always be the window that is being viewed.

View Batch Details

The Batch Details tab window displays information from the cr_batch_detail table. Sort the data by clicking the column header. To reverse the sort order, click the column header again. If data is sorted in ascending order it is then sorted in descending order and vice versa. To move the columns, select and drag the column header to the insertion point.

The columns included in this view are Batch Instance, Batch Detail Instance, ID Type (C for Client, E for Entity), ID (Client ID or Entity ID), Status, Status Flag (1 for Error), Update Date, and Report Location for all post imaging batches.

This window may also be filtered to retrieve a subset of data. If no filter is selected, then by default all records are selected. To filter data, simply select the batch status value or values you would like to retrieve and click the Execute or the Retrieve Data command.

To get a description for each status value, place your cursor over the letter and a tool tip appears with the long description of the status value.

The number of rows returned is displayed below the list view.

View Batch Run Statistics

The Batch Run Statistics window provides a summary overview for the status of the batch or batches selected. The top portion of the window provides information for all the packages in the batch that have completed processing. The details for the batch include the number of packages submitted, the number completed successfully, the elapsed time from the batch inception to the last completed package, the time for the last completed package and the average run time for the packages. When more than one batch is selected, all times are cumulative. Meaning, the start time is the minimum start time for the batches selected, and the last completed package is the maximum update date for the packages, and the time per package is a representation of that cumulative time period.

The middle portion of the window contains a summary of all engine status values. For each status the number of packages that are at that level is returned. A status flag value of 1 indicates an error has occurred at that level. In the case of approval stages, a status flag value of 1 would indicate that an approval has been rejected.

The bottom window displays the engines that are currently active in the cluster. A Master value of 1 indicates the server that is currently acting as the master engine in the cluster environment.

View Batch Errors

The Batch Errors window displays a list of all errors that have occurred in the selected batches. Sort this list by clicking on the column. Click the column again to reverse the sort. Further, the data may be filtered to show all errors, Visual Basic errors or non-Visual Basic errors. Click the button to filter data. Since there are only two options available, there is no need to execute an additional retrieve data command.

View Engine Statistics

The Engine Statistics window provides an overview of the engines that are currently scheduled and running in the current environment. The top half of the window shows the currently running engines based on the entries in the PACE_MASTER.DBO.SCHEDULE_DEF_DETAILS table. The lower half displays all currently enabled engines in the PACE_MASTER.DBO.SCHEDULE_DEF table. This window is meant to provide a general overview of the current system activity. For more detailed information or to disable an event, use the Scheduler windows from the PACE client.

Menu Options Quick Reference

This section describes the various options on the Client Reporting Batch Statistics utility menus:

File Menu

Options include:

Reset Connection – Resets your connection to the application server using the criteria defined in the login window.
New Connection – Establishes a connection to a different application server to query a different Eagle PACE environment.
Close – Closes the session and exit the application.

Filter Criteria Menu

Available from the menu and by right-clicking in the batch tree view. Options include:

Add Criteria – Adds the currently selected batch to the criteria list.
Select All – Adds all of the available batches to the criteria list.
Clear Criteria – Clears the currently selected batch from the list.
Clear All – Clears all selected batches from the list.
Retrieve Data – Retrieves data based on the criteria list.
Refresh Batch List – Refreshes the batch list in the cr_batch table.