Equipment Phase Definition

Batch Tracker objects are aware of individual Equipment Phases within an operation. These phases can be configured in the Equipment Phases Definition object.

Use Cases

configuration of individual Equipment Phases for Batch Trackers

Quick Configuration

In the I/O Model, select the Batch Operation Definition object and right-click. Select Admin New Production Tracking Equipment Phase Definition from the context menu.
In the Create Object wizard, enter an Object name and click Create
Select the newly created object in the I/O Model and look at the object properties panel.

General Configuration

Equipment Assignement Options
For each Equipment Phase, it is possible to define the equipment from the ISA-95 model, where this Equipment Phase is running on. Currently the fixed assignement shall be used to link the Equipment Phase to an Equipment. This equipment does not need to be related to the equipment defined within the scope of the BatchTracker
Phase Scope
The Phases Scope defines if this configuration shall be valid for all phases or for a dedicated equipment phase.
- Phase Mode
  - 'All Phases': This Equipment Phase Definition will be used for all Equipment Phases within the operation.
  - 'Distinct Phase': The phases to which this configuration shall be applied need to be specified.
    This can be done by either providing a Phase ID or a Phase Name. If either of them matches, the value of a Batch Data Characteristic with the related Target field, then the configuration is applied to this phase.
    The combination of Phase ID and Phase Name is additionally used a lookup table:
    If only the Phase ID or the Phase Name is available, then the other entry is added from the matching Phase Definition.
Batch Data
Here, additional Batch Characteristics, Events and Trends can be defined. These configurations only work within the scope of the given Equipment Phases. The entries of an Distinct Equipment Phase and an Equipment Phase with Phase scope 'All Phases' are combined to form the final configuration for that Equipment Phase.
- Batch Characteristics

Object Properties

Common

Object Name: The user-modifiable object name. This name overrides the name which has been supplied by the external system. It must be unique within the collection of objects of the parent object.

Object Description: This is the user-modifiable object description. This text overrides the description which has been supplied by the external system.

Attachments: File attachments stored in MongoDB file store.

Equipment Assignment Options

Compound to assign equipment modules.

Equipment Assignment Type

Select the type of equipment assignment.

Equipment Module Selection Options

Compound to define the assigned equipment module.

Equipment Module Selection: Equipment modules selection.

Equipment Module Mapping Options

Compound to define equipment module mappings.

Equipment Module Mapping: Assign equipment modules to equipment identifiers.

Phase Scope

Compound for phase scope settings.

Phase Mode

Selection of the batch phase mode.

Configuration: Configuration.

All Phases: All Phases.

Phase Parameters

Phase Parameters.

Phase ID: Phase ID.

Phase Name: Phase Name.

Batch Data

Compound for batch data.

Batch Characteristics

Compound for batch characteristics parameter.

Active: Sets the data collection of this batch field active.

Label: Defines the label for the characteristic.

EU Override: Optional field to override (or set) the engineering unit in case the configured input object does not supply the desired one.

Input: Defines the input object for the characteristic.

Target Field

Start Time: Start Time.
End Time: End Time.
Product Name: Product Name.
Product Eng. Unit: Product Eng. Unit.
Product Setpoint: Product Setpoint.
Product Actual: Product Actual.
Master Recipe Version: Master Recipe Version.
Educt Name: Educt Name.
Educt Eng. Unit: Educt Eng. Unit.
Educt Setpoint: Educt Setpoint.
Educt Actual: Educt Actual.
Product Code: Product Code.
Educt Code: Educt Code.
Control Recipe Name: Control Recipe Name.
Master Recipe Name: Master Recipe Name.
Batch ID: Batch ID.
Batch Number: Batch Number.
Recipe Type: Recipe Type.
Batch Status: Batch Status.
Material Type: Material Type.
Material Type Code: Material Type Code.
Unique Batch ID: Unique Batch ID.
Unit Name: Unit Name.
Unit Asset Code: Unit Asset Code.
Production Version: Production Version.
Equipment Active: Must return true or false in order to determine equipment active state.
Equipment State: Must return one of the standardized OMAC states for the equipment.
ERP Order: Must return the ERP order ident for the batch.
MES Batch ID: Must return the MES Batch ID in case different than the equipment batch ident.
Batch ERP Order Number: Batch ERP Order Number.
Batch ERP ID: Batch ERP ID.
Batch MES ID: Batch MES ID.
Batch Size: Batch Size.
Batch Size Eng. Unit: Batch Size Eng. Unit.
Campaign ID: Campaign ID.
Campaign MES ID: Campaign MES ID.
Campaign ERP ID: Campaign ERP ID.
Campaign ERP Order Number: Campaign ERP Order Number.
Campaign Size: Campaign Size.
Campaign Size Eng. Unit: Campaign Size Eng. Unit.
Shift Code: Shift Code.
Shift Name: Shift Name.
Custom Measurement: Custom Measurement.
Custom Timestamp: Custom Timestamp.
Custom State: Custom State.
Custom Quality: Custom Quality.
Sample Size: The amount of material taken for the sample.
Sample Type: The type of sample pulled. There are no standard codes defined. Examples: Receiving Sample, Online Sample, Lab Sample.
Sample Pull Reason: The reason the sample was pulled.
Sample Expiration: The date the sample expires.
Sample Physical Asset ID: A reference to a physical asset element that is associated with the sample.
Sample SOP Reference: The standard operating procedure (SOP) that is associated with the sample pull.
Sample Test: The tests on the sample.
Sample Test Code: The test procedure used.
Sample Test Name: The name associated with the test performed.
Sample Test Result: The result from a sample test.
Sample Test Disposition: An indication if the test results were acceptable. No standard identifiers defined. Example: Pass, Fail.
Sample Analysis Used: The statistical sampling analysis used to determine the result. No standard CodeType is defined. Example: Average, Minimum, Maximum.
Sample Test Result Expiration: The date and time that the sample test results expire.
Sample Result: The actual value or values returned from the test.
Sample Expected Results: The expected value or values returned from the test.
Sample Document: A JSON document according to B2MML.
Operation ID: Operation ID.
Operation Name: Operation Name.
Lot ID: Lot ID.
Material Definition ID: Material Definition ID.
Waste Actual: Waste Actual.
Waste Code: Waste Code.
Waste Eng. Unit: Waste Eng. Unit.
Waste Name: Waste Name.
Waste Setpoint: Waste Setpoint.
Reinsert Actual: Reinsert Actual.
Reinsert Code: Reinsert Code.
Reinsert Eng. Unit: Reinsert Eng. Unit.
Reinsert Name: Reinsert Name.
Reinsert Setpoint: Reinsert Setpoint.
Down-Time: Down-Time.
Down-Time Eng. Unit: Down-Time Eng. Unit.
BPR Extension Time: BPR Extension Time.
BPR Extension Time Eng. Unit: BPR Extension Time Eng. Unit.
BPR Extension Prohibited: BPR Extension Prohibited.
Annotation Prohibited: Annotation Prohibited.
Cleaning Actual: Cleaning Actual.
Cleaning Code: Cleaning Code.
Cleaning Eng. Unit: Cleaning Eng. Unit.
Cleaning Name: Cleaning Name.
Cleaning Setpoint: Cleaning Setpoint.
Down-Time Cause: Down-Time Cause.
Energy Consumption: Energy Consumption.
Energy Consumption Eng. Unit: Energy Consumption Eng. Unit.
Energy Consumption Limit: Energy Consumption Limit.
Energy Consumption Cost: Energy Consumption Cost.
Energy Consumption Cost Currency: Energy Consumption Cost Currency.
Batch Control ID: Batch Control ID.
Batch Source ID: Batch Source ID.
Batch System ID: Batch System ID.
Source Vendor: Source Vendor.
Source Product: Source Product.
Source Interface: Source Interface.
Source Datasource: Source Datasource.
Source Timestamp: Source Timestamp.
Scheduled Start Time: Scheduled Start Time.
Scheduled End Time: Scheduled End Time.
Source Batch Datasource: Source Batch Datasource.
Source Batch Area: Source Batch Area.
Source Timezone: Source Timezone.
Source Local Time: Source Local Time.
Record Type: S88 Record Type.
Unit Description: Batch Unit Description.
Runtime: The runtime of a distinct batch, procedure, operation etc.
Operation Sequence: Operation Sequence Number.
Operation Instance: Operation Instance Number.
Operator Name: Operator Name, responsible for Batch, Procedure, Operation etc.
Phase ID: Phase ID.
Phase Instance: Phase Instance Number.
Phase Name: Phase Name.
Phase Sequence: Phase Sequence Number.
Unit Procedure ID: Unit Procedure ID.
Unit Procedure Instance: Unit Procedure Instance Number.
Unit Procedure Name: Unit Procedure Name.
Unit Procedure Sequence: Unit Procedure Sequence Number.
Eventnumber: Eventnumber.
Eventtime: Eventtime.
Data Acquisition Type: Data Acquisition Type.
Acquisition Type: Specifies the acquisition type of the batch record. Can be one of 'Historical Data', 'Actual Data' and 'Real-Time Data'.
Blowout Datetime: Blowout Datetime.
Capping Start Datetime: Capping Start Datetime.
CIP Datetime: CIP Datetime.
Cleaning State: Cleaning State.
Control Recipe Expiration Datetime: Control Recipe Expiration Datetime.
Control Recipe Number: Control Recipe Number.
Control Recipe Version: Control Recipe Version.
Custom Mode: Custom Mode.
Filling End Datetime: Filling End Datetime.
Filling Start Datetime: Filling Start Datetime.
Format: Format.
MES Cleaning Order ID: MES Cleaning Order ID.
MES Order ID: MES Order ID.
Printer State: Printer State.
Product Count Bad: Product Count Bad.
Product Count Good: Product Count Good.
Product Actual: Product Actual.
Product Setpoint: Product Setpoint.
Product Weight: Product Weight.
Signature: Signature.
SIP Datetime: SIP Datetime.
SIP Temperature: SIP Temperature.
Speed Actual: Speed Actual.
Speed Setpoint: Speed Setpoint.
Stop Code: Stop Code.
Stop Downstream Cause: Stop Downstream Cause.
Stop Reason: Stop Reason.
Stop Upstream Cause: Stop Upstream Cause.
Unit: Unit.
Critical Process Parameter: Critical Process Parameter.
Critical Process Parameter (Aggregate): A Critical Process Parameter which has been aggregated based on a collected disting time series.
Equipment ID: Identifies an Equipment uniquely within a Procedure, Unit Procedure or Operation.
Equipment Name: Holds the Equipment Name used within a Procedure, Unit Procedure or Operation.
Equipment Phase ID: Identifies the current Equipment Phase.
Equipment Phase Instance: The instance number of the current Equipment Phase.
Equipment Phase Name: The textual name of the current Equipment Phase.
Equipment Phase Sequence Number: The sequence number of the current Equipment Phase.
Equipment Step ID: Identifies the current Equipment Step within the current Equipment Phase.
Equipment Step Name: The textual name of the current Equipment Step within the current Equipment Phase.
Equipment Step Instance: The instance number of the current Equipment Step within the current Equipment Phase.
Equipment Step Sequence Number: The sequence number of the current Equipment Step within the current Equipment Phase.
Equipment Phase Parallelism ID: The parallelism ID for a particular Equipment Phase within the current Recipe Phase or Operation. The ID identifies the Recipe "Swim Lane" this Equipment is associated with.
Yield: Yield.
Yield Count: Yield as count.
Yield Volume: Yield as volume.
Reject: Reject.
Reject Count: Reject Count.
Reject Volume: Reject Volume.
Duration: Duration.
Process Duration: Process Duration.
Holding Time: Holding Time.
Weight: Weight.
Length: Length.

Report Order: The order number for the Batch Report.

Batch Event Groups

Array compound for batch event data.

Active: Sets the data collection of this batch field active.

Name: The name of this group.

BPR Event Type

Alarm: Alarm.
Control Recipe: Control Recipe.
Equipment: Equipment.
General: General.
Material: Material.
Message: Message.
Operator: Operator.
Procedural Execution: Procedural Execution.
Other: Other.

Embedded: If this switch is set, this group is embedded.

Event Stream: The event stream from which events shall be filtered and assigned to the Batch Production Record.

Custom Filter: Custom Filter.

Batch Trend Groups

Array compound for batch trend data.

Active: Sets the data collection of this batch field active.

Name: The name of this group.

Embedded: If this switch is set, this group is embedded.

Batch Trend Pens: Definition of batch trend pens.

Custom Options

Compound to hold various structures to customize the object and to be read and written to by Lua-Script code or external interfaces.

Custom String: A generic string buffer to be used programmatically for custom purposes.

Custom Properties

This is an extensible set of named strings which can be used programmatically for custom purposes.

Property Name: A custom property name which can be used programmatically.

Property Value: The value of the custom property which can be read and written programmatically.

Custom Tables

This is an extensible set of named tables which can be used programmatically for custom purposes.

Table Name: A custom table name which can be used programmatically.

Table Data: Handles an entire table organized in columns and rows. The data can easily (cut, copy and paste) be exchanged with table-oriented data of other software products, e.g. MS Excel.