Tobacco Machinery - 6.4 MachineModuleSpecificationType

This OPC UA MachineModuleSpecificationType ObjectType contains the specification of the machine module as currently operating including capabilities, internal buffers and loading points.

Figure 12 shows an overview for the MachineModuleSpecificationType with related Objects. It is formally defined in Table 20.

Figure 12 – MachineModuleSpecificationType overview

6.4.2 ObjectType definition

The MachineModuleSpecificationType is formally defined in Table 20.

Table 20 – MachineModuleSpecificationType Definition

Attribute	Value
BrowseName	MachineModuleSpecificationType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of BaseObjectType defined in OPC 10000-5.
HasComponent	Object	DocumentationRep		FolderType	Mandatory
HasProperty	Variable	MaterialLoadingPoints	LoadUnloadPointType	PropertyType	Mandatory
HasProperty	Variable	MaterialStorageBuffers	MaterialStorageBufferType	PropertyType	Mandatory
HasProperty	Variable	TotalRunningHours	Counter	PropertyType	Mandatory
HasProperty	Variable	ValidSince	DateTime	PropertyType	Mandatory
HasComponent	Method	LoadMachineModuleDocumentation			Mandatory
HasComponent	Method	SetNewSpecification			Mandatory
GeneratesEvent	ObjectType	MachineModuleSpecificationChangeLogType

The MachineModuleSpecificationType ObjectType is a concrete type and can be used directly.

6.4.3 ObjectType Description

6.4.3.1 Object DocumentationRep

The Object DocumentationRep is the sole repository for the machine module documentation resources. The DocumentationRep is accessed, for example, by clients and HMIs.

6.4.3.2 Variable MaterialLoadingPoints

The 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 LoadUnloadPointType.

The type LoadUnloadPointType is defined in Table 21.

Table 21 – LoadUnloadPointType Definition

Name	Type	Description
LoadUnloadPointType	Structure	Description of a loading/unloading point.
ID	String	Unique identifier for the loading/unloading point.
MES_ID	String	Unique identifier for the loading/unloading point for higher level systems, e.g. MES, ERP.
UserName	String	Name of the loading/unloading point given by the end user.
Description	LocalizedText	Human readable identification of the loading/unloading point.
MaterialCapability	MaterialType[]	List of materials that can be loaded to the machine at this loading point or list of materials that may be unloaded at this unloading point.

The type MaterialType is defined in Table 22.

Table 22 – MaterialType Definition

Name	Type	Description
MaterialType	Structure	Description of a material.
Group	String	Material group of the material.
ID	String	Unique identifier for the material.
BatchID	String	Batch ID for the material. Can be empty (null) when the material is not batch managed.
Description	LocalizedText	Human readable identification of the material.
MES_ID	String	Material ID as stored in the MES/ERP system.
BaseUoM	EUInformation	The material base unit of measure. For each material one single base unit of measure is defined.

6.4.3.3 Variable MaterialStorageBuffers

The Property MaterialStorageBuffers describes the buffers inside the machine module and their current status. The Property MaterialStorageBuffers is a list of objects of type MaterialStorageBufferDataType.

The type MaterialStorageBufferDataType is defined in Table 23.

Table 23 – MaterialStorageBufferDataType Definition

Name	Type	Description
MaterialStorageBufferDataType	Structure	Description of a material storage buffer.
ID	String	Unique identifier for the storage buffer.
MES_ID	String	Unique identifier for the storage buffer for a higher level system, e.g. MES, ERP.
StoredMaterial	MaterialType	The material that is stored in the buffer.
EngineeringUnits	EUInformation	Unit of measure
TotalStorageCapacity	Double	The maximum quantity that can be stored in the buffer in the EngineeringUnits unit of measure.
StorageLogic	StorageLogicEnumeration	The way the storage is loaded/unloaded.

The type MaterialType is defined in Table 22. The StorageLogicEnumeration is defined in Table 24.

Table 24 – StorageLogicEnumeration Definition

Enumstring	Value	Description
Other	0	None of the below.
FIFO	1	The first product entering the storage buffer is the first to leave the storage buffer.
LIFO	2	The last product entering the storage buffer is the first to leave the storage buffer.
FEFO	3	The first expired material is the first to leave the storage buffer.

6.4.3.4 Variable TotalRunningHours

The 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.

The Value of the Property TotalRunningHours shall be persisted both in the OPC UA Server and in the underlying system so that if one fails and/or is replaced, the other will allow restoring the Value when the OPC UA Server and underlying system are on separate hardware infrastructure.

6.4.3.5 Variable ValidSince

The Property ValidSince is the date since the configuration was last modified.

6.4.3.6 Method LoadMachineModuleDocumentation

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

Signature

LoadMachineModuleDocumentation (

[in]ByteString DocumentToBeLoaded

[out]MethodExecutionFeedbackType ExecutionFeedback

);

Argument	Description
DocumentToBeLoaded	The document, as a byte string, to be transferred to the DocumentationRep folder.
ExecutionFeedback	The extended feedback returning a detailed message in case of execution failure.

Method Result Codes

6.4.3.7 Method SetNewSpecification

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.

Signature

SetNewSpecification (

[in]LoadUnloadPointType[] NewMaterialLoadingPoints

[in]MaterialStorageBufferDataType[] NewMaterialStorageBuffers

[out]MethodExecutionFeedbackType ExecutionFeedback

);

ResultCode	Description
BadNodeIdUnknown	See table 173 in OPC 10000-4 for the description of these result codes.
BadTypeMismatch
BadOutOfRange
BadNotWritable
BadNotFound

Argument	Description
NewMaterialLoadingPoints	The information about the material loading points that will be valid after the machine specification is changed.
NewMaterialStorageBuffers	The information about the storage buffers that will be valid after the machine specification is changed.
ExecutionFeedback	The extended feedback returning a detailed message in case of execution failure.

Method Result Codes

ResultCode	Description
BadNodeIdUnknown	See table 173 in OPC 10000-4 for the description of these result codes.
BadTypeMismatch
BadOutOfRange
BadNotWritable
BadNotFound