LogbookEvent – OPC UA for Plastics and Rubber Machinery

9 LogbookEvent

9.1 LogbookEvent Definition

Logbook events are fired by the machine for the documentation of relevant changes in the machine configuration/status. The LogbookEventType is formally defined in Table 12.

Table 12 – LogbookEventType Definiton

Attribute	Value
BrowseName	LogbookEventType
IsAbstract	True

References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of 0:BaseEventType defined in OPC UA Part 5
0:HasComponent	Object	User		UserType	M
0:HasProperty	Variable	EventOriginator	EventOriginatorEnumeration	0:PropertyType	M
0:HasProperty	Variable	JobCycleCounter	0:UInt64	0:PropertyType	O
0:HasSubtype	ObjectType	ParameterChangeLogType	Defined in 9.5
0:HasSubtype	ObjectType	UserLogType	Defined in 9.6
0:HasSubtype	ObjectType	RemoteAccessLogType	Defined in 9.7
0:HasSubtype	ObjectType	SequenceChangeLogType	Defined in 9.8
0:HasSubtype	ObjectType	MachineModeChangeLogType	Defined in 9.9
0:HasSubtype	ObjectType	ProductionStatusChangeLogType	Defined in 9.10
0:HasSubtype	ObjectType	ProductionDatasetChangeLogType	Defined in 9.11
0:HasSubtype	ObjectType	ProductionDatasetFrozenLogType	Defined in 9.12
0:HasSubtype	ObjectType	StandstillReasonLogType	Defined in 9.13
0:HasSubtype	ObjectType	MessageLogType	Defined in 9.14
0:HasSubtype	ObjectType	UserFeedbackLogType	Defined in 9.15

The LogbookEventType is abstract. There will be no instances of a LogbookEventType itself, but there will be instances of its subtypes which provide detailed information.

The EventSource is the root node of the interface (e.g. instance of IMM_MES_InterfaceType for OPC 40077).

NOTE: The EventSource, Time and a Message are already included in the BaseEventType of OPC UA.

There shall be a buffer to be accessible via the OPC UA service history read (even when the machine has been switched off in the meantime). The minimum size is 100 LogbookEvents to be stored in a (persistent) ring buffer containing the recent 100 events (over all LogbookEvents).

9.2 User

This Object indicates the user who is responsible for the change that leads to the event. The fields of UserType (see 13.2) shall be null or emtpy if no user is directly responsible (e.g. for messages coming from the machine control system).

9.3 EventOriginator

This Property represents the originator of a logbook event. The EventOriginatorEnumeration is defined in Table 13.

Table 13 – EventOriginatorEnumeration Items

Name	Value	Description
OTHER	0	Undefined
MACHINE	1	The machine causes the event (e.g. an alarm)
OPERATOR	2	The operator of the machine causes the event (e.g. a parameter change)
MES	3	The MES causes the event (e.g. a MESMessage)
PERIPHERAL_DEVICE	4	A peripheral device causes the event (e.g. an alarm)

9.4 JobCycleCounter

This Property represents the current value of JobCycleCounter in the ActiveJobValues Object when the event is fired (see 18.4.7.1). Only to be used for cyclic production (e.g. injection moulding).

9.5 ParameterChangeLogType

The ParameterChangeLogType is used for the logging of relevant changes in production parameters.

The decision which parameter is relevant for the production is done by the machine.

Table 14 – ParameterChangeLogType Definition

Attribute	Value
BrowseName	ParameterChangeLogType
IsAbstract	True

References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of LogbookEventType
0:HasProperty	Variable	ParameterId	0:String	0:PropertyType	M
0:HasProperty	Variable	OldValue	0:BaseDataType	0:PropertyType	M
0:HasProperty	Variable	OldValueUnit	0:EUInformation	0:PropertyType	O
0:HasProperty	Variable	NewValue	0:BaseDataType	0:PropertyType	M
0:HasProperty	Variable	NewValueUnit	0:EUInformation	0:PropertyType	O

The ParameterId Property represents the Id of the changed parameter.

The OldValue Property represents the old value of the changed parameter.

The NewValue Property represents the new value of the changed parameter.

Depending on the changed parameter, the Datatype of OldValue and NewValue are subtypes of 0:BaseDataType (0:String, Number, …). Where the unit is important (e.g. temperatures, lengths…), also OldValueUnit and NewValueUnit shall be used (see OPC UA Part 5 for the definition of EUInformation).

9.6 UserLogType

The UserLogType is used for logging which users are logged in to the machine.

Table 15 – UserLogType Definition

Attribute	Value
BrowseName	UserLogType
IsAbstract	True

References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of LogbookEventType
0:HasProperty	Variable	UserChange	UserChangeEnumeration	0:PropertyType	M

The UserChangeEnumeration is defined in Table 16.

Table 16 – UserChangeEnumeration Definition

Name	Value	Description
LOG_ON	0	The User has logged on the machine.
LOG_OFF	1	The User has logged off the machine.

9.7 RemoteAccessLogType

The RemoteAccessLogType is used for logging access from outside to the machine (e.g. remote service).

Table 17 – RemoteAccessLogType Definition

Attribute	Value
BrowseName	RemoteAccessLogType
IsAbstract	True

References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of LogbookEventType
0:HasProperty	Variable	RemoteUserName	0:String	0:PropertyType	M
0:HasProperty	Variable	UserChange	UserChangeEnumeration	0:PropertyType	M
0:HasProperty	Variable	Origin	0:String	0:PropertyType	O

RemoteUserName: Name of the remote user (e.g. name of the service employee doing remote service)

UserChange: The UserChangeEnumeration is the same used in UserLogType and is defined in Table 16.

Origin: Information about the origin of the remote access (e.g. "Headquarters").

9.8 SequenceChangeLogType

The SequenceChangeLogType is used for the logging changes in the production sequence.

Table 18 – SequenceChangeLogType Definition

Attribute	Value
BrowseName	SequenceChangeLogType
IsAbstract	True

References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of LogbookEventType
0:HasProperty	Variable	SequenceChange	SequenceChangeEnumeration	0:PropertyType	M

The SequenceChange Property allows classifying the changes. (A description of the changes is included in the Message Property of the LogBookEventType)

Table 19 – SequenceChangeEnumeration Definition

Name	Value	Description
UPDATE	0	The sequence has been updated (e.g. when a new production dataset has been activated)
ADD	1	An element has been added to the sequence
MODIFY	2	An element of the sequence has been modified.
MOVE	3	An element of the sequence has been moved.
DELETE	4	An element of the sequence has been deleted.

9.9 MachineModeChangeLogType

The MachineModeChangeLogType is used for logging changes of the machine mode.

Table 20 – MachineModeChangeLogType Definition

Attribute	Value
BrowseName	MachineModeChangeLogType
IsAbstract	True

References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of LogbookEventType
0:HasProperty	Variable	OldMachineMode	MachineModeEnumeration	0:PropertyType	M
0:HasProperty	Variable	NewMachineMode	MachineModeEnumeration	0:PropertyType	M

The MachineModeEnumeration is defined in 12.4.

9.10 ProductionStatusChangeLogType

The ProductionStatusChangeLogType is used for logging changes of the production status.

Table 21 – ProductionStatusChangeLogType Definition

Attribute	Value
BrowseName	ProductionStatusChangeLogType
IsAbstract	True

References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of LogbookEventType
0:HasProperty	Variable	OldProductionStatus	ProductionStatusEnumeration	0:PropertyType	M
0:HasProperty	Variable	NewProductionStatus	ProductionStatusEnumeration	0:PropertyType	M

The ProductionStatusEnumeration is defined in 14.7.1.

9.11 ProductionDatasetChangeLogType

The ProductionDatasetChangeLogType is used when a new production dataset is loaded and activated in the control system of the machine.

Table 22 – ProductionDatasetChangeLogType Definition

Attribute	Value
BrowseName	ProductionDatasetChangeLogType
IsAbstract	True

References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of LogbookEventType
0:HasProperty	Variable	OldProductionDatasetName	0:String	0:PropertyType	M
0:HasProperty	Variable	NewProductionDatasetName	0:String	0:PropertyType	M

9.12 ProductionDatasetFrozenLogType

The ProductionDatasetFrozenLogType is used when a production dataset is locked or unlocked (see 20.3.4).

Table 23 – ProductionDatasetFrozenLogType Definition

Attribute	Value
BrowseName	ProductionDatasetFrozenLogType
IsAbstract	True

References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of LogbookEventType
0:HasProperty	Variable	OldValue	0:Boolean	0:PropertyType	M
0:HasProperty	Variable	NewValue	0:Boolean	0:PropertyType	M

9.13 StandstillReasonLogType

The StandstillReasonLogType is used for logging StandstillReasons.

Table 24 – StandstillReasonLogType Definition

Attribute	Value
BrowseName	StandstillReasonLogType
IsAbstract	True

References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of LogbookEventType
0:HasProperty	Variable	StandstillReasonId	0:String	0:PropertyType	M

9.14 MessageLogType

The MessageLogType is used for logging MessageConditions (see 14.8).

Table 25 – MessageLogType Definition

Attribute	Value
BrowseName	MessageLogType
IsAbstract	True

References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of LogbookEventType
0:HasProperty	Variable	Id	0:String	0:PropertyType	M
0:HasProperty	Variable	IsStandstillMessage	0:Boolean	0:PropertyType	M
0:HasProperty	Variable	Classification	0:Enumeration	0:PropertyType	M

Classification: Classification of the message. The valid values of the Enumeration are specified in the specific Companion Specification (e.g. IMMMessageClassificationEnumeration in OPC 40077).

9.15 UserFeedbackLogType

The UserFeedbackLogType is used for logging text messages entered by the user into the machine control system.

Table 26 – UserFeedbackLogType Definition

Attribute	Value
BrowseName	UserFeedbackLogType
IsAbstract	True

References	Node Class	BrowseName	DataType	TypeDefinition	Other
Subtype of LogbookEventType
0:HasProperty	Variable	Classification	0:Enumeration	0:PropertyType	M

Classification: Classification of the message. The valid values of the Enumeration are specified in the specific Companion Specification (e.g. IMMMessageClassificationEnumeration in OPC 40077).

NOTE: The Message itself is included in the BaseEventType