11 OPC UA DataTypes

11.1 MaterialPointType Structure

The MaterialPointType structure provides the description of the capability of a material point.

The MaterialPointType structure is defined in the following table.

Table 192 – MaterialPointType Structure
NameTypeDescriptionOther
MaterialPointTypeStructureSubtype of Structure defined in OPC 10000-5M

ID

0:StringUnique identifier for the material point type.M

Description

0:LocalizedTextDescription of the material point type.M

MaterialCapability

MaterialDefinitionType[]The complete set of material definitions that the material point can process.M

ConnectedMaterialPoint

0:ExpandedNodeIdThe identifier for the node id of the connected material point. The connected material point may be exposed by a different OPC UA server.M

PropagatesProductionOrder

0:Boolean

The material point propagates the production order with the ConnectedMaterialPoint.

If the material point is a MaterialLoadingPointType, and PropagatesProductionOrder is True, then the material point receives a production order from the upstream ConnectedMaterialPoint.

If the material point is a MaterialOutputPointType, and PropagatesProductionOrder is True, then the material point sends a production order to the downstream ConnectedMaterialPoint.

If the material point is a MaterialRejectionPointType, and PropagatesProductionOrder is True, then the material point sends a production order to the downstream ConnectedMaterialPoint. This variable is defined by the end user and entered by the developer of the TMC server invoking the SetNewSpecification method.

M

11.2 MaterialStorageBufferDataType Structure

The MaterialStorageBufferDataType structure provides the description of the capability of a material storage buffer.

The MaterialStorageBufferDataType structure is defined in the following table.

Table 193 – MaterialStorageBufferDataType Structure
NameTypeDescriptionOther
MaterialStorageBufferDataTypeStructureSubtype of Structure defined in OPC 10000-5M

ID

0:StringUnique identifier for the material storage buffer.M

StoredMaterial

MaterialDefinitionTypeThe material definition for material that is stored in the material storage buffer.M

EngineeringUnits

0:EUInformationThe unit of measure for the material stored in the buffer.M

TotalStorageCapacity

0:DoubleThe total capacity of the material storage buffer.M

StorageLogic

StorageLogicEnumerationThe logic by which product is loaded and unloaded from the material storage buffer.M

MixingLogic

StorageMixingLogicEnumerationHow different materials loaded into the material storage buffer mix.M

11.3 MaterialDefinitionType Structure

The MaterialDefinitionType structure contains the definition of a material. It is harmonised with ISA 95 Material Definition.

The MaterialDefinitionType structure is defined in the following table.

Table 194 – MaterialDefinitionType Structure
NameTypeDescriptionOther
MaterialDefinitionTypeStructureSubtype of Structure defined in OPC 10000-5M

ID

0:StringUnique identifier for the material definition.M

MES_ID

0:StringUnique identifier for the material definition in an external system, e.g. MES.M

Description

0:LocalizedTextDescription of the material definition.M

BaseUnitOfMeasure

0:EUInformationThe base unit of measure for the material definition.M

BatchManaged

0:BooleanIf BatchManaged is True, the material lots of this material definition require a unique identification, often called BatchID. The material lots are also called batches in some contexts.M

GroupID

0:StringThe material group the material definition belongs to.O

ParentGroupID

0:StringThe parent group of the material group the material definition belongs to.O

ShelfLife

0:UInt32The number of days of usable life for the material definition. The usable life is counted from the production date.O

Properties

DataValueType[]An array containing additional properties that can be additionally required for the material definition.O

11.4 MaterialLotType Structure

The MaterialLotType structure contains the material lot information. It is harmonised with ISA 95 Material Lot.

The MaterialLotType structure is defined in the following table.

Table 195 – MaterialLotType Structure
NameTypeDescriptionOther
MaterialLotTypeStructureSubtype of Structure defined in OPC 10000-5M
ID0:StringUnique identifier for the material lot in the underlying system.M
MES_ID0:StringThe unique identifier for the material lot in higher level systems. In some production contexts the material lot is called a batch. When the material definition is batch managed, the MES_ID is mandatory and often named BatchID.M
Description0:LocalizedTextDescription of the material lot.M
MaterialDefinitionMaterialDefinitionTypeThe material definition of the material lot.M
StatusMaterialStockStatusEnumerationThe stock status of the material lot.M
ProductionDate0:UtcTimeThe date and time when the material lot was produced.M
BestUsedBeforeDate0:UtcTimeThe last date the material lot can be used. It is computed adding the material definition shelf life to the production date.O
PropertiesDataValueType[]An array containing additional properties that can be additionally required for the material lot,.O

11.5 MaterialSublotType Structure

The MaterialSublotType structure contains the material sublot information. It is harmonised with ISA 95 Material Sublot.

The MaterialSublotType structure is defined in the following table.

Table 196 – MaterialSublotType Structure
NameTypeDescriptionOther
MaterialSublotTypeStructureSubtype of Structure defined in OPC 10000-5M
ID0:StringUnique identifier for the material sublot in the underlying system.M
MES_ID0:StringThe unique identifier for the material sublot in higher level systems.M
MaterialLotMaterialLotTypeThe material lot the sublot belongs to.M
MaterialStorageLocationID0:StringUnique identifier for the location where the material is produced/stored.M
Quantity0:DoubleThe quantity of the sublot in the base unit of measure defined in the MaterialDefinition.M
CarrierID0:StringThe ID of the carrier holding the sublot, for example the bobbin core fitted with an RFID. If the sublot is not contained in any carrier, then the CarrierID is NULL.O
RelativePositionID0:StringThe unique identifier of the relative position of the sublot in the carrier identified by CarrierID. If CarrierID is NULL, then the string is empty.O
ParentSublotID0:StringThe parent sublot ID is the unique identifier of the material sublot that contains the sublot structure in question. If the sublot is not contained in any sublot, then the ParentSublotID is NULL.O
SublotsMaterialSublotType[]The material sublots contained in the material sublot in question.O

11.6 MaterialStockStatusEnumeration

The MaterialStockStatusEnumeration provides the stock status for a material lot.

The MaterialStockStatusEnumeration is defined in the following table.

Table 197 – MaterialStockStatusEnumeration Items
NameValueDescription
Unrestricted0The parameter depends solely from the machine and does not vary with the brand.
QualityInspection1The parameter depends solely from the brand being produced and does not vary with the machine.
Blocked2The parameter depends both from the machine and the brand being produced.

Its representation in the AddressSpace is defined in the following table.

Table 198 – MaterialStockStatusEnumeration Definition
Attribute Value
BrowseNameMaterialStockStatusEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
0:HasPropertyVariable0:EnumValues0: EnumValueType []0:PropertyType

11.7 ParameterDependencyEnumeration

The ParameterDependencyEnumeration contains what a parameter is depending upon.

The ParameterDependencyEnumeration is defined in the following table.

Table 199 – ParameterDependencyEnumeration Items
NameValueDescription
Machine0The parameter depends solely from the machine and does not vary with the brand.
Brand1The parameter depends solely from the brand being produced and does not vary with the machine.
Machine and Brand2The parameter depends both from the machine and the brand being produced.

Its representation in the AddressSpace is defined in the following table.

Table 200 – ParameterDependencyEnumeration Definition
Attribute Value
BrowseNameParameterDependencyEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
0:HasPropertyVariable0:EnumValues0: EnumValueType []0:PropertyType

11.8 ControlModeEnumeration

The ControlModeEnumeration contains the PackML modes of operation of a machine.

The ControlModeEnumeration is defined in the following table.

Table 201 – ControlModeEnumeration Items
NameValueDescription
OTHER0This state is used if no other state below applies.
PRODUCTION1Primary Mode used for all production activities, All PackML model states will be utilized. The unit/machine executes relevant logic in response to commands which are mainly coming from External Systems, or entered directly by the operator.
MAINTENANCE2Used for routine preventive Maintenance or planned maintenance. Shall be utilized to document planned maintenance occurrence and duration. This mode allows authorized personnel to run the unit/machine independent of other systems. This mode would typically be used for fault finding, machine trials, or testing operational improvements. For example: The cleaning of a print head is maintenance.
MANUAL3Used for fault diagnosis of unplanned technical intervention.
CHANGE OVER4Used specifically for format or recipe change over, includes “cleaning” operations.
CLEAN5Used for Routine Cleaning requirements example: as specified by factory maintenance procedures.
SET UP6Used for set up or adjustments example: mechanical adjustments and testing.
EMPTY OUT7Used to empty out machine example: end of a block of shifts prior to factory weekend shut down, empty out resident product within the machine that could be sent to finished product and minimize part finished “rework”.
REMOTE SERVICE8Used when the machine is serviced remotely, which is a form of remote maintenance. Remark. The Remote Service mode fulfil the safety requirements of the harmonized norm EN415-10:2011 (Safety of packaging machines).

Its representation in the AddressSpace is defined in the following table.

Table 202 – ControlModeEnumeration Definition
Attribute Value
BrowseNameControlModeEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
0:HasPropertyVariable0:EnumValues0: EnumValueType []0:PropertyType

11.9 StateEnumeration

The StateEnumeration contains the PackML states for a machine.

The underlying system will support the states that are required by the state machine.

The StateEnumeration is defined in the following table.

Table 203 – StateEnumeration Items
NameValueDescription
Stopped0The state of the machine module is stopped.
Resetting1The state of the machine module is resetting.
Idle2The state of the machine module is idle.
Starting3The state of the machine module is starting.
Execute4The state of the machine module is execute.
Completing5The state of the machine module is completing.
Complete6The state of the machine module is complete.
Aborting7The state of the machine module is aborting.
Aborted8The state of the machine module is aborted.
Stopping9The state of the machine module is stopping.
Clearing10The state of the machine module is clearing.
Suspending11The state of the machine module is suspending.
Suspended12The state of the machine module is suspended.
Unsuspending13The state of the machine module is unsuspending.
Holding14The state of the machine module is holding.
Held15The state of the machine module is held.
Unholding16The state of the machine module is unholding.

Its representation in the AddressSpace is defined in the following table.

Table 204 – StateEnumeration Definition
Attribute Value
BrowseNameStateEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
0:HasPropertyVariable0:EnumValues0: EnumValueType []0:PropertyType

11.10 ProductionStatusEnumeration

The ProductionStatusEnumeration contains the production state of a machine module.

The ProductionStatusEnumeration is defined in the following table.

Table 205 – ProductionStatusEnumeration Items
NameValueDescription
Other0None of the states below.
BrandChange1No production order is running, but some materials are being removed in preparation for a different brand.
Production2A production order is being produced.
NoProduction3No production order is running and no activity to remove materials is ongoing.

Its representation in the AddressSpace is defined in the following table.

Table 206 – ProductionStatusEnumeration Definition
Attribute Value
BrowseNameProductionStatusEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
0:HasPropertyVariable0:EnumValues0: EnumValueType []0:PropertyType

11.11 MotorDirectionEnumeration

The MotorDirectionEnumeration provides the rotation direction of a motor.

The MotorDirectionEnumeration is defined in the following table.

Table 207 – MotorDirectionEnumeration Items
NameValueDescription
Clockwise0The motor runs clockwise when energised.
CounterClockwise1The motor runs counter-clockwise when energised.

Its representation in the AddressSpace is defined in the following table.

Table 208 – MotorDirectionEnumeration Definition
Attribute Value
BrowseNameMotorDirectionEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
0:HasPropertyVariable0:EnumValues0: EnumValueType []0:PropertyType

11.12 StorageLogicEnumeration

The StorageLogicEnumeration describes standard loading and unloading material configurations.

The StorageLogicEnumeration is defined in the following table.

Table 209 – StorageLogicEnumeration Items
NameValueDescription
Other0None of the below options.
FIFO1First-In, First-Out.
LIFO2Last-In, First-Out.
FEFO3First-Expired, First-Out.

Its representation in the AddressSpace is defined in the following table.

Table 210 – StorageLogicEnumeration Definition
Attribute Value
BrowseNameStorageLogicEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
0:HasPropertyVariable0:EnumValues0: EnumValueType []0:PropertyType

11.13 StorageMixingLogicEnumeration

The StorageMixingLogicEnumeration describes standard ways of mixing material in a material storage buffer.

The StorageMixingLogicEnumeration is defined in the following table.

Table 211 – StorageMixingLogicEnumeration Items
NameValueDescription
Mixing0The material storage buffer containing a material accepts any other material.
NonMixingByProduct1The material storage buffer containing a material accepts other materials with the same MaterialDefinition.
NonMixingByBatch2The material storage buffer containing a material accepts other materials with the same MaterialLot.

Its representation in the AddressSpace is defined in the following table.

Table 212 – StorageMixingLogicEnumeration Definition
Attribute Value
BrowseNameStorageMixingLogicEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
0:HasPropertyVariable0:EnumValues0: EnumValueType []0:PropertyType

11.14 MaterialValidationStatusEnumeration

The MaterialValidationStatusEnumeration describes the status of the material validation process.

The MaterialValidationStatusEnumeration is defined in the following table.

Table 213 – MaterialValidationStatusEnumeration Items
NameValueDescription
None0No validation process status known.
Waiting1A material has been presented and not validation status is communicated by the material integrity agent.
Passed2The presented material is validated.
Failed3The presented material did not pass the validation.

Its representation in the AddressSpace is defined in the following table.

Table 214 – MaterialValidationStatusEnumeration Definition
Attribute Value
BrowseNameMaterialValidationStatusEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
0:HasPropertyVariable0:EnumValues0: EnumValueType []0:PropertyType

11.15 DataDescriptionType Structure

The DataDescriptionType structure contains a metadata, i.e. a description.

The DataDescriptionType structure is defined in the following table.

Table 215 – DataDescriptionType Structure
NameTypeDescriptionOther
DataDescriptionTypestructureSubtype of Structure defined in OPC 10000-5

ID

0:StringUnique identifier for the metadata description.M

MES_ID

0:StringUnique identifier for the metadata description in an external system, e.g. MES.M

Description

0:LocalizedTextThe metadata description.M

11.16 DataDefinitionType Structure

The DataDefinitionType structure contains the metadata that describes a parameter.

The DataDefinitionType structure is defined in the following table.

Table 216 – DataDefinitionType Structure
NameTypeDescription
DataDefinitionTypestructureSubtype of DataDescriptionType. See above.

EngineeringUnits

0:EUInformationUnit of measure for the parameter.

DisplayFormat

0:StringDisplay format for visualization. The same display format shall be used in the HMI.

Dependency

ParameterDependencyEnumerationThe dependency of the parameter with respect to machine and brand.

DataType

0:StringDescribes the data type of the data point, e.g. FLOAT, INT, STRING, etc.

UserSubset

0:BooleanUsed by the user to identify a subset of the dataset that is of interest.

ControlRange

0:RangeThe range where the parameter actual values is considered in control.

AlarmRange

0:RangeOutside this range, the underlying system generates an alarm for the parameter.

11.17 DataValueType Structure

The DataValueType structure contains a data value.

The DataValueType structure is defined in the following table.

Table 217 – DataValueType Structure
NameTypeDescription
DataValueTypeStructureSubtype of DataDescriptionType. See above.
Value0:BaseDataTypeThe value of the data.
EngineeringUnits0:EUInformationThe unit of measure of the value.

11.18 DataSetDefinitionType Structure

The DataSetDefinitionType structure contains the description and other necessary metadata of the complete set of machine settings required for production.

The DataSetDefinitionType structure is defined in the following table.

Table 218 – DataSetDefinitionType Structure
NameTypeDescription
DataSetDefinitionTypeStructureSubtype of Structure defined in OPC 10000-5
ID0:StringUnique identifier for the whole data set list.
Description0:LocalizedTextPlain English description of the whole data set list.
DefinitionsDataDefinitionType[]An array containing the definition of each data point belonging to the data set.

11.19 DataSetEntryType Structure

The DataSetEntryType structure contains the value of a single parameter, or data value.

The DatasSetEntryType structure is defined in the following table.

Table 219 – DataSetEntryType Structure
NameTypeDescription
DataSetEntryTypeStructureSubtype of Structure defined in OPC 10000-5
ID0:StringUnique identifier for the parameter value, or data value.
Value0:BaseDataTypeThe value of the parameter.

11.20 DataSetType Structure

The DataSetType structure contains a set of data values.

The DataSetType structure is defined in the following table.

Table 220 – DataSetType Structure
NameTypeDescription
DataSetTypeStructureSubtype of Structure defined in OPC 10000-5

ID

0:StringThe unique Id of the dataset.

Description

0:LocalizedTextThe human-readable description of the dataset.

Values

DataSetEntryType[]List of data values.

11.21 MaterialListItemType Structure

The MaterialListItemType structure contains a single material to be processed.

The MaterialListItemType structure is defined in the following table.

Table 221 – MaterialListItemType Structure
NameTypeDescription
MaterialListItemTypeStructureSubtype of Structure defined in OPC 10000-5

AssemblyID

0:StringUnique identifier for the material list item.

MaterialPointID

0:StringThe identifier of the material point where the material will be processed.

MaterialPointMES_ID

0:StringThe higher level system identifier of the of the material point where the material will be processed.

MaterialSublot

MaterialSublotType The material sublot to be used.

MaterialStockStatus

MaterialStockStatusEnumerationThe requested stock status for the material sublot.

FollowUpMaterials

MaterialSublotType[]A list of differently-coded materials that can be used alternatively, e.g. when switching to a different supplier.

11.22 MaterialListType Structure

The MaterialListType structure contains a set of material list items.

The MaterialListType structure is defined in the following table.

Table 222 – MaterialListType Structure
NameTypeDescription
MaterialListTypestructureSubtype of Structure defined in OPC 10000-5

ID

0:StringThe unique identifier of the material list.

Description

0:LocalizedTextThe human-readable description of the material list.

Items

MaterialListItemType[]List of material list items.

11.23 ProductionOrderHeaderType Structure

The ProductionOrderHeaderType structure contains the header information for a production order.

The ProductionOrderHeaderType structure is defined in the following table.

Table 223 – ProductionOrderHeaderType Structure
NameTypeDescription
ProductionOrderHeaderTypestructureSubtype of Structure defined in OPC 10000-5

Number

0:StringThe production order number.

ProducedMaterial

MaterialDefinitionTypeThe finished good that the material is produced by the production order.

TargetQuantity

0:DoubleThe quantity of ProducedMaterial that is requested by the production order.

ContinueAtJobEnd

0:BooleanWhen ContinueAtJobEnd is True, then the operator may continue production (overproduction) after fulfilling the required TargetQuantity.

TargetStartTime

0:UtcTimeThe planned start date and time.

TargetEndTime

0:UtcTimeThe planned end date and time.

DataSetID

0:StringThe identifier of the dataset to be used for the production order, when the dataset is late-bound. The DataSetID will be NULL when the dataset is not late-bound.

DataSetDescription

0:LocalizedTextThe description of the dataset.

MaterialListID

0:StringThe identifier of the material list to be used for the production order, when the material list is late-bound. The DataSetID will be NULL when the dataset is not late-bound.

MaterialListDescription

0:LocalizedTextThe description of the material list.

11.24 ProductionOrderType Structure

The ProductionOrderType structure contains the complete production order information.

The ProductionOrderType structure is defined in the following table.

Table 224 – ProductionOrderType Structure
NameTypeDescription
ProductionOrderTypestructureSubtype of Structure defined in OPC 10000-5

Header

ProductionOrderHeaderTypeThe header of the production order.

MaterialList

MaterialListTypeThe material list for the production order.

DataSet

DataSetTypeThe dataset for the production order.

11.25 OrchestrationProductionOrderType Structure

The OrchestrationProductionOrderType structure contains the complete production order information used by the Production Order Orchestration Layer.

The OrchestrationProductionOrderType structure is defined in the following table.

Table 225 – OrchestrationProductionOrderType Structure
NameTypeDescription
OrchestrationProductionOrderTypestructureSubtype of ProductionOrderType.
ActiveMachineModules0:String[]The list of machine modules required for processing the production order.

11.26 RootCauseMessageType Structure

The RootCauseMessageType structure contains a root cause message and its group identifier.

The RootCauseMessageType structure is defined in the following table.

Table 226 – RootCauseMessageType Structure
NameTypeDescription
RootCauseMessageTypeStructureSubtype of MessageType defined in OPC 10000-5

GroupID

0:StringGroupID identifies uniquely each group of root causes which are grouped in families, e.g. electrical, mechanical, controls, etc.

11.27 RootCauseGroupType Structure

The RootCauseGroupType structure contains a root cause message and its group identifier.

The RootCauseGropType structure is defined in the following table.

Table 227 – RootCauseGroupType Structure
NameTypeDescription
RootCauseGroupTypeStructureSubtype of Structure defined in OPC 10000-5

ID

0:StringUnique identifier for the root cause group.

ParentID

0:StringThe ID of the group containing the root cause group identified by Id. By means of the ParentID, multiple nested groups are allowed.

Description

0:LocalizedTextThe human-readable description of the root cause group identified by the unique identifier.

11.28 MessageType Structure

The MessageType provides a uniquely identified localised text.

The MessageType structure is defined in the following table.

Table 228 – MessageType Structure
NameTypeDescription
MessageTypeStructureSubtype of Structure defined in OPC 10000-5

ID

0:StringUnique identifier for the localised text.

LocalText

0:LocalizedTextThe localized text.

11.29 MethodExecutionFeedbackType Structure

The MethodExecutionFeedbackType provides suitable feedback, both positive and negative, to an OPC UA client invoking a method.

The MethodExecutionFeedbackType structure is defined in the following table.

Table 229 – MethodExecutionFeedbackType Structure
NameTypeDescription
MethodExecutionFeedbackTypeStructureSubtype of Structure defined in OPC 10000-5

Success

0:BooleanReturns True in case of successful execution.

Message

MessageType[]Array of detailed messages describing the reason for the unsuccessful execution or notice to the user.

11.30 MaterialIntegrityAgentEnumeration

The MaterialIntegrityAgentEnumeration identifies the possible agents responsible for material integrity checking.

The MaterialIntegrityAgentEnumeration is defined in the following table.

Table 230 – MaterialIntegrityAgentEnumeration Items
NameValueDescription
None0The material validation is not requested.
Local1The underlying system performs the material validation.
External2An external system performs the material validation.

Its representation in the AddressSpace is defined in the following table.

Table 231 – MaterialIntegrityAgentEnumeration Definition
Attribute Value
BrowseNameMaterialIntegrityAgentEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
0:HasPropertyVariable0:EnumValues0: EnumValueType []0:PropertyType

11.31 CommandEnumeration

The CommandEnumeration provides standardized commands that can be sent to a state machine.

The CommandEnumeration is defined in the following table.

Table 232 – CommandEnumeration Items
NameValueDescription
Abort0The Abort command.
Start1The Start command.
Stop2The Stop command.
Reset3The Reset command.
Hold4The Hold command.
Unhold5The Unhold command.
Clear6The Clear command.
Suspend7The Suspend command.
Unsuspend8The Unsuspend command.

Its representation in the AddressSpace is defined in the following table.

Table 233 – CommandEnumeration Definition
Attribute Value
BrowseNameCommandEnumeration
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the Enumeration type defined in OPC 10000-5
0:HasPropertyVariable0:EnumValues0: EnumValueType []0:PropertyType