1 Scope

This document provides information-modelling concepts and object libraries that can be applied to model a complete production workcentre or line. It covers machine configurations, product flows, production, set-up, service, live status as well as historical information. It applies to primary and secondary production, including conventional and heat-not-burn products.

This document aims at harmonizing data exchange and interoperability requirements for the common benefit of both cigarette manufacturers and OEMs.

OPC Foundation

OPC is the interoperability standard for the secure and reliable exchange of data and information in the industrial automation space and in other industries. It is platform independent and ensures the seamless flow of information among devices from multiple vendors. The OPC Foundation is responsible for the development and maintenance of this standard.

OPC UA is a platform independent service-oriented architecture that integrates all the functionality of the individual OPC Classic specifications into one extensible framework. This multi-layered approach accomplishes the original design specification goals of:

Platform independence: from an embedded microcontroller to cloud-based infrastructure

Secure: encryption, authentication, authorization and auditing

Extensible: ability to add new features including transports without affecting existing applications

Comprehensive information modelling capabilities: for defining any model from simple to complex

TMC Working Group

The Tobacco Machine Communication (TMC) Working Group was formed to help secondary machine manufacturers design their machines to meet the harmonised requirements of its clients, both in terms of machine-to-machine communication and in terms of machine-to-manufacturing system communication.

At the time of writing the TMC Working Group consists of the following members:

British American Tobacco

Imperial Tobacco Group

JT International

Philip Morris International

2 Normative references

The following referenced documents are indispensable for the application of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments and errata) applies.

For OPC UA referenced documents, 1.04.7 is the minimum required version for the following OPC Unified Architecture parts.

OPC 10000-1, OPC Unified Architecture - Part 1: Overview and Concepts

OPC 10000-1

OPC 10000-2, OPC Unified Architecture - Part 2: Security Model

OPC 10000-2

OPC 10000-3, OPC Unified Architecture – Part 3: Address Space Model

OPC 10000-3

OPC 10000-4, OPC Unified Architecture - Part 4: Services

OPC 10000-4

OPC 10000-5, OPC Unified Architecture - Part 5: Information Model

OPC 10000-5

OPC 10000-6, OPC Unified Architecture - Part 6: Mappings

OPC 10000-6

OPC 10000-7, OPC Unified Architecture - Part 7: Profiles

OPC 10000-7

OPC 10000-8, OPC Unified Architecture - Part 8: Data Access

OPC 10000-8

OPC 10000-9, OPC Unified Architecture - Part 9: Alarms and Conditions

OPC 10000-9

OPC 10000-100, OPC Unified Architecture - Part 100: Devices

OPC 10000-100

OPC 30050, OPC Unified Architecture – Common Object Model: PackML

http://www.opcfoundation.org/UA/PackML

3 Terms, abbreviated terms and conventions

3.1 Overview

It is assumed that basic concepts of OPC UA information modelling are understood in this document. This document will use these concepts to describe the Tobacco Machine Communication Information Model. For the purposes of this document, the terms and definitions given in OPC 10000-1, OPC 10000-3, OPC 10000-4, OPC 10000-5, OPC 10000-7, OPC 10000-8, OPC 10000-16, OPC 10000-100, OPC 30050, as well as the following apply.

Additionally, the terms and definitions given in ISA 95 and ISA 88 apply.

Note that OPC UA terms and terms defined in this document are italicized in the document.

3.2 OPC UA for Tobacco Machine Communication terms

3.2.1 Untitled

A mechanical artifact that performs one or more elementary process steps in processing tobacco or manufacturing cigarettes, e.g. hopper, rod maker, etc.

3.2.2 Untitled

A set of machine modules connected to each other so that the finished product can be progressively assembled while materials flow through.

3.2.3 Untitled

An organisation that runs one or more workcentres to produce cigarettes.

3.2.4 Untitled

Original Equipment Manufacturer: a manufacturer of machine modules.

3.2.5 Untitled

A period of time when a Machine Module is not available for production, e.g. because of a malfunction.

3.2.6 Untitled

A message that is reported by the control system of a machine module when a malfunction occurs.

3.2.7 Untitled

The root cause that caused a malfunction and the consequent downtime.

3.2.8 Untitled

An automatic mode of operation for a machine module that reduces the energy consumption.

3.2.9 Untitled

A token of information that affects the operation of a machine module.

3.2.10 Untitled

The process that verifies that a machine module can operate under a certain set of parameters.

3.2.11 Untitled

The system that the OPC UA Server is interfacing to higher-level systems like SCADA, MES.

3.3 Abbreviated terms

ACAlarm and Condition
ANSIAmerican National Standards Institute
APIApplication Program Interface
DAData Access
DCSDistributed Control Systems
ERPEnterprise Resource Planning
HMIHuman-Machine Interface
HTTPHypertext Transfer Protocol
IECInternational Electrotechnical Commission
IPInternet Protocol - RFC 791
ISOInternational Organization for Standardization
LANLocal Area Network
MESManufacturing Execution System
MoMManufacturing Operation Management
NaN"Not a Number", a unique binary pattern representing an invalid number
(see ANSI/IEEE 754-1985)
NATNetwork Address Translation - RFC 2663
PLCProgramable Logical Controller
PMSProduction Management System
TCPTransmission Control Protocol
UAUnified Architecture
UMLUnified Modelling Language
URIUniform Resource Identifier
UTCUniversal Time Coordinated
XMLExtensible Markup Language

3.4 Conventions used in this document

3.4.1 Conventions for Node descriptions

3.4.1.1 Node definitions

Node definitions are specified using tables (see Table 2).

Attributes are defined by providing the Attribute name and a value, or a description of the value.

References are defined by providing the ReferenceType name, the BrowseName of the TargetNode and its NodeClass.

  • If the TargetNode is a component of the Node being defined in the table the Attributes of the composed Node are defined in the same row of the table.

  • The DataType is only specified for Variables; “[<number>]” indicates a single-dimensional array, for multi-dimensional arrays the expression is repeated for each dimension (e.g. [2][3] for a two-dimensional array). For all arrays the ArrayDimensions is set as identified by <number> values. If no <number> is set, the corresponding dimension is set to 0, indicating an unknown size. If no number is provided at all the ArrayDimensions can be omitted. If no brackets are provided, it identifies a scalar DataType and the ValueRank is set to the corresponding value (see OPC 10000-3). In addition, ArrayDimensions is set to null or is omitted. If it can be Any or ScalarOrOneDimension, the value is put into “{<value>}”, so either “{Any}” or “{ScalarOrOneDimension}” and the ValueRank is set to the corresponding value (see OPC 10000-3) and the ArrayDimensions is set to null or is omitted. Examples are given in Table 1.

Table 1 – Examples of DataTypes
Notation Data­Type Value­Rank Array­Dimensions Description
0:Int320:Int32-1omitted or nullA scalar Int32.
0:Int32[]0:Int321omitted or {0}Single-dimensional array of Int32 with an unknown size.
0:Int32[][]0:Int322omitted or {0,0}Two-dimensional array of Int32 with unknown sizes for both dimensions.
0:Int32[3][]0:Int322{3,0}Two-dimensional array of Int32 with a size of 3 for the first dimension and an unknown size for the second dimension.
0:Int32[5][3]0:Int322{5,3}Two-dimensional array of Int32 with a size of 5 for the first dimension and a size of 3 for the second dimension.
0:Int32{Any}0:Int32-2omitted or nullAn Int32 where it is unknown if it is scalar or array with any number of dimensions.
0:Int32{ScalarOrOneDimension}0:Int32-3omitted or nullAn Int32 where it is either a single-dimensional array or a scalar.
  • The TypeDefinition is specified for Objects and Variables.

  • The TypeDefinition column specifies a symbolic name for a NodeId, i.e. the specified Node points with a HasTypeDefinition Reference to the corresponding Node.

  • The ModellingRule of the referenced component is provided by specifying the symbolic name of the rule in the ModellingRule column. In the AddressSpace, the Node shall use a HasModellingRule Reference to point to the corresponding ModellingRule Object.

If the NodeId of a DataType is provided, the symbolic name of the Node representing the DataType shall be used.

Note that if a symbolic name of a different namespace is used, it is prefixed by the NamespaceIndex (see 3.4.2.2).

Nodes of all other NodeClasses cannot be defined in the same table; therefore, only the used ReferenceType, their NodeClass and their BrowseName are specified. A reference to another part of this document points to their definition.

Table 2 illustrates the table. If no components are provided, the DataType, TypeDefinition and Other columns may be omitted and only a Comment column is introduced to point to the Node definition.

Table 2 – Type Definition Table
Attribute Value
Attribute nameAttribute value. If it is an optional Attribute that is not set “--“ is used.
References NodeClass BrowseName DataType TypeDefinition Other
ReferenceType name NodeClass of the target Node. BrowseName of the target Node. DataType of the referenced Node, only applicable for Variables. TypeDefinition of the referenced Node, only applicable for Variables and Objects.Additional characteristics of the TargetNode such as the ModellingRule or AccessLevel.
NOTE Notes referencing footnotes of the table content.

Components of Nodes can be complex that is containing components by themselves. The TypeDefinition, NodeClass and DataType can be derived from the type definitions, and the symbolic name can be created as defined in 3.4.3.1. Therefore, those containing components are not explicitly specified; they are implicitly specified by the type definitions.

The Other column defines additional characteristics of the Node. Examples of characteristics that can appear in this column are show in Table 3.

Table 3 – Examples of Other Characteristics
Name Short Name Description
0:MandatoryMThe Node has the Mandatory ModellingRule.
0:OptionalOThe Node has the Optional ModellingRule.
0:MandatoryPlaceholderMPThe Node has the MandatoryPlaceholder ModellingRule.
0:OptionalPlaceholderOPThe Node has the OptionalPlaceholder ModellingRule.
ReadOnlyROThe Node AccessLevel has the CurrentRead bit set but not the CurrentWrite bit.
ReadWriteRWThe Node AccessLevel has the CurrentRead and CurrentWrite bits set.
WriteOnlyWOThe Node AccessLevel has the CurrentWrite bit set but not the CurrentRead bit.
History ReadHRThe Node history is readable.

If multiple characteristics are defined they are separated by commas. The name or the short name may be used.

3.4.1.2 Additional References

To provide information about additional References, the format as shown in Table 4 is used.

Table 4 – <some>Type Additional References
SourceBrowsePath Reference Type Is Forward TargetBrowsePath
SourceBrowsePath is always relative to the TypeDefinition. Multiple elements are defined as separate rows of a nested table. ReferenceType nameTrue = forward Reference.

TargetBrowsePath points to another Node, which can be a well-known instance or a TypeDefinition. You can use BrowsePaths here as well, which is either relative to the TypeDefinition or absolute.

If absolute, the first entry needs to refer to a type or well-known instance, uniquely identified within a namespace by the BrowseName.

References can be to any other Node.

3.4.1.3 Additional sub-components

To provide information about sub-components, the format as shown in Table 5 is used.

Table 5 – <some>Type Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
BrowsePath is always relative to the TypeDefinition. Multiple elements are defined as separate rows of a nested tableNOTE Same as for Table 2
3.4.1.4 Additional Attribute values

The type definition table provides columns to specify the values for required Node Attributes for InstanceDeclarations. To provide information about additional Attributes, the format as shown in Table 6 is used.

Table 6 – <some>Type Attribute values for child Nodes
BrowsePath <Attribute name> Attribute
BrowsePath is always relative to the TypeDefinition. Multiple elements are defined as separate rows of a nested table

The values of attributes are converted to text by adapting the reversible JSON encoding rules defined in OPC 10000-6.

If the JSON encoding of a value is a JSON string or a JSON number then that value is entered in the value field. Double quotes are not included.

If the DataType includes a NamespaceIndex (QualifiedNames, NodeIds or ExpandedNodeIds) then the notation used for BrowseNames is used.

If the value is an Enumeration the name of the enumeration value is entered.

If the value is a Structure then a sequence of name and value pairs is entered. Each pair is followed by a newline. The name is followed by a colon. The names are the names of the fields in the DataTypeDefinition.

If the value is an array of non-structures then a sequence of values is entered where each value is followed by a newline.

If the value is an array of Structures or a Structure with fields that are arrays or with nested Structures then the complete JSON array or JSON object is entered. Double quotes are not included.

There can be multiple columns to define more than one Attribute.

3.4.2 NodeIds and BrowseNames

3.4.2.1 NodeIds

The NodeIds of all Nodes described in this standard are only symbolic names. Annex A defines the actual NodeIds.

The symbolic name of each Node defined in this document is its BrowseName, or, when it is part of another Node, the BrowseName of the other Node, a “.”, and the BrowseName of itself. In this case “part of” means that the whole has a HasProperty or HasComponent Reference to its part. Since all Nodes not being part of another Node have a unique name in this document, the symbolic name is unique.

The NamespaceUri for all NodeIds defined in this document is defined in Annex A. The NamespaceIndex for this NamespaceUri is vendor-specific and depends on the position of the NamespaceUri in the server namespace table.

Note that this document not only defines concrete Nodes, but also requires that some Nodes shall be generated, for example one for each Session running on the Server. The NodeIds of those Nodes are Server-specific, including the namespace. But the NamespaceIndex of those Nodes cannot be the NamespaceIndex used for the Nodes defined in this document, because they are not defined by this document but generated by the Server.

3.4.2.2 BrowseNames

The text part of the BrowseNames for all Nodes defined in this document is specified in the tables defining the Nodes. The NamespaceUri for all BrowseNames defined in this document is defined in 14.2.

For InstanceDeclarations of NodeClass Object and Variable that are placeholders (OptionalPlaceholder and MandatoryPlaceholder ModellingRule), the BrowseName and the DisplayName are enclosed in angle brackets (<>) as recommended in OPC 10000-3.If the BrowseName is not defined by this document, a namespace index prefix is added to the BrowseName (e.g., prefix '0' leading to ‘0:EngineeringUnits’ or prefix '2' leading to ‘2:DeviceRevision’). This is typically necessary if a Property of another specification is overwritten or used in the OPC UA types defined in this document. Table 260 provides a list of namespaces and their indexes as used in this document.

3.4.3 Common Attributes

3.4.3.1 General

The Attributes of Nodes, their DataTypes and descriptions are defined in OPC 10000-3. Attributes not marked as optional are mandatory and shall be provided by a Server. The following tables define if the Attribute value is defined by this document or if it is server-specific.

For all Nodes specified in this document, the Attributes named in Table 7 shall be set as specified in the table.

Table 7 – Common Node Attributes
Attribute Value
DisplayNameThe DisplayName is a LocalizedText. Each Server shall provide the DisplayName identical to the BrowseName of the Node for the LocaleId “en”. Whether the server provides translated names for other LocaleIds are server-specific.
DescriptionOptionally a server-specific description is provided.
NodeClassShall reflect the NodeClass of the Node.
NodeIdThe NodeId is described by BrowseNames as defined in 3.4.2.1.
WriteMaskOptionally the WriteMask Attribute can be provided. If the WriteMask Attribute is provided, it shall set all non-server-specific Attributes to not writable. For example, the Description Attribute may be set to writable since a Server may provide a server-specific description for the Node. The NodeId shall not be writable, because it is defined for each Node in this document.
UserWriteMaskOptionally the UserWriteMask Attribute can be provided. The same rules as for the WriteMask Attribute apply.
RolePermissionsOptionally server-specific role permissions can be provided.
UserRolePermissionsOptionally the role permissions of the current Session can be provided. The value is server-specific and depends on the RolePermissions Attribute (if provided) and the current Session.
AccessRestrictionsOptionally server-specific access restrictions can be provided.
3.4.3.2 Objects

For all Objects specified in this document, the Attributes named in Table 8 shall be set as specified in the Table 8. The definitions for the Attributes can be found in OPC 10000-3.

Table 8 – Common Object Attributes
Attribute Value
EventNotifierWhether the Node can be used to subscribe to Events or not is server-specific.
3.4.3.3 Variables

For all Variables specified in this document, the Attributes named in Table 9 shall be set as specified in the table. The definitions for the Attributes can be found in OPC 10000-3.

Table 9 – Common Variable Attributes
Attribute Value
MinimumSamplingIntervalOptionally, a server-specific minimum sampling interval is provided.
AccessLevelThe access level for Variables used for type definitions is server-specific, for all other Variables defined in this document, the access level shall allow reading; other settings are server-specific.
UserAccessLevelThe value for the UserAccessLevel Attribute is server-specific. It is assumed that all Variables can be accessed by at least one user.
ValueFor Variables used as InstanceDeclarations, the value is server-specific; otherwise it shall represent the value described in the text.
ArrayDimensions

If the ValueRank does not identify an array of a specific dimension (i.e. ValueRank <= 0) the ArrayDimensions can either be set to null or the Attribute is missing. This behaviour is server-specific.

If the ValueRank specifies an array of a specific dimension (i.e. ValueRank > 0) then the ArrayDimensions Attribute shall be specified in the table defining the Variable.

HistorizingThe value for the Historizing Attribute is server-specific.
AccessLevelExIf the AccessLevelEx Attribute is provided, it shall have the bits 8, 9, and 10 set to 0, meaning that read and write operations on an individual Variable are atomic, and arrays can be partly written.
3.4.3.4 VariableTypes

For all VariableTypes specified in this document, the Attributes named in Table 10 shall be set as specified in the table. The definitions for the Attributes can be found in OPC 10000-3.

Table 10 – Common VariableType Attributes
Attributes Value
ValueOptionally a server-specific default value can be provided.
ArrayDimensions

If the ValueRank does not identify an array of a specific dimension (i.e. ValueRank <= 0) the ArrayDimensions can either be set to null or the Attribute is missing. This behaviour is server-specific.

If the ValueRank specifies an array of a specific dimension (i.e. ValueRank > 0) then the ArrayDimensions Attribute shall be specified in the table defining the VariableType.

3.4.3.5 Methods

For all Methods specified in this document, the Attributes named in Table 11 shall be set as specified in the table. The definitions for the Attributes can be found in OPC 10000-3.

The implementation of methods shall be such that, if the execution fails, the state of the underlying system will be rolled back to what it was before the execution of the method started. In other words, no partial execution is allowed for methods.

Table 11 – Common Method Attributes
Attributes Value
ExecutableAll Methods defined in this document shall be executable (Executable Attribute set to “True”), unless it is defined differently in the Method definition.
UserExecutableThe value of the UserExecutable Attribute is server-specific. It is assumed that all Methods can be executed by at least one user.

3.4.4 Conventions for Tobacco Machine Communication

3.4.4.1 Types and Instances

Instances of a type <Some>Type will be simply called <Some> singular or <Some>s plural according to the need. Please, note the Italic.

This short-hand form makes the text more readable while preserving disambiguation, as one can simply add the suffix Type to identify the type as defined in the present document.

For example, MachineModules identify instances of type MachineModuleType, MaterialLoadingPoints are instances of type MaterialLoadingPointType and so on and so forth.

4 General information to Tobacco Machine Communication and OPC UA

4.1 Introduction to Tobacco Machine Communication

In most tobacco factories the machine communication landscape, both in primary and in secondary, is highly fragmented, both for machine-to-machine and machine-to-higher systems data streams.

The fragmentation is evident on many levels: physical media, protocols, data formats, sometimes proprietary, have added up over time with the machines. Unnecessarily high integration efforts result.

Moreover, extracting manufacturing insights from the machine data is a valuable opportunity that is severely limited by the fragmentation.

The Tobacco Machine Communication specification aims at harmonizing data exchange and interoperability requirements for the common benefit of both tobacco manufacturers and OEMs.

The Tobacco Machine Communication specification provides information-modelling concepts and object libraries that can be applied to model a complete production workcentre or line. It covers machine configurations, product flows, production, set-up, service, live status as well as historical information. Its scope encompasses both primary and secondary production, including conventional and heat-not-born products.

4.2 Introduction to OPC Unified Architecture

4.2.1 What is OPC UA?

OPC UA is an open and royalty free set of standards designed as a universal communication protocol. While there are numerous communication solutions available, OPC UA has key advantages:

A state of art security model (see OPC 10000-2).

A fault tolerant communication protocol.

An information modelling framework that allows application developers to represent their data in a way that makes sense to them.

OPC UA has a broad scope which delivers for economies of scale for application developers. This means that a larger number of high-quality applications at a reasonable cost are available. When combined with semantic models such as the Tobacco Machine Communication, OPC UA makes it easier for end users to access data via generic commercial applications.

The OPC UA model is scalable from small devices to ERP systems. OPC UA Servers process information locally and then provide that data in a consistent format to any application requesting data - ERP, MES, PMS, Maintenance Systems, HMI, Smartphone or a standard Browser, for examples. For a more complete overview see OPC 10000-1.

4.2.2 Basics of OPC UA

As an open standard, OPC UA is based on standard internet technologies, like TCP/IP, HTTP, Web Sockets.

As an extensible standard, OPC UA provides a set of Services (see OPC 10000-4) and a basic information model framework. This framework provides an easy manner for creating and exposing vendor defined information in a standard way. More importantly all OPC UA Clients are expected to be able to discover and use vendor-defined information. This means OPC UA users can benefit from the economies of scale that come with generic visualization and historian applications. This specification is an example of an OPC UA Information Model designed to meet the needs of developers and users.

OPC UA Clients can be any consumer of data from another device on the network to browser based thin clients and ERP systems. The full scope of OPC UA applications is shown in Figure 1.

Figure 1 – The Scope of OPC UA within an Enterprise

OPC UA provides a robust and reliable communication infrastructure having mechanisms for handling lost messages, failover, heartbeat, etc. With its binary encoded data, it offers a high-performing data exchange solution. Security is built into OPC UA as security requirements become more and more important especially since environments are connected to the office network or the internet and attackers are starting to focus on automation systems.

4.2.3 Information modelling in OPC UA

4.2.3.1 Concepts

OPC UA provides a framework that can be used to represent complex information as Objects in an AddressSpace which can be accessed with standard services. These Objects consist of Nodes connected by References. Different classes of Nodes convey different semantics. For example, a Variable Node represents a value that can be read or written. The Variable Node has an associated DataType that can define the actual value, such as a string, float, structure etc. It can also describe the Variable value as a variant. A Method Node represents a function that can be called. Every Node has a number of Attributes including a unique identifier called a NodeId and non-localized name called as BrowseName. An Object representing a ‘Reservation’ is shown in Figure 2.

Figure 2 – A Basic Object in an OPC UA Address Space

Object and Variable Nodes represent instances and they always reference a TypeDefinition (ObjectType or VariableType) Node which describes their semantics and structure. Figure 3 illustrates the relationship between an instance and its TypeDefinition.

The type Nodes are templates that define all of the children that can be present in an instance of the type. In the example in Figure 3 the PersonType ObjectType defines two children: First Name and Last Name. All instances of PersonType are expected to have the same children with the same BrowseNames. Within a type the BrowseNames uniquely identify the children. This means Client applications can be designed to search for children based on the BrowseNames from the type instead of NodeIds. This eliminates the need for manual reconfiguration of systems if a Client uses types that multiple Servers implement.

OPC UA also supports the concept of sub-typing. This allows a modeller to take an existing type and extend it. There are rules regarding sub-typing defined in OPC 10000-3, but in general they allow the extension of a given type or the restriction of a DataType. For example, the modeller may decide that the existing ObjectType in some cases needs an additional Variable. The modeller can create a subtype of the ObjectType and add the Variable. A Client that is expecting the parent type can treat the new type as if it was of the parent type. Regarding DataTypes, subtypes can only restrict. If a Variable is defined to have a numeric value, a sub type could restrict it to a float.

Figure 3 – The Relationship between Type Definitions and Instances

References allow Nodes to be connected in ways that describe their relationships. All References have a ReferenceType that specifies the semantics of the relationship. References can be hierarchical or non-hierarchical. Hierarchical references are used to create the structure of Objects and Variables. Non-hierarchical are used to create arbitrary associations. Applications can define their own ReferenceType by creating subtypes of an existing ReferenceType. Subtypes inherit the semantics of the parent but may add additional restrictions. Figure 4 depicts several References, connecting different Objects.

Figure 4 – Examples of References between Objects

The figures above use a notation that was developed for the OPC UA specification. The notation is summarized in Figure 5. UML representations can also be used; however, the OPC UA notation is less ambiguous because there is a direct mapping from the elements in the figures to Nodes in the AddressSpace of an OPC UA Server.

Figure 5 – The OPC UA Information Model Notation

A complete description of the different types of Nodes and References can be found in OPC 10000-3 and the base structure is described in OPC 10000-5.

OPC UA specification defines a very wide range of functionality in its basic information model. It is not required that all Clients or Servers support all functionality in the OPC UA specifications. OPC UA includes the concept of Profiles, which segment the functionality into testable certifiable units. This allows the definition of functional subsets (that are expected to be implemented) within a companion specification. The Profiles do not restrict functionality, but generate requirements for a minimum set of functionality (see OPC 10000-7)

4.2.3.2 Namespaces

OPC UA allows information from many different sources to be combined into a single coherent AddressSpace. Namespaces are used to make this possible by eliminating naming and id conflicts between information from different sources. Each namespace in OPC UA has a globally unique string called a NamespaceUri which identifies a naming authority and a locally unique integer called a NamespaceIndex, which is an index into the Server's table of NamespaceUris. The NamespaceIndex is unique only within the context of a Session between an OPC UA Client and an OPC UA Server- the NamespaceIndex can change between Sessions and still identify the same item even though the NamespaceUri's location in the table has changed. The Services defined for OPC UA use the NamespaceIndex to specify the Namespace for qualified values.

There are two types of structured values in OPC UA that are qualified with NamespaceIndexes: NodeIds and QualifiedNames. NodeIds are locally unique (and sometimes globally unique) identifiers for Nodes. The same globally unique NodeId can be used as the identifier in a node in many Servers – the node's instance data may vary but its semantic meaning is the same regardless of the Server it appears in. This means Clients can have built-in knowledge of of what the data means in these Nodes. OPC UA Information Models generally define globally unique NodeIds for the TypeDefinitions defined by the Information Model.

QualifiedNames are non-localized names qualified with a Namespace. They are used for the BrowseNames of Nodes and allow the same names to be used by different information models without conflict. TypeDefinitions are not allowed to have children with duplicate BrowseNames; however, instances do not have that restriction.

4.2.3.3 Companion Specifications

An OPC UA companion specification for an industry specific vertical market describes an Information Model by defining ObjectTypes, VariableTypes, DataTypes and ReferenceTypes that represent the concepts used in the vertical market, and potentially also well-defined Objects as entry points into the AddressSpace.

5 Use cases

This OPC UA companion specification provides support for multiple use cases connected to production machines running both in primary and secondary. Key use cases follow below:

Manage machine’s Overall Equipment Effectiveness, including identifying downtime and its root causes both for machines and for complex lines where it is important to identify which machine is the root cause. To this end, TMC uses TMCStateMachineType, an enhanced PackML state machine, stop reasons and root causes for downtime.

Manage production yield, meaning that high-quality machine or line output data is provided altogether with consumption and dispensing information on the input end and material waste and rejections to compute the line mass balance.
To this end, TMC has its backbone in MaterialLoadingPointType, MaterialOutputPointType and MaterialRejectionPointType.

Manage defects, identifying material rejections and their causes, including defect detections and the root cause reasons for detections. To this end, TMC provides a multi-layered model consisting of DefectDetectionSensorType, SensorFunctionType and DefectReasonType.

Enforce MES-integrated production orders for workcentres, including the dispatching of recipe datasets and material lists, which are constantly monitored during execution for changes and material integrity. To this end, TMC provides core constructs such as DatasetType, MaterialListType and ProductionOrderType.

Enforce MES-integrated production orders for process cells, including the orderly execution of a production order among workcentres (units) connected in any non-loopy process cell layout. To this end, TMC provides the ProductionOrderOrchestrationLayerType, as well as MachineModuleProductionStateMachineType to enforce and monitor execution.

Feed a companywide IIoT data stack, including pervasive, structured, high-quality data collection with aggregation directly at the data source for fast changing signals. To this end ProcessItemType is the core construct in conjunction with multiple pre-defined data points for machine, production data and events.

Implement remote control loops, meaning external smart applications, e.g. AI powered, can increase the production quality by controlling remotely existing machines. To this end, TMC provides ProcessControlLoopType with the necessary watchdogs and remote alarming.

Connect centralised SCADA systems above the machine HMI, including visualization and control functionality in a standardised and uniform way according to the ISA 88 physical structure model. To this end, TMC provides EquipmentModuleType, ControlModuleType with the relevant status and alarming functions.

Support smart visualisation applications above the machine HMI, including visualization resources so that a smart visualisation system can programmatically build visualisation and control functions. To this end, TMC provides the UIInformationType.

6 Tobacco Machine Communication Information Model overview

The main construct is the MachineModuleType ObjectType which is derived from an OPC 10000-100 DeviceType containing additional Information, including MachineModuleHistoricalRecord (8.2), MachineModuleConfiguration (8.3), MachineModuleLiveStatus (8.4), MachineModuleProduction (8.5), MachineModuleSpecification (8.6) and MachineModuleSetup (8.7).

MachineModules describe the production flow by means of their MaterialLoadingPoints (8.8), MaterialOutputPoints (8.9), MaterialStorageBuffers (8.10) where product is stored during production and MaterialRejectionPoints (8.11). MaterialRejectionPoints are triggered by DefectDetectionSensors (8.12) which contain SensorFunctions (8.13) and DefectReasons (8.14).

Connecting the MaterialOutputPoints of MachineModules to the MaterialLoadingPoints of the downstream MachineModule provides the production graph.

As far as production is concerned, a MachineModule is functionally equivalent to a Unit in ISA 95/88 language. A collection of MachineModules and their production graph make a Process Cell as defined in ISA 95/88.

Production in a non-loopy Process Cell, i.e. no connections looping back in the production graph, is orchestrated by means of the ProductionOrderOrchestrationLayer (8.38).

A MachineModule may contain one or more EquipmentModules (8.15) or ControlModules (8.19). In turn EquipmentModules may contain one or more ControlModules. Typical ControlModules such as AnalogInputs (8.25), DigitalInputs (8.26), Motors (8.27), Sensors (8.28) and Valves (8.29) are also provided.

Most TMC objects are described by a suitable state machine, TMCMachineStateMachine (8.43) and production state machines (8.39 and 8.40), that inherit from the OMAC PackML standardization effort adding guards to the transitions.

ProcessControlLoops (8.46) may also be included in MachineModules or used alone to expose a control loop in control of the underlying system or remotely controlled.

7 TMC Guideline

7.1 Naming Convention

One of the key goals of OPC UA is to communicate information, not just data. In order to do so, it is important that meaningful metadata is attached, starting with object names.

The names of objects are intended to tell objects apart and straightforwardly clarify what the object is, i.e. they must be human readable avoiding serials, UIDs, uncommon acronyms and other prefixes and suffixes that limit the human understanding whenever possible.

Developers shall name objects according to the following rules and principles:

CamelCase: the CamelCase capitalisation practice will be used for all names. Moreover, the developer shall comply with the whitepaper OPC11030 UA Modeling Best Practices.

Names shall be unique at their hierarchy level: no two servers provided by the same OEM shall have the same name twice, no two machine modules in the same server shall have the same name twice, no two loading points in the same machine module will have the same name twice and so on.

For instance, applying the principles above, it is acceptable to name a server adding a suffix to the machine name with a machine serial or UID e.g. Maker123, Maker 456 because no other alternative ensuring uniqueness is given. Prefixing makes the name less readable and shall be avoided.

Like function, like name: functionally equivalent objects will carry the same name. For example, each instance of a paper loading point in different machine modules will be named PaperLoadingPoint.

If a machine contains multiple objects with the same name, then the name will be completed with a suffix that allows to distinguish the objects with the same function. To continue the previous example, PaperLoadingPoint1 and PaperLoadingPoint2 are acceptable. Please, note that two paper loading points, for tipping paper and cigarette paper, will not be specialised by a suffix but a functional prefix is required i.e. TippingPaperLoadingPoint, CigarettePaperLoadingPoint because their function is different.

Name for brevity: names shall not contain redundant information and in particular information that is carried by the name of a parent object. Thus the name of a component of the SomeMachineModule shall not contain SomeMachineModule or any other string (serial, UID or similar) identifying the machine module, because the information is already captured by the name of the parent object given the inherently hierarchical structure of the TMC nodeset.

The description property and display name that belong to each object/variable instance contained in a TMC server will provide a short phrase in plain English that explains what the instance is and that an average user familiar with the domain can understand.

7.2 Historization and Persistency

The value of Nodes with readable history (marked as HR in the Other column) shall be persisted for a period of 8 hours, meaning the last 8 (eight) hours of data will be available.

The server shall implement historization of events for all events, accessible by client via the OPC UA service history read. The historization internal storage shall be sized to persist at least 1 (one) hour of events generated at the average server generation rate.

The Value of Nodes with NodeClass Variable shall be persisted in the control system in such a way that, in case of a hardware failure or replacement, the TMC server values will not be reset.

7.3 NodeIds

Nodes are unambiguously identified using a constructed identifier called the NodeId. A Server shall persist the NodeId of a Node, that is, it shall not generate new NodeIds when rebooting. In case of an update, a Server shall not generate new NodeIds for Nodes that have not been added with the update.

8 OPC UA ObjectTypes

8.1 MachineModuleType ObjectType

8.1.1 Overview

The MachineModuleType represents a machine module or workcentre and is formally defined in the following table.

Table 12 – MachineModuleType Definition
Attribute Value
BrowseNameMachineModuleType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the TMCDeviceType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectConfigurationMachineModuleConfigurationTypeM
0:HasComponentObjectControlModules0:FolderTypeO
0:HasComponentObjectDefectDetectionSensors0:FolderTypeO
0:HasComponentObjectEquipmentModules0:FolderTypeO
0:HasComponentObjectLiveStatusMachineModuleLiveStatusTypeM
0:HasComponentObjectMaterialBuffers0:FolderTypeO
0:HasComponentObjectMaterialLoadingPoints0:FolderTypeO
0:HasComponentObjectMaterialLocations0:FolderTypeO
0:HasComponentObjectMaterialOutputPoints0:FolderTypeO
0:HasComponentObjectMaterialRejectionPoints0:FolderTypeO
0:HasComponentObjectPastSpecificationRecords0:FolderTypeO
0:HasComponentObjectProcessControlLoops0:FolderTypeO
0:HasComponentObjectProcessItems0:FolderTypeO
0:HasComponentObjectProductionMachineModuleProductionTypeO
0:HasPropertyVariableRemote0:Boolean0:PropertyTypeM, RO
0:HasComponentObjectSetupMachineModuleSetupTypeO
0:HasComponentObjectSpecificationMachineModuleSpecificationTypeO
Conformance Units
TMC Data Collection
TMC Core Production
TMC Process Variables Ingestion and Control
TMC Intralogistics at the machine
BrowseName Description
ConfigurationThe Configuration Object provides the descriptions (metadata) for settings, stop reasons and root causes of the machine module as well as affordances to make modifications.
ControlModulesThe ControlModules folder provides control modules belonging to the machine module (and not belonging to an equipment module).
DefectDetectionSensorsThe DefectDetectionSensors folder provides the sensor(s) and sensing systems fitted to the machine module that detect product defects.
EquipmentModulesThe EquipmentModules folder provides equipment modules of the machine module.
LiveStatusThe LIveStatus Object provides information about the real time status of the machine module and provides affordances to control the machine module remotely in real time.
MaterialBuffersThe MaterialBuffers folder provides material storage buffers of the machine module.
MaterialLoadingPointsThe MaterialLoadingPoints folder provides the loading points and the materials being loaded, as well as the brand integrity checks required.
MaterialLocationsThe MaterialLocations folder provides material locations used to deliver or retrieve materials to/from the machine.
MaterialOutputPointsThe MaterialOutputPoints folder provides the output(s) of the machine module.
MaterialRejectionPointsThe MaterialRejectionPoints folder provides rejection traps where material is discarded from the machine module.
PastSpecificationRecordsThe PastSpecificationRecords folder contains the information about the machine as was operating in a previous period of time.
ProcessControlLoopsThe ProcessControlLoops folder provides control loops of the machine module.
ProcessItemsThe ProcessItems folder provides analog sensor values.
ProductionThe Production Object provides information about the current production order and quantity produced as well as affordances to start/stop a production order and reset totals for the machine module.
Remote

When Remote is True, all methods exposed by the machine module and contained objects are executed and all variables marked as RW can be written to.

When Remote is False, the OEM may decide to not execute some qualified methods and/or not allow some qualified RW variables to be written to because of justified safety concerns. The justification shall be provided in the machine safety assessment provided to the customer. Lacking justification, the method shall be executable. For instance, informative methods such as (but not limited to) GetProductionOrder, GetDataSet, GetMaterialList, GetDataSetList, GetRootCauseGroupList, GetRootCauseList, GetStopReasonList, ValidateDataSet, ValidateMaterialList are executable regardless of the value of Remote.

The invoking of qualified methods and/or writing of qualified RW variables can be disallowed only for the MachineModuleLiveStatus which includes the methods SendCommand and SetControlMode.

When a method is not executed due to the Remote flag, the MethodExecutionFeedback shall report “The system is under local control. Please, switch to Remote to execute the method.” When a RW variable is not allowed to be written to, the StatusCode “Bad_NotWritable” is produced.

Remote is read-only because of safety concerns and because it is typically implemented as a physical rotary selector on the machine cabinet: it is the operator who will release the control to a remote system.

SetupThe SetUp Object contains the value of all the settings (including mechanical adjustments) required to run production as well as affordances to validate and load settings for the machine module.
SpecificationThe Specification Object contains the specification about the machine as currently operating including capabilities, internal buffers and loading points.

The components of the MachineModuleType have additional subcomponents which are defined in the following table.

Table 13 – MachineModuleType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
ControlModules0:HasComponent Object AnalogInputs 0:FolderTypeO
0:HasComponent Object <AnalogInput> AnalogInputTypeOP
ControlModules0:HasComponent Object DigitalInputs 0:FolderTypeO
0:HasComponent Object <DigitalInput> DigitalInputTypeOP
ControlModules0:HasComponent Object Motors 0:FolderTypeO
0:HasComponent Object <Motor> MotorTypeOP
ControlModules0:HasComponent Object Sensors 0:FolderTypeO
0:HasComponent Object <Sensor> SensorTypeOP
ControlModules0:HasComponent Object Valves 0:FolderTypeO
0:HasComponent Object <Valve> ValveTypeOP
DefectDetectionSensors0:HasComponent Object <DefectDetectionSensor> DefectDetectionSensorTypeOP
EquipmentModules0:HasComponent Object <EquipmentModule> EquipmentModuleTypeOP
MaterialBuffers0:HasComponent Object <MaterialStorageBuffer> MaterialStorageBufferTypeOP
MaterialLoadingPoints0:HasComponent Object <MaterialLoadingPoint> MaterialLoadingPointTypeOP
MaterialLocations0:HasComponent Object <MaterialLocation> MaterialLocationTypeOP
MaterialOutputPoints0:HasComponent Object<MaterialOutput> MaterialOutputPointTypeOP
MaterialRejectionPoints0:HasComponent Object <MaterialRejectionPoint> MaterialRejectionPointTypeOP
PastSpecificationRecords0:HasComponent Object <SpecificationRecord>MachineModuleHistoricalRecordTypeOP
ProcessControlLoops0:HasComponent Object <ProcessControlLoop> ProcessControlLoopTypeOP
ProcessItems0:HasComponent Object <ProcessItem> ProcessItemTypeOP
ProcessItems0:HasComponent Object <ProcessControlItem> ProcessControlItemTypeOP
ProcessItems0:HasComponent Object <ProcessControlItem> ProcessControlItemTypeOP

Instances of the MachineModuleType are components of the DeviceSet Object as defined by OPC10000-100, 5.9 DeviceSet.

For additional clarity, MachineModuleType instances shall be grouped under the DeviceSet object.

8.2 MachineModuleHistoricalRecordType ObjectType

8.2.1 Overview

The MachineModuleHistoricalRecordType ObjectType contains the specifications of the machine module that have been valid in the past. When the machine module manufacturer modifies the machine in a way that impact the OPC UA server specification, the machine module manufacturer will save an object of type MachineModuleHistoricalType to the folder PastSpecificationRecords which is a component of the relevant MachineModule

The MachineModuleHistoricalRecordType is formally defined in the following table.

Table 14 – MachineModuleHistoricalRecordType Definition
Attribute Value
BrowseNameMachineModuleHistoricalRecordType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectMachineModuleSpecificationMachineModuleSpecificationTypeM
0:HasPropertyVariableValidUntil0:UtcTime0:PropertyTypeM, RO
Conformance Units
TMC Asset Management
BrowseName Description
MachineModuleSpecificationThe MachineModuleSpecification Object contains a specification that was valid in the past.
ValidUntilThe ValidUntil Propertyontains the date and time the MachineModuleSpecification was last valid. The Property ValidUntil shall be set by the OEM when changes that impact the machine module specification are made.

8.3 MachineModuleConfigurationType ObjectType

8.3.1 Overview

The MachineModuleConfigurationType provides descriptions for settings, stop reasons and root causes as well as affordances to make modifications.

The MachineModuleConfigurationType is formally defined in the following table.

Table 15 – MachineModuleConfigurationType Definition
Attribute Value
BrowseNameMachineModuleConfigurationType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasPropertyVariableDataSetListDataSetDefinitionType0:PropertyTypeO, RO
0:HasComponentMethodGetDataSetListSee below.O
0:HasComponentMethodGetRootCauseGroupListSee below.M
0:HasComponentMethodGetRootCauseListSee below.M
0:HasComponentMethodGetStopReasonListSee below.M
0:HasPropertyVariableLastChangeDate0:UtcTime0:PropertyTypeM, RO
0:HasPropertyVariableLongestMicroStopDuration0:Double0:PropertyTypeM, RW
0:HasPropertyVariableRootCauseGroupListRootCauseGroupType[]0:PropertyTypeM, RW
0:HasPropertyVariableRootCauseListRootCauseMessageType[]0:PropertyTypeM, RW
0:HasPropertyVariableRootCauseListInputIsMandatory0:Boolean0:PropertyTypeM, RW
0:HasComponentMethodSetDataSetListMESIDSee below.M
0:HasComponentMethodSetRootCauseListsSee below.M
0:HasPropertyVariableStopReasonListMessageType[]0:PropertyTypeM, RO
0:GeneratesEventObjectTypeRootCauseGroupListChangeLogType
0:GeneratesEventObjectTypeRootCauseListChangeLogType
0:GeneratesEventObjectTypeStopReasonListChangeLogType
Conformance Units
TMC Data Collection
TMC Single PO Production
TMC Multi PO Production
BrowseName Description
DataSetListThe Property DataSetList of type DataSetDefinition contains the descriptors for all the parameters used to set up the machine.
LastChangeDate

The Property LastChangeDate is the date and time of the last change applied to the machine

module configuration and the effective date of the modification.

LongestMicroStopDurationThe Property LongestMicroStopDuration is the maximum duration of a micro-stop in seconds, longer stops are not micro-stops. Operators are not required to enter a root cause for micro-stops.
RootCauseGroupList

The Property RootCauseGroupList is the list of groups that root causes can be grouped in.

They are defined by the end user. Same as the RootCauseList property. The RootCauseGroupList is user defined.

RootCauseListThe Property RootCauseList is the complete list of the root causes that the end user has defined to classify and organize the downtime due to the machine module stops. The RootCauseList is user defined.
RootCauseGroupListIsMandatoryThe Property RootCauseListInputIsMandatory is true when the operator is mandatorily required to select the root cause that best describes the current stop situation. For micro- stops such requirement does not apply.
StopReasonListThe Property StopReasonList is a list containing the descriptors for all the possible machine module messages, including alarms and warnings. Messages include their localization. The list is defined, created and maintained by the OEM.

8.3.2 GetDataSetList Method

The GetDatasetList Method returns the list of descriptions for parameters of the dataset filtered by the dependency and subset created by the user.

The GetDatasetList Method is typically used for clients to visualize the parameters’ descriptions and related metadata.

The signature of this Method is specified below. Table 16 specifies the Arguments representation.

Signature

	GetDataSetList (
	  [in]  ParameterDependencyEnumeration			Dependency,
	  [in]  0:Boolean								UserSubset,
	  [in]  0:Boolean       						CompleteSet,
	  [out] DataSetDefinitionType						DataSetList,
	  [out] MethodExecutionFeedbackType				ExecutionFeedback
			);
Table 16 – GetDataSetList Method Arguments
Argument Description
DependencyDependency specifies how to select (filter) a subset of the dataset based on dependency.
UserSubsetUserSubset specifies how to select (filter) a subset of the dataset based on the user-defined UserSubset.
CompleteSetIf CompleteSet is True, then the method returns the complete dataset without considering the input parameters Dependency and UserSubset.
DataSetListThe list of parameters filtered as per the input arguments Dependency and UserSubset.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.3.3 GetRootCauseGroupList Method

The GetRootCauseGroupList Method returns the complete list of root cause groups as persisted by the server.

The signature of this Method is specified below. Table 17 specifies the Arguments representation.

Signature

	GetRootCauseGroupList(
	  [out] RootCauseGroupType[]			RootCauseGroupList,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 17 – GetRootCauseGroupList Method Arguments
Argument Description
RootCauseGroupListThe complete list of root cause groups.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.3.4 GetRootCauseList Method

The GetRootCauseList Method returns the complete list of root causes as persisted by the server.

The signature of this Method is specified below. Table 18 specifies the Arguments representation.

Signature

	GetRootCauseList(
	  [out] RootCauseMessageType[]			RootCauseList,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 18 – GetRootCauseList Method Arguments
Argument Description
RootCauseListThe complete list of root cause messages.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.3.5 GetStopReasonList Method

The GetStopReasonList Method returns the complete list of stop reasons as persisted by the server.

The signature of this Method is specified below. Table 19 specifies the Arguments representation.

Signature

	GetStopReasonList(
	  [out] MessageType[]					StopReasonList,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 19 – GetStopReasonList Method Arguments
Argument Description
StopReasonListThe complete list of stop reason messages.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.3.6 SetDataSetListMESID Method

The SetDataSetListMESID Method sets the MES_ID of one or more items of the array Definitions contained in the DataSetList.

For clarity, the DataSetList is a Variable of type DataSetDefinitionType which contains Definitions, an array of structures of type DataDefinitionType. In turn DataDefinitionType is a subtype of DataDescriptionType, meaning it inherits MES_ID. The latter is set by SetDataSetListMESID.

Each item of Definitions is identified by its ID.

The signature of this Method is specified below. Table 20 specifies the Arguments representation.

Signature

	SetDataSetListMESID (
	  [in]  0:String[]						IDs,
	  [in]  0:String[]						MESIDs,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 20 – SetDataSetListMESID Method Arguments
Argument Description
IDsThe IDs of the elements of the Definitions array whose MES_ID shall be changed if the method executes successfully.
MESIDsThe values of the MES_IDs to be set.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.3.7 SetRootCauseLists Method

The SetRootCauseLists Method sets both the RootCauseList and RootCauseGroupList according to the input arguments. The RootCauseList and RootCauseGroupList properties are set together to ensure consistency of root causes with the relevant groups.

The signature of this Method is specified below. Table 21 specifies the Arguments representation.

Signature

	SetRootCauseLists (
	  [in]  RootCauseMessageType[]			RootCauseList,
	  [in]  RootCauseGroupType[]			RootCauseGroupList,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 21 – SetRootCauseLists Method Arguments
Argument Description
RootCauseListThe list of root causes to be transferred to and used by the server.
RootCauseGroupListThe list of root cause groups to be transferred to and used by the server.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.4 MachineModuleLiveStatusType ObjectType

8.4.1 Overview

The MachineModuleLiveStatusType ObjectType contains information about the real time status of the machine module and provides affordances to control the machine module remotely in real time.

The MachineModuleLiveStatusType is formally defined in the following table.

Table 22 – MachineModuleLiveStatusType Definition
Attribute Value
BrowseNameMachineModuleLiveStatusType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentMethodAcknowledgeAlarmsSee below.M
0:HasComponentObjectAlarms0:FolderTypeM
0:HasPropertyVariableControlModeControlModeEnumeration0:PropertyTypeM, RW
0:HasComponentObjectData0:FolderTypeO
0:HasPropertyVariableIdleEnergySavingMode0:Boolean0:PropertyTypeM, RW
0:HasComponentMethodResetAggregatesSee below.M
0:HasComponentMethodSendCommandSee below.M
0:HasComponentMethodSetControlModeSee below.M
0:HasComponentMethodSetIdleEnergySavingModeSee below.M
0:HasPropertyVariableStateStateEnumeration0:PropertyTypeM, RO
0:HasComponentObjectStateMachineTMCStateMachineTypeO
0:GeneratesEventObjectTypeControlModeChangeLogType
0:GeneratesEventObjectType0:DiscreteAlarmType
0:GeneratesEventObjectTypeDowntimeLogType
0:GeneratesEventObjectTypeExternalAlarmType
0:GeneratesEventObjectTypeStateChangeLogType
Conformance Units
TMC Basic Machine Status
TMC Advanced Machine Status
BrowseName Description
ControlModeThe ControlMode property describes the current control mode of the machine.
IdleEnergySavingModeThe IdleEnergySavingMode Property is set to True when the energy saving mode during the idle phase is set.
StateThe Property State describes the status of the state machine controlling the machine module. State provides a subset of the information of the state machine, when the latter is implemented.
StateMachineThe state machine describes the current state of the machine, the possible transitions and their conditions.
AlarmsThe Alarms folder contains alarms of the machine module.
DataThe Data Folder contains additional data that is not identified elsewhere in this specification.

The components of the MachineModuleLiveStatusType have additional subcomponents which are defined in the following table.

Table 23 – MachineModuleLiveStatusType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
Alarms0:HasComponentObject<Alarm> 0:DiscreteAlarmTypeOP
Alarms0:HasComponentObject<ExternalAlarm> ExternalAlarmTypeOP
Data0:HasComponentVariable<DataItem>0:BaseDataType 0:BaseDataVariableTypeOP, RO

8.4.2 AcknowledgeAlarms Method

The AcknowledgeAlarms Method acknowledges all alarms of the machine module. The acknowledgement is cascades to other objects belonging to the machine module e.g., equipment modules and control modules.

The signature of this Method is specified below. Table 24 specifies the Arguments representation.

Signature

	AcknowledgeAlarms (
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 24 – AcknowledgeAlarms Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.4.3 ResetAggregates Method

The ResetAggregates resets all the aggregates for the objects contained in the ProcessItems and ProcessControlLoops of the machine module.

The signature of this Method is specified below. Table 25 specifies the Arguments representation.

Signature

	ResetAggregates (
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 25 – ResetAggregates Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.4.4 SendCommand Method

The Method SendCommand sends a command to change the state of the machine module state machine remotely.

The signature of this Method is specified below. Table 26 specifies the Arguments representation.

Signature

	SendCommand (
	  [in]  CommandEnumeration				Command,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 26 – SendCommand Method Arguments
Argument Description
CommandThe command to be sent to the machine module.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.4.5 SetControlMode Method

The SetControlMode Method sets the control mode of the machine module.

The signature of this Method is specified below. Table 27 specifies the Arguments representation.

Signature

	SetControlMode (
	  [in]  ControlModeEnumeration			ControlMode,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 27 – SetControlMode Method Arguments
Argument Description
ControlModeThe control mode to be set to the machine module.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.4.6 SetIdleEnergySavingMode Method

The Method SetIdleEnergySavingMode activates the energy saving mode when the machine module is idle.

The signature of this Method is specified below. Table 28 specifies the Arguments representation.

Signature

	SetIdleEnergySavingMode (
	  [in]  0:Boolean						IdleEnergySavingMode,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 28 – SetIdleEnergySavingMode Method Arguments
Argument Description
IdleEnergySavingModeThe energy saving mode to set.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.5 MachineModuleProductionType ObjectType

8.5.1 Overview

The MachineModuleProductionType Object provides information about the current production order and quantity produced as well as affordances to start/stop a production order and reset totals for the machine module.

The MachineModuleProductionType is formally defined in the table below.

Table 29 – MachineModuleProductionType Definition
Attribute Value
BrowseNameMachineModuleProductionType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentMethodAbortProductionOrderSee below.O
0:HasPropertyVariableAssignedProductionOrdersProductionOrderType[]0:PropertyTypeO, RO
0:HasComponentMethodAssignProductionOrderSee below.O
0:HasPropertyVariableAutoComplete0:Boolean0:PropertyTypeO, RW
0:HasPropertyVariableAutoStart0:Boolean0:PropertyTypeO, RW
0:HasComponentMethodClearProductionOrderSee below.O
0:HasComponentMethodCompleteProductionOrderSee below.M
0:HasComponentObjectData0:FolderTypeO
0:HasPropertyVariableProductionOrderProductionOrderHeaderType0:PropertyTypeM, RO
0:HasPropertyVariableProductionStatusProductionStatusEnumeration0:PropertyTypeM, RO
0:HasComponentMethodResetProductionTotalsSee below.M
0:HasComponentMethodStartAssignedProductionOrderSee below.O
0:HasComponentMethodStartProductionOrderSee below.M
0:HasComponentObjectStateMachineMachineModuleProductionStateMachineTypeO
0:HasComponentMethodUnassignProductionOrderSee below.O
0:GeneratesEventObjectTypePOStartedLogType
0:GeneratesEventObjectTypePOStoppedLogType
Conformance Units
TMC Core Production
TMC Single PO Production
TMC Multi PO Production
BrowseName Description
AssignedProductionOrdersThe AssignedProductionOrders array contains the production orders that have been assigned to the machine module and have not yet been started or unassigned.
AutoCompleteThe AutoComplete Boolean defines how to trigger the machine module to complete the execution of a production order. When AutoComplete is False, the completion of a production order at the machine module is triggered with the method CompleteProductionOrder. When AutoComplete is True, the machine module initiates the completion of the production order when all the active upstream machine modules running the production order are in state complete.
AutoStart

The Autostart Boolean defines how to trigger the machine module to start a production order.

When AutoStart is True and AssignedProductionOrders[] contains one PO, the assigned machine module initiates the starting sequence automatically for the assigned production order.

When AutoStart is False, the start of a production order at the machine module is triggered with the method StartProductionOrder. StartProductionOrder is also invoked when AutoStart is True and AssignedProductionOrders[] contains more than one production order.

DataThe Data folder provides additional production data that is not identified elsewhere in this specification. e.g. a shift report.
ProductionOrderThe production order header in execution at the machine module.
ProductionStatusThe execution status of the production order.
StateMachineThe StateMachine extends ProductionStatus and provides detailed production execution status as well as methods to trigger the transitions and events when the transitions occur.

8.5.2 AbortProductionOrder Method

The AbortProductionOrder method is used to abnormally terminate, or abort, a production order that is in execution or starting or completing. Aborting cannot be reversed or undone.

The signature of this Method is specified below. Table 30 specifies the Arguments representation.

Signature

	AbortProductionOrder (
	  [in]  ProductionOrderHeaderType		POToAbort,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 30 – AbortProductionOrder Method Arguments
Argument Description
POToAbortThe production order to be aborted. The argument is unnecessary for execution (since at most one production order can be executed at any time in the machine module) but provided as a safety net since aborting cannot be reversed.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.5.3 AssignProductionOrder Method

The AssignProductionOrder Method is used to transfer the information of an upcoming production order to the machine module.

The signature of this Method is specified below. Table 31 specifies the Arguments representation.

Signature

	AssignProductionOrder (
	  [in]  ProductionOrderType			POToAssign,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
	
Table 31 – AssignProductionOrder Method Arguments
Argument Description
POToAssignThe production order to assign to the machine module for later execution.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.5.4 ClearProductionOrder Method

The ClearProductionOrder method is used to positively confirm that the machine module where a production order is aborted has been cleared of the product or parts left by the aborted production order.

The signature of this Method is specified below. Table 32 specifies the Arguments representation.

Signature

	ClearProductionOrder (
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 32 – ClearProductionOrder Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.5.5 CompleteProductionOrder Method

The CompleteProductionOrder method is used to complete a production order in execution.

The signature of this Method is specified below. Table 33 specifies the Arguments representation.

Signature

	CompleteProductionOrder (
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 33 – CompleteProductionOrder Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

When the StateMachine is in state Execute, the successful execution of the method causes the transition to state Completing.

When the method is invoked in any other state, the method property Executable is False and when the method is invoked, the status code Bad_NotSupported is returned.

8.5.6 StartAssignedProductionOrder Method

The StartAssignedProductionOrder Method starts a production order whose state is Assigned at the machine module.

The signature of this Method is specified below. Table 34 specifies the Arguments representation.

Signature

	StartAssignedProductionOrder (
	  [in]  ProductionOrderHeaderType	POHeaderToStart,
	  [in]  0:String[]					SourceMaterialLoadingPointIDs,
	  [in]  0:String[]				 DestinationMaterialOutputPointIDs,
	  [out] MethodExecutionFeedbackType	ExecutionFeedback);
Table 34 – StartAssignedProductionOrder Method Arguments
Argument Description
POHeaderToStartThe header of the production order to be started.
SourceMaterialLoadingPointIDsThe list of material loading points that are going to be used by the production order to be started.
DestinationMaterialOutputPointIDsThe list of material output points that are going to be used by the production order to be started.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.5.7 StartProductionOrder Method

The StartProductionOrder Method starts a production order at the machine module.

The signature of this Method is specified below. Table 35 specifies the Arguments representation.

Signature

	StartProductionOrder (
	  [in]  ProductionOrderType			POToStart,
	  [in]  0:String[]					SourceMaterialLoadingPointIDs,
	  [in]  0:String[]				 DestinationMaterialOutputPointIDs,
	  [out] MethodExecutionFeedbackType	ExecutionFeedback);
Table 35 – StartProductionOrder Method Arguments
Argument Description
POToStartThe production order to be started.
SourceMaterialLoadingPointIDsThe list of material loading points that are going to be used by the production order to be started.
DestinationMaterialOutputPointIDsThe list of material output points that are going to be used by the production order to be started.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.5.8 UnassignProductionOrder Method

The UnassignProductionOrder method is used to remove the specified production order from AssignedProductionOrders[] of an infeed machine module.

The signature of this Method is specified below. Table 36 specifies the Arguments representation.

Signature

	UnassignProductionOrder (
	  [in]  ProductionOrderHeaderType		POToUnassign,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 36 – UnassignProductionOrder Method Arguments
Argument Description
POToUnassignThe production order to be unassigned at the machine module.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.5.9 ResetProductionTotals

The Method ResetProductionTotals simultaneously resets the totals of the machine components belonging to the following machine folders: DefectDetectionSensors, MaterialLoadingPoints, MaterialOutputPoints, MaterialRejectionPoints.

The master totals belonging to the same objects are not reset.

The signature of this Method is specified below. Table 37 specifies the Arguments representation.

Signature

	ResetProductionTotals (
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 37 – ResetProductionTotals Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.6 MachineModuleSpecificationType ObjectType

8.6.1 Overview

The MachineModuleSpecificationType provides the specification of the machine module as currently operating including capabilities, internal buffers and loading points.

This MachineModuleSpecificationType is formally defined in the table below.

Table 38 – MachineModuleSpecificationType Definition
Attribute Value
BrowseNameMachineModuleSpecificationType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentMethodDeleteSpecificationRecordSee below.M
0:HasComponentObjectDocumentation0:FolderTypeM
0:HasComponentMethodLoadMachineModuleDocumentationSee below.M
0:HasPropertyVariableLocationName0:String0:PropertyTypeM, RW
0:HasPropertyVariableMaterialLoadingPointsMaterialPointType[]0:PropertyTypeM, RO
0:HasPropertyVariableMaterialOutputPointsMaterialPointType[]0:PropertyTypeM, RO
0:HasPropertyVariableMaterialRejectionPointsMaterialPointType[]0:PropertyTypeM, RO
0:HasPropertyVariableMaterialStorageBuffersMaterialStorageBufferDataType[]0:PropertyTypeM, RO
0:HasComponentMethodRemoveMachineModuleDocumentationSee below.M
0:HasComponentMethodSetNewSpecificationSee below.M
0:HasPropertyVariableTimeZone0:TimeZoneDataType0:PropertyTypeM, RW
0:HasPropertyVariableTotalRunningHours0:UInt640: PropertyTypeM, RO
0:HasPropertyVariableUserMachineName0:String0:PropertyTypeM, RW
0:HasPropertyVariableValidSince0:UtcTime0:PropertyTypeM, RO
0:GeneratesEventObjectTypeMachineModuleSpecificationChangeLogType
Conformance Units
TMC Single PO Production
TMC Asset Management
BrowseName Description
DocumentationThe Object Documentation is the sole repository for the machine module documentation resources. The Documentation is accessed, for example, by clients and HMIs.
LocationNameThe Property LocationName of type String contains the location of the machine module within the user production site. The Property LocationName will contain the following: Country/City/Department/Floor/Bay/Position. LocationName and UserMachineName uniquely identify the machine module in the user organization.
MaterialLoadingPointsThe Property MaterialLoadingPoints identifies the loading points of the machine module and their capability in terms of what materials can be loaded at a loading point. The Property MaterialLoadingPoints is defined as a list of objects of type MaterialPointType.
MaterialOutputPointsThe Property MaterialOutputPoints identifies the output points of the machine module and their capability in terms of what materials can be output The Property MaterialOutputPoints is defined as a list of objects of type MaterialPointType.
MaterialRejectionPointsThe Property MaterialRejectionPoints identifies the rejection points of the machine module and their capability in terms of what materials are rejected The Property MaterialRejectionPoints is defined as a list of objects of type MaterialPointType.
MaterialStorageBuffersThe Property MaterialStorageBuffers describes the buffers inside the machine module and their current status. The Property MaterialStorageBuffers is a list of objects of type MaterialStorageBufferDataType.
TimeZoneThe local time zone where the machine operates. It is required to convert UTC times into local time.
TotalRunningHoursThe Property TotalRunningHours counts the number of hours the machine module has been in operation since the last time its configuration was changed. More specifically, time is counted when the machine module state is different from: Stopping, Stopped, Aborting, Aborted, Clearing.
UserMachineNameThe Property UserMachineName of type String contains the name used by the user to identify the machine module. LocationName and UserMachineName uniquely identify the machine module in the user organization.
ValidSinceThe Property ValidSince is the date since the configuration was last modified.

The components of the MachineModuleSpecificationType have additional subcomponents which are defined in the table below.

Table 39 – MachineModuleSpecificationType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
Documentation0:HasPropertyVariable <DocumentName>0:ByteString 0:PropertyTypeOP, RO

8.6.2 DeleteSpecificationRecord Method

The DeleteSpecificationRecord Method deletes a specification record.

The signature of this Method is specified below. Table 40 specifies the Arguments representation.

Signature

	DeleteSpecificationRecord (
	[in]		0:NodeId							SpecificationRecord,
	[out] 	MethodExecutionFeedbackType		ExecutionFeedback);
Table 40 – DeleteSpecificationRecord Method Arguments
Argument Description
SpecificationRecordThe OPC UA unique node identifier for the specification to be deleted from the underlying system repository.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.6.3 LoadMachineModuleDocumentation Method

The LoadMachineModuleDocumentation Method allows to securely load any machine module documentation to the documentation repository Documentation folder where it can be reached by applications.

The signature of this Method is specified below. Table 41 specifies the Arguments representation.

Signature

	LoadMachineModuleDocumentation (
	[in]		0:ByteString						DocumentToBeLoaded,
	[in]		0:String							DocumentName,
	[out] 	MethodExecutionFeedbackType		ExecutionFeedback);
Table 41 – LoadMachineModuleDocumentation Method Arguments
Argument Description
DocumentToBeLoadedThe document, as a byte string, to be transferred to the Documentation folder.
DocumentNameThe document name to be associated to the document in the underlying system.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.6.4 RemoveMachineModuleDocumentation Method

The RemoveMachineModuleDocumentation Method allows to securely remove, i.e. permanently delete, any machine module documentation from the documentation repository Documentation.

The signature of this Method is specified below. Table 42 specifies the Arguments representation.

Signature

	RemoveMachineModuleDocumentation (
	[in]		0:String							DocumentName,
	[out] 	MethodExecutionFeedbackType		ExecutionFeedback);
Table 42 – RemoveMachineModuleDocumentation Method Arguments
Argument Description
DocumentNameThe document name to be associated to the document in the underlying system.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.6.5 SetNewSpecification Method

The Method SetNewSpecification saves its arguments as the new specification for the machine module. Prior to that it saves the previous specification into the PastSpecification Records Object of the same machine module.

The signature of this Method is specified below. Table 43 specifies the Arguments representation.

Signature

	SetNewSpecification (
	[in]	MaterialPointType[]     			NewMaterialLoadingPoints,
	[in]	MaterialStorageBufferDataType[]	NewMaterialStorageBuffers,
	[in]	MaterialPointType[]     			NewMaterialOutputPoints,
	[in]	MaterialPointType[]     		   NewMaterialRejectionPoints,
	[out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 43 – SetNewSpecification Method Arguments
Argument Description
NewMaterialLoadingPointsThe information about the material loading points that will be valid after the machine specification is changed.
NewMaterialStorageBuffersThe information about the storage buffers that will be valid after the machine specification is changed.
NewMaterialOutputPointsThe information about the material output points that will be valid after the machine specification is changed.
NewMaterialRejectionPointsThe information about the material rejection points that will be valid after the machine specification is changed.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.7 MachineModuleSetupType ObjectType

8.7.1 Overview

The MachineModuleSetupType ObjectType contains the value of all the settings (including mechanical adjustments) required to run production as well as affordances to validate and load settings for the machine module.

This MachineModuleSetupType is formally defined in the table below.

Table 44 – MachineModuleSetupType Definition
Attribute Value
BrowseNameMachineModuleSetupType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasPropertyVariableDataSetDataSetType0:PropertyTypeM, RW
0:HasComponentMethodLoadDataSetSee below.O
0:HasComponentMethodLoadMaterialListSee below.O
0:HasPropertyVariableMaterialListMaterialListType0:PropertyTypeM, RO
0:HasComponentObjectMechanicalAdjustments0:FolderTypeM
0:HasComponentObjectDataSetFolder0:FolderTypeM
0:HasComponentMethodValidateDataSetSee below.O
0:HasComponentMethodValidateMaterialListSee below.O
0:GeneratesEventObjectTypeDataSetChangeLogTypeM
Conformance Units
TMC Single PO Production
TMC Advanced Setup
BrowseName Description
DataSet DataSet contains all the digital settings (other than the mechanical settings stored in the folder MechanicalAdjustments) required by the machine module.
MaterialList MaterialList contains the list of materials that are going to be used for the production of the current production order.
MechanicalAdjustmentsThe MechanicalAdjustments folder contains the non-digital settings required to setup the machine e.g. mechanical adjustments.
DataSetFolderThe DataSetFolder contains the DataSet including values and descriptions. It contains the same information as DataSet but in a way that is friendlier to simple clients.

The components of the MachineModuleSetupType have additional subcomponents which are defined in the table below.

Table 45 – MachineModuleSetupType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
MechanicalAdjustments0:HasPropertyVariable <DocumentName>0:ByteString 0:PropertyTypeOP, RO
DataSetFolder0:HasComponentVariable DataSetID0:String 0:DataItemTypeM, RW
DataSetFolder0:HasComponentVariable DataSetDescription0:LocalizedText 0:DataItemTypeM, RW
DataSetFolder0:HasComponentVariable <DataSetValue>0:BaseDataType 0:DataItemTypeOP, RW

8.7.2 LoadDataSet Method

The LoadDataSet Method loads the dataset to the underlying system after having validated that (a) the dataset is complete when IsCompleteDataset is True and (b) the dataset is valid.

When the validation is not passed, then the data set is not loaded to the underlying system rolling back any data change and a specific message shall be returned via ExecutionFeedback.

For detailed validation diagnostics, the Method ValidateDataSet shall be invoked.

The signature of this Method is specified below. Table 46 specifies the Arguments representation.

Signature

	LoadDataSet (
	[in]		DataSetType						DataSet,
	[in]		Boolean							IsCompleteDataSet,
	[out] 	MethodExecutionFeedbackType		ExecutionFeedback);
Table 46 – LoadDataSet Method Arguments
Argument Description
DataSetThe dataset to be transferred to the underlying system.
IsCompleteDataSetWhen true, the DataSet argument is a complete dataset, meaning all DataSet entries are included.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.7.3 LoadMaterialList Method

The LoadMaterialList Method loads the material list to the underlying system after having validated that (a) the material list is complete and (b) the material list is valid.

When the validation is not passed, then the material list is not loaded to the underlying system rolling back any data change and a specific message shall be returned via ExecutionFeedback.

For detailed validation diagnostics, the Method ValidateMaterialList shall be invoked.

The signature of this Method is specified below. Table 47 specifies the Arguments representation.

Signature

	LoadDataSet (
	[in]		MaterialListType				MaterialList,
	[out] 	MethodExecutionFeedbackType		ExecutionFeedback);
Table 47 – LoadMaterialList Method Arguments
Argument Description
MaterialListThe material list to be transferred to the underlying system.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.7.4 ValidateDataSet Method

The ValidateDataSet Method transfers a dataset, complete when IsCompleteDataSet is True, to the underlying system and returns the result of the validation, i.e. verifying that the dataset is complete and can run in production.

When the ValidateDataSet Method is executed, the DataSet variable is not affected. If the validation is not passed, the identifiers of the datapoints that did not pass are provided with the ExecutionFeedback.

The validation of the DataSet normally occurs before the DataSet is required, i.e. while production is running and using a different dataset. As a matter of fact, the ValidateDataSet Method is used to validate a DataSet beforehand giving time to the higher-level systems in charge to correct mistakes. Thus the underlying system is required to provide all affordances to perform the validation without disrupting running production orders.

The signature of this Method is specified below. Table 48 specifies the Arguments representation.

Signature

	ValidateDataSet (
	[in]		DataSetType					DataSet,
	[in] 	Boolean						IsCompleteDataSet,
	[out] 	DataSetEntryType[]	 		FailedValidationEntries,
	[out] 	MessageType[]					FailedValidationMessages,
	[out] 	MethodExecutionFeedbackType	ExecutionFeedback);
Table 48 – ValidateDataSet Method Arguments
Argument Description
DataSetThe dataset to be validated by the underlying system.
IsCompleteDataSetWhen true, the DataSet argument is a complete dataset, meaning all DataSet entries are included.
FailedValidationEntriesThe dataset items that failed the validation.
FailedValidationMessagesThe detailed reasons the validation failed.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.7.5 ValidateMaterialList Method

The ValidateMaterialList Method transfers a material list to the underlying system and returns the result of the validation, i.e. verifying that the material list is complete and can run in production.

When the ValidateMaterialList is executed, the MaterialList variable is not affected. If the validation is not passed, the identifiers of the materials that did not pass are provided with the ExecutionFeedback.

The validation of the MaterialList normally occurs before the MaterialList is required, i.e. while production is running and using a different material list. As a matter of fact, the ValidateMaterialList Method is used to validate a MaterialList beforehand giving time to the higher-level systems in charge to correct mistakes. Thus the underlying system is required to provide all affordances to perform the validation without disrupting running production orders.

The signature of this Method is specified below. Table 49 specifies the Arguments representation.

Signature

	ValidateMaterialList (
	[in]		MaterialListType			MaterialList,
	[out] 	MaterialListItemType[] 		FailedValidationEntries,
	[out] 	MessageType[]				FailedValidationMessages,
	[out] 	MethodExecutionFeedbackType	ExecutionFeedback);
Table 49 – ValidateMaterialList Method Arguments
Argument Description
MaterialListThe material list to be validated by the underlying system.
FailedValidationEntriesThe material list items that failed the validation.
FailedValidationMessagesThe detailed reasons the validation failed.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.8 MaterialLoadingPointType ObjectType

8.8.1 Overview

The MaterialLoadingPointType ObjectType describes the machine module part where materials are loaded (either manually or by means of an automated system or both) and the materials being loaded, as well as the brand integrity checks required.

The MaterialLoadingPointType is formally defined in the following table.

Table 50 – MaterialLoadingPointType Definition
Attribute Value
BrowseNameMaterialLoadingPointType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the TMCDeviceType i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariableActualDispensingRate0:DoubleMaterialRateTypeM, RO, HR
0:HasComponentVariableConsumedMaterialMasterTotal0:DoubleMaterialQuantityVariableTypeM, RO
0:HasComponentVariableConsumedMaterialTotal0:DoubleMaterialQuantityVariableTypeM, RO, HR
0:HasComponentVariableDispensedMaterialMasterTotal0:DoubleMaterialQuantityVariableTypeM, RO
0:HasComponentVariableDispensedMaterialTotal0:DoubleMaterialQuantityVariableTypeM, RO, HR
0:HasComponentVariableDispensingRateState0:LocalizedText0:StateVariableTypeM, RO, HR
0:HasPropertyVariableExpectedMaterialsMaterialSublotType[]0:PropertyTypeM, RO
0:HasComponentVariableLoadedMaterialMaterialSublotType[]0:BaseDataVariableTypeM, RO
0:HasPropertyVariableMaterialPointDefinitionMaterialPointType0:PropertyTypeM, RO
0:HasPropertyVariableMaterialIntegrityAgentMaterialIntegrityAgentEnumeration0:PropertyTypeM, RW
0:HasPropertyVariableMES_ID0:String0:PropertyTypeM, RW
0:HasComponentVariableNominalDispensingRate0:DoubleMaterialRateTypeM, RO
0:HasComponentVariablePresentedMaterialMaterialSublotType0:BaseDataVariableTypeM, RW
0:HasComponentVariablePresentedMaterialValidationStatusMaterialValidationStatusEnumeration0:BaseDataVariableTypeM, RO
0:HasComponentMethodSetPresentedMaterialValidationStatusSee below.M
0:HasPropertyVariableAllowMixedLots0:Boolean0:PropertyTypeM, RW
0:HasPropertyVariableUpstreamHold0:Boolean0:PropertyTypeM, RO
0:GeneratesEventObjectTypeIntegrityRejectedMaterialLogType
0:GeneratesEventObjectTypeLoadingPointUnloadedLogType
0:GeneratesEventObjectTypeMaterialConsumedLogType
0:GeneratesEventObjectTypeMaterialDispensedLogType
0:GeneratesEventObjectTypeMaterialUnloadingRequiredLogType
0:GeneratesEventObjectTypeNewPresentedMaterialLogType
Conformance Units
TMC Core Production
BrowseName Description
ActualDispensingRateThe actual rate at which the input material is being dispensed.
ConsumedMaterialMasterTotalThe total quantity of material that entered the machine loading point. This total is never reset.
ConsumedMaterialTotal

The total quantity of material that entered the machine loading point. When the material is loaded, it may be immediately dispensed or may be stored and dispensed when required according to the machine logic. When the material is immediately dispensed, the consumed material quantity equals the dispensed material quantity (DispensedMaterialTotal).

The quantity is reset by the successful execution of the ResetMachineTotals method, only.

DispensedMaterialMasterTotalThe total quantity of material dispensed at the machine after loading at the loading point. This total is never reset.
DispensedMaterialTotalThe total quantity of material dispensed at the machine after loading at the loading point. The quantity is reset by the successful execution of the ResetMachineTotals method, only.
DispensingRateState

The DispensingRateState provides information about the state of the dispensing rate justifying why the ActualDispensingRate is different from the NominalDispensingRate. At a minimum the list of states below shall be provided:

Id=0, Speed is at Nominal value

Id=1, Speed Changed by Operator

Id=2, Speed Followed from Downstream Internal

Id=3, Speed Reduced due to low input material

Id=4, Speed Reduced due to internal high input material level

Id=5, Speed Reduced due to Filling Mode

Id=6, Speed Reduced due to internal procedure (e.g. calibration)

Id=7, Speed Reduced due to input material change (e.g. foil splicing, inner frame bobbin change, etc.)

Id=8, Speed Changed by Remote Host

When the actual rate is not measured, Id=0 Speed is at Nominal value will be returned. The speed set by an external host, if any, is used as the NominalDispensingRate.

Null speed is a speed reduction. The list may be extended for specific states not already covered in the list above.

ExpectedMaterialsThe array of sublots of the material that are expected at the machine loading point for the current production. ExpectedMaterials is a set of MaterialListItems such that the UserMachineName in LoadingPoint matches the LoadingPointID of the MaterialListItem.
LoadedMaterial

An array of the sublots that entered the machine loading point. When a sublot is unloaded, it is also removed from the array.

The sublot in the first position is the sublot from which the machine module is currently dispensing the material. The quantity of the sublot in the first position is decreased by an amount equal to the dispensing.

MaterialPointDefinitionThe Property MaterialPointDefinition contains the identification of the material point and the material that is processed.
MaterialIntegrityAgent

MaterialIntegrityAgent defines how material validation is performed. The scenarios taken into consideration are defined by the MaterialIntegrityEnumeration:

None: the material validation is not requested. In this case the underlying system sets MaterialValidationResult to None.

External: an external system performs the material validation. The external system validates the PresentedMaterial and invokes the SetValidationResult method to transfer the validation results to the machine.

Local: the underlying system performs the material validation on the PresentedMaterial and sets the result in MaterialValidationResult.

When an unsupported value is written to the variable, the underlying system will overwrite it with a supported one.

MES_IDUnique identifier for the material point in an external system, e.g. MES.
NominalDispensingRateThe nominal rate at which the input material is dispensed when the machine runs at design speed.
PresentedMaterial

The material presented to the material loading point, but not yet loaded.

When the material is loaded, the underlying system resets the PresentedMaterial and the MaterialValidationStatus to Failed.

When an upstream machine is connected, the material output from the upstream machine is the presented material.

Read/Write to allow for external systems to request the validation of a material. When the PresentedMaterial changes, the validation system performs validation.

PresentedMaterialValidationStatusThe status of the validation of the presented material. When Passed, the presented material is loaded by the machine module; when Failed, the presented material will be removed from the loading point, either automatically or manually. When InProgress, the validation is in progress. When MaterialIntegrityAgent is None and MaterialPresented is empty, then the value is None.
AllowMixedLotsWhen AllowMixedLots is False and BatchManaged in the material definition of the ExpectedMaterials is True, then one material lot will be processed i.e. the first material lot received.
UpstreamHold UpstreamHold is true when the loading point cannot receive more product and the upstream machine is required to stop loading, False when the loading point can receive product.

8.8.2 SetPresentedMaterialValidationStatus Method

The SetPresentedMaterialValidationStatus Method provides a client with an affordance to perform the validation of the PresentedMaterial against the ExpectedMaterials and set the result of the validation in the PresentedMaterialValidationStatus variable.

The method is called by the material integrity agent, i.e. when MaterialIntegrityAgent is External.

The method is executed only when the MaterialValidationStatus is Waiting.

The signature of this Method is specified below. Table 51 specifies the Arguments representation.

Signature

	SetPresentedMaterialValidationStatus (
	  [in]  MaterialValidationStatusEnumeration		ValidationResult,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 51 – SetPresentedMaterialValidationStatus Method Arguments
Argument Description
ValidationResultThe result of the validation of the PresentedMaterial.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

The material validation is performed checking (1) a sublot, (2) material lot of the sublot and (3) material definition of the PresentedMaterial against each material sublot in the ExpectedMaterials array. When one matches, the PresentedMaterial is valid and its ValidationStatus is set to True, otherwise False.

The PresentedMaterial is compared against a material sublot from the ExpectedMaterials array as follows being valid when all checks are True:

Sublot:

The PresentedMaterial sublot MES_ID is equal to the sublot MES_ID of a material sublot from the ExpectedMaterials. If the MES_ID of a material sublot from the ExpectedMaterials is Null, then the result of the check is true.

Material lot:

If AllowMixedLots is True, then the result of the check is True. If AllowMixedLots is False, then the result of the check is True for the first presented MaterialSublot and for all subsequent MaterialSublots of the same MaterialLot.

The PresentedMaterial MaterialStockStatus is Unrestricted or equal to the ExpectedMaterial MaterialStockStatus. For example, a ripping machine processes blocked material.

The BestUsedBeforeDate of the material sublot from the ExpectedMaterials is not greater than the current date. If BestUsedBeforeDate is NULL, then the result of this check is true.

Material Definition:

The PresentedMaterial material definition MES_ID is equal to an ExpectedMaterial material definition MES_ID. If the ExpectedMaterial MES_ID is Null, then the result of the check is true.

When the material is validated, the machine proceeds loading it. If it is not validated, the IntegrityRejectedMaterialLogType event is triggered and when the PresentedMaterial is unloaded and the loading procedure terminates, the LoadingPointUnloadedLogType event is generated. If the underlying system cannot reject the invalid material automatically, a MaterialUnloadingRequiredLogType event is generated.

8.9 MaterialOutputPointType ObjectType

8.9.1 Overview

This OPC UA MaterialOutputPointType ObjectType describes the capability and real time information about the hand-over point of material from one machine module to another.

The MaterialOutputPointType is formally defined in the following table.

Table 52 – MaterialOutputPointType Definition
Attribute Value
BrowseNameMaterialOutputPointType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the TMCDeviceType i.e. inheriting the Instance Declarations of that Node.
0:HasPropertyVariableDownstreamHeld0:Boolean0:PropertyTypeM, RO
0:HasComponentVariableNominalProductionRate0:DoubleMaterialRateTypeM, RO
0:HasComponentVariableProducedMaterialMasterTotal0:DoubleMaterialQuantityVariableTypeM, RO
0:HasPropertyVariableMaterialDefinitionMaterialDefinitionType0:PropertyTypeM, RO
0:HasPropertyVariableMES_ID0:String0:PropertyTypeM, RW
0:HasComponentVariableActualProductionRate0:DoubleMaterialRateTypeM, RO, HR
0:HasComponentVariableProducedMaterialMaterialSublotType0:BaseDataVariableTypeM, RO
0:HasComponentVariableProducedMaterialTotal0:DoubleMaterialQuantityVariableTypeM, RO, HR
0:HasComponentVariableProductionRateState0:LocalizedText0:StateVariableTypeM, RO, HR
0:HasPropertyVariableMaterialPointDefinitionMaterialPointType0:PropertyTypeM, RO
0:GeneratesEventObjectTypeMaterialOutputProducedLogType
Conformance Units
TMC Data Collection
BrowseName Description
DownstreamHeld

When the downstream machine module cannot receive the product flow, the upstream machine is required to hold the transfer of product to the downstream machine module.

The Variable DownstreamHeld is True when the corresponding Variable UpstreamHold in the connected MaterialLoadingPoint is True.

NominalProductionRate The nominal rate at which the output is produced, a.k.a. the machine design speed.
ProducedMaterialMasterTotalThe total quantity of complete sublots created at the machine material output. The value is never reset.
MaterialDefinitionThe material definition of the material that the material output is expected to produce.
MES_IDA higher-level system e.g., MES, identification of the carrier.
ProducedMaterialThe sublot currently being produced by the material output. The sublot quantity is updated by the underlying system as output is generated.
ActualProductionRate The actual rate at which the output is being produced.
ProducedMaterialTotalThe total quantity of complete sublots created at the machine material output.
ProductionRateState

The ProductionRateState provides information about the state of the production rate justifying why the ActualProductionRate is different from the NominalProductionRate. At a minimum the list of states below shall be provided:

Id=0, Speed is at Nominal value

Id=1, Speed Changed by Operator

Id=2, Speed Followed from Downstream Machine

Id=3, Speed Reduced due to high material level at outfeed

Id=4, Speed Reduced due to internal low material level

Id=5, Speed Reduced due to Emptying Mode

Id=6, Speed Reduced due to internal procedure (e.g. calibration)

Id=7, Speed Reduced due to input material change (e.g. foil splicing, inner frame bobbin change, etc.)

Id=8, Speed Changed by Remote Host

When the actual rate is not measured, Id=0 Speed is at Nominal value will be returned. The speed set by an external host, if any, is used as the NominalProductionRate.

Null speed is a speed reduction. The list may be extended for specific states not already covered in the list above.

MaterialPointDefinitionThe Property MaterialPointDefinition contains the identification of the material point and the material that is processed.

8.10 MaterialStorageBufferType ObjectType

The MaterialStorageBufferType ObjectType describes locations where the product is stored in a machine module and the stored product.

The MaterialStorageBufferType representation in the AddressSpace is formally defined in the following table.

Table 53 – MaterialStorageBufferType Definition
Attribute Value
BrowseNameMaterialStorageBufferType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the TMCDeviceType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariableActualLoadingRate0:DoubleMaterialRateTypeM, RO, HR
0:HasComponentVariableLoadingRateState0:LocalizedText0:StateVariableTypeM, RO, HR
0:HasPropertyVariableMaterialPointDefinitionMaterialStorageBufferDataType0:PropertyTypeM, RO
0:HasPropertyVariableMES_ID0:String0:PropertyTypeM, RW
0:HasPropertyVariableMixingLogicStorageMixingLogicEnumeration0:PropertyTypeM, RW
0:HasComponentVariableNominalLoadingRate0:DoubleMaterialRateTypeM, RO
0:HasComponentVariableNominalUnloadingRate0:DoubleMaterialRateTypeM, RO
0:HasPropertyVariableStorageLogicStorageLogicEnumeration0:PropertyTypeM, RO
0:HasComponentVariableStoredLot0:DoubleMaterialLotVariableTypeM, RO, HR
0:HasPropertyVariableTotalStorageCapacity0:Double0:PropertyTypeM, RW
0:HasComponentVariableActualUnloadingRate0:DoubleMaterialRateTypeM, RO, HR
0:HasComponentVariableUnloadingRateState0:LocalizedText0:StateVariableTypeM, RO, HR
Conformance Units
TMC Core Production
BrowseName Description
IDThe unique identifier for the material storage buffer.
ActualLoadingRateThe rate at which the material is loaded onto the material storage buffer. The variable ActualLoadingRate indicates the quantity of the material consumed in 60 seconds.
LoadingRateState

The LoadingRateState provides information about the state of the loading rate justifying why the ActualLoadingRate is different from the NominalLoadingRate. At a minimum the list of states below shall be provided:

Id=0, Speed is at Nominal value

Id=1, Speed Changed by Operator

Id=2, Speed Followed from Upstream Internal

Id=3, Speed Reduced due to Upstream Internal low material level

Id=4, Speed Reduced due to internal high material level

Id=5, Speed Reduced due to Filling Mode

Id=6, Speed Reduced due to internal procedure (e.g. calibration)

Id=7, Speed Reduced due to input material change (e.g. foil splicing, inner frame bobbin change, etc.)

Id=8, Speed Changed by Remote Host

When the actual rate is not measured, Id=0 Speed is at Nominal value will be returned. The speed set by an external host, if any, is used as the NominalLoadingRate.

Null speed is a speed reduction. The list may be extended for specific states not already covered in the list above.

MaterialPointDefinitionThe Property MaterialPointDefinition contains the identification of the material point and the material that is processed or stored in the buffer.
MES_IDThe unique identifier of the material buffer storage according to a higher-level system, e.g. MES or ERP.
MixingLogic MixingLogic identifies if and how materials can be mixed in the MaterialStorageBuffer.
NominalLoadingRateThe MaterialStorageBuffer loading rate at nominal conditions.
NominalUnloadingRateThe MaterialStorageBuffer unloading rate at nominal conditions.
StorageLogicThe logic used at the buffer storage to store and retrieve material.
StoredLotThe material stored in the material storage buffer.
TotalStorageCapacityThe total capacity of the material storage buffer.
ActualUnloadingRateThe rate at which the material is unloaded from the material storage buffer. The variable ActualUnloadingRate indicates the quantity of the material consumed in 60 seconds.
UnloadingRateState

The UnloadingRateState provides information about the state of the unloading rate justifying why the ActualUnloadingRate is different from the NominalUnloadingRate. At a minimum the list of states below shall be provided:

Id=0, Speed is at Nominal value

Id=1, Speed Changed by Operator

Id=2, Speed Followed from Downstream Internal

Id=3, Speed Reduced due to low material level

Id=4, Speed Reduced due to Downstream Internal high material level

Id=5, Speed Reduced due to Emptying Mode

Id=6, Speed Reduced due to internal procedure (e.g. calibration)

Id=7, Speed Reduced due to input material change (e.g. foil splicing, inner frame bobbin change, etc.)

Id=8, Speed Changed by Remote Host

When the actual rate is not measured, Id=0 Speed is at Nominal value will be returned. The speed set by an external host, if any, is used as the NominalUnloadingRate.

Null speed is a speed reduction. The list may be extended for specific states not already covered in the list above.

8.11 MaterialRejectionPointType ObjectType

8.11.1 Overview

The MaterialRejectionPointType describes a device that is capable of rejecting product from the product flow. The MaterialRejectionPointType is formally defined in the following table.

Table 54 – MaterialRejectionPointType Definition
Attribute Value
BrowseNameMaterialRejectionPointType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the TMCDeviceType, i.e. inheriting the Instance Declarations of that Node.
0:HasPropertyVariableMaterialDefinitionMaterialDefinitionType0:PropertyTypeM, RO
0:HasPropertyVariableMES_ID0:String0:PropertyTypeM, RW
0:HasComponentVariableRejectedMaterialMasterTotal0:DoubleMaterialQuantityVariableTypeM, RO
0:HasComponentVariableRejectedMaterialTotal0:DoubleMaterialQuantityVariableTypeM, RO, HR
0:HasComponentVariableRejectedMaterialRatio0:Double0:BaseDataVariableTypeM, RO
0:HasComponentVariableRejectionCountMasterTotal0:UInt640:BaseDataVariableTypeM, RO
0:HasComponentVariableRejectionCountTotal0:UInt640:BaseDataVariableTypeM, RO, HR
0:HasPropertyVariableRejectionMode0:Boolean0:PropertyTypeM, RW
0:HasPropertyVariableMaterialPointDefinitionMaterialPointType0:PropertyTypeM, RO
0:HasComponentVariableRejectionsRatio0:Double0:BaseDataVariableTypeM, RO, HR
0:HasComponentMethodSetRejectionModeSee below.O
0:GeneratesEventObjectTypeMaterialRejectedLogType
0:GeneratesEventObjectTypeRejectionModeChangeLogType
Conformance Units
TMC Data Collection
BrowseName Description
MaterialDefinitionThe material definition for the material to be rejected at the rejection trap.
MES_IDUnique identifier for the material point in an external system, e.g. MES.
RejectedMaterialMasterTotalThe total material quantity rejected at the rejection trap. The total is never reset to zero.
RejectedMaterialTotalThe total material quantity rejected at the rejection trap. The total is reset to zero only when the ResetRejecitonTotals is invoked.
RejectedMaterialRatioThe Variable MaterialRejectedRatio is the ratio of the total material rejected (MaterialRejectedTotal) over the total good product and is computed by the underlying system.
RejectionCountMasterTotalThe total number of times the rejection trap was triggered. The total is never reset to zero.
RejectionModeWhen RejectionMode is True, the rejection trap discharges material when triggered, otherwise no material is rejected.
MaterialPointDefinitionThe Property MaterialPointDefinition contains the identification of the material point and the material that is processed.
RejectionsRatioThe Variable RejectionsRatio is the ratio between the good product output total and the rejected quantity total.
RejectionCountTotalThe total number of times the rejection trap was triggered. The total is reset to zero only when the ResetRejectionTotals is invoked.

8.11.2 SetRejectionMode Method

The Method SetRejectionMode enables or disables the rejection trap.

The signature of this Method is specified below. Table 55 specifies the Arguments representation.

Signature

	SetRejectionMode (
	  [in]  0:Boolean     					RejectionMode,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 55 – SetRejectionMode Method Arguments
Argument Description
RejectionModeWhen True, the rejection trap rejects.When False, the rejection trap does not reject.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.12 DefectDetectionSensorType ObjectType

8.12.1 Overview

The DefectDetectionSensorType represents a sensor or sensing system fitted to the machine module that detects product defects or a quality sampling point that can be triggered by an operator.

The DefectDetectionSensorType is formally defined in the following table.

Table 56 – DefectDetectionSensorType Definition
Attribute Value
BrowseNameDefectDetectionSensorType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the TMCDeviceType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObject<SensorFunction>SensorFunctionTypeMP
0:HasComponentObjectData0:FolderTypeO
0:HasComponentVariableDetectionCountMasterTotal0:UInt640:BaseDataVariableTypeM, RO
0:HasComponentVariableDetectionCountTotal0:UInt640:BaseDataVariableTypeM, RO, HR
0:HasPropertyVariableDetectionMode0:Boolean0:PropertyTypeM, RW
0:HasComponentMethodSetDetectionModeSee below.O
0:GeneratesEventObjectTypeDetectionModeChangeLogType
Conformance Units
TMC Quality Assurance and Control
BrowseName Description
SensorFunctionThe sensor functions that the defect detection sensor or system is measuring.
DetectionCountMasterTotalThe total number of times a detection occurred. The total is never reset to zero.
DetectionCountTotalThe total number of times a detection occurred. The total is reset to zero only when the ResetProductionTotals method in the MachineModuleProductionType is executed successfully.
DetectionModeWhen DetectionMode is True, the defect detection sensor or system detects defects and the inner sensor functions are enabled, meaning they can be active or not. When DetectionMode is False, the inner sensor functions are also not active.

The components of the DefectDetectionSensorType have additional subcomponents which are defined in the following table.

Table 57 – DefectDetectionSensorType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
Data0:HasComponent Variable<DataItem>0:BaseDataType0:BaseDataVariableTypeOP, RO

8.12.2 SetDetectionMode Method

The Method SetDetectionMode enables or disables the defect detection sensor.

The signature of this Method is specified below. Table 58 specifies the Arguments representation.

Signature

	SetDetectionMode (
	  [in]  0:Boolean     					Enable,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 58 – SetDetectionMode Method Arguments
Argument Description
EnableSpecifies if the method enables, when True, or disables, when False, the defect detection sensor.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

The Method SetDetectionMode sets the DetectionMode of the defect detection sensor and of its components, i.e. sensor functions and defect reasons.

8.13 SensorFunctionType ObjectType

8.13.1 Overview

The SensorFunctionType describes a single measuring function or quality sampling function and is formally defined in the following table.

Table 59 – SensorFunctionType Definition
Attribute Value
BrowseNameSensorFunctionType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObject<DefectReason>DefectReasonTypeOP
0:HasPropertyVariableDetectionMode0:Boolean0:PropertyTypeM, RW
0:HasComponentMethodLoadReferenceFeaturesSee below.O
0:HasComponentVariableSensorValue0:Number0:AnalogUnitTypeO, RO
0:HasComponentMethodSetDetectionModeSee below.O
0:HasComponentObjectUIInfoUIInformationTypeO
0:GeneratesEventObjectTypeDetectionModeChangeLogType
Conformance Units
TMC Quality Assurance and Control
BrowseName Description
<DefectReason>The defect reasons triggered by the sensor function.
DetectionModeWhen DetectionMode is True, the sensor function measures the sensor value and the inner defect reasons are enabled, meaning they can be active or not. When DetectionMode is False, the inner defect reasons are also not active.
SensorValueThe value measured for the sensor function.
UIInfoThe visualization resources to display the SensorFunctionType on the User Interface.

8.13.2 LoadReferenceFeatures Method

The Method LoadReferenceFeatures loads binary profiles to be used as references for defect detection.

The signature of this Method is specified below. Table 60 specifies the Arguments representation.

Signature

	LoadReferenceFeatures (
	  [in]  0:ByteString[]     				Features,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 60 – LoadReferenceFeatures Method Arguments
Argument Description
FeaturesThe list of binary profiles used as references for a detection system.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.13.3 SetDetectionMode

The Method SetDetectionMode enables or disables the defect detection sensor.

The signature of this Method is specified below. Table 61 specifies the Arguments representation.

Signature

	SetDetectionMode (
	  [in]  0:Boolean     					Enable,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 61 – SetDetectionMode Method Arguments
Argument Description
EnableSpecifies if the method enables, when True, or disables, when False, the sensor function.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

The Method SetDetectionMode sets the DetectionMode of the sensor function and of its components, i.e. the defect reasons.

8.14 DefectReasonType ObjectType

8.14.1 Overview

The DefectReasonType describes a defect reason that is monitored by a SensorFunction. The DefectReasonType is formally defined in the following table.

Table 62 – DefectReasonType Definition
Attribute Value
BrowseNameDefectReasonType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasPropertyVariableDetectionMode0:Boolean0:PropertyTypeM, RW
0:HasComponentVariableDetectionCountMasterTotal0:UInt640:BaseDataVariableTypeM, RO
0:HasComponentVariableDetectionCountTotal0:UInt640:BaseDataVariableTypeM, RO, HR
0:HasComponentObjectUIInfoUIInformationTypeO
0:HasComponentMethodSetDetectionModeSee below.O
0:GeneratesEventObjectTypeDetectionModeChangeLogType
0:GeneratesEventObjectTypeDefectDetectedLogType
Conformance Units
TMC Quality Assurance and Control
BrowseName Description
DetectionModeWhen DetectionMode is True, the defect reason is triggered. When DetectionMode is False, the defect reason is not active, i.e. never triggered.
DetectionCountMasterTotalThe total number of times the defect reason occurred. The total is never reset to zero.
DetectionCountTotalThe total number of times a defect reason occurred. The total is reset to zero only when the ResetProductionTotals method in the MachineModuleProductionType is executed successfully.
UIInfoThe visualization resources to display the DefectReasonType on the User Interface.

8.14.2 SetDetectionMode

The Method SetDetectionMode enables or disables the defect detection sensor.

The signature of this Method is specified below. Table 63 specifies the Arguments representation.

Signature

	SetDetectionMode (
	  [in]  0:Boolean     					Enable,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 63 – SetDetectionMode Method Arguments
Argument Description
EnableSpecifies if the method enables, when True, or disables, when False, the defect reason.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.15 EquipmentModuleType ObjectType

8.15.1 Overview

The EquipmentModuleType ObjectType represents an equipment module according to the ISA 95 Physical Structure.

The EquipmentModuleType is formally defined in the following table.

Table 64 – EquipmentModuleType Definition
Attribute Value
BrowseNameEquipmentModuleType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the TMCDeviceType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectConfigurationEquipmentModuleConfigurationTypeM
0:HasComponentObjectControlModules0:FolderTypeO
0:HasComponentObjectLiveStatusEquipmentModuleLiveStatusTypeM
0:HasComponentObjectProcessControlLoops0:FolderTypeO
0:HasComponentObjectProcessItems0:FolderTypeO
0:HasComponentObjectSetupEquipmentModuleSetupTypeM
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
ConfigurationThe Configuration contains all digital settings, stop reasons and root causes of an equipment module.
ControlModulesThe ControlModules folder contains the control modules belonging to the equipment module.
LiveStatusThe LiveStatus Object contains information about the real time status of the equipment module and provides affordances to control the equipment module remotely in real time.
ProcessControlLoopsThe ProcessControlLoops folder contains process control loops of the equipment module.
ProcessItemsThe ProcessItems folder contains process items of the equipment module.
SetupThe Setup Object contains the value of all the settings (including mechanical adjustments) required to run production as well as affordances to validate and load settings for the equipment module.

The components of the EquipmentModuleType have additional subcomponents which are defined in the following table.

Table 65 – EquipmentModuleType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
ControlModules0:HasComponent Object <ControlModule> ControlModuleTypeOP
ControlModules0:HasComponent Object AnalogInputs 0:FolderTypeO
0:HasComponent Object <AnalogInput> AnalogInputTypeOP
ControlModules0:HasComponent Object DigitalInputs 0:FolderTypeO
0:HasComponent Object <DigitalInput> DigitalInputTypeOP
ControlModules0:HasComponent Object Motors 0:FolderTypeO
0:HasComponent Object <Motor> MotorTypeOP
ControlModules0:HasComponent Object Sensors 0:FolderTypeO
0:HasComponent Object <Sensor> SensorTypeOP
ControlModules0:HasComponent Object Valves 0:FolderTypeO
0:HasComponent Object <Valve> ValveTypeOP
ProcessControlLoops0:HasComponentObject <ProcessControlLoop> ProcessControlLoopTypeOP
ProcessItems0:HasComponentObject <ProcessItem> ProcessItemTypeOP
ProcessItems0:HasComponentObject <ProcessControlItem> ProcessControlItemTypeOP

8.16 EquipmentModuleConfigurationType ObjectType

8.16.1 Overview

The EquipmentModuleConfigurationType ObjectType contains all digital settings, stop reasons and root causes of an equipment module.

The EquipmentModuleConfigurationType is formally defined in the following table.

Table 66 – EquipmentModuleConfigurationType Definition
Attribute Value
BrowseNameEquipmentModuleConfigurationType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariable<ConfigurationItem>0:BaseDataType0:DataItemTypeOP, RO
0:HasPropertyVariableLastChangeDate0:UtcTime0:PropertyTypeM, RO
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
ConfigurationItemA data item used for configuration of the equipment module such as for example a setting, stop reason, root cause or another editable field. The data item type is any BaseDataType, e.g., string, float, integer and so on, for maximum flexibility.
LastChangeDateThe UTC date and time when the configuration was last changed.

8.17 EquipmentModuleLiveStatusType ObjectType

8.17.1 Overview

The EquipmentModuleLiveStatusType ObjectType contains information about the real time status of the equipment module and provides affordances to control the control module remotely in real time.

The EquipmentModuleLiveStatusType is formally defined in the following table.

Table 67 – EquipmentModuleLiveStatusType Definition
Attribute Value
BrowseNameEquipmentModuleLiveStatusType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentMethodAcknowledgeAlarmsSee below.O
0:HasComponentObjectAlarms0:FolderTypeM
0:HasPropertyVariableControlModeControlModeEnumeration0:PropertyTypeM, RW
0:HasComponentObjectData0:FolderTypeO
0:HasComponentMethodSendCommandSee below.O
0:HasComponentMethodSetControlModeSee below.O
0:HasPropertyVariableStateStateEnumeration0:PropertyTypeM, RO
0:HasComponentObjectStateMachineTMCStateMachineTypeO
0:GeneratesEventObjectTypeDiscreteAlarmType
0:GeneratesEventObjectTypeControlModeChangeLogType
0:GeneratesEventObjectTypeStateChangeLogType
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
AlarmsThe Alarms folder contains alarms of the equipment module.
ControlModeThe ControlMode describes the current control mode of the equipment module.
DataThe Data folder provides additional production data that is not already identified by TMC.
StateThe State Property describes the status of the state machine controlling the equipment module. State provides a subset of the information of the state machine when the latter is implemented.
StateMachineThe state machine describes the current state of the equipment module, the possible transitions, and their conditions.

The components of the EquipmentModuleLiveStatusType have additional subcomponents which are defined in the following table.

Table 68 – EquipmentModuleLiveStatusType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
Alarms0:HasComponentObject <Alarm> 0:DiscreteAlarmTypeOP
Data0:HasComponentVariable <DataItem> 0:BaseDataType 0:BaseDataVariableTypeOP, RO

8.17.2 AcknowledgeAlarms Method

The AcknowledgeAlarms method acknowledges the alarms of the equipment module and control modules belonging to it.

The signature of this Method is specified below. Table 69 specifies the Arguments representation.

Signature

	AcknowledgeAlarms (
	  [out] 	MethodExecutionFeedbackType		ExecutionFeedback);
Table 69 – AcknowledgeAlarms Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.17.3 SendCommand Method

The Method SendCommand sends a command to change the state of the equipment module state machine remotely.

The signature of this Method is specified below. Table 70 specifies the Arguments representation.

Signature

	SendCommand (
	  [in]  CommandEnumeration				Command,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 70 – SendCommand Method Arguments
Argument Description
CommandThe command to be sent to the machine module.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.17.4 SetControlMode Method

The SetControlMode Method sets the control mode of the equipment module.

The signature of this Method is specified below. Table 71 specifies the Arguments representation.

Signature

	SetControlMode (
	  [in]  ControlModeEnumeration			ControlMode,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 71 – SetControlMode Method Arguments
Argument Description
ControlModeThe control mode to be set to the machine module.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.18 EquipmentModuleSetupType ObjectType

8.18.1 Overview

The EquipmentModuleSetupType ObjectType contains the value of all the settings required to run as well as affordances to validate and load settings for the equipment module.

The EquipmentModuleSetupType is formally defined in the following table.

Table 72 – EquipmentModuleSetupType Definition
Attribute Value
BrowseNameEquipmentModuleSetupType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariable<SetupItem>0:BaseDataType0:DataItemTypeOP, RW
Conformance Units
TMC Basic Visualisation and Control

8.19 ControlModuleType ObjectType

8.19.1 Overview

The ControlModuleType ObjectType represents a control module according to the ISA 95 Physical Structure.

The ControlModuleType is formally defined in the following table.

Table 73 – ControlModuleType Definition
Attribute Value
BrowseNameControlModuleType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the TMCDeviceType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectAggregatesControlModuleAggregatesTypeO
0:HasComponentObjectConfigurationControlModuleConfigurationTypeM
0:HasComponentObjectLiveStatusControlModuleLiveStatusTypeM
0:HasComponentObjectSetupControlModuleSetupTypeO
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
Aggregates Aggregates contains aggregate information for the control module e.g., running hours for a motor.
Configuration Configuration provides configuration (i.e., seldom changing) settings, stop reasons and root causes of a control module.
LiveStatus LiveStatus Object provides information about the real time status of the control module and affordances to control the control module remotely in real time.
Setup Setup provides the value of all the digital settings required to run the control module.

8.20 ControlModuleAggregatesType ObjectType

8.20.1 Overview

The ControlModuleAggregatesType ObjectType contains aggregated data for the control module e.g. running hours for a motor.

The ControlModuleAggregatesType is formally defined in the following table.

Table 74 – ControlModuleAggregatesType Definition
Attribute Value
BrowseNameControlModuleAggregatesType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariable<AggregateItem>0:BaseDataType0:BaseDataVariableTypeOP, RO
0:HasComponentMethodResetAggregatesSee below.M
0:HasPropertyVariableValidSince0:UtcTime0:PropertyTypeM, RO
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
AggregateItemAn aggregate data item computed by the control module.
ValidSinceThe UTC date and time of the last aggregates reset.

8.20.2 ResetAggregates Method

The ResetAggregates resets the aggregates of the control module.

The signature of this Method is specified below. Table 75 specifies the Arguments representation.

Signature

	ResetAggregates (
	  [out] 	MethodExecutionFeedbackType		ExecutionFeedback);
Table 75 – ResetAggregates Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.21 ControlModuleConfigurationType ObjectType

8.21.1 Overview

The ControlModuleConfigurationType ObjectType contains all digital settings, stop reasons and root causes of a control module.

The ControlModuleConfigurationType is formally defined in the following table.

Table 76 – ControlModuleConfigurationType Definition
Attribute Value
BrowseNameControlModuleConfigurationType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariable<ConfigurationItem>0:BaseDataType0:DataItemTypeOP, RO
0:HasPropertyVariableDeviceLifeSpan0:UInt320:PropertyTypeO, RO
0:HasPropertyVariableValidSince0:UtcTime0:PropertyTypeM, RO
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
ConfigurationItemA digital setting for the control module e.g. parameter, stop reason or root cause.
DeviceLifeSpanThe control module expected life span duration.
ValidSinceThe UTC date and time when the configuration was last changed.

8.22 ControlModuleLiveStatusType ObjectType

8.22.1 Overview

The ControlModuleLiveStatusType ObjectType contains information about the real time status of the control module and provides affordances to control the control module remotely in real time.

The ControlModuleLiveStatusType is formally defined in the following table.

Table 77 – ControlModuleLiveStatusType Definition
Attribute Value
BrowseNameControlModuleLiveStatusType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentMethodAcknowledgeAlarmsSee below.O
0:HasComponentObjectAlarms0:FolderTypeM
0:HasPropertyVariableControlModeControlModeEnumeration0:PropertyTypeM, RW
0:HasComponentObjectData0:FolderTypeO
0:HasComponentObjectInterlocks0:FolderTypeO
0:HasComponentObjectMeasurements0:FolderTypeO
0:HasComponentObjectProcessControlLoops0:FolderTypeO
0:HasComponentMethodSendCommandSee below.O
0:HasComponentMethodSetControlModeSee below.O
0:HasPropertyVariableStateStateEnumeration0:PropertyTypeM, RO
0:HasComponentObjectStateMachineTMCStateMachineTypeO
0:GeneratesEventObjectTypeControlModeChangeLogType
0:GeneratesEventObjectTypeDiscreteAlarmType
0:GeneratesEventObjectTypeStateChangeLogType
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
AlarmsThe Alarms folder provides alarms of the control module.
ControlModeThe ControlMode describes the current control mode of the equipment module.
DataThe Data folder contains additional data whose structure and name are not known in advance.
InterlocksThe Interlocks Folder provides the interlocks that, when not True, do not allow the operation of the control module.
MeasurementsThe Measurement Folder provides measurement values produced by the control module that do not require a dedicated process item e.g., actual motor current.
ProcessControlLoopsThe ProcessControlLoops Folder contains regulation systems of the control module e.g., servo drives.
StateThe State Property describes the status of the state machine controlling the control module. State provides a subset of the information of the state machine, when the latter is implemented.
StateMachineThe StateMachine describes the current state of the control module, the possible transitions, and their conditions.

The components of the ControlModuleLiveStatusType have additional subcomponents which are defined in the following table.

Table 78 – ControlModuleLiveStatusType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
Alarms0:HasComponentObject <Alarm> 0:DiscreteAlarmTypeOP
Data0:HasComponentVariable <DataItem> 0:BaseDataType 0:BaseDataVariableTypeOP, RO
Interlocks0:HasComponentVariable <InterlockConditionItem> 0:Boolean 0:BaseDataVariableTypeOP, RO
Measurements0:HasComponentVariable <MeasurementItem> 0:Number 0:AnalogItemTypeOP, RO
ProcessControlLoops0:HasComponentObject <ProcessControlLoop> ProcessControlLoopTypeOP

8.22.2 AcknowledgeAlarms Method

The AcknowledgeAlarms Method acknowledges the alarms of the control module.

The signature of this Method is specified below. Table 79 specifies the Arguments representation.

Signature

	AcknowledgeAlarms (
	  [out] 	MethodExecutionFeedbackType		ExecutionFeedback);
Table 79 – AcknowledgeAlarms Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.22.3 SendCommand Method

The Method SendCommand sends a command to change the state of the control module state machine remotely.

The signature of this Method is specified below. Table 80 specifies the Arguments representation.

Signature

	SendCommand (
	  [in]  CommandEnumeration				Command,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 80 – SendCommand Method Arguments
Argument Description
CommandThe command to be sent to the machine module.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.22.4 SetControlMode Method

The SetControlMode Method sets the control mode of the control module.

The signature of this Method is specified below. Table 81 specifies the Arguments representation.

Signature

	SetControlMode (
	  [in]  ControlModeEnumeration			ControlMode,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 81 – SetControlMode Method Arguments
Argument Description
ControlModeThe control mode to be set to the machine module.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.23 ControlModuleSetupType ObjectType

8.23.1 Overview

The ControlModuleSetupType ObjectType contains the value of all the settings required to run as well as affordances to validate and load settings for the control module.

The ControlModuleSetupType is formally defined in the following table.

Table 82 – ControlModuleSetupType Definition
Attribute Value
BrowseNameControlModuleSetupType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariable<SetupItem>0:BaseDataType0:DataItemTypeOP, RW
Conformance Units
TMC Basic Visualisation and Control

8.24 UIInformationType ObjectType

8.24.1 Overview

The UIInformationType provides graphical specifications required for creating faceplates to display the information made available by the OPC UA Server.

When the information described in the UIInformationType is provided, an OPC UA Client can render the visualisation without further configuration efforts. Thus a suitable zero-config, zero- engineering visualisation is possible.

The UIInformationType is formally defined in the following table.

Table 83 – UIInformationType Definition
Attribute Value
BrowseNameUIInformationType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentMethodDeleteUIResourceSee below.M
0:HasComponentMethodLoadUIResourceSee below.M
0:HasPropertyVariablePositionX0:Double0:PropertyTypeM, RW
0:HasPropertyVariablePositionY0:Double0:PropertyTypeM, RW
0:HasPropertyVariablePositionZ0:Double0:PropertyTypeM, RW
0:HasPropertyVariableResizable0:Boolean0:PropertyTypeM, RW
0:HasComponentObjectUIResources0:FolderTypeM
0:HasPropertyVariableWidth0:Double0:PropertyTypeM, RW
Conformance Units
TMC Advanced Visualisation and Control
BrowseName Description
PositionX PositionX is the relative horizontal position of the top-left corner of the object rendering in the target visualization scope.
PositionY PositionX is the relative vertical position of the top-left corner of the object rendering in the target visualization scope.
PositionZ PositionZ is the depth of the object rendering in the target visualization scope.
ResizableWhen Resizable is True, the UI resource Width is rescaled based on the actual display size.
UIResources

The UIResources folder contains any number of vectorial images of the object to be rendered in the status/mode defined by the name of the file, e.g. Running.svg is the representation of the object when the status is running.

The server will persist external resources that a client will save into the folder.

Width Width is the width of the object visualization in the target visualization scope.

The components of the UIInformationType have additional subcomponents which are defined in the following table.

Table 84 – UIInformationType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
UIResources0:HasPropertyVariable<ResourceName>0:String0:PropertyTypeOP, RW
UIResources0:HasPropertyVariableDefault0:String0:PropertyTypeM, RW

8.24.2 LoadUIResource Method

The Method LoadUIResource loads a UI resource in the underlying system for visualization. It will override the existing UI resource by the same name.

The signature of this Method is specified below. Table 85 specifies the Arguments representation.

Signature

	LoadUIResource (
	  [in] 	0:String							ResourceName,
	  [in] 	0:String							ResourceValue,
	  [out] 	MethodExecutionFeedbackType		ExecutionFeedback);
Table 85 – LoadUIResource Method Arguments
Argument Description
ResourceNameThe name of the UI resource to be created in the underlying system.
ResourceValueThe value that the UI resource will obtain in the underlying system, i.e. the SVG file.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.24.3 DeleteUIResource Method

The Method DeleteUIResource permanently removes a UI resource from the underlying system memory.

The signature of this Method is specified below. Table 86 specifies the Arguments representation.

Signature

	DeleteUIResource (
	  [in]		0:String							ResourceName,
	  [out] 	MethodExecutionFeedbackType		ExecutionFeedback);
Table 86 – DeleteUIResource Method Arguments
Argument Description
ResourceNameThe name of the UI resource to be deleted from the underlying system.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.25 AnalogInputType ObjectType

The AnalogInputType ObjectType describes an analog input signal.

The AnalogInputType representation in the AddressSpace is formally defined in the following table.

Table 87 – AnalogInputType Definition
Attribute Value
BrowseNameAnalogInputType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ControlModuleType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariableRawValue0:Number0:AnalogItemTypeM, RO
0:HasComponentObjectSetupAnalogInputSetupTypeM
0:HasComponentVariableValue0:Double0:AnalogItemTypeM, RO
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
RawValueThe raw value of the analog input.
SetupThe settings to set up the analog input.
ValueThe engineering unit value of the analog input.

8.26 DigitalInputType ObjectType

The DigitalInputType ObjectType describes a digital input signal.

The DigitalInputType representation in the AddressSpace is formally defined in the following table.

Table 88 – DigitalInputType Definition
Attribute Value
BrowseNameDigitalInputType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ControlModuleType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectSetupDigitalInputSetupTypeM
0:HasComponentVariableValue0:Boolean0:TwoStateDiscreteTypeM, RO
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
SetupThe settings to set up the digital input.
ValueThe raw value of the digital input.

8.27 MotorType ObjectType

The MotorType ObjectType describes a motor.

The MotorType representation in the AddressSpace is formally defined in the following table.

Table 89 – MotorType Definition
Attribute Value
BrowseNameMotorType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ControlModuleType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectAggregatesMotorAggregatesTypeM
0:HasComponentObjectSetupMotorSetupTypeM
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
AggregatesThe aggregated data exposed by the motor.
SetupThe settings to set up the motor.

8.28 SensorType ObjectType

The SensorType ObjectType describes a sensor.

The SensorType representation in the AddressSpace is formally defined in the following table.

Table 90 – SensorType Definition
Attribute Value
BrowseNameSensorType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ControlModuleType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectSetupControlModuleSetupTypeM
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
SetupThe settings to set up the motor.

8.29 ValveType ObjectType

The ValveType ObjectType describes a valve.

The ValveType representation in the AddressSpace is formally defined in the following table.

Table 91 – ValveType Definition
Attribute Value
BrowseNameValveType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ControlModuleType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectAggregatesValveAggregatesTypeM
0:HasComponentObjectConfigurationControlModuleConfigurationTypeM
0:HasComponentObjectSetupValveSetupTypeM
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
AggregatesThe aggregated data exposed by the valve.
ConfigurationThe configuration settings for the valve.
SetupThe settings to set up the valve.

8.30 ControlModuleAggregatesType ObjectType

The ControlModuleAggregatesType ObjectType provides aggregates computed by the underlying system for the control module.

The ControlModuleAggregatesType representation in the AddressSpace is formally defined in the following table.

Table 92 – ControlModuleAggregatesType Definition
Attribute Value
BrowseNameControlModuleAggregatesType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariable<AggregateItem>0:BaseDataType0:BaseDataVariableTypeOP, RO
0:HasComponentMethodResetAggregatesSee below.M
0:HasPropertyVariableValidSince0:UtcTime0:PropertyTypeM, RO
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
AggregateItemA single aggregate data point exposed by the control module.
ValidSinceThe time of the last reset for the aggregates.

8.30.1 ResetAggregates Method

The ResetAggregates Method resets the aggregates of the control module.

The signature of this Method is specified below. Table 93 specifies the Arguments representation.

Signature

	ResetAggregates (
	  [out]	MethodExecutionFeedbackType		ExecutionFeedback);
Table 93 – ResetAggregates Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.31 MotorAggregatesType ObjectType

The MotorAggregatesType ObjectType provides aggregates computed by the underlying system for an analog input.

The MotorAggregatesType representation in the AddressSpace is formally defined in the following table.

Table 94 – MotorAggregatesType Definition
Attribute Value
BrowseNameMotorAggregatesType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ControlModuleAggregatesType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariableTotalRunningHours0:UInt320:BaseDataVariableTypeM, RO
0:HasComponentVariableTotalStartStopCounter0:UInt320:BaseDataVariableTypeM, RO
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
TotalRunningHoursThe total number of running hours for the motor.
TotalStartStopCounterThe total number of times the motor was started and stopped.

8.32 ValveAggregatesType ObjectType

The ValveAggregatesType ObjectType provides aggregates computed by the underlying system for an analog input.

The ValveAggregatesType representation in the AddressSpace is formally defined in the following table.

Table 95 – ValveAggregatesType Definition
Attribute Value
BrowseNameValveAggregatesType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ControlModuleAggregatesType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariableCycleCounter0:UInt320:BaseDataVariableTypeM, RO
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
CycleCounterThe total number of times the solenoid valve was energized and de-energised.

8.33 AnalogInputSetupType ObjectType

The AnalogInputSetupType ObjectType provides settings and other affordance to set up an analog input.

The AnalogInputSetupType representation in the AddressSpace is formally defined in the following table.

Table 96 – AnalogInputSetupType Definition
Attribute Value
BrowseNameAnalogInputSetupType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ControlModuleSetupType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariableForcedValue0:Double0:AnalogItemTypeM, RW
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
ForcedValueThe value to set as the input value when control mode is manual.

8.34 DigitalInputSetupType ObjectType

The DigitalInputSetupType ObjectType provides settings and other affordance to set up an analog input.

The DigitalInputSetupType representation in the AddressSpace is formally defined in the following table.

Table 97 – DigitalInputSetupType Definition
Attribute Value
BrowseNameDigitalInputSetupType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ControlModuleSetupType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariableForcedValue0:Boolean0:DataItemTypeM, RW
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
ForcedValueThe value to set as the input value when control mode is manual.

8.35 MotorSetupType ObjectType

The MotorSetupType ObjectType provides settings and other affordances to set up a motor.

The MotorSetupType representation in the AddressSpace is formally defined in the following table.

Table 98 – MotorSetupType Definition
Attribute Value
BrowseNameMotorSetupType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ControlModuleSetupType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariableDirectionMotorDirectionEnumeration0:DataItemTypeO, RW
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
DirectionThe rotation direction of the motor.

8.36 ValveSetupType ObjectType

The ValveSetupType ObjectType provides aggregates computed by the underlying system for a valve.

The ValveSetupType representation in the AddressSpace is formally defined in the following table.

Table 99 – ValveSetupType Definition
Attribute Value
BrowseNameValveSetupType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ControlModuleSetupType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentVariablePositionSetPoint0:Double0:AnalogItemTypeO, RW
Conformance Units
TMC Basic Visualisation and Control
BrowseName Description
PositionSetPointThe position set point for the valve to reach.

8.37 UserInterfaceType ObjectType

8.37.1 Overview

The UserInterfaceType provides a generic User Interface description consisting of:

An overview display, modelled by OverVU;

A close-up, detail display, modelled by ZoomedVU;

A control-loop view where the connections (modelled by the LoopVUReferences) among objects belonging to the same control loop are shown;

An overlay display where KPIs are shown, modelled by KPIVU;

A control panel, where shown objects can be read only (modelled by ControlPanelVURO) or read-write (modelled by ControlPanelVURW);

The UserInterfaceType is formally defined in the following table.

Table 100 – UserInterfaceType Definition
Attribute Value
BrowseNameUserInterfaceType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectControlPanelVURO0:Double0:BaseObjectTypeM
0:HasComponentObjectControlPanelVURW0:Double0:BaseObjectTypeM
0:HasComponentObjectKPIVU0:Double0:BaseObjectTypeM
0:HasComponentObjectLoopVUReferences0:Double0:BaseObjectTypeM
0:HasComponentObjectOverVU0:Double0:BaseObjectTypeM
0:HasComponentObjectZoomedVU0:Double0:BaseObjectTypeM
Conformance Units
TMC Advanced Visualisation and Control
BrowseName Description
ControlPanelVUROThe control panel area where read-only objects are shown. Objects connected to a ControlPanelVURO by means of a non-hierarchical reference of type IsDisplayedBy are shown in the control panel.
ControlPanelVURWThe control panel area where read-write objects are shown. Objects connected to a ControlPanelVURW by means of a non-hierarchical reference of type IsDisplayedBy are shown in the control panel.
KPIVUThe object collecting variables to be displayed in the KPI section. Objects connected to a KPIVU by means of a non-hierarchical reference of type IsDisplayedBy are shown in the KPI display area.
LoopVUReferencesThe collection of references to control loops to be displayed. Non-hierarchical references connected to LoopVuReferences by means of a non-hierarchical reference of type IsDisplayedBy are shown in the control panel.
OverVUThe overview of the UI interface. Objects connected to an OverVU by means of a non-hierarchical reference of type IsDisplayedBy are shown in the overview display.
ZoomedVUThe zooned view of the UI interface. Objects connected to a ZoomedVU by means of a non-hierarchical reference of type IsDisplayedBy are shown in the zoomed in area.

8.38 ProductionOrderOrchestrationLayerType ObjectType

8.38.1 Overview

The ProductionOrderOrchestrationLayerType (POOL) ObjectType consists of a set of variables, generated events and methods that are used to orchestrate production orders for a set of Machine Modules that implement the MachineModuleProductionType and are variously connected in a production line. The production line is also known as a Process Cell according to ANSI/ISA-88.00.01-2010 Physical Model.

The POOL ObjectType is an external application, i.e. it is not implemented by a machine module. Nonetheless it is of interest for machine modules and their implementations because of the tight connection and interaction.

The ProductionOrderOrchestrationLayerType is formally defined in the following table.

Table 101 – ProductionOrderOrchestrationLayerType
Attribute Value
BrowseNameProductionOrderOrchestrationLayerType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the TMCDeviceType, i.e. inheriting the Instance Declarations of that Node.
0:HasPropertyVariableProductionOrdersRetentionTime0:UInt32M, RW
0:HasComponentObjectProductionOrders0:FolderTypeM
0:HasComponentMethodAbortProductionOrderSee below.M
0:HasComponentMethodAssignProductionOrderSee below.M
0:HasComponentMethodCompleteProductionOrderSee below.M
0:HasComponentMethodGetDataSetSee below.M
0:HasComponentMethodGetMaterialListSee below.M
0:HasComponentMethodGetProductionOrderSee below.M
0:HasComponentMethodReleaseProductionOrderSee below.M
0:HasComponentMethodStartProductionOrderSee below.M
0:HasComponentMethodUnassignProductionOrderSee below.M
0:HasComponentMethodUnreleaseProductionOrderSee below.M
Conformance Units
TMC Production Order Orchestration Layer

The components of the ProductionOrderOrchestrationLayerType have additional subcomponents which are defined in the following table.

Table 102 – ProductionOrderOrchestrationLayerType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
ProductionOrders0:HasComponent Object <ProductionOrderNumber>ProductionOrderExecutionStateMachineTypeOP
BrowseName Description
ProductionOrdersRetentionTimeThe time in hours a ProductionOrderStateMachine is retained in memory after the production order is complete. When the ProductionOrdersRetentionTime is elapsed, the ProductionOrderExecutionStateMachine is discarded from memory and from the containing folder ProductionOrders.
ProductionOrders

ProductionOrders is a folder that organizes objects of type ProductionOrderExecutionStateMachineType i.e., one state machine per production order managed by POOL.

Production orders are managed by POOL from their release by a higher-level system, e.g. MES, MOM, to their normal or abnormal completion or un-release and afterwards are persisted for a period of time defined by ProductionOrdersRetentionTime after which production orders are discarded from memory.

The reader shall note that there is one production order state machine for any given production order for the entire process cell regardless of the number of machine modules, each having its own StateMachine of the Production object within the MachineModule. In ways that are defined in this section, ProductionOrderExecutionStateMachine consolidates and coordinates the state of all machine modules with respect to the production order.

8.38.2 AbortProductionOrder Method

The AbortProductionOrder Method is used to abort a production order that is in execution or starting or completing in the production line.

To execute the method, POOL will in turn invoke the AbortProductionOrder method at all the machine modules where the production order is present in the arrary AssignedProductionOrders.

The signature of this Method is specified below. Table 103 specifies the Arguments representation.

Signature

	AbortProductionOrder(
	  [in]  ProductionOrderHeaderType   	POToAbort,
	  [out] MethodExecutionFeedbackType     ExecutionFeedback);
Table 103 – AbortProductionOrder Method Arguments
Argument Description
POToAbortThe Production Order to be aborted.
ExecutionFeedbackThe result of the execution of the method.

8.38.3 AssignProductionOrder Method

The AssignProductionOrder Method is used to assign a production order to one infeed machine module where it shall be executed.

To execute the method, POOL will in turn invoke the AssignProductionOrder method at the machine modules identified by the argument MachineModulesToAssign.

Assignment is required and useful because there are generally many machine modules that can execute a production order so that it is necessary to identify which machine module will be executing the specific one. The attentive reader shall note that a production order may require many infeed machine modules to execute the production order.

The signature of this Method is specified below. Table 104 specifies the Arguments representation.

Signature

	AssignProductionOrder(
	  [in]  ProductionOrderHeaderType   	POToAssign,
	  [in]  0:String[]					     MachineModuleUserName,
	  [out] MethodExecutionFeedbackType     ExecutionFeedback);
Table 104 - AssignProductionOrder Method Arguments
Argument Description
POToAssignThe Production Order Header to be assigned.
MachineModuleUserNameThe user name of the machine modules to which the PO is assigned. The machine module identifier is exposed in the UserName in the MachineModuleConfiguration of the machine module.
ExecutionFeedbackThe result of the execution of the method.

8.38.4 CompleteProductionOrder Method

The CompleteProductionOrder Method is used to complete a production order in execution.

To execute the method, POOL will in turn invoke the CompleteProductionOrder method at the machine module identified by the input argument MachineModuleToComplete.

The signature of this Method is specified below. Table 105 specifies the Arguments representation.

Signature

	CompleteProductionOrder(
	  [in]  ProductionOrderHeaderType		POToComplete,
	  [in]  0:String						MachineModuleUserName,
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 105 - CompleteProductionOrder Method Arguments
Argument Description
POToCompleteThe Production Order Header to be completed.
MachineModuleUserNameThe user name of the machine module where the PO is completed. The machine module identifier is exposed in the UserName in the MachineModuleConfiguration of the machine module.
ExecutionFeedbackThe result of the execution of the method.

8.38.5 GetDataSet Method

The signature of this Method is specified below. Table 106 specifies the Arguments representation.

Signature

	GetDataSet(
	 	[in]  ProductionOrderHeaderType		POHeader,
		[in]  0:String						MachineModuleUserName,
	[out] DataSetType					DataSet,
	 	[out] MethodExecutionFeedbackType     ExecutionFeedback);
Table 106 - GetDataSet Method Arguments
Argument Description
POHeaderThe Production Order Header of the dataset to be retrieved.
MachineModuleUserNameThe user name of the machine module for which the information is requested. The machine module identifier is exposed in the UserName in the MachineModuleConfiguration of the machine module.
DataSetThe DataSet for the production order with Production Order Header.
ExecutionFeedbackThe result of the execution of the method.

8.38.6 GetMaterialList Method

The GetMaterialList Method is used to retrieve the material list information from a production order header. The primary intended use is for a memory constrained underlying system to retrieve the production order information just in time without storing it for all assigned production orders.

The signature of this Method is specified below. Table 107 specifies the Arguments representation.

Signature

	GetMaterialList(
	 	[in]  ProductionOrderHeaderType		POHeader,
		[in]  0:String						MachineModuleUserName,
	[out] MaterialListType				MaterialList,
	 	[out] MethodExecutionFeedbackType     ExecutionFeedback);
Table 107 - GetMaterialList Method Arguments
Argument Description
POHeaderThe Production Order Header of the Material List to be retrieved.
MaterialListThe Material List for the production order with Production Order Header.
MachineModuleUserNameThe user name of the machine module for which the information is requested. The machine module identifier is exposed in the UserName in the MachineModuleConfiguration of the machine module.
ExecutionFeedbackThe result of the execution of the method.

8.38.7 GetProductionOrder Method

The GetProductionOrder Method is used to retrieve the complete production order information starting with a production order header as an input argument. The primary intended use is for a memory constrained underlying system to retrieve the production order information just in time without storing it for many assigned production orders. In the memory constrained case, it is the responsibility of the underlying system to retrieve the production order information on time without delaying the production order execution start.

The signature of this Method is specified below. Table 108 specifies the Arguments representation.

Signature

	GetProductionOrder(
	 	[in]  ProductionOrderHeaderType		POHeader,
		[in]  0:String						MachineModuleUserName,
	[out] ProductionOrderType			ProductionOrder,
	 	[out] MethodExecutionFeedbackType     ExecutionFeedback);
Table 108 - GetProductionOrder Method Arguments
Argument Description
POHeaderThe Production Order Header of the Material List to be retrieved.
MachineModuleUserNameThe user name of the machine module for which the information is requested. The machine module identifier is exposed in the UserName in the MachineModuleConfiguration of the machine module.
ProductionOrderThe complete Production Order with header Production Order Header.
ExecutionFeedbackThe result of the execution of the method.

8.38.8 ReleaseProductionOrder Method

The ReleaseProductionOrder Method is used to make a production order available to a machine module for orchestrated execution in a production line (Process Cell according to ANSI/ISA-88.00.01-2010 Physical Model).

When the method is executed successfully, a new ProductionOrderExecutionStateMachine is instantiated for the released production order when not already existing.

When the ProductionOrderExecutionStateMachine is in state Unreleased, the successful execution of the method causes the state transition to Releasing.

The signature of this Method is specified below.

Signature

	ReleaseProductionOrder(
	 	[in]  OrchestrationProductionOrderType POToRelease,
	[in]  0:String						 MachineModuleUserName,
	 	[out] MethodExecutionFeedbackType      ExecutionFeedback);
Table 109 - ReleaseProductionOrder Method Arguments
Argument Description
POToReleaseThe Production Order Header for the Production Order to be released.
MachineModuleUserNameThe user name of the machine module where the PO is released. The machine module identifier is exposed in the UserName in the MachineModuleConfiguration of the machine module.
ExecutionFeedbackThe result of the execution of the method.

8.38.9 StartProductionOrder Method

The StartProductionOrder Method is used to start the execution of a production order at a machine module specifying the loading points that input materials will be fed to and the output points where output will be directed.

To execute the method, POOL will in turn invoke the StartProductionOrder method at the machine module identified by the input argument MachineModuleToStart.

The signature of this Method is specified below.

Signature

	StartProductionOrder(
	 	[in]  ProductionOrderHeaderType	POToStart,
	[in]  0:String					MachineModuleUserName,
	[in]  0:String[]					SourceMaterialLoadingPointIDs,
	[in]  0:String[]				 DestinationMaterialOutputPointIDs,
	 	[out] MethodExecutionFeedbackType	ExecutionFeedback);
Table 110 - StartProductionOrder Method Arguments
Argument Description
POToStartThe Production Order Header for the Production Order to be started.
MachineModuleUserNameThe user name of the machine module where the PO is started. The machine module identifier is exposed in the UserName in the MachineModuleConfiguration of the machine module.
SourceMaterialLoadingPointIDsThe MaterialLoadingPoints where input materials will be fed for the Production Order to be started.
DestinationMaterialOutputPointIDsThe MaterialOutputPoints where output materials will be directed to for the Production Order to be started.
ExecutionFeedbackThe result of the execution of the method.

8.38.10 UnassignProductionOrder Method

The UnAssignProductionOrder Method is used to unassign a production order previously assigned to an infeed machine module. It reverses the effect of the AssignProductionOrder method when the production order is not yet in execution.

To execute the method, POOL will in turn invoke the UnAssignProductionOrder method at all the machine modules where the production order is present in the AssignedProductionOrders.

The signature of this Method is specified below.

Signature

	UnassignProductionOrder(
	 	[in]  ProductionOrderHeaderType		 POToUnassign,
		[out] MethodExecutionFeedbackType      ExecutionFeedback);
Table 111 - UnassignProductionOrder Method Arguments
Argument Description
POToUnassignThe Production Order Header for the Production Order to be unassigned.
ExecutionFeedbackThe result of the execution of the method.

8.38.11 UnreleaseProductionOrder Method

The UnreleaseProductionOrder Method is used to reverse the effect of the ReleaseProductionOrder method and make a previously released production order unavailable for assignment and production.

For example, it is used prior to sending changes to an already released production order.

The signature of this Method is specified below. Table 109 specifies the Arguments representation.

Signature

	ReleaseProductionOrder(
	 	[in]  ProductionOrderHeaderType		 POToUnrelease,
		[out] MethodExecutionFeedbackType      ExecutionFeedback);
Table 112 - UnreleaseProductionOrder Method Arguments
Argument Description
POToUnreleaseThe Production Order Header for the Production Order to be unreleased.
ExecutionFeedbackThe result of the execution of the method.

8.39 MachineModuleProductionStateMachineType Object Type

The MachineModuleProductionStateMachineType provides state information about the execution of a production order at a Machine Module.

The MachineModuleProductionStateMachineType is formally defined in the following table.

Table 113 – MachineModuleProductionStateMachineType Definition
Attribute Value
BrowseNameMachineModuleProductionStateMachineType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the FiniteStateMachineType defined in OPC 10000-5 Annex B, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectAborted0:StateType
0:HasComponentObjectAbortedToComplete0:TransitionType
0:HasComponentVariableAbortedToCompleteGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectAborting0:StateType
0:HasComponentObjectAbortingToAborted0:TransitionType
0:HasComponentVariableAbortingToAbortedGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectAssigned0:StateType
0:HasComponentObjectAssignedToComplete0:TransitionType
0:HasComponentVariableAssignedToCompleteGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectAssignedToStarting0:TransitionType
0:HasComponentVariableAssignedToStartingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectComplete0:InitialStateType
0:HasComponentObjectCompleteToAssigned0:TransitionType
0:HasComponentVariableCompleteToAssignedGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectCompleting0:StateType
0:HasComponentObjectCompletingToAborting0:TransitionType
0:HasComponentVariableCompletingToAbortingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectCompletingToComplete0:TransitionType
0:HasComponentVariableCompletingToCompleteGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectExecute0:StateType
0:HasComponentObjectExecuteToAborting0:TransitionType
0:HasComponentVariableExecuteToAbortingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectExecuteToCompleting0:TransitionType
0:HasComponentVariableExecuteToCompletingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentVariableLastTransition0:LocalizedText0:FiniteTransitionVariableTypeM, RO
0:HasComponentObjectStarting0:StateType
0:HasComponentObjectStartingToAborting0:TransitionType
0:HasComponentVariableStartingToAbortingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectStartingToExecute0:TransitionType
0:HasComponentVariableStartingToExecuteGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:GeneratesEventObjectTypeProductionOrderTransitionLogType
Conformance Units
TMC Single PO Production
BrowseName Description
Assigned

When the CurrentState of the StateMachine is Assigned, the information for at least one production order to be started is available.

When the CurrentState of the StateMachine is Assigned and there is a production order in execution, i.e. ProductionOrder is not null, the state transitions to Starting.

The variable ProductionOrder is set in the following cases:

For infeed machine modules: the method StartProductionOrder method is executed successfully.

For non-infeed machine modules with more than one assigned production order: when AssignedProductionOrders[] contains more than one production order, the method StartProductionOrder method is executed successfully.

For non-infeed machine modules configured to start automatically: when the AssignedProductionOrders array contains one production order and the state of the upstream machine modules is Execute or Starting for the same production order.

When the CurrentState of the StateMachine is Assigned and there are no assigned production orders, i.e. no elements in the array AssignedProductionOrders, the CurrentState of the MachineModuleProductionStateMachineType transitions to Complete.

Starting

When the CurrentState of the StateMachine is Starting, the underlying system performs the preparation to process product or parts according to the started production order. The machine module can receive input product(s) or parts from the loading points specified by the production order according to its machine specific sequence.

For example, while the CurrentState of the StateMachine is Starting, the machine may be pre-filled, warmed up or cooled down according to the requirements of the production order.

When the underlying system completes such machine specific sequence and starts processing product, the CurrentState of the StateMachine transitions to Execute.

When the CurrentState of the StateMachine is Starting and the AbortProductionOrder method is successfully executed, the ProductionState state machine transitions to Aborting.

The machine module shall not receive product from an upstream machine module processing a different production order. To this goal, the machine module underlying system will set UpstreamHold to True for the MaterialLoadingPoints connected to (1) non-active upstream machine modules and (2) active upstream machine modules with a different ProductionOrder.

Execute

When the CurrentState of the StateMachine is Execute, the production order is processed and input product(s) or parts are received.

In order to further detail the processing phases, the StateMachine object within the object LiveStatus may be used. The states and transitions of the machine are defined according to the underlying system specifics.

The machine module shall not receive product from an upstream machine module processing a different production order. To this end, the machine module will set UpstreamHold to True of the MaterialLoadingPoints connected to (1) non-active upstream machine modules and (2) active upstream machine modules with a different ProductionOrder.

For machine modules with AutoComplete false, when the CurrentState of the StateMachine is Execute, the successful execution of the method CompleteProductionOrder causes the state transition to Completing.

For machine modules with AutoComplete true, when the CurrentState of the StateMachine is Execute and the active upstream machine modules are in state Complete the CurrentState of the StateMachine transitions to Completing.

The described logic implements production order propagation in a standardized and transparent way.

Completing

When the CurrentState of the StateMachine is Completing, the underlying system performs the preparation to complete the production order which is complete in the active upstream machine modules.

When the underlying system completes such machine specific sequence, including checking that no more product(s) or parts are being received and that no more product(s) or parts that can be processed are in the machine module, and the active upstream machine modules’ state is Complete, the CurrentState of the StateMachine transitions to Complete and the ProductionOrder is nulled. Likewise, when the CurrentState of the StateMachine is Execute and the active upstream machine modules are in state Assigned or Execute for a different production order.

The machine module shall not receive product from an upstream machine module processing a different production order. To this end, the machine module will set UpstreamHold to True of the MaterialLoadingPoints connected to (1) non-active upstream machine modules and (2) active upstream machine modules with a different ProductionOrder.

Aborting

When the CurrentState of the StateMachine is Aborting, the machine module stops receiving additional product or parts from the active upstream machine modules in an orderly way.

When the stopping sequence is complete the CurrentState of the StateMachine transitions to Aborted.

Aborted

When the CurrentState of the StateMachine is Aborted, the product(s) or parts present in the machine module are discharged from the machine, either through machine specific automatic sequences or manually by the operators.

When the CurrentState of the StateMachine is Aborted and the ClearProductionOrder method is successfully executed, the state transitions to Complete.

Complete

When the CurrentState of the StateMachine is Complete, the machine module does not accept any more input product(s) or parts, the ProductionOrder is nulled and the machine is ready to execute a new production order.

When the CurrentState of the StateMachine is Complete and there is at least one production order in the AssignedProductionOrders array, the CurrentState of the StateMachine transitions to Assigned.

The components of the MachineModuleProductionStateMachineType have additional references which are defined in the following table.

Table 114 – MachineModuleProductionStateMachineType Additional References
SourceBrowsePath Reference Type Is Forward TargetBrowsePath
AbortedToComplete0:FromStateTrueAborted
0:HasGuardTrueAbortedToCompleteGuard
0:ToStateTrueComplete
0:HasEffectTrueProductionOrderTransitionLogType
AbortingToAborted0:FromStateTrueAborting
0:HasGuardTrueAbortingToAbortedGuard
0:ToStateTrueAborted
0:HasEffectTrueProductionOrderTransitionLogType
AssignedToComplete0:FromStateTrueAssigned
0:HasGuardTrueAssignedToCompleteGuard
0:ToStateTrueComplete
0:HasEffectTrueProductionOrderTransitionLogType
AssignedToStarting0:FromStateTrueAssigned
0:HasGuardTrueAssignedToStartingGuard
0:ToStateTrueStarting
0:HasEffectTrueProductionOrderTransitionLogType
CompleteToAssigned0:FromStateTrueComplete
0:HasGuardTrueCompleteToAssignedGuard
0:ToStateTrueAssigned
0:HasEffectTrueProductionOrderTransitionLogType
CompletingToAborting0:FromStateTrueCompleting
0:HasGuardTrueCompletingToAbortingGuard
0:ToStateTrueAborting
0:HasEffectTrueProductionOrderTransitionLogType
CompletingToComplete0:FromStateTrueCompleting
0:HasGuardTrueCompletingToCompleteGuard
0:ToStateTrueComplete
0:HasEffectTrueProductionOrderTransitionLogType
ExecuteToAborting0:FromStateTrueExecute
0:HasGuardTrueExecuteToAbortingGuard
0:ToStateTrueAborting
0:HasEffectTrueProductionOrderTransitionLogType
ExecuteToCompleting0:FromStateTrueExecute
0:HasGuardTrueExecuteToCompletingGuard
0:ToStateTrueCompleting
0:HasEffectTrueProductionOrderTransitionLogType
StartingToAborting0:FromStateTrueStarting
0:HasGuardTrueStartingToAbortingGuard
0:ToStateTrueAborting
0:HasEffectTrueProductionOrderTransitionLogType
StartingToExecute0:FromStateTrueStarting
0:HasGuardTrueStartingToExecuteGuard
0:ToStateTrueExecute
0:HasEffectTrueProductionOrderTransitionLogType

The component Variables of the MachineModuleProductionStateMachineType have additional Attributes defined in the following table.

Table 115 – MachineModuleProductionStateMachineType Attribute values for child Nodes
BrowsePath Attribute Value
1
2
3
4
5
6
7

8.40 ProductionOrderExecutionStateMachineType Object Type

The ProductionOrderExecutionStateMachineType provides state information about the execution of a production order at a production line.

The ProductionOrderExecutionStateMachineType is formally defined in the following table.

Table 116 - ProductionOrderExecutionStateMachineType Definition
Attribute Value
BrowseNameProductionOrderExecutionStateMachineType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the FiniteStateMachineType defined in OPC 10000-5 Annex B, i.e. inheriting the Instance Declarations of that Node.
0:HasPropertyVariableProductionOrderHeaderProductionOrderHeaderType0:PropertyTypeM
0:HasComponentObjectMachineModuleProductionOrders0:FolderTypeM
0:HasComponentObjectAborted0:StateType
0:HasComponentObjectAborting0:StateType
0:HasComponentObjectAssigned0:StateType
0:HasComponentObjectAssigning0:StateType
0:HasComponentObjectComplete0:StateType
0:HasComponentObjectCompleting0:StateType
0:HasComponentObjectExecute0:StateType
0:HasComponentObjectReleased0:StateType
0:HasComponentObjectReleasing0:InitialStateType
0:HasComponentObjectStarting0:StateType
0:HasComponentObjectUnassigning0:StateType
0:HasComponentObjectUnreleased0:StateType
0:HasComponentObjectUnreleasing0:StateType
0:HasComponentObjectAbortingToAborted0:TransitionType
0:HasComponentVariableAbortingToAbortedGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectAssignedToStarting0:TransitionType
0:HasComponentVariableAssignedToStartingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectAssignedToUnassigning0:TransitionType
0:HasComponentVariableAssignedToUnassigningGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectAssignedToUnreleasing0:TransitionType
0:HasComponentVariableAssignedToUnreleasingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectAssigningToAssigned0:TransitionType
0:HasComponentVariableAssigningToAssignedGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectCompletingToAborting0:TransitionType
0:HasComponentVariableCompletingToAbortingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectCompletingToComplete0:TransitionType
0:HasComponentVariableCompletingToCompleteGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectExecuteToAborting0:TransitionType
0:HasComponentVariableExecuteToAbortingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectExecuteToCompleting0:TransitionType
0:HasComponentVariableExecuteToCompletingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectReleasedToAssigning0:TransitionType
0:HasComponentVariableReleasedToAssigningGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectReleasedToUnreleasing0:TransitionType
0:HasComponentVariableReleasedToUnreleasingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectReleasingToReleased0:TransitionType
0:HasComponentVariableReleasingToReleasedGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectReleasingToUnreleasing0:TransitionType
0:HasComponentVariableReleasingToUnreleasingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectStartingToAborting0:TransitionType
0:HasComponentVariableStartingToAbortingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectStartingToExecute0:TransitionType
0:HasComponentVariableStartingToExecuteGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectUnassigningToReleased0:TransitionType
0:HasComponentVariableUnassigningToReleasedGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectUnreleasedToReleased0:TransitionType
0:HasComponentVariableUnreleasedToReleasedGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectUnreleasingToUnreleased0:TransitionType
0:HasComponentVariableUnreleasingToUnreleasedGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentVariableLastTransition0:LocalizedText0:FiniteTransitionVariableTypeM, RO
0:GeneratesEventObjectTypeProductionOrderTransitionLogTypeM
Conformance Units
TMC Production Order Orchestration Layer
BrowseName Description
ProductionOrderHeaderThe ProductionOrderHeader of the production order in execution. When no production order is in execution, the ProductionOrderNumber in the ProductionOrderHeader is an empty string.
MachineModuleProductionOrdersThe production orders that have been released to the ProductionOrderExecutionLayer. The MachineModuleProductionOrders folder contains one production order for each required machine module having the ProductionOrderHeader (above).

The components of the ProductionOrderExecutionStateMachineType have additional subcomponents which are defined in the following table.

Table 117 – ProductionOrderExecutionStateMachineType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
MachineModuleProductionOrders0:HasComponent Variable<MachineModuleUserName>ProductionOrderType0:BaseDataVariableTypeOP

The components of the ProductionOrderExecutionStateMachineType have additional references which are defined in the following table.

Table 118 – ProductionOrderExecutionStateMachineType Additional References
SourceBrowsePath Reference Type Is Forward TargetBrowsePath
AbortingToAborted0:FromStateTrueAborting
0:HasGuardTrueAbortingToAbortedGuard
0:ToStateTrueAborted
0:HasEffectTrueProductionOrderTransitionLogType
AssignedToStarting0:FromStateTrueAssigned
0:HasGuardTrueAssignedToStartingGuard
0:ToStateTrueStarting
0:HasEffectTrueProductionOrderTransitionLogType
AssignedToUnassigning0:FromStateTrueAssigned
0:HasGuardTrueAssignedToUnassigningGuard
0:ToStateTrueUnassigning
0:HasEffectTrueProductionOrderTransitionLogType
AssignedToUnreleasing0:FromStateTrueAssigned
0:HasGuardTrueAssignedToUnreleasingGuard
0:ToStateTrueUnreleasing
0:HasEffectTrueProductionOrderTransitionLogType
AssigningToAssigned0:FromStateTrueAssigning
0:HasGuardTrueAssigningToAssignedGuard
0:ToStateTrueAssigned
0:HasEffectTrueProductionOrderTransitionLogType
CompletingToAborting0:FromStateTrueCompleting
0:HasGuardTrueCompletingToAbortingGuard
0:ToStateTrueAborting
0:HasEffectTrueProductionOrderTransitionLogType
CompletingToComplete0:FromStateTrueCompleting
0:HasGuardTrueCompletingToCompleteGuard
0:ToStateTrueComplete
0:HasEffectTrueProductionOrderTransitionLogType
ExecuteToAborting0:FromStateTrueExecute
0:HasGuardTrueExecuteToAbortingGuard
0:ToStateTrueAborting
0:HasEffectTrueProductionOrderTransitionLogType
ExecuteToCompleting0:FromStateTrueExecute
0:HasGuardTrueExecuteToCompletingGuard
0:ToStateTrueCompleting
0:HasEffectTrueProductionOrderTransitionLogType
ReleasedToAssigning0:FromStateTrueReleased
0:HasGuardTrueReleasedToAssigningGuard
0:ToStateTrueAssigning
0:HasEffectTrueProductionOrderTransitionLogType
ReleasingToUnreleasing0:FromStateTrueReleasing
0:HasGuardTrueReleasingToUnreleasingGuard
0:ToStateTrueUnreleasing
0:HasEffectTrueProductionOrderTransitionLogType
ReleasingToReleased0:FromStateTrueReleasing
0:HasGuardTrueReleasingToReleasedGuard
0:ToStateTrueReleased
0:HasEffectTrueProductionOrderTransitionLogType
StartingToAborting0:FromStateTrueStarting
0:HasGuardTrueStartingToAbortingGuard
0:ToStateTrueAborting
0:HasEffectTrueProductionOrderTransitionLogType
StartingToExecute0:FromStateTrueStarting
0:HasGuardTrueStartingToExecuteGuard
0:ToStateTrueExecute
0:HasEffectTrueProductionOrderTransitionLogType
UnassigningToReleased0:FromStateTrueUnassigning
0:HasGuardTrueUnassigningToReleasedGuard
0:ToStateTrueReleased
0:HasEffectTrueProductionOrderTransitionLogType
UnreleasedToReleased0:FromStateTrueUnreleased
0:HasGuardTrueUnreleasedToReleasedGuard
0:ToStateTrueReleased
0:HasEffectTrueProductionOrderTransitionLogType
UnreleasingToUnreleased0:FromStateTrueUnreleasing
0:HasGuardTrueUnreleasingToUnreleasedGuard
0:ToStateTrueUnreleased
0:HasEffectTrueProductionOrderTransitionLogType

The component Variables of the ProductionOrderEecutionStateMachineType have additional Attributes defined in the following table.

Table 119 – ProductionOrderExecutionStateMachineType Attribute values for child Nodes
BrowsePath Value Attribute
1
2
3
4
5
6
7
8
9
10
11
12
13

8.41 TMCStateMachineType ObjectType

8.41.1 Overview

The TMCStateMachineType describes the finite state machine of a complex automation item including a machine module, an equipment module and a control module.

The TMCStateMachineType is modelled and inherits from the PackMLBaseStateMachineType defined in OPC 30050 - UA for PackML (OMAC) v1.01 and provides additional TMCMachineStateMachineType and transition information by means of guards implemented by the BooleanGuardVariableType.

The TMCStateMachineType is formally defined in the following table.

Table 120 – TMCStateMachineType Definition
Attribute Value
BrowseNameTMCStateMachineType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the PackMLBaseStateMachineType defined in OPC 30050, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentMethod3:AbortSee OPC 30050, PackMLStateMachineType.O
0:HasComponentObjectAborted0:StateType
0:HasComponentObjectAbortedSubstateStateMachineTypeO
0:HasComponentObjectAbortedToCleared0:TransitionType
0:HasComponentVariableAbortedToClearedGuard0:LocalizedTextBooleanGuardVariableTypeM, RW
0:HasComponentObjectAborting0:StateType
0:HasComponentObjectAbortingToAborted0:TransitionType
0:HasComponentVariableAbortingToAbortedGuard0:LocalizedTextBooleanGuardVariableTypeM, RW
0:HasComponentMethod3:ClearSee OPC 30050, PackMLStateMachineType.O
0:HasComponentObjectCleared0:StateType
0:HasComponentObjectClearedToAborting0:TransitionType
0:HasComponentVariableClearedToAbortingGuard0:LocalizedTextBooleanGuardVariableTypeM, RW
0:HasComponentVariableLastTransition0:LocalizedText0:FiniteTransitionVariableTypeM, RO
0:HasComponentObjectMachineStateTMCMachineStateMachineTypeM
0:GeneratesEventObjectTypeTransitionEventTypeM
Conformance Units
TMC Advanced Equipment Module and Control Module Status

The component Variables of the TMCStateMachineType have additional Attributes defined in the following table.

Table 121 – TMCStateMachineType Attribute Values for Child Nodes
BrowsePath Value Attribute
9
8
19

The components of the TMCStateMachineType have additional references which are defined in the following table.

Table 122 – TMCStateMachineType Additional References
SourceBrowsePath Reference Type Is Forward TargetBrowsePath
Aborted0:HasSubStateMachineTrueAbortedSubstate
AbortedToCleared0:FromStateTrueAborted
0:HasGuardTrueAbortedToClearedGuard
0:HasCauseTrue3:Clear
0:ToStateTrueCleared
0:HasEffectTrueTransitionEventType
AbortingToAborted0:FromStateTrueAborting
0:HasGuardTrueAbortingToAbortedGuard
0:ToStateTrueAborted
0:HasEffectTrueTransitionEventType
ClearedToAborting0:FromStateTrueCleared
0:HasGuardTrueClearedToAbortingGuard
0:HasCauseTrue3:Abort
0:ToStateTrueAborting
0:HasEffectTrueTransitionEventType

8.42 TMCExecuteStateMachineType ObjectType

8.42.1 Overview

The TMCExecuteStateMachineType is modelled and inherits from the PackMLExecuteStateMachineType defined in OPC 30050 - UA for PackML (OMAC) v1.01, and provides additional transition information by means of guards implemented by the BooleanGuardVariableType.

The TMCExecuteStateMachineType is formally defined in the following table.

Table 123 – TMCExecuteStateMachineType Definition
Attribute Value
BrowseNameTMCExecuteStateMachineType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the PackMLExecuteStateMachineType defined in OPC 30050, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectComplete0:StateType
0:HasComponentObjectCompleteSubstateStateMachineTypeO
0:HasComponentObjectCompleteToResetting0:TransitionType
0:HasComponentVariableCompleteToResettingGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentObjectCompleting0:StateType
0:HasComponentObjectCompletingToComplete0:TransitionType
0:HasComponentVariableCompletingToCompleteGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentObjectExecute0:StateType
0:HasComponentObjectExecuteSubstateStateMachineTypeO
0:HasComponentObjectExecuteToCompleting0:TransitionType
0:HasComponentVariableExecuteToCompletingGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentObjectExecuteToHolding0:TransitionType
0:HasComponentVariableExecuteToHoldingGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentObjectExecuteToSuspending0:TransitionType
0:HasComponentVariableExecuteToSuspendingGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentObjectHeld0:StateType
0:HasComponentObjectHeldToUnholding0:TransitionType
0:HasComponentVariableHeldToUnholdingGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentMethod3:HoldSee OPC 30050, PackMLExecuteStateMachineType.O
0:HasComponentObjectHolding0:StateType
0:HasComponentObjectHoldingToHeld0:TransitionType
0:HasComponentVariableHoldingToHeldGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentObjectIdle0:StateType
0:HasComponentObjectIdleSubstateStateMachineTypeO
0:HasComponentObjectIdleToStarting0:TransitionType
0:HasComponentVariableIdleToStartingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentVariableLastTransition0:LocalizedText0:FiniteTransitionVariableTypeM, RO
0:HasComponentMethod3:ResetSee OPC 30050, PackMLExecuteStateMachineType.O
0:HasComponentObjectResetting0:StateType
0:HasComponentObjectResettingToIdle0:TransitionType
0:HasComponentVariableResettingToIdleGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentMethod3:StartSee OPC 30050, PackMLExecuteStateMachineType.O
0:HasComponentObjectStarting0:StateType
0:HasComponentObjectStartingToExecute0:TransitionType
0:HasComponentVariableStartingToExecuteGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectStartingToHolding0:TransitionType
0:HasComponentVariableStartingToHoldingGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentMethod3:SuspendSee OPC 30050, PackMLExecuteStateMachineType.O
0:HasComponentObjectSuspended0:StateType
0:HasComponentObjectSuspendedToHolding0:TransitionType
0:HasComponentVariableSuspendedToHoldingGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentObjectSuspendedToUnsuspending0:TransitionType
0:HasComponentVariableSuspendedToUnsuspendingGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentObjectSuspending0:StateType
0:HasComponentObjectSuspendingToHolding0:TransitionType
0:HasComponentVariableSuspendingToHoldingGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentObjectSuspendingToSuspended0:TransitionType
0:HasComponentVariableSuspendingToSuspendedGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentMethod3:ToCompleteSee OPC 30050, PackMLExecuteStateMachineType.O
0:HasComponentMethod3:UnholdSee OPC 30050, PackMLExecuteStateMachineType.O
0:HasComponentObjectUnholding0:StateType
0:HasComponentObjectUnholdingToExecute0:TransitionType
0:HasComponentVariableUnholdingToExecuteGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentObjectUnholdingToHolding0:TransitionType
0:HasComponentVariableUnholdingToHoldingGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentMethod3:UnsuspendSee OPC 30050, PackMLExecuteStateMachineType.O
0:HasComponentObjectUnsuspending0:StateType
0:HasComponentObjectUnsuspendingToExecute0:TransitionType
0:HasComponentVariableUnsuspendingToExecuteGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:HasComponentObjectUnsuspendingToHolding0:TransitionType
0:HasComponentVariableUnsuspendingToHoldingGuard0:LocalizedTextBooleanGuardVariableTypeO, RO
0:GeneratesEventObjectTypeTransitionEventTypeM
Conformance Units
TMC Advanced Equipment Module and Control Module Status

The component Variables of the TMCExecuteStateMachineType have additional Attributes defined in the following table.

Table 124 – TMCExecuteStateMachineType Attribute Values for Child Nodes
Source Path Value Attribute
17
16
6
11
10
4
15
3
5
13
12
14

The components of the TMCExecuteStateMachineType have additional references which are defined in the following table.

Table 125 – TMCExecuteStateMachineType Additional References
SourceBrowsePath Reference Type Is Forward TargetBrowsePath
Complete0:HasSubStateMachineTrueCompleteSubstate
Execute0:HasSubStateMachineTrueExecuteSubstate
Idle0:HasSubStateMachineTrueIdleSubstate
CompleteToResetting0:FromStateTrueComplete
0:HasGuardTrueCompleteToResettingGuard
0:HasCauseTrue3:Reset
0:ToStateTrueResetting
0:HasEffectTrueTransitionEventType
CompletingToComplete0:FromStateTrueCompleting
0:HasGuardTrueCompletingToCompleteGuard
0:ToStateTrueComplete
0:HasEffectTrueTransitionEventType
ExecuteToCompleting0:FromStateTrueExecute
0:HasGuardTrueExecuteToCompletingGuard
0:HasCauseTrue3:ToComplete
0:ToStateTrueCompleting
0:HasEffectTrueTransitionEventType
ExecuteToHolding0:FromStateTrueExecute
0:HasGuardTrueExecuteToHoldingGuard
0:HasCauseTrue3:Hold
0:ToStateTrueHolding
0:HasEffectTrueTransitionEventType
ExecuteToSuspending0:FromStateTrueExecute
0:HasGuardTrueExecuteToSuspendingGuard
0:HasCauseTrue3:Suspend
0:ToStateTrueSuspending
0:HasEffectTrueTransitionEventType
HeldToUnholding0:FromStateTrueHeld
0:HasGuardTrueHeldToUnholdingGuard
0:HasCauseTrue3:Unhold
0:ToStateTrueUnholding
0:HasEffectTrueTransitionEventType
HoldingToHeld0:FromStateTrueHolding
0:HasGuardTrueHoldingToHeldGuard
0:ToStateTrueHeld
0:HasEffectTrueTransitionEventType
IdleToStarting0:FromStateTrueIdle
0:HasGuardTrueIdleToStartingGuard
0:HasCauseTrue3:Start
0:ToStateTrueStarting
0:HasEffectTrueTransitionEventType
ResettingToIdle0:FromStateTrueResetting
0:HasGuardTrueResettingToIdleGuard
0:ToStateTrueIdle
0:HasEffectTrueTransitionEventType
StartingToExecute0:FromStateTrueStarting
0:HasGuardTrueStartingToExecuteGuard
0:ToStateTrueExecute
0:HasEffectTrueTransitionEventType
StartingToHolding0:FromStateTrueStarting
0:HasGuardTrueStartingToHoldingGuard
0:HasCauseTrue3:Hold
0:ToStateTrueHolding
0:HasEffectTrueTransitionEventType
SuspendedToHolding0:FromStateTrueSuspended
0:HasGuardTrueSuspendedToHoldingGuard
0:HasCauseTrue3:Hold
0:ToStateTrueHolding
0:HasEffectTrueTransitionEventType
SuspendedToUnsuspending0:FromStateTrueSuspended
0:HasGuardTrueSuspendedToUnsuspendingGuard
0:HasCauseTrue3:Unsuspend
0:ToStateTrueUnsuspending
0:HasEffectTrueTransitionEventType
SuspendingToHolding0:FromStateTrueSuspending
0:HasGuardTrueSuspendingToHoldingGuard
0:HasCauseTrue3:Hold
0:ToStateTrueHolding
0:HasEffectTrueTransitionEventType
SuspendingToSuspended0:FromStateTrueSuspending
0:HasGuardTrueSuspendingToSuspendedGuard
0:ToStateTrueSuspended
0:HasEffectTrueTransitionEventType
UnholdingToExecute0:FromStateTrueUnholding
0:HasGuardTrueUnholdingToExecuteGuard
0:ToStateTrueExecute
0:HasEffectTrueTransitionEventType
UnholdingToHolding0:FromStateTrueUnholding
0:HasGuardTrueUnholdingToHoldingGuard
0:HasCauseTrue3:Hold
0:ToStateTrueHolding
0:HasEffectTrueTransitionEventType
UnsuspendingToExecute0:FromStateTrueUnsuspending
0:HasGuardTrueUnsuspendingToExecuteGuard
0:ToStateTrueExecute
0:HasEffectTrueTransitionEventType
UnsuspendingToHolding0:FromStateTrueUnsuspending
0:HasGuardTrueUnsuspendingToHoldingGuard
0:ToStateTrueHolding
0:HasEffectTrueTransitionEventType

8.43 TMCMachineStateMachineType ObjectType

8.43.1 Overview

The TMCMachineStateMachineType is modelled and inherits from the PackMLMachineStateMachineType defined in OPC 30050 - UA for PackML (OMAC) v1.01, and provides additional transition information by means of guards implemented by the BooleanGuardVariableType.

The TMCMachineStateMachineType is formally defined in the following table.

Table 126 – TMCMachineStateMachineType Definition
Attribute Value
BrowseNameTMCMachineStateMachineType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the PackMLMachineStateMachineType defined in OPC 30050, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectClearing0:StateType
0:HasComponentObjectClearingToStopped0:TransitionType
0:HasComponentVariableClearingToStoppedGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectExecuteStateTMCExecuteStateMachineTypeM
0:HasComponentVariableLastTransition0:LocalizedText0:FiniteTransitionVariableTypeM, RO
0:HasComponentMethod3:ResetSee OPC 30050, PackMLMachineStateMachineType.O
0:HasComponentObjectRunning0:StateType
0:HasComponentObjectRunningToStopping0:TransitionType
0:HasComponentVariableRunningToStoppingGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentMethod3:StopSee OPC 30050, PackMLMachineStateMachineType.O
0:HasComponentObjectStopped0:StateType
0:HasComponentObjectStoppedSubstateStateMachineTypeO
0:HasComponentObjectStoppedToRunning0:TransitionType
0:HasComponentVariableStoppedToRunningGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:HasComponentObjectStopping0:StateType
0:HasComponentObjectStoppingToStopped0:TransitionType
0:HasComponentVariableStoppingToStoppedGuard0:LocalizedTextBooleanGuardVariableTypeM, RO
0:GeneratesEventObjectTypeTransitionEventTypeM
Conformance Units
TMC Advanced Machine Status

The component Variables of the TMCMachineStateMachineType have additional Attributes defined in the following table.

Table 127 – TMCMachineStateMachineType Attribute Values for Child Nodes
Source Path Value Attribute
1
18
2
7

The components of the TMCMachineStateMachineType have additional references which are defined in the following table.

Table 128 – TMCMachineStateMachineType Additional References
SourceBrowsePath Reference Type Is Forward TargetBrowsePath
Stopped0:HasSubStateMachineTrueStoppedSubstate
ClearingToStopped0:FromStateTrueClearing
0:HasGuardTrueClearingToStoppedGuard
0:HasCauseTrue3:Stop
0:ToStateTrueStopped
0:HasEffectTrueTransitionEventType
RunningToStopping0:FromStateTrueRunning
0:HasGuardTrueRunningToStoppingGuard
0:HasCauseTrue3:Stop
0:ToStateTrueStopping
0:HasEffectTrueTransitionEventType
StoppedToRunning0:FromStateTrueStopped
0:HasGuardTrueStoppedToRunningGuard
0:HasCauseTrue3:Reset
0:ToStateTrueRunning
0:HasEffectTrueTransitionEventType
StoppingToStopped0:FromStateTrueStopping
0:HasGuardTrueStoppingToStoppedGuard
0:ToStateTrueStopped
0:HasEffectTrueTransitionEventType

8.44 ProcessItemType ObjectType

8.44.1 Overview

The ProcessItemType is used to measure and monitor over time a measurement point. The ProcessItemType also provides aggregates (Avg, Max, Min, Std, Total) that are computed by the underlying system. The aggregates are computed over a time period or for a product quantity and can be configured by a client altogether with the sampling time.

The ProcessItemType is formally defined in the following table.

Table 129 – ProcessItemType Definition
Attribute Value
BrowseNameProcessItemType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasPropertyVariableAggregationWindow0:UInt320:PropertyTypeM, RW
0:HasComponentObjectLimitAlarms0:NonExclusiveLevelAlarmTypeM
0:HasComponentVariableValue0:DoubleDisplayAnalogUnitTypeM, RO, HR
0:HasComponentVariableAvg0:Double0:BaseDataVariableTypeM, RO, HR
0:HasPropertyVariableLastResetTime0:UtcTime0:PropertyTypeM, RO
0:HasComponentVariableMax0:Double0:BaseDataVariableTypeM, RO
0:HasComponentVariableMin0:Double0:BaseDataVariableTypeM, RO
0:HasComponentMethodResetAggregatesSee below.M
0:HasComponentVariableSamplingRate0:Double0:AnalogUnitRangeTypeM, RW
0:HasComponentVariableStd0:Double0:BaseDataVariableTypeM, RO, HR
0:HasComponentVariableTotal0:Double0:BaseDataVariableTypeM, RO
0:HasComponentObjectUIInfoUIInformationTypeO
0:GeneratesEventObjectType0:NonExclusiveLevelAlarmType
0:GeneratesEventObjectTypeProcessItemResetLogType
Conformance Units
TMC Process Variables Ingestion and Control
BrowseName Description
AggregationWindow

Tthe number of samples over which the aggregates are computed. When the number of aggregated samples since the last reset exceeds the AggregationWindow, the aggregates are rolled over, i.e. computed over the last AggregationWindow number of samples.

The value of the AggregationWindow can be set by a client to obtain the desired aggregation.

If the written value is below (above) the minimum (maximum) value that can be managed by the underlying system, the underlying system will overwrite it with the minimum (maximum).

LimitAlarmsThe deviation alarm with 4 thresholds: HighHigh, High, Low, LowLow. All 4 thresholds shall be supported.
ValueValue represents the current value measured by the sensor.
Avg

The average of valid values over the last AggregationWindow samples and after the last reset.

It is only reset by the successful execution of the ResetAggregates method.

LastResetTimeThe time (in UTC) when ResetAggregates was last successfully executed.
Max

The maximum valid value for the last AggregationWindow samples and after the last reset.

It is only reset by the successful execution of the ResetAggregates method.

Min

The minimum valid value for the last AggregationWindow samples and after the last reset.

It is only reset by the successful execution of the ResetAggregates method.

SamplingRate

The rate samples are collected for aggregation. The rate is referred to the either product or time, as indicated by the EURange property.

For example, SamplingRate equal to 100 ms means that the value is measured and collected for aggregation every 100 ms. SamplingRate equal to 10 kg means that the value is measured and collected for aggregation every 10 kg of product. SamplingRate equal to 100 rods means that the value is measured and collected for aggregation every 100 rods of product.

The EURange property of the SamplingRate is read only and defines both the unit of measure and the supported range.

The value of the SamplingRate can be set by a client to obtain the desired sampling rate for aggregation.

If the written value is below (above) the minimum (maximum) value that can be managed by the underlying system, the underlying system will overwrite it with the minimum (maximum).

The underlying system will support equivalent sampling rates of 100ms or better.

Std

The standard deviation of the valid value for the last AggregationWindow samples and after the last reset. After reset, when only one value is available, the standard deviation is not defined and zero will be returned.

It is only reset by the successful execution of the ResetAggregates method.

Total

The accumulated total of the valid value for the last AggregationWindow samples and after the last reset.

It is only reset by the successful execution of the ResetAggregates method.

UIInfoThe visualization resources to display the ProcessItemType on the UserInterface.

8.44.2 ResetAggregates Method

The ResetAggregates Method restarts from new the computation of aggregates performed by the underlying system.

The signature of this Method is specified below. Table 130 specifies the Arguments representation.

Signature

	ResetAggregates (
	  [out] MethodExecutionFeedbackType		ExecutionFeedback);
Table 130 – ResetAggregates Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

When the ResetAggregates method is invoked, an event of type ProcessItemResetLogType is generated with the last value of the aggregate variables, then the aggregates are reset as specified and the LastResetTime is set at the time when the method completes successfully.

8.45 ProcessControlItem ObjectType

8.45.1 Overview

The ProcessItemType is formally defined in the following table.

Table 131 – ProcessControlItemType Definition
Attribute Value
BrowseNameProcessControlItemType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the ProcessItemType, i.e. inheriting the Instance Declarations of that Node.
0:HasPropertyVariableOperatorControl0:Boolean0:PropertyTypeM, RO, HR
0:HasPropertyVariableRemoteControlEnable0:Boolean0:PropertyTypeM, RO, HR
0:HasComponentVariableRemoteValue0:Double0:BaseDataVariableTypeM, RW, HR
0:HasPropertyVariableRemoteControl0:Boolean0:PropertyTypeM, RW, HR
0:HasComponentMethodSetRemoteControlSee below.M
BrowseName Description
RemoteValueThe value set by the client to override the object value.
RemoteControlEnableThe RemoteControlEnable variable exposes when the underlying system is ready to activate the RemoteControl upon a request by a client. When RemoteControlEnable is False, the underlying system is not ready and will not activate a request to remotely control the ProcessControlItem.
RemoteControl

The RemoteControl variable lets the underlying system expose which system is currently in control of the ProcessControlItem. More specifically, if RemoteControl is True, the underlying system copies the RemoteValue to the ProcesControlItem Value to drive it, i.e. the ProcessControlItem is remotely controlled. If RemoteControl is False, the underlying system is not using RemoteValue to drive the ProcessControlItem, but another value that is exposed as the ProcessControlItem Value, i.e. the ProcessControlItem is locally controlled.

A client requests (resp. releases) control of the ProcessControlItem by setting RemoteControl to True (resp. False) preferably by invoking the SetRemoteControl Method. If the client does not support methods, then the client sets RemoteControl to True. The underlying system will reset RemoteControl to False if remote control is not activated.

OperatorControlThe OperatorControl variable qualifies the source of the ProcessControlItem Value when RemoteControl is False, otherwise OperatorControl is undefined. When OperatorControl is True, the underlying system exposes the information that the ProcessControlItem Value is modified by the operator with respect to the nominal value, e.g. NominalRate, a.k.a. design speed for a speed control loop. When OperatorControl is False, the underlying system exposes the information that the ProcessControlItem Value is not modified by the operator.

8.45.2 SetRemoteControl Method

The SetRemoteControl Method enables or disables the remote control mode.

The signature of this Method is specified below. Table 132 specifies the Arguments representation.

Signature

	SetRemoteControl (
	  [in]		0:Boolean						Enable,
	  [out]	MethodExecutionFeedbackType		ExecutionFeedback);
Table 132 – SetRemoteControl Method Arguments
Argument Description
EnableThe flag enables (True) or disables (False) the remote control mode.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

When the method SetRemoteControl completes successfully with input argument Enable equal to True, RemoteControl is set to True and the RemoteAnalogMeasurement persistently overrides the ProcessControlItem value.

When the method SetRemoteControl completes successfully with input argument Enable equal to False, RemoteControl is set to False and the ProcessControlItem value is generated by the underlying system.

8.46 ProcessControlLoopType ObjectType

8.46.1 Overview

The ProcessControlLoopType is the general description of a control loop consisting of the desired value (SetPoint) for a measured value (ProcessValue) which is obtained by acting on an actuator (ControlValue).

The ProcessControlLoopType is formally defined in the following table.

Table 133 – ProcessControlLoopType Definition
Attribute Value
BrowseNameProcessControlLoopType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the TMCDeviceType, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectsControlValueProcessControlItemTypeM
0:HasComponentObjectsProcessValueProcessControlItemTypeM
0:HasComponentObjectsSetPointProcessControlItemTypeO
0:HasPropertyVariableWatchdogEnabled0:Boolean0:PropertyTypeM, RW
0:HasPropertyVariableWatchdogTimeout0:Duration0:PropertyTypeM, RW
0:HasComponentObjectExternalAlarms0:FolderTypeM
0:GeneratesEventObjectTypeExternalAlarmType
Conformance Units
TMC Process Variables Ingestion and Control
BrowseName Description
ControlValueThe ControlValue is the output of the control loop function. The control value directly drives the actuator.
ProcessValueThe value read by a sensor or other analog measurement of the physical quantity that is monitored.
SetPointThe value we aim to obtain from the ProcessValue by means of driving the control value.
WatchdogEnableWhen WatchdogEnable is True, if a ProcessControlLoop component’s RemoteControl is True and the time between two consecutive writes of the RemoteValue is longer than WatchdogTimeout, then the underlying system will generate an alarm, set RemoteControl to False and take control of the loop. When WatchdogEnable is False, no watchdog alarm is generated.
WatchdogTimeoutThe longest time between two write actions before a watchdog alarm is generated by the underlying system. The value is expressed in milliseconds. If the written value is below (above) the minimum (maximum) value that can be managed by the underlying system, the underlying system will overwrite it with the minimum (maximum).
ExternalAlarmsThe external alarms folder is used to organize external alarms.

The components of the ProcessControlLoopType have additional subcomponents which are defined in the following table.

Table 134 – ProcessControlLoopType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
ExternalAlarms0:HasComponentObject ExternalAlarm1ExternalAlarmTypeM
ExternalAlarms0:HasComponentObject ExternalAlarm2ExternalAlarmTypeM
ExternalAlarms0:HasComponentObject ExternalAlarm3ExternalAlarmTypeM
ExternalAlarms0:HasComponentObject ExternalAlarm4ExternalAlarmTypeM
ExternalAlarms0:HasComponentObject ExternalAlarm5ExternalAlarmTypeM
ExternalAlarms0:HasComponentObject ExternalAlarm6ExternalAlarmTypeM
ExternalAlarms0:HasComponentObject ExternalAlarm7ExternalAlarmTypeM
ExternalAlarms0:HasComponentObject ExternalAlarm8ExternalAlarmTypeM
ExternalAlarms0:HasComponentObject ExternalAlarm9ExternalAlarmTypeM
ExternalAlarms0:HasComponentObject ExternalAlarm10ExternalAlarmTypeM
ExternalAlarms0:HasComponentObject <ExternalAlarmN>ExternalAlarmTypeOP

The ExternalAlarms folder provides 10 spare external alarms that are mandatorily implemented by the underlying system. Additional ones can be added via the ExternalAlarmN optional placeholder.

8.47 CarrierType ObjectType

8.47.1 Overview

The CarrierType ObjectType provides a description for a uniquely identified reusable carrier. Examples of CarrierType implementations are AGVs, trays with RFIDs, IBCs with RFIDs, bins with permanent bar codes.

The CarrierType is formally defined in the following table.

Table 135 – CarrierType Definition
Attribute Value
BrowseNameCarrierType
IsAbstractFalse
References Node Class BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectData0:FolderTypeO
0:HasComponentMethodEndSubCarrierLoadingSee below.M
0:HasComponentMethodEndSubCarrierUnloadingSee below.M
0:HasPropertyVariableFormFactor0:String0:PropertyTypeM, RO
0:HasPropertyVariableID0:String0:PropertyTypeM, RO
0:HasComponentMethodLoadSubCarrierSee below.M
0:HasComponentMethodLoadSublotsSee below.M
0:HasPropertyVariableMES_ID0:String0:PropertyTypeM, RW
0:HasPropertyVariableParentCarrierID0:String0:PropertyTypeM, RO
0:HasComponentMethodStartSubCarrierLoadingSee below.M
0:HasComponentMethodStartSubCarrierUnloadingSee below.M
0:HasComponentObjectSubCarriers0:FolderTypeO
0:HasComponentVariableSublotsMaterialSublotType[]0:BaseDataVariableTypeO, RO
0:HasComponentMethodUnloadSubCarrierSee below.M
0:HasComponentMethodUnloadSublotsSee below.M
0:GeneratesEventObjectTypeCarrierSublotsChangeLogType
0:GeneratesEventObjectTypeSubCarrierLoadedLogType
0:GeneratesEventObjectTypeSubCarrierLoadingEndedLogType
0:GeneratesEventObjectTypeSubCarrierLoadingStartedLogType
0:GeneratesEventObjectTypeSubCarrierUnloadedLogType
0:GeneratesEventObjectTypeSubCarrierUnloadingEndedLogType
0:GeneratesEventObjectTypeSubCarrierUnloadingStartedLogType
Conformance Units
TMC Intralogistics at the machine
BrowseName Description
DataThe Data folder organizes implementation specific data for the carrier.
FormFactorThe form factor of the carrier e.g., trolley, AGV, core, IBC, etc.
IDThe underlying system identification of the carrier.
MES_IDA higher-level system e.g., MES, identification of the carrier.
ParentCarrierIDThe unique identifier of the carrier that contains the carrier in question.
SubCarriersThe SubCarriers folder organizes carriers contained in the carrier.
SubLotsThe SubLots contained in the carrier.

The components of the CarrierType have additional subcomponents which are defined in the following table.

Table 136 – CarrierType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
Data 0:HasComponentVariable <DataItem> 0:BaseDataType 0:BaseDataVariableTypeOP, RO
SubCarriers 0:HasComponentObject <SubCarrier> CarrierTypeOP

8.47.2 EndSubCarrierLoading Method

The EndSubCarrierLoading Method informs the underlying system that the loading of (sub) carriers into the carrier is complete.

The signature of this Method is specified below. Table 137 specifies the Arguments representation.

Signature

	EndSubCarrierLoading (
	  [out]	MethodExecutionFeedbackType		ExecutionFeedback);
Table 137 – EndSubCarrierLoading Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.47.3 EndSubCarrierUnloading Method

The EndSubCarrierUnloading Method informs the underlying system that the unloading of (sub) carriers into the carrier is complete.

The signature of this Method is specified below. Table 138 specifies the Arguments representation.

Signature

	EndSubCarrierUnloading (
	  [out]	MethodExecutionFeedbackType		ExecutionFeedback);
Table 138 – EndSubCarrierUnloading Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.47.4 LoadSubCarrier Method

The LoadSubCarrier Method requests the underlying system to load a subcarrier into the carrier that is currently being loaded.

The signature of this Method is specified below. Table 139 specifies the Arguments representation.

Signature

	LoadSubCarrier (
	  [in]		0:String							ID,
	  [in]		0:String							MESID,
	  [in]		0:String							ParentCarrierID,
	  [in]		MaterialSublotType[]				Sublots,
	  [out]	MethodExecutionFeedbackType		ExecutionFeedback);
Table 139 – LoadSubCarrier Method Arguments
Argument Description
IDThe unique identifier of the carrier to be loaded.
MESIDThe higher-level system identifier for the carrier to be loaded.
ParentCarrierIDThe unique identifier of the parent carrier i.e., the carrier containing the carrier.
SublotsThe material sublots to be loaded to the carrier.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.47.5 LoadSublots Method

The LoadSublots Method requests the underlying system to load one or more material sublots into the carrier that is currently being loaded.

The signature of this Method is specified below. Table 140 specifies the Arguments representation.

Signature

	LoadSublots (
	  [in]		MaterialSublotType[]				Sublots,
	  [out]	MethodExecutionFeedbackType		ExecutionFeedback);
Table 140 – LoadSublots Method Arguments
Argument Description
SublotsThe material sublots to be loaded to the carrier.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.47.6 StartSubCarrierLoading Method

The StartSubCarrierLoading Method informs the underlying system that the loading of (sub) carriers into the carrier has started.

The underlying system is expected to perform its own loading process while the (sub) carriers are loaded.

The signature of this Method is specified below. Table 141 specifies the Arguments representation.

Signature

	StartSubCarrierLoading (
	  [out]	MethodExecutionFeedbackType		ExecutionFeedback);
Table 141 – StartSubCarrierLoading Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.47.7 StartSubCarrierUnloading Method

The StartSubCarrierUnloading Method informs the underlying system that the unloading of (sub) carriers from the carrier has started.

The underlying system is expected to perform its own unloading process while the (sub) carriers are unloaded.

The signature of this Method is specified below. Table 142 specifies the Arguments representation.

Signature

	StartSubCarrierUnloading (
	  [out]	MethodExecutionFeedbackType		ExecutionFeedback);
Table 142 – StartSubCarrierUnloading Method Arguments
Argument Description
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.47.8 UnloadSubCarrier Method

The UnloadSubCarrier Method requests the underlying system to unload a subcarrier from the carrier that is currently being unloaded.

The signature of this Method is specified below. Table 143 specifies the Arguments representation.

Signature

	LoadSubCarrier (
	  [in]		0:String							ID,
	  [out]	MethodExecutionFeedbackType		ExecutionFeedback);
Table 143 – UnloadSubCarrier Method Arguments
Argument Description
IDThe unique identifier of the carrier to be loaded.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.47.9 UnloadSublots Method

The UnloadSublots Method requests the underlying system to unload one or more sublots from the carrier that is currently being unloaded.

The signature of this Method is specified below. Table 144 specifies the Arguments representation.

Signature

	UnloadSublots (
	  [in]		0:String[]						SublotIDs,
	  [out]	MethodExecutionFeedbackType		ExecutionFeedback);
Table 144 – UnloadSublots Method Arguments
Argument Description
SublotIDsThe unique identifiers of the material sublots to be unloaded.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

8.48 MaterialLocationType ObjectType

The MaterialLocationType ObjectType describes locations where material is stored around a machine module.

Examples of such locations are the designated areas on the floor where materials are delivered for consumption or where material produced by the machine is waiting to be collected. When the location where the material is stored is integral part of the mechanics or controls of the machine, the location shall be modelled as a MaterialStorageBuffer.

The MaterialLocationType representation in the AddressSpace is formally defined in the following table.

Table 145 – MaterialLocationType Definition
Attribute Value
BrowseNameMaterialLocationType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the BaseObjectType defined in OPC 10000-5 - Part 5: Information Model, i.e. inheriting the Instance Declarations of that Node.
0:HasPropertyVariableCanReceive0:Boolean0:PropertyTypeM, RO
0:HasPropertyVariableCanSend0:Boolean0:PropertyTypeM, RO
0:HasComponentObjectCarriers0:FolderTypeM
0:HasComponentVariableSublotsMaterialSublotType[]0:BaseDataVariableTypeM, RO
0:HasPropertyVariableID0:String0:PropertyTypeM, RO
0:HasPropertyVariableMES_ID0:String0:PropertyTypeM, RW
0:HasPropertyVariableStateStateEnumeration0:PropertyTypeO, RO
0:HasComponentObjectStateMachineTMCStateMachineTypeO
0:HasComponentObjectUIInfoUIInformationTypeO
0:GeneratesEventObjectTypeCarrierEnteredLogType
0:GeneratesEventObjectTypeCarrierReleasedLogType
0:GeneratesEventObjectTypeStateChangeLogType
Conformance Units
TMC Intralogistics at the machine
BrowseName Description
CanReceiveWhen True, material sublots or carriers can be stored in the material location. It is set by the underlying system to make the material location available for receiving.
CanSendWhen True, material sublots or carriers can be removed in the material location. It is set by the underlying system to make the material location available for sending.
CarriersThe Carriers folder provides carriers that are stored in the material location.
SublotsThe Sublots array of MaterialSublotType provides carriers that are stored in the material location.
IDThe unique identifier for the material location.
MES_IDThe unique identifier of the material location according to a higher-level system, e.g. MES or ERP.
StateThe state the material location is in.
StateMachineThe state machine describing the state and transitions of the material location.
UIInfoThe visualization resources to display the MaterialLocationType on the User Interface.
Table 146 – MaterialLocationType Additional Subcomponents
BrowsePath References NodeClass BrowseName DataType TypeDefinition Others
Carriers 0:HasComponentObject <Carrier> CarrierTypeOP

8.49 TMCDeviceType ObjectType

The TMCDeviceType ObjectType is used to include UIInfo and specify which DeviceType components are mandatory when used in compliance with TMC. The TMCDeviceType is abstract, meaning there will be no instances of the TMCDeviceType.

The TMCDeviceType representation in the AddressSpace is formally defined in the following table.

Table 147 – TMCDeviceType Definition
Attribute Value
BrowseNameTMCDeviceType
IsAbstractTrue
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the DeviceType defined in OPC 10000-100, i.e. inheriting the Instance Declarations of that Node.
0:HasComponentObjectUIInfoUIInformationTypeO
Conformance Units
TMC Advanced Visualisation and Control
BrowseName Description
UIInfoThe visualization resources to display the Device on the User Interface.

Instances of the TMCDeviceType and derived types are components of the DeviceSet Object as defined by OPC10000-100, 5.9 DeviceSet.

For additional clarity, TMCDeviceType instances and instances of derived types shall be grouped under the DeviceSet object.

9 OPC UA EventTypes

Servers shall generate events for the TMC defined objects according to the 0:GeneratesEvent reference in the model. The implementation of events is mandatory for all instances having such references.

9.1 LogbookEventType Event Type

The LogbookEventType is abstract. There will be no instances of a LogbookEventType itself, but there will be instances of its sub-types.

Subtypes of LogbookEventType provide detailed information on the event they are triggered by.

The LogbookEventType representation in the AddressSpace is formally defined in the following table.

Table 148 – LogbookEventType Definition
Attribute Value
BrowseNameLogbookEventType
IsAbstractTrue
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the BaseEventType defined in OPC 10000-5: OPC Unified Architecture Part 5: Information Model, which means it inherits the Instance Declarations of that Node. Please note that Time and Message belong to BaseEventType.

9.2 CarrierEnteredLogType EventType

The CarrierEnteredLogType event is generated when a carrier is identified by the underlying system.

The CarrierEnteredLogType representation in the AddressSpace is formally defined in the following table.

Table 149 – CarrierEnteredLogType Definition
Attribute Value
BrowseNameCarrierEnteredLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the LogbookEventType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableCarrierID0:String0:PropertyTypeM, RO
BrowseName Description
CarrierIDThe unique identifier for the carrier that has just entered.

9.3 CarrierReleasedLogType EventType

The CarrierReleasedLogType event is generated when a carrier is released by the underlying system.

The CarrierReleasedLogType representation in the AddressSpace is formally defined in the following table.

Table 150 – CarrierReleasedLogType Definition
Attribute Value
BrowseNameCarrierReleasedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the LogbookEventType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableCarrierID0:String0:PropertyTypeM, RO
BrowseName Description
CarrierIDThe unique identifier for the carrier that is released.

9.4 CarrierSublotsChangeLogType EventType

The CarrierSublotsChangeLogType event is generated when the sublots in a carrier change.

The CarrierSublotsChangeLogType representation in the AddressSpace is formally defined in the following table.

Table 151 – CarrierSublotsChangeLogType Definition
Attribute Value
BrowseNameCarrierSublotsChangeLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the LogbookEventType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableCarrierID0:String0:PropertyTypeM, RO
0:HasPropertyVariableSublotsMaterialSublotType[]0:PropertyTypeM, RO
BrowseName Description
CarrierIDThe unique identifier for the carrier whose payload is modified.
SublotsThe sublots after the modification.

9.5 SubCarrierLoadedLogType EventType

The SubCarrierLoadedLogType event is generated when a (sub)carrier or a material lot is loaded onto a carrier.

The SubCarrierLoadedLogType representation in the AddressSpace is formally defined in the following table.

Table 152 – SubCarrierLoadedLogType Definition
Attribute Value
BrowseNameSubCarrierLoadedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the LogbookEventType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableCarrierID0:String0:PropertyTypeM, RO
0:HasPropertyVariableSubCarrierID0:String0:PropertyTypeM, RO
BrowseName Description
CarrierIDThe unique identifier of the carrier where the subcarrier is loaded.
SubCarrierIDThe unique identifier for the subcarrier that is loaded on the carrier.

9.6 SubCarrierLoadingEndedLogType EventType

The SubCarrierLoadingEndedLogType event is generated when the loading of a carrier is complete.

The SubCarrierLoadingEndedLogType representation in the AddressSpace is formally defined in the following table.

Table 153 – SubCarrierLoadingEndedLogType Definition
Attribute Value
BrowseNameSubCarrierLoadingEndedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the LogbookEventType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableCarrierID0:String0:PropertyTypeM, RO
BrowseName Description
CarrierIDThe unique identifier for the carrier that ended loading.

9.7 SubCarrierLoadingStartedLogType EventType

The SubCarrierLoadingStartedLogType event is generated when the loading onto a carrier is started.

The SubCarrierLoadingStartedLogType representation in the AddressSpace is formally defined in the following table.

Table 154 – SubCarrierLoadingStartedLogType Definition
Attribute Value
BrowseNameSubCarrierLoadingStartedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the LogbookEventType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableCarrierID0:String0:PropertyTypeM, RO
BrowseName Description
CarrierIDThe unique identifier for the carrier that started loading.

9.8 SubCarrierUnloadedLogType EventType

The SubCarrierUnloadedLogType event is generated when a (sub)carrier or a material sublot is unloaded from a carrier.

The SubCarrierUnloaadedLogType representation in the AddressSpace is formally defined in the following table.

Table 155 – SubCarrierUnloadedLogType Definition
Attribute Value
BrowseNameSubCarrierUnloadedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the LogbookEventType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableCarrierID0:String0:PropertyTypeM, RO
0:HasPropertyVariableSubCarrierID0:String0:PropertyTypeM, RO
BrowseName Description
CarrierIDThe unique identifier for the carrier that has been unloaded with the subcarrier.
SubCarrierIDThe unique identifier for the subcarrier that has been unloaded.

9.9 SubCarrierUnloadingEndedLogType EventType

The SubCarrierUnloadingEndedLogType event is generated when the unloading from a carrier is complete.

The SubCarrierUnloadingEndedLogType representation in the AddressSpace is formally defined in the following table.

Table 156 – SubCarrierUnloadingEndedLogType Definition
Attribute Value
BrowseNameSubCarrierUnloadingEndedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the LogbookEventType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableCarrierID0:String0:PropertyTypeM, RO
BrowseName Description
CarrierIDThe unique identifier for the carrier that ended unloading.

9.10 SubCarrierUnloadingStartedLogType EventType

The SubCarrierUnloadingStartedLogType event is generated when the unloading from a carrier is started.

The SubCarrierUnloadingStartedLogType representation in the AddressSpace is formally defined in the following table.

Table 157 – SubCarrierUnloadingStartedLogType Definition
Attribute Value
BrowseNameSubCarrierUnloadingStartedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the LogbookEventType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableCarrierID0:String0:PropertyTypeM, RO
BrowseName Description
CarrierIDThe unique identifier for the carrier that started unloading.

9.11 MachineContextLogType EventType

The MachineContextLogType event is abstract, meaning no instances of the event type will be created. The MachineContextLogType payload contains machine status context to the derived event types.

The MachineContextLogType representation in the AddressSpace is formally defined in the following table.

Table 158 – MachineContextLogType Definition
Attribute Value
BrowseNameMachineContextLogType
IsAbstractTrue
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the LogbookEventType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableExecuteStateMachineStateNumber0:UInt320:PropertyTypeM, RO
0:HasPropertyVariableUserMachineName0:String0:PropertyTypeM, RO
0:HasPropertyVariableStateMachineStateNumber0:UInt320:PropertyTypeM, RO
BrowseName Description
ExecuteStateMachineStateNumberThe value of the state number attribute for the ExecuteStateMachine of the object containing the event notifier.
UserMachineNameThe name of the machine for the user.
StateMachineStateNumberThe value of the state number attribute for the TMCStateMachine of the object containing the event notifier.

9.12 ControlModeChangeLogType EventType

The ControlModeChangeLogType event is generated when the control mode changes.

The ControlModeChangeLogType representation in the AddressSpace is formally defined in the following table.

Table 159 – ControlModeChangeLogType Definition
Attribute Value
BrowseNameControlModeChangeLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MachineContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableNewControlModeControlModeEnumeration0:PropertyTypeM, RO
0:HasPropertyVariableOldControlModeControlModeEnumeration0:PropertyTypeM, RO
BrowseName Description
NewControlModeThe control mode after the change.
OldControlModeThe control mode prior to the change.

9.13 MachineModuleSpecificationChangeLogType EventType

The MachineModuleSpecificationChangeLogType event is generated when the specification of a machine module is changed.

The MachineModuleSpecificationChangeLogType representation in the AddressSpace is formally defined in the following table.

Table 160 – MachineModuleSpecificationChangeLogType Definition
Attribute Value
BrowseNameMachineModuleSpecificationChangeLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MachineContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableNewMaterialLoadingPointsMaterialPointType[]0:PropertyTypeM, RO
0:HasPropertyVariableNewMaterialOutputPointsMaterialPointType[]0:PropertyTypeM, RO
0:HasPropertyVariableNewMaterialRejectionPointsMaterialPointType[]0:PropertyTypeM, RO
0:HasPropertyVariableNewMaterialStorageBuffersMaterialStorageBufferDataType[]0:PropertyTypeM, RO
0:HasPropertyVariableNewValidSince0:UtcTime0:PropertyTypeM, RO
0:HasPropertyVariableOldMaterialLoadingPointsMaterialPointType[]0:PropertyTypeM, RO
0:HasPropertyVariableOldMaterialOutputPointsMaterialPointType[]0:PropertyTypeM, RO
0:HasPropertyVariableOldMaterialRejectionPointsMaterialPointType[]0:PropertyTypeM, RO
0:HasPropertyVariableOldMaterialStorageBuffersMaterialStorageBufferDataType[]0:PropertyTypeM, RO
BrowseName Description
NewMaterialLoadingPointsThe specification of the material loading points after the change.
NewMaterialOutputPointsThe specification of the material output points after the change.
NewMaterialRejectionPointsThe specification of the material rejection points after the change.
NewMaterialStorageBuffersThe specification of the material storage buffers after the change.
NewValidSinceWhen the change to the specifications occurred.
OldMaterialLoadingPointsThe specification of the material loading points prior to the change.
OldMaterialRejectionPointsThe specification of the material rejection points prior to the change.
OldMaterialStorageBuffersThe specification of the material storage buffers prior to the change.

9.14 RootCauseGroupListChangeLogType EventType

The RootCauseGroupListChangeLogType event is generated when the root cause group list is changed.

The RootCauseGroupListChangeLogType representation in the AddressSpace is formally defined in the following table.

Table 161 – RootCauseGroupListChangeLogType Definition
Attribute Value
BrowseNameRootCauseGroupListChangeLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MachineContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableNewRootCauseGroupsRootCauseGroupType[]0:PropertyTypeM, RO
0:HasPropertyVariableOldRootCauseGroupsRootCauseGroupType[]0:PropertyTypeM, RO
BrowseName Description
NewRootCauseGroupsThe root cause groups after the change.
OldRootCauseGroupsThe root cause groups prior to the change.

9.15 RootCauseListChangeLogType EventType

The RootCauseListChangeLogType event is generated when the root cause list is changed.

The RootCauseListChangeLogType representation in the AddressSpace is formally defined in the following table.

Table 162 – RootCauseListChangeLogType Definition
Attribute Value
BrowseNameRootCauseListChangeLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MachineContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableNewRootCauseMessagesRootCauseMessageType[]0:PropertyTypeM, RO
0:HasPropertyVariableOldRootCauseMessagesRootCauseMessageType[]0:PropertyTypeM, RO
BrowseName Description
NewRootCauseMessagesThe list of modified root cause messages.
OldRootCauseMessages

The list of root cause messages prior to the change.

Each old root cause message is in the same position in the array as the respective new root cause message.

9.16 StopReasonListChangeLogType EventType

The StopReasonListChangeLogType event is generated when the stop reason list changes.

The StopReasonListChangeLogType representation in the AddressSpace is formally defined in the following table.

Table 163 – StopReasonListChangeLogType Definition
Attribute Value
BrowseNameStopReasonListChangeLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MachineContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableNewStopReasonMessagesMessageType[]0:PropertyTypeM, RO
0:HasPropertyVariableOldStopReasonMessagesMessageType[]0:PropertyTypeM, RO
BrowseName Description
NewStopReasonMessagesThe list of modified stop reasons.
OldStopReasonMessages

The list of stop reasons prior to the change.

Each old stop reason is in the same position in the array as the respective new stop reason.

9.17 ProductionContextLogType EventType

The ProductionContextLogType event is abstract, meaning no instances of the event type will be created. The ProductionContextLogType payload contains production status context to the derived event types.

The ProductionContextLogType representation in the AddressSpace is formally defined in the following table.

Table 164 – ProductionContextLogType Definition
Attribute Value
BrowseNameProductionContextLogType
IsAbstractTrue
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MachineContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariablePONumber0:String0:PropertyTypeM, RO
0:HasPropertyVariableProductionStateMachineStateNumber0:UInt320:PropertyTypeM, RO
BrowseName Description
PONumber

The PO number for the production order running in the machine module containing the node that generates the event.

If no PO is running, then PONumber returns an empty string.

ProductionStateMachineStateNumber

The value of the state number attribute for the ProductionStateMachine of the machine module containing the event notifier.

If no PO is running, then PONumber returns 0.

9.18 DataSetChangeLogType EventType

The DataSetChangeLogType event is generated when the dataset changes.

The DataSetChangeLogType representation in the AddressSpace is formally defined in the following table.

Table 165 – DataSetChangeLogType Definition
Attribute Value
BrowseNameDataSetChangeLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ProductionContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableNewDataSetEntriesDataSetEntryType[]0: PropertyTypeM, RO
0:HasPropertyVariableNewDataSetID0:String0: PropertyTypeM, RO
0:HasPropertyVariableOldDataSetEntriesDataSetEntryType[]0: PropertyTypeM, RO
0:HasPropertyVariableOldDataSetID0:String0: PropertyTypeM, RO
BrowseName Description
NewDataSetEntriesThe list of modified dataset entries.
NewDataSetIDThe unique identifier for the dataset after the modification.
OldDataSetEntries

The list of dataset entries prior to the change.

Each old dataset entry is in the same position in the array as the respective modified dataset entry.

OldDataSetIDThe unique identifier for the dataset before the modification.

9.19 DefectDetectedLogType EventType

The DefectDetectedLogType event is generated when a defect is detected. Multiple defect detections can be grouped to generate a lower number of messages that is supported by the underlying system.

The DefectDetectedLogType representation in the AddressSpace is formally defined in the following table.

Table 166 – DefectDetectedLogType Definition
Attribute Value
BrowseNameDefectDetectedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ProductionContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableDefectEU0:EUInformation[]0:PropertyTypeO, RO
0:HasPropertyVariableDefectPicture0:Image0:PropertyTypeO, RO
0:HasPropertyVariableDefectValue0:Double[]0:PropertyTypeO, RO
BrowseName Description
DefectEUThe engineering units of the measurement of the defect.
DefectPictureThe picture relevant to the defect detected.
DefectValueThe measurement of the defects.

9.20 DetectionModeChangeLogType EventType

The DetectionModeChangeLogType event is generated when the detection mode of a defect detection sensor changes.

The DetectionModeChangeLogType representation in the AddressSpace is formally defined in the following table.

Table 167 – DetectionModeChangeLogType Definition
Attribute Value
BrowseNameDetectionModeChangeLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ProductionContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableDetectionMode0:Boolean0:PropertyTypeM, RO
BrowseName Description
DetectionModeThe detection mode after the change.

9.21 DowntimeLogType EventType

The DowntimeLogType event is generated when a downtime event finishes and the machine restarts.

The DowntimeLogType representation in the AddressSpace is formally defined in the following table.

Table 168 – DowntimeLogType Definition
Attribute Value
BrowseNameDowntimeLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ProductionContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableDuration0:Duration0:PropertyTypeM, RO
0:HasPropertyVariableRootCausesRootCauseMessageType[]0:PropertyTypeO, RO
0:HasPropertyVariableStopReasonsMessageType[]0:PropertyTypeM, RO
BrowseName Description
DurationThe duration of the downtime in seconds until the machine restarts.
RootCausesThe root causes reported by the machine during the downtime.
StopReasonsThe stop reasons reported by the machine during the downtime.

9.22 POStartedLogType EventType

The POStartedLogType event is generated when a PO is started.

The POStartedLogType representation in the AddressSpace is formally defined in the following table.

Table 169 – POStartedLogType Definition
Attribute Value
BrowseNamePOStartedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ProductionContextLogType, which means it inherits the Instance Declarations of that Node.

9.23 POStoppedLogType EventType

The POStoppedLogType event is generated when the running production order changes in a machine module.

The POStoppedLogType representation in the AddressSpace is formally defined in the following table.

Table 170 – POStoppedLogType Definition
Attribute Value
BrowseNamePOStoppedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ProductionContextLogType, which means it inherits the Instance Declarations of that Node.

9.24 ProcessItemResetLogType EventType

The ProcessItemResetLogType event is generated when the aggregates of a process item are reset.

The ProcessItemResetLogType representation in the AddressSpace is formally defined in the following table.

Table 171 – ProcessItemResetLogType Definition
Attribute Value
BrowseNameProcessItemResetLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ProductionContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasComponentVariableAvg0:Double0:BaseDataVariableTypeM, RO
0:HasComponentVariableMax0:Double0:BaseDataVariableTypeM, RO
0:HasComponentVariableMin0:Double0:BaseDataVariableTypeM, RO
0:HasComponentVariableStd0:Double0:BaseDataVariableTypeM, RO
0:HasComponentVariableTotal0:Double0:BaseDataVariableTypeM, RO
0:HasComponentVariableSamplingRate0:Double0:AnalogUnitRangeTypeM, RO
0:HasPropertyVariableAggregationWindow0:UInt320:PropertyTypeM, RO
0:HasPropertyVariableLastResetTime0:UtcTime0:PropertyTypeM, RO
BrowseName Description
Avg

The average of valid values over the last AggregationWindow samples and after the last reset.

It is only reset by the successful execution of the ResetAggregates method.

Max

The maximum valid value for the last AggregationWindow samples and after the last reset.

It is only reset by the successful execution of the ResetAggregates method.

Min

The minimum valid value for the last AggregationWindow samples and after the last reset.

It is only reset by the successful execution of the ResetAggregates method.

Std

The standard deviation of the valid value for the last AggregationWindow samples and after the last reset. After reset, when only one value is available, the standard deviation is not defined and zero will be returned.

It is only reset by the successful execution of the ResetAggregates method.

Total

The accumulated total of the valid value for the last AggregationWindow samples and after the last reset.

It is only reset by the successful execution of the ResetAggregates method.

SamplingRate

The rate samples are collected for aggregation. The rate is referred to the either product or time, as indicated by the EURange property.

For example, SamplingRate equal to 100 ms means that the value is measured and collected for aggregation every 100 ms. SamplingRate equal to 10 kg means that the value is measured and collected for aggregation every 10 kg of product. SamplingRate equal to 100 rods means that the value is measured and collected for aggregation every 100 rods of product.

The EURange property of the SamplingRate is read only and defines both the unit of measure and the supported range.

The value of the SamplingRate can be set by a client to obtain the desired sampling rate for aggregation.

If the written value is below (above) the minimum (maximum) value that can be managed by the underlying system, the underlying system will overwrite it with the minimum (maximum).

The underlying system will support equivalent sampling rates of 100ms or better.

AggregationWindow

Tthe number of samples over which the aggregates are computed. When the number of aggregated samples since the last reset exceeds the AggregationWindow, the aggregates are rolled over, i.e. computed over the last AggregationWindow number of samples.

The value of the AggregationWindow can be set by a client to obtain the desired aggregation.

If the written value is below (above) the minimum (maximum) value that can be managed by the underlying system, the underlying system will overwrite it with the minimum (maximum).

LastResetTimeThe time (in UTC) when ResetAggregates was last successfully executed.

9.25 RejectionModeChangeLogType EventType

The RejectionModeChangeLogType event is generated when the rejection mode of a material rejection trap changes.

The RejectionModeChangeLogType representation in the AddressSpace is formally defined in the following table.

Table 172 – RejectionModeChangeLogType Definition
Attribute Value
BrowseNameRejectionModeChangeLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ProductionContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableRejectionMode0:Boolean0:PropertyTypeM, RO
BrowseName Description
RejectionModeThe rejection mode after the change.

9.26 StateChangeLogType EventType

The StateChangeLogType event is generated when the state in a LiveStatus object changes.

The StateChangeLogType representation in the AddressSpace is formally defined in the following table.

Table 173 – StateChangeLogType Definition
Attribute Value
BrowseNameStateChangeLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ProductionContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableNewStateStateEnumeration0:PropertyTypeM, RO
0:HasPropertyVariableOldStateStateEnumeration0:PropertyTypeM, RO
BrowseName Description
NewStateThe state after the change,
OldStateThe state prior to the change,

9.27 MaterialContextLogType EventType

The MaterialContextLogType event is abstract, meaning no instances of the event type will be created. The MaterialContextLogType payload contains the location of material production and consumption context to the derived event types.

The MaterialContextLogType representation in the AddressSpace is formally defined in the following table.

Table 174 – MaterialContextLogType Definition
Attribute Value
BrowseNameMaterialContextLogType
IsAbstractTrue
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the ProductionContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableMaterialPointID0:String0:PropertyTypeM, RO
0:HasPropertyVariableMaterialPointMES_ID0:String0:PropertyTypeM, RO
BrowseName Description
MaterialPointIDThe unique identifier of the material point (loading point, rejection point or output point).
MaterialPointMES_IDThe higher-level system unique identifier of the material point (loading point, rejection point or output point).

9.28 IntegrityRejectedMaterialLogType EventType

The IntegrityRejectedMaterialLogType event is generated when the validation of a presented material is negative.

The IntegrityRejectedMaterialLogType representation in the AddressSpace is formally defined in the following table.

Table 175 – IntegrityRejectedMaterialLogType Definition
Attribute Value
BrowseNameIntegrityRejectedMaterialLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MaterialContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableRejectedSublotMaterialSublotType0:PropertyTypeM, RO
BrowseName Description
RejectedSublotThe sublot of the rejected material.

9.29 LoadingPointUnloadedLogType EventType

The LoadingPointUnloadedLogType event is generated when a presented material is removed from a loading point.

The LoadingPointUnloadedLogType representation in the AddressSpace is formally defined in the following table.

Table 176 – LoadingPointUnloadedLogType Definition
Attribute Value
BrowseNameLoadingPointUnloadedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MaterialContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableMaterialSublotMaterialSublotType0:PropertyTypeM, RO
BrowseName Description
MaterialSublotThe material sublot unloaded from the loading point.

9.30 MaterialConsumedLogType EventType

The MaterialConsumedLogType event is generated when a material sublot is consumed at a loading point.

The MaterialConsumedLogType representation in the AddressSpace is formally defined in the following table.

Table 177 – MaterialConsumedLogType Definition
Attribute Value
BrowseNameMaterialConsumedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MaterialContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasComponentVariableConsumedMaterial0:DoubleMaterialSublotVariableTypeM, RO
0:HasComponentVariableConsumedMaterialTotal0:DoubleMaterialQuantityVariableTypeM, RO
BrowseName Description
ConsumedMaterialThe last material sublot consumed.
ConsumedMaterialTotalThe total consumed material.

9.31 MaterialDispensedLogType EventType

The MaterialDispensedLogType event is generated when some material is dispensed at a loading point.

The MaterialDispensedLogType representation in the AddressSpace is formally defined in the following table.

Table 178 – MaterialDispensedLogType Definition
Attribute Value
BrowseNameMaterialDispensedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MaterialContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasComponentVariableDispensedMaterial0:DoubleMaterialSublotVariableTypeM, RO
0:HasComponentVariableDispensedMaterialTotal0:DoubleMaterialQuantityVariableTypeM, RO
BrowseName Description
DispensedMaterialThe material dispensed from the last consumed sublot.
DispensedMaterialTotalThe total dispensed material.

9.32 MaterialOutputProducedLogType EventType

The MaterialOutputProducedLogType event is generated when (a) a sublot of good product is produced or (b) some time elapsed.

If a sublot is not produced, events are generated anyway maximum every 5 seconds. A period of 1 second is recommended.

QuantityProduced is incremented every time an identified sublot is produced.

TotalProduced is incremented as product output is produced.

The MaterialOutputProducedLogType representation in the AddressSpace is formally defined in the following table.

Table 179 – MaterialOutputProducedLogType Definition
Attribute Value
BrowseNameMaterialOutputProducedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MaterialContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasComponentVariableProducedMaterial0:DoubleMaterialSublotVariableTypeM, RO
0:HasComponentVariableProducedMaterialTotal0:DoubleMaterialQuantityVariableTypeM, RO
BrowseName Description
ProducedMaterialThe material quantity last produced i.e. produced since the previous event of the same type.
ProducedMaterialTotalThe total material quantity.

9.33 MaterialRejectedLogType EventType

The MaterialRejectedLogType event is generated when some material is rejected at a rejection trap.

Multiple material rejection can be grouped to generate a lower number of messages that is supported by the underlying system.

The MaterialRejectedLogType representation in the AddressSpace is formally defined in the following table.

Table 180 – MaterialRejectedLogType Definition
Attribute Value
BrowseNameMaterialRejectedLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MaterialContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasComponentVariableRejectedMaterial0:DoubleMaterialQuantityVariableTypeM, RO
0:HasComponentVariableRejectedMaterialTotal0:DoubleMaterialQuantityVariableTypeM, RO
BrowseName Description
RejectedMaterialThe material quantity last rejected, i.e. rejected since the previous event of the same type.
RejectedMaterialTotalThe total material quantity rejected.

9.34 MaterialUnloadingRequiredLogType EventType

The MaterialUnloadingRequiredLogType event is generated when some material is required to be removed from the machine module loading point.

The MaterialUnloadingRequiredLogType representation in the AddressSpace is formally defined in the following table.

Table 181 – MaterialUnloadingRequiredLogType Definition
Attribute Value
BrowseNameMaterialUnloadingRequiredLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MaterialContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableMaterialSublotMaterialSublotType0:PropertyTypeM, RO
BrowseName Description
MaterialSublotThe material sublot that is requested to be unloaded.

9.35 NewPresentedMaterialLogType EventType

The NewPresentedMaterialLogType event is generated when a new material sublot is presented and identified at a machine module loading point.

The NewPresentedMaterialLogType representation in the AddressSpace is formally defined in the following table.

Table 182 – NewPresentedMaterialLogType Definition
Attribute Value
BrowseNameNewPresentedMaterialLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MaterialContextLogType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableMaterialSublotMaterialSublotType0:PropertyTypeM, RO
BrowseName Description
MaterialSublotThe material sublot that is presented.

9.36 ProductionOrderTransitionLogType EventType

The ProductionOrderTransitionLogType event is generated when there is a state transition in the machine module production order state machine.

The ProductionOrderTransitionLogType representation in the AddressSpace is formally defined in the following table.

Table 183 – ProductionOrderTransitionLogType Definition
Attribute Value
BrowseNameProductionOrderTransitionLogType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the TransitionEventType defined in OPC 10000-16, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableUserMachineName0:String0:PropertyTypeM, RO
0:HasPropertyVariablePONumber0:String0:PropertyTypeM, RO
BrowseName Description
UserMachineNameThe user name for the machine producing the production order.
PONumberThe PO active when the production order state machine performed a transition.

9.37 ExternalAlarmType Event Type

The ExternalAlarmType EventType is an alarm that is managed by the underlying system (display, acknowledge, retain, reset, etc) while the alarm condition is generated and set by an external system connected as a client.

The ExternalAlarmType representation in the AddressSpace is formally defined in the following table.

Table 184 – ExternalAlarmType Definition
Attribute Value
BrowseNameExternalAlarmType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the DiscreteAlarmType defined in OPC 10000-9: OPC Unified Architecture Part 9: Alarms & Conditions, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableExternalAlarmCondition0:Boolean0:PropertyTypeM, RW
0:HasComponentMethodSetMessageSee below.M
BrowseName Description
ExternalAlarmConditionThe condition that causes the alarm.

9.37.1 SetMessage Method

The Method SetMessage sets the Message that the underlying system will display for the alarm. Message is inherited from a parent type.

The signature of this Method is specified below. Table 185 specifies the Arguments representation.

Signature

	SetMessage (
	  [in]		0:LocalizedText				Message,
	  [out] 	MethodExecutionFeedbackType	ExecutionFeedback);
Table 185 – SetMessage Method Arguments
Argument Description
MessageThe message that will be displayed for the external alarm.
ExecutionFeedbackThe extended feedback returning a detailed message in case of execution failure.

10 OPC UA VariableTypes

10.1 DisplayAnalogUnitType

The DisplayAnalogUnitType is a subtype of the AnalogUnitType. It is used to provide an analog signal as well as its display format.

DisplayAnalogUnitType is formally defined in the following table.

Table 186 – DisplayAnalogUnitType Definition
Attribute Value
BrowseNameDisplayAnalogUnitType
IsAbstractFalse
ValueRank−1 (−1 = Scalar)
DataType0:Number
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the AnalogUnitType defined in OPC 10000-8, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableDisplayFormat0:String0:PropertyTypeM, RO
BrowseName Description
DisplayFormatDisplay format for visualization of the AnalogUnitType. The same display format shall be used in the HMI. DisplayFormat is a numeric format string as defined by the Microsoft .NET documentation (check link).

10.2 MaterialQuantityVariableType

The MaterialQuantityVariableType is a subtype of the DisplayAnalogUnitType. It is used to provide a material quantity.

MaterialQuantityVariableType is formally defined in the following table.

Table 187 – MaterialQuantityVariableType Definition
Attribute Value
BrowseNameMaterialQuantityVariableType
IsAbstractFalse
ValueRank−1 (−1 = Scalar)
DataType0:Double
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the DisplayAnalogUnitType defined in OPC 10000-8, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableEURange0:Range0:PropertyTypeM, RO
0:HasComponentVariableValueInBUoM0:DoubleDisplayAnalogUnitTypeM, RO
BrowseName Description
EURangeThe range for the material quantity value.
ValueInBUoMThe material quantity in base unit of measure.

10.3 MaterialRateType

The MaterialRateType is a subtype of the MaterialQuantityVariableType. It is used to provide the rate for a material flow rate.

MaterialRateType is formally defined in the following table.

Table 188 – MaterialRateType Definition
Attribute Value
BrowseNameMaterialRateType
IsAbstractFalse
ValueRank−1 (−1 = Scalar)
DataType0:Double
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MaterialQuantityVariableType, which means it inherits the Instance Declarations of that Node.

10.4 MaterialLotVariableType

The MaterialLotVariableType is a subtype of the MaterialQuantityVariableType. It is used to provide the quantity for a material lot.

MaterialLotVariableType is formally defined in the following table.

Table 189 – MaterialLotVariableType Definition
Attribute Value
BrowseNameMaterialLotVariableType
IsAbstractFalse
ValueRank−1 (−1 = Scalar)
DataType0:Double
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MaterialQuantityVariableType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableMaterialLotMaterialLotType0:PropertyTypeM, RO
BrowseName Description
MaterialLotThe material definition for the lot.

10.5 MaterialSublotVariableType

The MaterialSublotVariableType is a subtype of the MaterialQuantityVariableType. It is used to provide the quantity for a material sublot.

MaterialSublotVariableType is formally defined in the following table.

Table 190 – MaterialSublotVariableType Definition
Attribute Value
BrowseNameMaterialSublotVariableType
IsAbstractFalse
ValueRank−1 (−1 = Scalar)
DataType0:Double
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the MaterialQuantityVariableType, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariableCarrierID0:String0:PropertyTypeO, RO
0:HasPropertyVariableID0:String0:PropertyTypeM, RO
0:HasPropertyVariableMaterialLotMaterialLotType0:PropertyTypeM, RO
0:HasPropertyVariableMaterialStorageLocationID0:String0:PropertyTypeM, RO
0:HasPropertyVariableMES_ID0:String0:PropertyTypeM, RO
0:HasPropertyVariableParentSublotID0:String0:PropertyTypeO, RO
0:HasPropertyVariableRelativePositionID0:String0:PropertyTypeO, RO
0:HasPropertyVariableSublotsMaterialSublotType[]0:PropertyTypeO, RO
BrowseName Description
CarrierIDThe unique identifier of the carrier containing the material sublot.
IDThe unique identifier for the material sublot.
MaterialLotThe material lot of the material sublot.
MaterialStorageLocationIDThe material storage location where the material sublot is located.
MES_IDThe unique identifier for the material sublot for a higher-level system e.g. MES.
ParentSublotIDThe unique identified for the parent sublot, if any.
RelativePositionIDThe relative position of the sublot within the carrier identified by CarrierID.
SublotsThe sublots contained in the sublot.

10.6 BooleanGuardVariableType

The BooleanGuardVariableType is a subtype of the GuardVariableType. It is used to provide the conditions to trigger a transition in a state machine. Each Condition component is necessary. When all the Condition components are True, the transition is triggered (sufficient).

BooleanGuardVariableType is formally defined in the following table.

Table 191 – BooleanGuardVariableType Definition
Attribute Value
BrowseNameBooleanGuardVariableType
IsAbstractFalse
ValueRank−1 (−1 = Scalar)
DataType0:LocalizedText
References NodeClass BrowseName DataType TypeDefinition Other
Subtype of the GuardVariableType defined in OPC 10000-16, which means it inherits the Instance Declarations of that Node.
0:HasPropertyVariable<Condition>0:Boolean0:PropertyTypeMP, RW
BrowseName Description
ConditionA condition that is necessary to trigger a transition in a state machine. The description is the human-readable identification of the value of the Condition. The browse name is the human-readable identification subject to naming conventions and browse name limitations.

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

12 OPC UA ReferenceTypes

12.1 FlowsTo ReferenceType

The FlowsTo ReferenceType is a concrete ReferenceType and can be used directly. It is a subtype of NonHierarchicalReferences.

The semantic of this ReferenceType is to link TMC objects according to the material flow, within a machine module and between machine modules.

The SourceNode of References of this type shall be of type: MaterialLoadingPointType, MaterialOutputPointType, MaterialRejectionPointType, MaterialStorageBufferType.

The TargetNode of this ReferenceType shall be of type: MaterialLoadingPointType, MaterialOutputPointType, MaterialRejectionPointType, MaterialStorageBufferType.

The FlowsTo ReferenceType is formally defined in the following table.

Table 234 – FlowsTo ReferenceType Definition
Attributes Value
BrowseNameFlowsTo
InverseNameFlowsFrom
SymmetricFalse
IsAbstractFalse
References NodeClass BrowseName Comment
Subtype 0:NonHierarchicalReferences defined in OPC 10000-5

12.2 Precedes ReferenceType

The Precedes ReferenceType is a concrete ReferenceType and can be used directly. It is a subtype of NonHierarchicalReferences.

The semantic of this ReferenceType is to link upstream process values to downstream process values.

The SourceNode of References of this type shall be of type ProcessItemType ObjectType.

The TargetNode of this ReferenceType shall be of type ProcessItemType ObjectType.

The Precedes ReferenceType is formally defined in the following table.

Table 235 – Precedes ReferenceType Definition
Attributes Value
BrowseNamePrecedes
InverseNameFollows
SymmetricFalse
IsAbstractFalse
References NodeClass BrowseName Comment
Subtype 0:NonHierarchicalReferences defined in OPC 10000-5

12.3 HasUIShapeSelector ReferenceType

The HasUIShapeSelector is a concrete ReferenceType and can be used directly. It is a subtype of NonHierarchicalReferenceTypes.

The semantic of this ReferenceType is to link a UI resource to the conditions that will identify how it is displayed.

The SourceNode of References of this type shall be of type UIInformationType ObjectType.

The TargetNode of this ReferenceType shall be of NodeClass Variable.

The HasUIShapeSelector ReferenceType is formally defined in the following table.

Table 236 – HasUIShapeSelector ReferenceType Definition
Attributes Value
BrowseNameHasUIShapeSelector
InverseNameSelectsUIShape
SymmetricFalse
IsAbstractFalse
References NodeClass BrowseName Comment
Subtype of NonHierarchicalReferences defined in OPC 10000-5

12.4 IsDisplayedBy ReferenceType

The IsDisplayedReferenceType is a concrete ReferenceType and can be used directly. It is a subtype of NonHierarchicalReferenceType.

The semantic of this ReferenceType is to link an OPC UA construct to its UI representation.

The SourceNode of References of this type shall be of type ObjectType, when the ObjectType has the component UIInfo of type UIInformationType.

The TargetNode of this ReferenceType shall be the Variable ZoomedVU or the Variable OverVU of the UserInterfaceType ObjectType.

The IsDisplayedBy ReferenceType is formally defined in the following table.

Table 237 – IsDisplayedBy ReferenceType Definition
Attributes Value
BrowseNameIsDisplayedBy
InverseNameDisplays
SymmetricFalse
IsAbstractFalse
References NodeClass BrowseName Comment
Subtype NonHierarchicalReferences defined in OPC 10000-5

13 Profiles and Conformance Units

13.1 Conformance Units

The following table defines the ConformanceUnits for the OPC UA Information Model for TMC.

Table 238 – Conformance Units for TMC
Category Title Description
ServerTMC Data Collection

The CU supports the collection of basic data, including output counters and downtimes of machine modules.

At least one instance of the MachineModuleType is required.

The optional folders listed below and subcomponents are required for all instances of the MachineModuleType:

MaterialRejectionPoints;

MaterialOutputPoints.

ServerTMC Core Production

The CU supports production and the relevant flow of materials: from incoming raw materials to good output and rejects. The CU supports the minimum set of objects to capture which PO is running without datasets or material lists.

In detail, the Conformance Unit requires the following TMC types:

MachineModuleProductionType;

The optional folders listed below and subcomponents are required mandatorily for all instances of the MachineModuleType:

MaterialLoadingPoints;

MaterialBuffers.

ClientTMC Client Single PO Production

The CU supports the management of a single production order at the machine module, including starting, aborting and completing a production order.

In detail, the CU supports the following TMC types:

MachineModuleSetupType;

MachineModuleProductionType;

MachineModuleSpecificationType.

MachineModuleConfigurationType including optional subcomponents are required mandatorily for all instance of the MachineModuleType.

The optional methods listed below are required mandatorily for all instances of the MachineModuleProductionType:

AbortProductionOrder;

ClearProductionOrder;

ServerTMC Single PO Production

The CU supports the management of a single production order at the machine module, including starting, aborting and completing a production order.

In detail, the CU requires the following TMC types:

MachineModuleSetupType;

MachineModuleProductionType;

MachineModuleSpecificationType.

MachineModuleConfigurationType including optional subcomponents are required mandatorily for all instance of the MachineModuleType.

The optional methods listed below are required mandatorily for all instances of the MachineModuleProductionType:

AbortProductionOrder;

ClearProductionOrder;

ServerTMC Advanced Setup

The CU supports additional methods to manage the dataset and material list.

The optional methods of the MachineModuleSetup are required for all instances of the MachineModuleType.

ServerTMC Multi PO Production

The CU supports the management of multiple production orders at the machine module, a.k.a. batch control, including automatic batch propagation.

In detail, the CU requires the following TMC types:

MachineModuleSetupType;

MachineModuleProductionType;

MachineModuleConfigurationType including optional subcomponents are required mandatorily for all instance of the MachineModuleType.

The optional components of the MachineModuleProductionType, including those listed below, are required mandatorily for all instances of the MachineModuleProductionType:

AbortProductionOrder;

AssignedProductionOrders;

AssignProductionOrder;

AutoComplete;

AutoStart;

ClearProductionOrder;

StartAssignedProductionOrder;

StateMachine;

UnassignProductionOrder.

ClientTMC Client Multi PO Production

The CU supports the management of multiple production orders at the machine module, a.k.a. batch control, including automatic batch propagation.

The optional components of the MachineModuleProductionType, including those listed below, shall be supported for all instances of the MachineModuleProductionType:

AbortProductionOrder;

AssignedProductionOrders;

AssignProductionOrder;

AutoComplete;

AutoStart;

ClearProductionOrder;

StartAssignedProductionOrder;

StateMachine;

UnassignProductionOrder.

ServerTMC Asset Management

The CU supports the management of the machine asset digital information over its whole lifecycle.

The optional components listed below and subcomponents are required mandatorily for all instances of the MachineModuleType:

MachineModuleSpecification;

PastSpecificationRecords.

ServerTMC Quality Assurance and Control

The CU supports the management of defects and quality control at the machine.

The optional components listed below and subcomponents are required for all instances of the MachineModuleType:

DefectDetectionSensors, including the contained SensorFunctions and DefectReasons.

ServerTMC Basic Machine Status

The CU supports the collection and control of live machine status.

The CU requires the following TMC types:

MachineModuleLiveStatusType.

ServerTMC Advanced Machine Status

The CU supports the advanced collection and control of live machine status, including complete state machines and transition conditions.

The optional components listed below are required mandatorily for all instances of the MachineModuleLiveStatusType:

StateMachine.

ServerTMC Basic Visualization and Control

The CU supports the visualization and control of equipment modules and control modules.

The optional components listed below and subcomponents are required for all instances of the MachineModuleType:

EquipmentModules;

The instances of the types listed below shall be provided:

EquipmentModuleType;

EquipmentModuleConfigurationType;

EquipmentModuleLiveStatusType;

ControlModuleType;

ControlModuleAggregatesType;

ControlModuleConfigurationType;

ControlModuleLiveStatusType;

ControlModuleSetupType;

AnalogInputType;

DigitalInputType;

MotorType;

SensorType;

ValveType;

MotorAggregatesType;

ValveAggregatesType;

AnalogInputSetupType;

DigitlaInputSetupType;

MotorSetupType;

ValveSetupType.

ServerTMC Advanced Visualization and Control

The CU supports advanced visualization and control by means of UI information exposed by the server enabling automatic generation of faceplates.

The optional components listed below are required mandatorily for all instances of the TMCDeviceType:

UIInfo

ServerTMC Process Variables Ingestion and Control

The CU supports the ingestion and control of process variables.

The optional components listed below and subcomponents shall be supported for all instances of the MachineModuleType:

ProcessItems;

ProcessControlLoops.

The instances of the types listed below are required:

ProcessItemType;

ProcessControlItemType;

ProcessControlLoopType.

ServerTMC Intralogistics at the Machine

The CU supports the intralogistics around the machine, i.e. material locations and the delivery of materials via carriers.

The optional components listed below and subcomponents shall be supported for all instances of the MachineModuleType:

MaterialLocations;

The instances of the types listed below and subcomponents are mandatorily required:

CarrierObjectType;

MaterialLocationType.

ServerTMC Production Order Orchestration Layer for Single PO

The CU supports the dispatching of single production orders to machine modules of a production cell, a.k.a. line.

The CU supports the ProductionOrderOrchestrationLayerType with all its mandatory InstanceDeclarations, and optionally the optional InstanceDeclarations.

ServerTMC Production Order Orchestration Layer for Multi PO

The CU supports the centralized management of production orders at a production cell, a.k.a. line, including waiting lists.

The CU supports the ProductionOrderOrchestrationLayerType with all its mandatory InstanceDeclarations, and also mandatorily the optional InstanceDeclarations.

ClientTMC Client Production Order Orchestration Layer

The CU supports the centralized management of production orders at a production cell, a.k.a. line.

The CU supports the ProductionOrderOrchestrationLayerType with all its mandatory InstanceDeclarations, and also mandatorily the optional InstanceDeclarations.

ServerTMC Advanced Equipment Module and Control Module Status

The CU supports the collection and control of advanced live equipment module status by means of state machines and transition conditions.

The CU supports the optional StateMachine component in the EquipmentModuleLiveStatusType and in the ControlModuleLiveStatusType.

13.2 Profiles

13.2.1 Profile list

The following table lists all Profiles defined in this document and defines their URIs.

Table 239 – Profile URIs for Tobacco Machine Communication
Profile URI
TMC Core Production Server Facet http://opcfoundation.org/UA-Profile/TMC/Server/CoreProduction
TMC Asset Management Server Facet http://opcfoundation.org/UA-Profile/TMC/Server/AssetManagement
TMC Quality Assurance and Control Server Facet http://opcfoundation.org/UA-Profile/TMC/Server/QualityAssuranceAndControl
TMC Base Machine Status Server Facet http://opcfoundation.org/UA-Profile/TMC/Server/BaseMachineStatus
TMC Advanced Machine Status Server Facet http://opcfoundation.org/UA-Profile/TMC/Server/AdvancedMachineStatus
TMC Basic Visualization and Control Server Facet http://opcfoundation.org/UA-Profile/TMC/Server/BasicVisualizationAndControl
TMC Advanced Visualization and Control Server Facet http://opcfoundation.org/UA-Profile/TMC/Server/AdvancedVisualizationAndControl
TMC Process Variables Ingestion and Control Server Facet http://opcfoundation.org/UA-Profile/TMC/Server/ProcessVariablesIngestionAndControl
TMC Intralogistics at the Machine Server Facet http://opcfoundation.org/UA-Profile/TMC/Server/IntralogisticsAtTheMachine
TMC Advanced Equipment Module and Control Module Status Server Facet http://opcfoundation.org/UA-Profile/TMC/Server/AdvancedEquipmentModuleAndControlModuleStatus
TMC OPC UA Server Profile http://opcfoundation.org/UA-Profile/TMC/Server/Base
TMC OPC UA Client Profile http://opcfoundation.org/UA-Profile/TMC/Client/Base
TMC Data Collection Server Profile http://opcfoundation.org/UA-Profile/TMC/Server/DataCollectionProfile
TMC Single PO Production Server Profile http://opcfoundation.org/UA-Profile/TMC/Server/SinglePOProductionProfile
TMC Multi PO Production Profile http://opcfoundation.org/UA-Profile/TMC/ MultiPOProductionProfile
TMC Visualization and Control Profile http://opcfoundation.org/UA-Profile/TMC/ VCProfile
TMC Process Variables Ingestion and Control Profile http://opcfoundation.org/UA-Profile/TMC/ PVIngestionAndControlProfile
TMC Production Order Orchestration Layer Single PO Profile http://opcfoundation.org/UA-Profile/TMC/ ProductionOrderOrchestrationLayerSinglePOProfile
TMC Production Order Orchestration Layer Multi PO Profile http://opcfoundation.org/UA-Profile/TMC/ ProductionOrderOrchestrationLayerMultiPOProfile

13.2.2 Server Facets

13.2.2.1 Overview

The following sections specify the Facets available for Servers that implement the TMC companion specification. Each section defines and describes a Facet or Profile.

Optional Conformance Units and Facets are requested on a case-by-case basis by the TMC Server or Client user.

13.2.2.2 TMC Core Production Server Facet

The following table defines a Facet that describes the production and the relevant flow of materials: from incoming raw materials to good output and rejects.

Table 240 – TMC Core Production Server Facet
Group Conformance Unit / Profile Title Mandatory / Optional
TMCTMC Core ProductionM
TMCTMC Advanced SetupO
13.2.2.3 TMC Asset Management Server Facet

The following table defines a Facet that describes the management of the machine asset digital information over its whole lifecycle.

Table 241 – TMC Asset Management Server Facet
Group Conformance Unit / Profile Title Mandatory / Optional
TMCTMC Asset ManagementM
13.2.2.4 TMC Quality Assurance and Control Server Facet

The following table defines a Facet that describes the collection of quality and defect sensor data including reject reasons.

Table 242 – TMC Quality Assurance and Control Server Facet
Group Conformance Unit / Profile Title Mandatory / Optional
TMCTMC Data CollectionM
TMCTMC Core ProductionM
TMCTMC Quality Assurance and ControlM
13.2.2.5 TMC Basic Machine Status Server Facet

The following table defines a Facet that describes the collection and control of live machine status.

Table 243 – TMC Basic Machine Status Server Facet
Group Conformance Unit / Profile Title Mandatory / Optional
TMCTMC Core ProductionM
TMCTMC Basic Machine StatusM
13.2.2.6 TMC Advanced Machine Status Server Facet

The following table defines a Facet that describes the advanced collection and control of live machine status, including complete state machines and transition conditions.

Table 244 – TMC Advanced Machine Status Server Facet
Group Conformance Unit / Profile Title Mandatory / Optional
TMCTMC Basic Machine StatusM
TMCTMC Advanced Machine StatusM
13.2.2.7 TMC Basic Visualization and Control Server Facet

The following table defines a Facet that describes the visualisation and control of equipment modules and control modules.

Table 245 – TMC Basic Visualisation and Control Server Facet
Group Conformance Unit / Profile Title Mandatory / Optional
TMCTMC Basic Visualization and ControlM
13.2.2.8 TMC Advanced Visualization and Control Server Facet

The following table defines a Facet that describes the advanced visualization and control by means of UI information exposed by the server enabling automatic generation of faceplates.

Table 246 – TMC Advanced Visualisation and Control Server Facet
Group Conformance Unit / Profile Title Mandatory / Optional
TMCTMC Basic Visualization and ControlM
TMCTMC Advanced Visualization and ControlM
13.2.2.9 TMC Process Variables Ingestion and Control Server Facet

The following table defines a Facet that describes the ingestion and control of process variables.

Table 247 – TMC Process Variables Ingestion and Control Server Facet
Group Conformance Unit / Profile Title Mandatory / Optional
TMCTMC Process Variables Ingestion and ControlM
13.2.2.10 TMC Intralogistics at the Machine Server Facet

The following table defines a Facet that describes the intralogistics around the machine, i.e. material locations and the delivery of materials via carriers.

Table 248 – TMC Intralogistics at the Machine Server Facet
Group Conformance Unit / Profile Title Mandatory / Optional
TMCTMC Intralogistics at the MachineM
13.2.2.11 TMC Advanced Equipment Module and Control Module Status Server Facet

The following table defines a Facet that describes the collection and control of advanced live equipment module status by means of state machines and transition conditions.

Table 249 – TMC Advanced Equipment Module and Control Module Status Server Facet
Group Conformance Unit / Profile Title Mandatory / Optional
TMCTMC Advanced Equipment Module and Control Module StatusM
13.2.2.12 TMC OPC UA Server Profile

The following table defines a Profile that includes the OPC UA facets and profiles required by the TMC servers.

Table 250 – TMC OPC UA Server Profile
Group Conformance Unit / Profile Title Mandatory / Optional
Profile0:Standard 2017 UA Server ProfileM
Profile0:Base Server Behavior FacetM
Profile0:Request Server State ChangeO
Profile0:Documentation Server FacetO
Profile0:Durable Subscription Server FacetM
Profile0:Data Access Server FacetM
Data Access0:Data Access PercentDeadbandO
Profile0:ComplexType 2017 Server FacetM
Monitor Item Services0:Monitor Complex ValueM
Profile0:Standard Event Subscription Server FacetM
Profile0:Address Space Event Notifier Server FacetM
Profile0:Method Server FacetM
Method Services0:Method Call ComplexM
Profile0:Historical Raw Data Server FacetM
Profile0:Historical Data AtTime Server FacetM
Profile0:Historical Access Structured Data Server FacetM
Profile0:Base Historical Event Server FacetM
Profile0:Security Policy [B] – Basic256Sha256M
Profile0:Security Time SynchronizationM
Profile0:Best Practice - TimeoutsM
Profile0:Subnet Discovery Server FacetO
Profile0:Reverse Connect Server FacetO
Profile0:Global Certificate Management Server FacetM
Profile0:A & C CertificateExpiration Server FacetM
Profile0:A & C Non-Exclusive Alarm FacetM
Profile0:Auditing Server FacetO
13.2.2.13 TMC OPC UA Client Profile

The following table defines a Profile that includes the OPC UA facets and profiles required by the TMC servers.

Table 251 – TMC OPC UA Client Profile
Group Conformance Unit / Profile Title Mandatory / Optional
Profile0:Standard UA Client 2017 ProfileM
Profile0:State Machine Client FacetO
Profile0:Durable Subscription Client FacetM
Profile0:Data Access Client FacetM
Profile0:Event Subscriber Client FacetM
Profile0:Historical Access Client FacetO
Profile0:Subnet Discovery Client FacetO
Profile0:Reverse Connect Client FacetO
Profile0:Multi-Server Client Connection FacetM
Profile0:A & C Certificate Expiration Client FacetO
Profile0:Auditing Client FacetO
Profile0:Advanced Type Programming Client FacetO
13.2.2.14 TMC Data Collection Server Profile

The following table defines a Profile that describes the collection of basic production data, including output counters and downtimes.

Table 252 – TMC Data Collection Server Profile
Group Conformance Unit / Profile Title Mandatory / Optional
ProfileTMC OPC UA Server ProfileM
TMCTMC Data CollectionM
TMCTMC Core ProductionO
TMCTMC Single PO ProductionO
TMCTMC Multi PO ProductionO
TMCTMC Quality Assurance and ControlO
TMCTMC Basic Machine StatusO
TMCTMC Advanced Machine StatusO
TMCTMC Process Variables Ingestion and ControlO
TMCTMC Intralogistics at the MachineO
TMCTMC Asset ManagementO
13.2.2.15 TMC Single PO Production Server Profile

The following table defines a Profile that describes the production of a single production order at the machine module, including starting, aborting and completing a production order.

Table 253 – TMC Single PO Production Server Profile
Group Conformance Unit / Profile Title Mandatory / Optional
ProfileTMC OPC UA Server ProfileM
TMCTMC Data CollectionM
TMCTMC Core ProductionM
TMCTMC Single PO ProductionM
TMCTMC Multi PO ProductionO
TMCTMC Quality Assurance and ControlO
TMCTMC Basic Machine StatusM
TMCTMC Advanced Machine StatusO
TMCTMC Process Variables Ingestion and ControlO
TMCTMC Intralogistics at the MachineO
TMCTMC Asset ManagementO
13.2.2.16 TMC Multi PO Production Profile

The following table defines a Profile that describes the production of multiple production orders at the machine module, a.k.a. batch control, including automatic batch propagation.

Table 254 – TMC Multi PO Production Profile
Group Conformance Unit / Profile Title Mandatory / Optional
ProfileTMC OPC UA Server ProfileM
ProfileTMC OPC UA Client ProfileM
TMCTMC Data CollectionM
TMCTMC Core ProductionM
TMCTMC Single PO ProductionM
TMCTMC Client Single PO ProductionM
TMCTMC Multi PO ProductionM
TMCTMC Quality Assurance and ControlO
TMCTMC Basic Machine StatusM
TMCTMC Advanced Machine StatusO
TMCTMC Process Variables Ingestion and ControlO
TMCTMC Intralogistics at the MachineO
TMCTMC Asset ManagementO
TMCTMC Client Multi PO ProductionM
13.2.2.17 TMC Process Variables Ingestion and Control Profile

The following table defines a Profile that describes the ingestion and control of process variables.

Table 255 – TMC Process Variables Ingestion and Control Profile
Group Conformance Unit / Profile Title Mandatory / Optional
ProfileTMC OPC UA Server ProfileM
TMCTMC Data CollectionM
TMCTMC Basic Machine StatusM
TMCTMC Advanced Machine StatusO
TMCTMC Process Variables Ingestion and ControlM
13.2.2.18 TMC Visualization and Control Profile

The following table defines a Profile that describes the visualization and control of a machine, including its subcomponents.

Table 256 – Visualization and Control Profile
Group Conformance Unit / Profile Title Mandatory / Optional
ProfileTMC OPC UA Server ProfileM
TMCTMC Data CollectionM
TMCTMC Core ProductionO
TMCTMC Single PO ProductionO
TMCTMC Multi PO ProductionO
TMCTMC Quality Assurance and ControlO
TMCTMC Basic Machine StatusM
TMCTMC Advanced Machine StatusO
TMCTMC Process Variables Ingestion and ControlO
TMCTMC Intralogistics at the MachineO
TMCTMC Asset ManagementO
TMCTMC Basic Visualization and ControlM
TMCTMC Advanced Visualization and ControlO
TMCTMC Advanced Equipment Module and Control Module StatusO
13.2.2.19 TMC Production Order Orchestration Layer Profile

The following table defines a Profile that describes the centralized management of production orders at a production cell, a.k.a. line.

Table 257 – TMC Production Order Orchestration Layer Profile
Group Conformance Unit / Profile Title Mandatory / Optional
ProfileTMC OPC UA Server ProfileM
ProfileTMC OPC UA Client ProfileM
TMCTMC Production Order Orchestration LayerM
TMCTMC Client Production Order Orchestration LayerM

14 Namespaces

14.1 Namespace Metadata

The following table defines the namespace metadata for this document. The Object is used to provide version information for the namespace and an indication about static Nodes. Static Nodes are identical for all Attributes in all Servers, including the Value Attribute. See OPC 10000-5 for more details.

The information is provided as Object of type NamespaceMetadataType. This Object is a component of the Namespaces Object that is part of the Server Object. The NamespaceMetadataType ObjectType and its Properties are defined in OPC 10000-5.

The version information is also provided as part of the ModelTableEntry in the UANodeSet XML file. The UANodeSet XML schema is defined in OPC 10000-6.

Table 258 – NamespaceMetadata Object for this Document
Attribute Value
BrowseName http://opcfoundation.org/UA/TMC/v2/
Property DataType Value
NamespaceUriString http://opcfoundation.org/UA/TMC/v2/
NamespaceVersionString2.00.1
NamespacePublicationDateDateTime2022-07-25
IsNamespaceSubsetBooleanFalse
StaticNodeIdTypesIdType []0
StaticNumericNodeIdRangeNumericRange []
StaticStringNodeIdPatternString

Note: The IsNamespaceSubset Property is set to False as the UaNodeSet XML file contains the complete Namespace. Servers only exposing a subset of the Namespace need to change the value to True.

14.2 Handling of OPC UA Namespaces

Namespaces are used by OPC UA to create unique identifiers across different naming authorities. The Attributes NodeId and BrowseName are identifiers. A Node in the UA AddressSpace is unambiguously identified using a NodeId. Unlike NodeIds, the BrowseName cannot be used to unambiguously identify a Node. Different Nodes may have the same BrowseName. They are used to build a browse path between two Nodes or to define a standard Property.

Servers may often choose to use the same namespace for the NodeId and the BrowseName. However, if they want to provide a standard Property, its BrowseName shall have the namespace of the standards body although the namespace of the NodeId reflects something else, for example the EngineeringUnits Property. All NodeIds of Nodes not defined in this document shall not use the standard namespaces.

The following table provides a list of mandatory and optional namespaces used in an TMC OPC UA Server.

Table 259 – Namespaces used in a TMC Server
NamespaceURI Description Use
http://opcfoundation.org/UA/Namespace for NodeIds and BrowseNames defined in the OPC UA specification. This namespace shall have namespace index 0.Mandatory
Local Server URINamespace for nodes defined in the local server. This namespace shall have namespace index 1.Mandatory
http://opcfoundation.org/UA/DI/Namespace for NodeIds and BrowseNames defined in OPC 10000-100. The namespace index is Server specific.Mandatory
http://opcfoundation.org/UA/TMC/v2/Namespace for NodeIds and BrowseNames defined in this document. The namespace index is Server specific.Mandatory
Vendor specific typesA Server may provide vendor-specific types like types derived from ObjectTypes defined in this document in a vendor-specific namespace.Optional
Vendor specific instances

A Server provides vendor-specific instances of the standard types or vendor-specific instances of vendor-specific types in a vendor-specific namespace.

It is recommended to separate vendor specific types and vendor specific instances into two or more namespaces.

Mandatory

The following table provides a list of namespaces and their indices used for BrowseNames in this document. The default namespace of this document is not listed since all BrowseNames without prefix use this default namespace.

Table 260 – Namespaces used in this document
NamespaceURI Namespace Index Example
http://opcfoundation.org/UA/00:EngineeringUnits
http://opcfoundation.org/UA/DI/22:DeviceType
http://opcfoundation.org/UA/PackML/ 33:PackMLMachineStateMachineType

Annex A TMC Namespace and mappings (Normative)

A.1 Namespace and identifiers for TMC Information Model

This appendix defines the numeric identifiers for all the numeric NodeIds defined in this document. The identifiers are specified in a CSV file with the following syntax:

<SymbolName>, <Identifier>, <NodeClass>

Where the SymbolName is either the BrowseName of a Type Node or the BrowsePath for an Instance Node that appears in the specification and the Identifier is the numeric value for the NodeId.

The BrowsePath for an Instance Node is constructed by appending the BrowseName of the instance Node to the BrowseName for the containing instance or type. An underscore character is used to separate each BrowseName in the path. Let’s take for example, the <type> ObjectType Node which has the <property> Property. The Name for the <property> InstanceDeclaration within the <type> declaration is: <type>_<property>.

The NamespaceUri for all NodeIds defined here is http://opcfoundation.org/UA/TMC/v2/

The CSV released with this version of the specification can be found here:

http://www.opcfoundation.org/UA/schemas/TMC/2.0/NodeIds.csv

http://www.opcfoundation.org/UA/schemas/TMC/NodeIds.csv

A computer processible version of the complete Information Model defined in this document is also provided. It follows the XML Information Model schema syntax defined in OPC 10000-6.

The Information Model Schema for this version of the document (including any revisions, amendments or errata) can be found here:

http://www.opcfoundation.org/UA/schemas/TMC/2.0/Opc.Ua.TMC.NodeSet2.xml

http://www.opcfoundation.org/UA/schemas/TMC/Opc.Ua.TMC.NodeSet2.xml

_____________

Annex B (descriptive) TMC Reference Machine Example

B.1 Maker Reference Diagram

This appendix provides a reference diagram for a tobacco Maker.

Figure 6 – A Cigarette Maker TMC Model
Figure 7 - Types and Instances in a TMC Model of a Cigarette Maker
Figure 8 - References in a TMC Model of a Cigarette Maker

Agreement of Use

COPYRIGHT RESTRICTIONS

This document is provided "as is" by the OPC Foundation and the TMC Working Group.

Right of use for this specification is restricted to this specification and does not grant rights of use for referred documents.

Right of use for this specification will be granted without cost.

This document may be distributed through computer systems, printed or copied as long as the content remains unchanged and the document is not modified.

OPC Foundation and the TMC Working Group do not guarantee usability for any purpose and shall not be made liable for any case using the content of this document.

The user of the document agrees to indemnify OPC Foundation and TMC Working Group and their officers, directors and agents harmless from all demands, claims, actions, losses, damages (including damages from personal injuries), costs and expenses (including attorneys' fees) which are in any way related to activities associated with its use of content from this specification.

The document shall not be used in conjunction with company advertising, shall not be sold or licensed to any party.

The intellectual property and copyright is solely owned by the OPC Foundation and the TMC Working Group.

PATENTS

The attention of adopters is directed to the possibility that compliance with or adoption of OPC or TMC Working Group specifications may require use of an invention covered by patent rights. OPC Foundation or TMC Working Group shall not be responsible for identifying patents for which a license may be required by any OPC or TMC Working Group specification, or for conducting legal inquiries into the legal validity or scope of those patents that are brought to its attention. OPC or TMC Working Group specifications are prospective and advisory only. Prospective users are responsible for protecting themselves against liability for infringement of patents.

WARRANTY AND LIABILITY DISCLAIMERS

WHILE THIS PUBLICATION IS BELIEVED TO BE ACCURATE, IT IS PROVIDED "AS IS" AND MAY CONTAIN ERRORS OR MISPRINTS. THE OPC FOUDATION NOR TMC Working Group MAKES NO WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, WITH REGARD TO THIS PUBLICATION, INCLUDING BUT NOT LIMITED TO ANY WARRANTY OF TITLE OR OWNERSHIP, IMPLIED WARRANTY OF MERCHANTABILITY OR WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR USE. IN NO EVENT SHALL THE OPC FOUNDATION NOR TMC Working Group BE LIABLE FOR ERRORS CONTAINED HEREIN OR FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, RELIANCE OR COVER DAMAGES, INCLUDING LOSS OF PROFITS, REVENUE, DATA OR USE, INCURRED BY ANY USER OR ANY THIRD PARTY IN CONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS MATERIAL, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

The entire risk as to the quality and performance of software developed using this specification is borne by you.

RESTRICTED RIGHTS LEGEND

This Specification is provided with Restricted Rights. Use, duplication or disclosure by the U.S. government is subject to restrictions as set forth in (a) this Agreement pursuant to DFARs 227.7202-3(a); (b) subparagraph (c)(1)(i) of the Rights in Technical Data and Computer Software clause at DFARs 252.227-7013; or (c) the Commercial Computer Software Restricted Rights clause at FAR 52.227-19 subdivision (c)(1) and (2), as applicable. Contractor / manufacturer are the OPC Foundation, 16101 N. 82nd Street, Suite 3B, Scottsdale, AZ, 85260-1830

COMPLIANCE

The combination of TMC Working Group and OPC Foundation shall at all times be the sole entities that may authorize developers, suppliers and sellers of hardware and software to use certification marks, trademarks or other special designations to indicate compliance with these materials as specified within this document. Products developed using this specification may claim compliance or conformance with this specification if and only if the software satisfactorily meets the certification requirements set by the TMC Working Group or the OPC Foundation. Products that do not meet these requirements may claim only that the product was based on this specification and must not claim compliance or conformance with this specification.

Trademarks

Most computer and software brand names have trademarks or registered trademarks. The individual trademarks have not been listed here.

GENERAL PROVISIONS

Should any provision of this Agreement be held to be void, invalid, unenforceable or illegal by a court, the validity and enforceability of the other provisions shall not be affected thereby.

This Agreement shall be governed by and construed under the laws of Germany.

This Agreement embodies the entire understanding between the parties with respect to, and supersedes any prior understanding or agreement (oral or written) relating to, this specification.

Revision 2.0 Highlights

Revision 2.0 is based on four years of experience in the modelling and development of TMC compliant OPC UA servers by the TMC Working Group and their business partners. It also includes improvements suggested by feedback from the OEMs.

Additionally, Revision 2.0 extends the scope of TMC to the following:

Primary production processes.

Production Orchestration in a Process Cell.

More transparent machine operations by means of state machines.

Support for Remote Control Loops.

Some constructs for intralogistics around the machine.

Material management aligned with ISA 95.