AVEVA™ Batch Management

Reporting System Components

Save PDF

Reporting System Components

Save PDF

Last UpdatedNov 20, 2024
5 minute read

Operations and Execution

The reporting system uses a variety of software components. Some are industry standard components and others are unique to the batch system. This section describes the primary components of the reporting system. It is recommended that you familiarize yourself with the components as this enables you to more clearly understand how to deploy the reporting system.

AVEVA Batch Management Server

The AVEVA Batch Management Server contains one reporting system component, the History Queue Manager. The History Queue Manager is installed with the AVEVA Batch Management Server.

History Queue Manager

The History Queue Manager transmits data to the History Server. This guaranteed delivery is accomplished by maintaining the data locally in the case of a disconnection and then transmitting the data when the connection is restored. All data is time stamped by the AVEVA Batch Management Server so that if data communication to the History Server is interrupted, the time and date stamps are still accurate.

AVEVA Batch Management History Server

The AVEVA Batch Management History Server is dedicated to the storage of historical information.

The AVEVA Batch Management History Server uses Microsoft SQL Server, a History Queue, and a History Queue Reader Service.

History Queue

The History Queue is a first-in-first-out (FIFO) queue which is located on the AVEVA Batch Management History Server that is responsible for transferring all historical data from the Batch Manager on the AVEVA Batch Management Server to the Batch History database. The History Queue is also responsible for notifying the report queue of End-of-Batch and End-of-Phase events which trigger reports.

History Queue Reader

The History Queue Reader is a background processing task (service) which runs on the AVEVA Batch Management History Server and is responsible for reading historical data and report requests from the history queue, storing the data, and queuing report jobs to the SQL Server database.

AVEVA Batch Management Reports

When you install the reporting components on an SSRS platform, they enable you to configure, schedule, and view reports. You can define schedules for the reports or interactively request a report on an as-needed basis.

Note: When you perform a fresh install of AVEVA Batch Management, the Reports folder name is displayed as "Batch Management Reports". However, if you upgrade to the latest version of Batch Management from any previous versions, the Reports folder name is displayed as "InBatch Reports".

Report Queue

The Report Queue is a First-In-First-Out (FIFO) queue located on the AVEVA Batch Management History Server that handles all requests for reporting activity. The queue also contains all parameter data necessary for the processing of the report.

Report Queue Reader

The Report Queue Reader is a background processing task (service) that coordinates the generation of reports as directed from the report queue.

AVEVA Batch Management Reports Administration Client

The report administration client can be accessed from any supported web browser. However, a shortcut menu is also created on the Reporting Content platform.

Based on your AVEVA Batch Management Server permissions for "AdminWeb", you can configure and schedule reports. You can also run reports on demand using the SQL Server Reporting Services.

AVEVA Batch Management Reports Display Client

The report display client can be accessed from any supported web browser. However, a shortcut menu is also created on the Reporting Content platform. Additionally, the BatchReport icon in EnvDspl can be used to bring up this client.

Based on your AVEVA Batch Management Server permissions for "ReportWeb", you can view executed reports. You can also run reports on demand using the SQL Server Reporting Services.

Report Templates

The following report templates are provided for you to use as a basis for creating your own customized reports.

These report templates are intended only to be used as examples for the development of custom reports. These templates are stored on the computer where you installed the reporting software in the following folder:

C:\Program Files\Wonderware\Batch Management\Reporting Services

A summary of each template is provided in the following table.

Report Name	Description
Batch Alarms	Provides a summary of all alarms for a specific batch.
BatchDetail	Provides a summary of all batch processing activities for a batch.
Batch Events	Provides a listing of the batch events for a recipe.
Batch Journal	Provides a comprehensive journal of batch history for a specific batch.
Batch Listing	Provides a summary report of all batches produced.
Batch Questions	Provides a summary of all questions for a batch.
Batch Transitions	Provides a summary of all batch transitions.
Batches By Material	Provides a list of batches that used a specific material or material from a specific vendor.
Document View Events	Provides a listing of the Documentation Review events for a recipe.
EquipmentStatus	Provides a listing of all Equipment Status changes that occurred during batch processing.
Material Characteristics	Provides a summary of all material characteristics for a campaign, lot, and batch.
Material Input Changes	Provides a summary of the changes made by operators to the original formula inputs quantities for a batch.
Material Inputs	Provides a summary of all materials consumed in a batch.
Material Outputs	Provides a summary of all materials produced by a batch.
Material Output Totals	Totals all materials produced for a batch.
Operator Comments	Provides a summary of all operator comments for a batch.
Phase Instructions	Provides a summary of all recipe phase instructions for a batch.
Process Log1	Provides a summary of all process log values for a batch.
Process Log2	Provides statistical information of all process log values recorded for a specific tag.
Process Log3	Provides a graphical representation of all process log values recorded for a specific tag.
Process Variables	Provides a summary of all process variable target and actual values for a batch.
Process Variable Changes	Provides a summary of changes made by operators to the original formula process variables for a batch.
Production	Provides a summary report that includes number of finished products produced, number of lots, number of batches and total quantity produced.
Production By Lot	Provides a summary of all finished products produced.
Security Listing	Provides a summary report of all security related activity for a batch.

Note: InBatch 8.1 and later does not support expression triggered reports. If you were using expression triggered reports in a previous version, they are converted when you upgrade the databases and appear in the list of configured reports on the Configuration web page. The report names exist in the ReportDef table in batch history. However, these reports are not generated.

Additional Report Templates for Foxboro DCS Components

Report Name	Description
Batch Analog Alarms	Provides a listing of analog alarms issued for a batch. Alarm comments that were entered for an analog alarm with the Alarm Comment application are also included in the report.
Batch Boolean Alarms	Provides a listing of Boolean alarms issued for a batch. Alarm comments that were entered for a Boolean alarm with the Alarm Comment application are also included in the report.
Non-Batch Operator Action Journal	Provides a summary of all non-batch-related operator actions that occurred during a batch.
Operator Action Journal	Provides a summary of all operator actions during a batch.
Sequence Block Alarms	Provides a listing of sequence block messages issued for a batch. Comments that were entered for each sequence with the Alarm Comment application are also included in the report.

AVEVA™ Batch Management