Electronic Batch Record (EBR) Viewer

Using Batch Procedure EBR Viewer

The Batch EBR Viewer component is installed with the Batch Procedure module.

EBR Viewer Component is provided in 3.81.6 RC 1 and later.

EBR is a comprehensive listing of parameter and processing data. Parameter data include the parameters at the Recipe/Batch, Operation, and Phase levels. EBR processing data include start, end, and steps carried out throughout the batch execution. Min and max parameter settings are only included if they differ from default values.

When an equipment phase is activated, the Electronic Batch Record (EBR) captures specific data regarding the Permissive Start status. According to the sources, both the "Permissive Start" state and the "Message" parameters must be recorded and displayed within the EBR.

Additionally, if the "Message" parameter is set by the PLC (field equipment), it serves a dual purpose: aside from being recorded in the EBR, it will also appear in the Message List and Batch Controller components, provided that display messages are enabled.

EBR records the current values of the parameters with time stamps and as the step parameter-values change, EBR records the changes with time stamps.

In MES 3.81.12 SP2, MES 4.83.1 SP2, and later, a running step is included as soon as the phase starts. The EBR records the initial value of each parameter on that step. Restart from Held and Resume from Paused do not record those initial values again. A later execution of the same step records a new set of initial values.

After a command reaches its final state, the EBR records Command as None. A blank State is shown as Unknown. A blank Command is shown as None. A blank recipe execution state is shown as Unknown.

When an e-Signature phase starts, the EBR includes Signature_Template, Signature_Expression, Complete, eSignature_Approved, eSignature_Rejected, and eSignature_Phase_Description.

When acknowledgement is not required, User Message steps omit Message_Ack_By and Message_Ack_Date_Time at the start of the step. Equipment, Synchronize, Transfer In, and Transfer Out steps omit Message_Ack_By, Message_Ack_Confirm, and Message_Ack_Date_Time at the start of the step. Those parameters are recorded when the operator acknowledges the message.

In the EBR Viewer, an integer whose absolute value is greater than 9007199254740991 is shown as text so the displayed digits stay exact.

Generating a EBR

You can generate two types of EBR:

An EBR for a Master Recipe EBR
An EBR for a Batch (this is a recipe that has been executed) called Control Recipe EBR.

In MES 3.81.11 SP12 and later, set dateTimeFormat to control the date-time strings shown in the EBR. The default is yyyy-MM-dd HH:mm:ss.SSS.

For properties and reference information, see Batch EBR Viewer Component.

Viewing EBR

EBR	Batch Recipe


Drill down to see the parameter values and changes that occurred during batch execution.

Specifying a BatchID or a RecipeName for EBR

EBR Viewer component provides design-time properties that include the BatchID and RecipeName parameters.

For a Recipe set RecipeName
For a Batch (this is a recipe that has been executed) set BatchID.

In MES 3.81.11 SP12 and later, set dateTimeFormat to control the date-time strings shown in the EBR. The default is yyyy-MM-dd HH:mm:ss.SSS. See Batch EBR Viewer Component.

You can set those in Ignition Designer and view the EBR output. See those below under EBR Viewer Component Properties.

For usability during run-time for the end-user to select a batch, use Ignition Expression Binding with a dropdown menu using the batch queue scripting functions.

Below is an example of binding a dropdown to get the last 20 batches that have executed in the batch queue.

Binding EBR Viewer to a Dropdown Menu

Scripting function queue.getEntryLinks() is available in versions:

3.81.5 SP5 Stable and later

3.81.6 RC2 Release Candidate and later

This script bound to a dropdown menu provides the ability to select a batch for EBR on a Perspective View during runtime.

Copy Code

Python

def transform(self, value, quality, timestamp):
	"""
	Transform the incoming value and return a result.

	Arguments:
		self: A reference to the component this binding is configured on.
		value: The incoming value from the binding or the previous transform.
		quality: The quality code of the incoming value.
		timestamp: The timestamp of the incoming value as a java.util.Date
	"""
	list = system.mes.batch.queue.getEntryLinks(1, 20, None)
	finalList = []
	for i in range(len(list)):
		#finalList.append({'value':list[i],'label':list[i]})
		batchID = list[i].getMESObject().getBatchID()
		finalList.append({'value':batchID,'label':batchID})
	return finalList

Adding EBR Viewer in Ignition Designer

You must have the Batch Procedure module installed.

In Ignition Designer, with a Perspective View active in the Project Browser, go to the Perspective Component Palette and add the EBR Viewer component to the design space.

Generating a PDF

When you open an EBR, you can download as a PDF.