Configuring Process Value References in SIMATIC BATCH to Display Actual Quantities in Batch Reports
In SIMATIC BATCH order reports, the actual batch quantity field appears as a hyphen (-) or empty space if the 'Process value reference' has not been configured in the recipe properties. SIMATIC BATCH does not automatically infer actual dosed or produced quantities; an engineer must explicitly link the recipe parameter to an AS process variable. In the SIMATIC BATCH Recipe Editor or BatchCC recipe header, open the parameter properties, click the ellipsis button (...) under Process Value Reference, and select the corresponding runtime parameter (such as totalized weight or volume from a CFC block). The actual value is captured and archived into the batch record only when the recipe transitions into a terminal state (Held, Completed, or Aborted).
Table of Contents
- Executive Summary
- Architecture and Fundamental Mechanics
- Step-by-Step Implementation Procedure
- Verification
- Limitations and Operational Precautions
- Engineer FAQ
- Technical References
- Related Articles
- Related Tags
Executive Summary
In process manufacturing plants governed by SIMATIC BATCH (such as pharmaceuticals, specialty chemicals, and food & beverage), batch order reports serve as critical quality documentation and electronic batch records (EBR). After executing a production batch, engineers frequently discover that while planned setpoint quantities (e.g. 3,000 kg) display correctly in the report print preview, the corresponding 'Actual Amount' or 'Actual Quantity' column displays only a hyphen (-) or empty field. This article details the underlying data acquisition mechanisms in SIMATIC BATCH, explains how Process Value References link AS process variables to recipe parameters, and outlines the step-by-step configuration required to guarantee accurate reporting.
Architecture and Fundamental Mechanics
Batch Database Mechanics and Parameter Acquisition Architecture:
- SIMATIC BATCH Parameter Separation: Planned vs Actual:
- In SIMATIC BATCH recipes, parameters are divided into two fundamental classes: Setpoints and Process Values.
- Setpoint parameters are defined during recipe authoring or order creation in BatchCC and represent targeted quantities (e.g. Planned = 3,000 kg). These values are written to the batch database when the batch is planned.
-
Actual parameters represent physical production yields, dosed weights, or process totals measured during execution in the automation station (AS). SIMATIC BATCH cannot guess which AS tag corresponds to the recipe yield; it requires an explicit technological link termed the Process Value Reference.
-
The Role of Process Value Reference:
- The Process Value Reference links a recipe header parameter or phase output parameter directly to an AS block output parameter (e.g.
V_Outof a totalizer block,ER_ACTof an analog measurement, or a parameter on anIEPAR_REALblock). -
The parameter must possess the WinCC operator control attribute (
S7_m_c := 'true') and be recognized in the SIMATIC BATCH type definition. -
Recording State Machine Constraints:
- Actual values are not continuously logged in the batch report summary while the batch is running.
- SIMATIC BATCH samples and writes the referenced AS parameter into the batch SQL database (
BATCH_CDV) only when the batch achieves specific terminal or paused states:- Completed
- Held
- Aborted
- If a report is generated while the batch is in 'Running' or if the reference is unassigned, the report engine renders a hyphen (
-) by design.
Step-by-Step Implementation Procedure
-
Define the Quantity Parameter in the Master Recipe Header:
* In BatchCC or the SIMATIC BATCH Recipe Editor, open the Master Recipe in edit mode.
* Open Recipe Header Properties by selecting Edit -> Header Properties.
* Navigate to the 'Parameters' tab.
* Locate or insert the parameter representing final batch quantity (e.g.Actual_Yield, Unit:kg, Data Type:REAL). -
Configure the Process Value Reference:
* Select the parameter in the list and locate the field 'Process value reference'.
* Click the ellipsis button (...) next to the field to open the parameter browser.
* In the technological hierarchy tree, navigate to the specific Unit and Phase responsible for measuring or dosing the final quantity.
* Select the corresponding AS block output parameter (e.g.Dose_Tot.V_OutorPhase_Discharge.ActWeight).
* Click OK to assign the reference. -
Verify AS Block Attributes and Batch Type Compilation:
* In SIMATIC Manager on the Engineering Station, verify that the referenced AS block parameter has the attributeS7_m_c := 'true'.
* ExecuteCompile and Download Objects -> SIMATIC BATCHfrom SIMATIC Manager to update the Batch type and instance database. -
Release Recipe and Execute Test Batch:
* In BatchCC, release the updated Master Recipe for production (Status -> Released).
* Create a new batch order specifying a planned quantity (e.g. 3,000 kg).
* Start the batch and allow it to run through completion (Completedstate). -
Validate Batch Order Report Output:
* In BatchCC, right-click the completed batch and selectPrint Preview(or open SIMATIC BATCH Report Viewer).
* Inspect the Batch Order Report summary table.
* Confirm that both Planned Quantity (3,000 kg) and Actual Quantity (e.g. 2,998.5 kg) appear clearly.
Verification
Verify Accurate Batch Reporting:
1. In the BatchCC Recipe Editor, verify that the Process Value Reference field displays the full technological path to the AS measurement pin.
2. In the printed or previewed Batch Order Report, verify that the 'Actual Amount' column displays the measured numerical value instead of a hyphen (-).
3. Query the SIMATIC BATCH SQL database (BATCH_CDV) under the ParameterValues table to confirm that the actual value is recorded with status 'Valid' and exact end-of-batch timestamp.
Limitations and Operational Precautions
Operational Precautions and Timing Considerations:
- Modifying a Process Value Reference in a Master Recipe does not update previously completed or archived batches; historical batches retain the data captured during their execution.
- Ensure the AS totalizer or measurement block does not reset its output to zero before SIMATIC BATCH captures the terminal state; if a totalizer resets upon phase completion, configure an intermediate hold register in CFC.
- In validated 21 CFR Part 11 environments, master recipe parameter revisions require formal approval and version incrementation.
Engineer FAQ
Why does my batch report display a hyphen (-) for actual quantity?
A hyphen indicates that no Process Value Reference was linked to the parameter in the recipe properties, or that the batch has not yet reached a supported terminal state (Held, Completed, or Aborted).
Can SIMATIC BATCH record actual values while the batch is still running?
No. Final actual batch parameters are evaluated and archived into the batch report summary only when the batch transitions into Completed, Held, or Aborted status.
What attribute is required on the AS block parameter for Batch visibility?
The parameter must have the attribute S7_m_c := 'true' (operator control and monitoring) so that it is compiled into the WinCC tag database and SIMATIC BATCH type library.
Can I link multiple process values to a single recipe parameter?
No. Each recipe parameter links to exactly one Process Value Reference. If an aggregate calculation is required, implement the arithmetic in a CFC block and reference the calculated output.
Where can I customize the visual layout of SIMATIC BATCH reports?
Batch report templates can be customized using the SIMATIC BATCH Advanced Report tool or Crystal Reports templates supplied with the SIMATIC BATCH installation.
Technical References
- SIMATIC BATCH V9.0 Operating Manual
- SIMATIC BATCH Getting Started Manual
- SIMATIC PCS 7 Compendium Part C - Technical Functions with SFC Types
Related Articles
- Aborting and Deleting Blocked Control Recipes in SIMATIC BATCH when SFC Phases Hang
- Tracking Motor Operating Hours with CountOh and Exporting Shift Reports to Excel in PCS 7
- Transmitting Batch Recipe Start and Complete Status Bits Between SIMATIC BATCH and PCS 7 Controllers
- Defining Block Contacts with S7_contact Attribute for SFC Types in SIMATIC PCS 7
Related Tags
- SIMATIC BATCH
- Batch Order Report
- Process Value Reference
- Recipe Header
- BatchCC
- Electronic Batch Record
- PCS 7 V9.0