Tobacco Machinery - 6.19 LogbookEvent

Logbook events are fired by the machine module for the documentation of relevant changes in the machine configuration/status.

Table 51 – LogbookEvent Type Definition

Attribute	Value
BrowseName	LogBookEventType
IsAbstract	True
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of BaseEventType defined in OPC 10000-5.
HasSubType	ObjectType	ControlModeChangeLogType	Defined in 6.19.2
HasSubType	ObjectType	DataSetChangeLogType	Defined in 6.19.3
HasSubType	ObjectType	DefectDetectedLogType	Defined in 6.19.4
HasSubType	ObjectType	DefectDetectionSensorDisabledLogType	Defined in 6.19.5
HasSubType	ObjectType	DowntimeLogType	Defined in 6.19.6
HasSubType	ObjectType	GoodOutputProducedLogType	Defined in 6.19.7
HasSubType	ObjectType	LoadingPointIsUnloadedLogType	Defined in 6.19.8
HasSubType	ObjectType	MachineModuleSpecificationChangeLogType	Defined in 6.19.9
HasSubType	ObjectType	MaterialIsConsumedLogType	Defined in 6.19.10
HasSubType	ObjectType	MaterialRejectedLogType	Defined in 6.19.11
HasSubType	ObjectType	MaterialRejectionTrapDisasbledLogType	Defined in 6.19.12
HasSubType	ObjectType	MaterialUnloadingIsRequiredLogType	Defined in 6.19.13
HasSubType	ObjectType	NewSystemDumpIsGeneratedLogType	Defined in 6.19.14
HasSubType	ObjectType	POChangeLogType	Defined in 6.19.15
HasSubType	ObjectType	RootCauseListChangeLogType	Defined in 6.19.16
HasSubType	ObjectType	StateChangeLogType	Defined in 6.19.18
HasSubType	ObjectType	StopReasonListChangeLogType	Defined in 6.19.19
HasSubType	ObjectType	IntegrityRejectedMaterialLogType	Defined in 6.19.20
HasSubType	ObjectType	NewPresentedMaterialLogType	Defined in 6.19.21
HasSubType	ObjectType	ProductionLogType	Defined in 6.19.22

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

With several subtypes detailed information on the changes are provided.

NOTE: The EventSource (Node which creates the event), Time and a Message are already included in the BaseEventType of OPC UA.

Server shall implement buffering and historization of events, accessible by client via the OPC UA service history read.

6.19.2 ControlModeChangeLogType

The ControlModeChangeLogType is used to log changes of the ControlMode Property of the machine module. The ControlMode property is contained in the LiveStatus object of the MachineModule.

Table 52 – ControlModeChangeLogType Definition

Attribute	Value
BrowseName	ControlModeChangeLogType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	NewControlMode	ControlModeEnumeration	BaseDataVariableType	Mandatory
HasComponent	Variable	OldControlMode	ControlModeEnumeration	BaseDataVariableType	Mandatory

ControlModeEnumeration DataType is defined in 6.2.3.1.

The NewControlMode Variable represents the new control mode of the MachineModule.

The OldControlMode Variable represents the previous control mode of the MachineModule.

6.19.3 DataSetChangeLogType

The DataSetChangeLogType is used to log changes to the values of the parameters contained in the DataSet. The DataSet is contained in the Setup object of the MachineModule.

Table 53 – DataSetChangeLogType Definition

Attribute	Value
BrowseName	DataSetChangeLogType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	NewDataSet	DataSetType	BaseDataVariableType	Mandatory
HasComponent	Variable	OldDataSet	DataSetType	BaseDataVariableType	Mandatory

The DataSetType DataType is defined in Table 31.

The NewDataSet Variable representes the new value of the DataSet Variable.

The OldDataSet Variable representes the previous value of the DataSet Variable.

6.19.4 DefectDetectedLogType

The DefectDetectedLogType is used for the logging defect detection by a DefectDetectionSensor of a MachineModule.

Table 54 – DefectDetectedLogType Definition

Attribute	Value
BrowseName	DefectDetectedLogType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasProperty	Variable	DefectEU	EUInformation	PropertyType	Optional
HasProperty	Variable	DefectPicture	Image	PropertyType	Optional
HasProperty	Variable	DefectValue	Float	PropertyType	Optional

The DefectEU Property represents the unit(s) of measure of the measurement that was identified as a defect.

The DefectPicture Property represents the picture that was identified as a defect.

The DefectValue Property represents the value(s) of the measurement that was identified as a defect.

6.19.5 DefectDetectionSensorDisabledLogType

When the DefectDetectionMode of a DefectDetectionSensor changes value to false, the DefectDetectionSensorDisabledLogType is fired.

Table 55 – DefectDetectionSensorDisabledLogType Definition

Attribute	Value
BrowseName	DefectDetectionSensorDisabledLogType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType

6.19.6 DowntimeLogType

The DowntimeLog event captures the complete information about the downtime which is logged when the stop reason is not any more active, i.e. after a clear/reset command. The root cause, as identified by the user, is also reported for downtimes longer than a microstop.

Table 56 – DowntimeLogType Definition

Attribute	Value
BrowseName	DowntimeLogType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasProperty	Variable	Duration	Duration	PropertyType	Mandatory
HasProperty	Variable	RootCause_s	MessageType[ ]	PropertyType	Optional
HasProperty	Variable	StopReason_s	MessageType[ ]	PropertyType	Mandatory

The MessageType DataType is defined in Table 13.

The Duration Property represents the duration (in seconds) of the downtime computed from the time the root cause is active to the time when it is not active any more.

The StopReason_s Property represents a list of one or more reasons generated by the control system for the logged downtime.

The RootCause_s Property represents a list of the root causes of the downtime, as identified and entered by the user. The user can enter a root cause for any downtime, it is mandatory to enter a root cause for downtimes longer than a microstop when the machine module is configured in such a way.

6.19.7 GoodOutputProducedLogType

When the MasterTotalOutput of a MaterialOutput Object of a MachineModule increases its value, the GoodOutputProduced LogType is fired.

Table 57 – GoodOutputProducedLogType Definition

Attribute	Value
BrowseName	GoodOutputProducedLogType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasProperty	Variable	QuantityProduced	Double	MaterialLotType	Optional
HasProperty	Variable	TotalProduced	Double	MaterialLotType	Mandatory

The MaterialLotType Variable Type is defined in Table 75.

The QuantityProduced Variable represents the quantity of material produced and the type of material produced. It is Optional.

The TotalProduced Variable represents the total quantity of material produced as in MasterTotalOutput (see 6.12.4.5) and the type of material produced. It is Optional.

6.19.8 LoadingPointIsUnloadedLogType

The LoadingPointIsUnloaded Event is used for logging that some moterial is unloaded from the loading point.

Table 58 – LoadingPointIsUnloadedLogType Definition

Attribute	Value
BrowseName	LoadingPointIsUnloadedLogType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	MaterialQuantity	Double	MaterialLotType	Mandatory

The MaterialLotType Variable Type is defined in Table 75.

The MaterialQuantity Variable represents the quantity of the unloaded material and its type.

6.19.9 MachineModuleSpecificationChangeLogType

The MachineModuleSpecificationChange Event is used for logging the changes of Specification object of a MachineModule.

Table 59 – MachineModuleSpecificationChangeLogType Definition

Attribute	Value
BrowseName	MachineModuleSpecificationChangeLogType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Object	OldSpecification		MachineModuleSpecificationType	Mandatory

The MachineModuleSpecificationType ObjectType is defined in Table 20.

The OldSpecifciation component represents the instance of the Information object of the MachineModule before the change.

6.19.10 MaterialIsConsumedLogType

The MaterialIsConsumed Event is used for logging that the material at the loading point has been consumed. The event may be raised when all the material at the loading point has been consumed or when a known portion of the material has been consumed.

Table 60 – MaterialIsConsumedLogType Definition

Attribute	Value
BrowseName	MaterialIsConsumedLogType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	MaterialQuantity	Double	MaterialLotType	Optional

The MaterialLotType Variable Type is defined in Table 75.

The MaterialQuantity Variable represents the consumed quantity of the material and its type.

6.19.11 MaterialRejectedLogType

The MaterialRejected Event is used by the material rejection trap for logging that some material has been rejected.

Table 61 – MaterialRejectedLogType Definition

Attribute	Value
BrowseName	MaterialRejectedLogType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	MaterialQuantityRejected	Double	MaterialLotType	Optional
HasComponent	Variable	TotalQuantityRejected	Double	MaterialLotType	Mandatory

The MaterialLotType Variable Type is defined in Table 75.

The MaterialQuantityRejected Variable represents the rejected quantity of the specified material and its type.

The TotalQuantityRejected Variable represents the total rejected quantity as in MaterialQuantityRejectedMasterTotal Variable (see 6.10.4.5) of the specified material and its type.

6.19.12 MaterialRejectionTrapDisabledLogType

The MaterialRejectionTrapDisabled Event is used for logging that a material rejection trap has been disabled.

Table 62 – MaterialRejectionTrapDisabledLogType Definition

Attribute	Value
BrowseName	MaterialRejectionTrapDisabledLogType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType

6.19.13 MaterialUnloadingIsRequiredLogType

The MaterialUnloadingIsRequired Event is used for logging when an unsuitable material for production is present at the loading point, i.e. when a brand change is required or when the wrong material was loaded.

Table 63 – MaterialUnloadingIsRequiredLogType Definition

Attribute	Value
BrowseName	MaterialUnloadingIsRequiredLogType
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	MaterialQuantity	Double	MaterialLotType	Mandatory

The MaterialLotType Variable Type is defined in Table 75.

The MaterialQuantity Variable represents the quantity of the specified material to be unloaded and its type.

6.19.14 NewSystemDumpIsGeneratedLogType

When a new system dump is generated by an Object of type ControlsSWType or ControlsHWType, the event NewSystemDumpIsGenerated is fired.

Table 64 – NewSystemDumpIsGeneratedLogType Definition

Attribute	Value
BrowseName	NewSystemDumpIsGeneratedLogType
IsAbstract	False
References	Node Class		BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	SystemDump		String	BaseDataVariableType	Mandatory

6.19.15 POChangeLogType

When the ProductionOrder Property of an object of type MachineModuleProductionType changes, then the event POChangeLogType is fired.

Table 65 – POChangeLogType Definition

Attribute	Value
BrowseName	POChangeLogType
IsAbstract	False
References	Node Class		BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasProperty	Variable	NewPO		POType	PropertyType	Mandatory

The POType DataType is defined in Table 28. The NewPO Property is the changed production order.

6.19.16 RootCauseListChangeLogType

The RootCauseListChangeLog Event is used for logging the change of the RootCauseList Property in the Configuration object of the MachineModule.

Table 66 – RootCauseListChangeLogType Definition

Attribute	Value
BrowseName	RootCauseListChangeLogType
IsAbstract	False
References	Node Class		BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	NewRootCauseList		MessageType[ ]	BaseDataVariableType	Mandatory
HasComponent	Variable	OldRootCauseList		MessageType[ ]	BaseDataVariableType	Mandatory

The MessageType DataType is defined in Table 13.

The NewRootCauseList Variable represents the new value of the root cause list.

The OldRootCauseList Variable represents the value of the root cause list before the change.

6.19.17 RootCauseGroupListChangeLogType

The RootCauseGroupListChangeLog Event is used for logging the change of the RootCauseGroupList Property in the Configuration object of the MachineModule.

Table 67 – RootCauseListChangeLogType Definition

Attribute	Value
BrowseName	RootCauseListChangeLogType
IsAbstract	False
References	Node Class		BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	NewRootCauseGroupList		RootCauseGroupType[ ]	BaseDataVariableType	Mandatory
HasComponent	Variable	OldRootCauseGroupList		RootCauseGroupType[ ]	BaseDataVariableType	Mandatory

The RootCauseGroupType DataType is defined in Table 19.

The NewRootCauseGroupList Variable represents the new value of the root cause group list.

The OldRootCauseGroupList Variable represents the value of the root cause group list before the change.

6.19.18 StateChangeLogType

The StateChangeLog Event is used for logging the change of the state of the MachineModule.

Table 68 – StateChangeLogType Definition

Attribute	Value
BrowseName	StateChangeLogType
IsAbstract	False
References	Node Class		BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	NewState		StateEnumeration	BaseDataVariableType	Mandatory
HasComponent	Variable	OldState		StateEnumeration	BaseDataVariableType	Mandatory

The StateEnumeration DataType is defined in Table 10.

The NewState Variable represents the new value of the State Property in the LiveStatus Object of the MachineModule.

The OldState Variable represents the previous value of the State Property in the LiveStatus object of the MachineModule.

6.19.19 StopReasonListChangeLogType

The StopReasonListChangeLog Event is used for logging the change of the StopReasonList Property in the Configuration object of the MachineModule.

Table 69 – StopReasonListChangeLog Definition

Attribute	Value
BrowseName	StopReasonListChangeLogType
IsAbstract	False
References	Node Class		BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	NewStopReasonList		MessageType[ ]	BaseDataVariableType	Mandatory
HasComponent	Variable	OldStopReasonList		MessageType[ ]	BaseDataVariableType	Mandatory

The MessageType DataType is defined in Table 13.

The NewStopReasonList Variable represents the new value of the StopReasonList Property in the Configuration Object of the MachineModule.

The OldStopReasonList Variable represents the value of the StopReasonList Property in the Configuration Object of the MachineModule before the change.

6.19.20 IntegrityRejectedMaterialLogType

The IntegrityRejectedMaterialLogType Event is triggered when a presented material is rejected at an object of type MaterialLoadingPointType because of a failed material integrity check.

Table 70 – IntegrityRejectedMaterialLogType Definition

Attribute	Value
BrowseName	IntegrityRejectedMaterial LogType
IsAbstract	False
References	Node Class		BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	RejectedLot		Double	MaterialLotType	Mandatory

The MaterialLotType VariableType is defined in 8.3.

The RejectedLot Variable describes the presented lot of material that did not pass the integrity check.

6.19.21 NewPresentedMaterialLogType

The NewPresentedMaterialLogType Event is triggered when a new material is presented at an object of type MaterialLoadingPointType.

Table 71 – NewPresentedMaterialLogType Definition

Attribute	Value
BrowseName	NewPresentedMaterialLogType
IsAbstract	False
References	Node Class		BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	PresentedMaterialLot		Double	MaterialLotType	Mandatory

The MaterialLotType VariableType is defined in 8.3.

The PresentedMaterialLot Variable describes the lot of material presented at the object of type MaterialLoadingPointType.

6.19.22 ProductionLogType

The ProductionLogType Event is used for logging production order information.

Table 72 – ProductionLogType Definition

Attribute	Value
BrowseName	ProductionLogType
IsAbstract	False
References	Node Class		BrowseName	DataType	TypeDefinition	Modelling Rule
Subtype of LogbookEventType
HasComponent	Variable	PO		POType	PropertyType	Mandatory