OPC UA FX extends the Standard EventType hierarchy by several EventTypes defined in this clause. Figure 50 informally describes the hierarchy of these EventTypes.

image055.png

Figure 50 – OPC UA FX EventType Hierarchy

This EventType is used to categorise Events generated by a Server implementing UAFX. Its representation in the AddressSpace is formally defined in Table 109.

Table 109 – AuditUaFxEventType definition

Attribute

Value

BrowseName

3:AuditUaFxEventType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the 0:AuditEventType defined in OPC 10000-5, which means it inherits the InstanceDeclarations of that Node.

ConformanceUnits

UAFX Auditing Connection Cleanup

Audit\Events of this class are generated by Servers that implement UAFX. They represent internal actions taken by the Server.

This EventType inherits all Properties of the AuditEventType. Their semantics are defined in OPC 10000-5. The SourceNode Property for Events of this type shall be assigned to the NodeId of the Object that is related to the action; if no Object is related, then the SourceNode Property shall be the ObjectId of the Server Object.

If AutomationComponentLog is supported, this AuditEvent shall set either the ConditionClassType or a ConditionSubClassType to LogEntryConditionClassType, which results in the AuditEvent being mapped to LogObject records. The mapping of these AuditEvents to LogRecords shall use the AdditionalData field to include fields of the AuditEvent. Subtypes of the AuditEvent will describe in detail which fields shall be mapped.

This EventType allows Connection clean-up, as performed by a Server, to be audited. Its representation in the AddressSpace is formally defined in Table 110.

Table 110 – AuditConnectionCleanupEventType definition

Attribute

Value

BrowseName

3:AuditConnectionCleanupEventType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the 3:AuditUaFxEventType, which means it inherits the InstanceDeclarations of that Node.

0:HasProperty

Variable

3:RemovedEndpoint

0:String

0:PropertyType

M

0:HasProperty

Variable

3:RelatedEndpoint

2:RelatedEndpointDataType

0:PropertyType

M

ConformanceUnits

UAFX Auditing Connection Cleanup

AuditEvents of this class are generated by Servers that implement UAFX in the case when a ConnectionEndpoint is cleaned up (see 6.6.2).

This EventType inherits all Properties of the AuditUaFxEventType.

The SourceNode for this Event shall be the FunctionalEntity that contained the RemovedEndpoint.

RemovedEndpoint identifies the BrowseName of the ConnectionEndpoint that was removed.

RelatedEndpoint points to the former related ConnectionEndpoint (i.e., the other end of the Connection).

If AutomationComponentLog is supported, this AuditEvent shall set either the ConditionClassType or a ConditionSubClassType to LogEntryConditionClassType, which results in the AuditEvent being mapped to LogObject records. The RemovedEndpoint and the RelatedEndpoint shall be included in the resulting LogRecord as AdditionalData.

This EventType allows auditing Method Calls with a response. Its representation in the AddressSpace is formally defined in Table 111.

Table 111 – AuditUpdateMethodResultEventType definition

Attribute

Value

BrowseName

2:AuditUpdateMethodResultEventType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the 0:AuditUpdateMethodEventType defined in OPC 10000-5, which means it inherits the InstanceDeclarations of that Node.

0:HasProperty

Variable

0:StatusCodeId

0:StatusCode

0:PropertyType

M

0:HasProperty

Variable

0:OutputArguments

0:BaseDataType[]

0:PropertyType

M

ConformanceUnits

UAFX Auditing Connection Management

This EventType inherits all Properties of the AuditUpdateMethodEventType. Their semantics are defined in OPC 10000-5.

The StatusCodeId and OutputArguments are as defined in AuditUpdateMethodEventType. They are included here only to indicate that they are mandatory in this Type.

If ConnectionManagerLog is supported, this AuditEvent shall set either the ConditionClassType or a ConditionSubClassType to LogEntryConditionClassType, which results in the AuditEvent being mapped to LogObject records. The StatusCodeId shall be included in the resulting LogRecord as AdditionalData.

The ConnectionConfigurationSetEventType is formally defined in Table 112. It is a subtype of the BaseEventType defined in OPC 10000-5. This new type does not add any additional information on top of the BaseEventType besides the semantics that an Event was generated by the ConnectionConfigurationSetStateMachineType.

Table 112 – ConnectionConfigurationSetEventType

Attribute

Value

BrowseName

4:ConnectionConfigurationSetEventType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the 0:BaseEventType defined in OPC 10000-5

0:HasProperty

Variable

4:ConnectionConfigurationSetNode

0:NodeId

0:PropertyType

M

0:HasProperty

Variable

4:Name

0:String

0:PropertyType

M

0:HasProperty

Variable

4:Action

4:FxProcessEnum

0:PropertyType

M

0:HasSubtype

ObjectType

4:ConnectionConfigurationSetProcessingStartedEventType

Defined in 8.6.

0:HasSubtype

ObjectType

4:ConnectionConfigurationSetProcessingSucceededEventType

Defined in 8.7.

0:HasSubtype

ObjectType

4:ConnectionConfigurationSetProcessingFailedEventType

Defined in 8.8.

ConformanceUnits

UAFX ConnectionManager Configuration Set Processing Events

This EventType inherits all Properties of the BaseEventType.

For all Events of this type, the SourceNode (from BaseEventType) shall be set to the NodeId of the ConnectionManager that is executing the state machine.

ConnectionConfigurationSetNode and Name identify the ConnectionConfigurationSet, which was processed.

Action identifies the action that was requested to process the ConnectionConfigurationSet.

If ConnectionManagerLog is supported, this Event shall set either the ConditionClassType or a ConditionSubClassType to LogEntryConditionClassType, which results in the Event being mapped to LogObject records. This applies to all subtypes of this EventType. The ConnectionConfigurationSetNode, the Name, and the Action shall be included in the resulting LogRecord as AdditionalData.

This EventType is generated by a ConnectionConfigurationSetStateMachine upon transition from the Ready State to the Processing State as a result of a ConnectionManager starting to process the ConnectionConfigurationSet. Its representation in the AddressSpace is formally defined in Table 113.

Table 113 – ConnectionConfigurationSetProcessingStartedEventType Definition

Attribute

Value

BrowseName

4:ConnectionConfigurationSetProcessingStartedEventType

IsAbstract

True

References

Node Class

BrowseName

Note

Subtype of the 4:ConnectionConfigurationSetEventType defined in 8.5.

ConformanceUnits

UAFX ConnectionManager Configuration Set Processing Events

This EventType inherits all Properties of the ConnectionConfigurationSetEventType.

An Event of this EventType is generated by a ConnectionConfigurationSetStateMachineType upon transition from the Processing State to the Ready State after successful completion of the Connection establishment. Its representation in the AddressSpace is formally defined in Table 114.

Table 114 – ConnectionConfigurationSetProcessingSucceededEventType definition

Attribute

Value

BrowseName

4:ConnectionConfigurationSetProcessingSucceededEventType

IsAbstract

True

References

Node Class

BrowseName

Note

Subtype of the 4:ConnectionConfigurationSetEventType defined in 8.5.

ConformanceUnits

UAFX ConnectionManager Configuration Set Processing Events

This EventType inherits all Properties of the ConnectionConfigurationSetEventType.

This EventType is generated by a ConnectionConfigurationSetStateMachineType upon transition from the Processing State to the Error State as a result of encountering an error during Connection establishment. Its representation in the AddressSpace is formally defined in Table 115.

Table 115 – ConnectionConfigurationSetProcessingFailedEventType definition

Attribute

Value

BrowseName

4:ConnectionConfigurationSetProcessingFailedEventType

IsAbstract

True

References

Node Class

BrowseName

Note

Subtype of the 4:ConnectionConfigurationSetEventType defined in 8.5.

ConformanceUnits

UAFX ConnectionManager Configuration Set Processing Events

This EventType inherits all Properties of the ConnectionConfigurationSetEventType.

This EventType is generated by a ConnectionManager when an error is returned on an EstablishConnection Method invocation or any related actions. Its representation in the AddressSpace is formally defined in Table 116. The generation of this Event is not required, but this EventType provides a mapping from the returned EstablishConnection Method parameters to the LogEntry record structure. The mapping also applies to related actions.

Table 116 - EstablishConnectionErrorEventType definition

Attribute

Value

BrowseName

4:EstablishConnectionErrorEventType

IsAbstract

True

References

Node Class

BrowseName

Note

Subtype of the 0:BaseLogEventType.

ConformanceUnits

UAFX ConnectionManager LogObject Events

This EventType inherits all Properties of the BaseLogEventType.

The ConditionClassId shall be set to LogEntryConditionClassType.

SourceNode shall be the NodeId of the ConnectionConfigurationSet that is being processed.

SourceName shall be the BrowseName of the Connection that was being created. If the error is not related to a specific Connection, then it shall be “ConnectionManager”.

Message describes the issue. It shall include a description of the action that was being taken, e.g. resolving NodeIds, configuring an SKS, verifying Nodes, or establishing a Connection. It shall include the FxErrorEnum value reported in the ConnectionDiagnosticsDataType associated with this error.

ErrorCode shall contain the detailed error code returned in the nested return parameters of the EstablishConnection method or the error code returned in other processing. If multiple error codes are returned, then multiple records should be generated, one for each error code.

ErrorCodeNode shall contain the internal Node in the ConnectionConfigurationSet to which the error is related. For example, if the error was related to an asset verification, it would contain the NodeId of the AssetToVerify. It may be null if no specific Node is related to the LogRecord.

If ConnectionManagerLog is supported, this Event shall set either the ConditionClassType or a ConditionSubClassType to LogEntryConditionClassType, which results in the Event being mapped to LogObject records. If the LogObject is recording LogRecords, the ErrorCode and the ErrorCodeNode shall be included in the resulting LogRecord as AdditionalData.

This EventType is generated by a ConnectionManager when an error is returned on a CloseConnection Method invocation. Its representation in the AddressSpace is formally defined in Table 117.

Table 117 – CloseConnectionErrorEventType

Attribute

Value

BrowseName

4:CloseConnectionErrorEventType

IsAbstract

True

References

Node Class

BrowseName

Note

Subtype of the 0:BaseLogEventType.

ConformanceUnits

UAFX ConnectionManager LogObject Events

This EventType inherits all Properties of the BaseLogEventType.

The ConditionClassId shall be set to LogEntryConditionClassType.

SourceNode shall be the NodeId of the ConnectionConfigurationSet that the connection belonged to.

SourceName shall be the BrowseName of the Connection that was being closed.

Message describes the issue. It shall include a description of the action that was being taken. It shall include the FxErrorEnum value reported in the ConnectionDiagnosticsDataType associated with this error.

ErrorCode shall contain the detailed error code returned in the CloseConnection Method.

ErrorCodeNode shall contain the NodeId of the Connection that was being closed.

If ConnectionManagerLog is supported, this Event shall set either the ConditionClassType or a ConditionSubClassType to LogEntryConditionClassType, which results in the Event being mapped to LogObject records. If the LogObject is recording LogRecords, the ErrorCode and the ErrorCodeNode shall be included in the resulting LogRecord as AdditionalData.