Batch EBR Viewer Component

Sepasoft MES Module Suite

EBR Viewer Component Reference

Installed with the Batch Procedure module.

Find this component under the Ignition Designer Perspective Component Palette, named EBR Viewer

For user information, see Using Batch Procedure EBR Viewer.

Component Properties

META Properties

Name

ebrViewer

Properties

Available in 3.81.11 RC and later

The following components have a user property field:

Batch List
Message List
Batch Controller
Document Viewer
Batch Monitor
Formula Manager

These components record user actions in the EBR recording the component's actions, including setting parameter values, setting logic mode, issuing recipe commands, issuing step commands, forcing step completion, manually executing steps, and skipping transitions.

In version 3.81.11 SP10 and later:

EBR includes a ChangedBy column, see an example Sample Batch EBR PDF.

Available in 3.81.11 RC and later | Calculated Parameter Values

MES-6613: Updated calculated expression logic to only record new calculated values to the EBR when the step is in Running state. The parameter itself on the object will continue to be updated with the calculated values as they occur.

batchID

You must specify either a recipe or a batch. When you execute a recipe, it is then referred to as a 'Batch'.

batchID: Control Recipe/Batch EBR
recipeName: Master Recipe EBR

If you add values to both properties, then the batchID is used.

recipeName

dateTimeFormat

String

Optional. Format used for every date-time string in the EBR, including step titles, details, parameter values, and minimum and maximum dates. Added in MES 3.81.11 SP12. Default is yyyy-MM-dd HH:mm:ss.SSS. Leave blank to use that default. An invalid pattern shows an error when the EBR is loaded. Examples: yyyy-MM-dd HH:mm:ss, EEE, MMM d, yyyy h:mm a z, yyyy.MM.dd G 'at' HH:mm:ss z, YYYY-'W'ww-u.

procedure

Defines what is shown in the EBR at the highest level in a recipe hierarchy, called the Procedure level.

Keep in mind the step hierarchy when setting properties. The 'steps' property scope is defined by its level in this hierarchy.

Valid Step Hierarchy:

Recipe Procedure Level > Phase
Recipe Procedure Level > Unit Procedure > Phase
Recipe Procedure Level > Unit Procedure > Operation > Phase

title

Any batch procedure-level parameter and data items in the EBR can be referenced and displayed as value in the title property.

To view all the data items in an EBR, see sample script queue.getBatchEBR and Print to JSON.

String

For Example:

Property Value	Description
'{LogicType} - {Recipe_Name}'	Adds the name of the user-defined recipe name.
'{LogicType} - {Batch_ID}'	Adds the batchID to the title of the EBR.
'{Formula_Name}'	Adds the Formula Name to the title of the EBR.

Do not reference data items with the 'array' data type . This data type is not allowed in the title reference and will produce an error.

details

show Boolean True/False. When set to True, the EBR displays the details you list under the items property.

items

List Array

Mapping of parameters to include in the EBR at the Procedure level (this is the top-level, also called recipe). The syntax is '<label in EBR>: {recipe parameters}'

Version Specific

In MES 3.81.8 SP6 and later, detail and title strings can use {first(ParamName)} and {last(ParamName)}. In MES 3.81.13 SP2, MES 4.83.3 SP2, and later, those tokens use the first or last non-empty value. See Detail item parameter tokens.

parameters

Referring to the Valid Step Hierarchy above, you can reference properties in a Unit Procedure or Phase at the top Procedure recipe level.

In the output EBR, you can sort parameter by clicking on the column headers. By default, the Parameter tables are sorted by the Timestamp column.

show

Boolean

True/False. When set to True, the EBR includes the parameter section of the report.

title String Title for parameter section.

includesystemParameters Boolean When set to True, EBR includes the parameters at the Procedure recipe level.

includeNameFilter

List Array

List the parameters to include in the EBR. You can use wildcards in the expression:

'*' and '?'

['*_Date_Time']

excludeNameFilter

List Array

Exclude the parameters in the EBR. You can use wildcards in the expression:

'*' and '?'

['*_Date_Time']

steps Referring to the Valid Step Hierarchy above, this could include Unit Procedures or Phases at the top Procedure recipe level.

show Boolean True/False. When set to True, the EBR displays the details defined within this section.

title String Title for parameter section.

includeIdleSteps Boolean True/False. When set to True, the EBR displays the steps that are in the Idle state and have not run. Only for Control Recipe EBR (i.e., Batches)

includeNameFilter

List Array

List the steps to include in the EBR. You can use wildcards in the expression:

'*' and '?'

['*_Date_Time']

excludeNameFilter

List Array

Exclude the parameters in the EBR. You can use wildcards in the expression:

'*' and '?'

['*_Date_Time']

step

Referring to the Valid Step Hierarchy above, this could include Operations or Phases under a Unit Procedure.

title

Sets the Title syntax of the Step panel in the EBR.

String

Use curly braces to reference data items.

In this example the Step can reference a unit procedure or a phase. Then the Phase references any phases under the step.

'{Step} - {Phase}'

details

show Boolean True/False. When set to True, the EBR displays the details defined within this section.

items

List Array

Mapping of parameters to include in the EBR at the step level (this could be a Unit Procedure, Operation and Phase). The syntax is '<label in EBR>: {recipe parameters}'

Version Specific

parameters In the output EBR, you can sort parameter by clicking on the column headers. By default, the Parameter tables are sorted by the Timestamp column.

show Boolean True/False. When set to True, the EBR displays the details defined within this section.

title String Title for parameter section.

includeSystemParameters Boolean True/False. When set to True, the EBR displays the system parameters identified under includeNameFilter below.

includeNameFilter

List Array

List the steps to include in the EBR. You can use wildcards in the expression:

'*' and '?'

['*_Date_Time']

excludeNameFilter

List Array

Exclude the parameters in the EBR. You can use wildcards in the expression:

'*' and '?'

['*_Date_Time']

steps Referring to the Valid Step Hierarchy above, this could include Unit Procedures or Phases.

show Boolean True/False. When set to True, the EBR displays the details defined within this section.

title String Title for steps section.

includeIdleSteps Boolean True/False. When set to True, the EBR displays the steps that are in the Idle state and have not run. Only for Control Recipe EBR (i.e., Batches)

includeNameFilter

List Array

List the steps to include in the EBR. You can use wildcards in the expression:

'*' and '?'

['*_Date_Time']

excludeNameFilter

List Array

Exclude the parameters in the EBR. You can use wildcards in the expression:

'*' and '?'

['*_Date_Time']

Use the properties below to customize the styling of an EBR.

Detail item parameter tokens

These tokens work in procedure.title, procedure.details.items, step.title, and step.details.items.

Token	Value shown
`{ParamName}`	Last non-empty value. `{Begin_Date_Time}` is the exception: it uses the first non-empty value, the same as `{first(Begin_Date_Time)}`.
`{first(ParamName)}`	First non-empty value, by time.
`{last(ParamName)}`	Last non-empty value, by time.

A null or blank history value is skipped. Example: Began At: {first(Begin_Date_Time)}.

A phase can record empty parameter values when it starts. first() and last() skip those rows, so Began At shows the real begin time when one exists later in history.

If a date or time parameter has only empty history, the detail shows No date/time found. A non-date parameter does not use that message. The label is followed by a blank value.

Default procedure details:

Batch ID: {Batch_ID}
Batch Name: {Batch_Name}
Began: {first(Begin_Date_Time)}
Ended: {End_Date_Time}

Default step details:

Began At: {first(Begin_Date_Time)}
Ended At: {End_Date_Time}
Execute Count: {Execute_Count}

Property	Description
`style`	Style for the EBR Viewer window.
`panelStyle`	Style for the body of each procedure and step panel, including the details block under the title.
`panelTitleStyle`	Style for the collapsible title bar of each panel. `color` or `fill` also sets the expand icon color.
`tableStyle`	Style for the body cells of the parameter tables. The printed EBR uses the same style.
`tableHeaderStyle`	Style for the header cells of the parameter tables, such as Name, Value, and Changed By. The printed EBR uses the same style.
`toolbarStyle`	Style for the toolbar that contains Export and Print. The toolbar height stays 48 pixels.
`tooltipStyle`	Style for the Export and Print tooltips.

tooltipStyle is the property that has the extra fields at the bottom of that table. Fill those as:

Field	Description
`classes`	Perspective style class for the tooltip.
`backgroundColor`	Tooltip background. Default is `rgba(97, 97, 97, 0.9)`.
`color`	Tooltip text color. Default is `#FFFFFF`.
`fontSize`	Tooltip text size. Default is `12px`.

Sepasoft MES Module Suite