F.1 DataTypes for Connection Manager Configuration

F.1.1 Overview

This section describes DataTypes that can be used to serialise the Objects that compose a ConnectionConfigurationSet (see 6.8 and 6.10) into a single structure (ConnectionConfigurationSetDataType). The ConnectionConfigurationSetDataType can, for example, be used for persisting a ConnectionConfigurationSet, for storing it within a File (see F.2), or for maintaining the configuration of a ConnectionManager (see F.3).

For the base principles used for the mapping, see clause F.1.2.

Figure F.1 depicts the different components of the ConnectionConfigurationSetDataType and their relation to each other.

Figure F.1 – ConnectionConfigurationSet serialisation

F.1.2 Base principles

F.1.2.1 References

References between Objects in different Object lists are mapped using an array index field for the related structure array. For example, the AutomationComponentConfigurationDataType has ServerAddressIndex that contains an index into the ServerAddress in the ConnectionConfigurationSetConfDataType. Indices are defined as Int32; a negative number indicates no Reference exists.

F.1.2.2 Namespaces

OPC UA uses Namespaces, and in a defined scope, all identifiers (NodeId, QualifiedName) use a NamespaceIndex instead of a NamespaceUri. The scope has a NamespaceArray with URIs where the NamespaceIndex is defined as an index into this array. For a Server, the scope is the complete Server. For a UANodeSet XML file, it is the file.

A ConnectionConfigurationSet (see 6.8.2) contains node identifiers related to different scopes, as illustrated in Figure F.2. In this illustration, the ConnectionConfigurationSet contains information for two different Servers. Node identifiers in the Information Model for the ConnectionManager (i.e., an instance of ConnectionConfigurationSetType) use PortableNodeIdentifier (see 10.36) to support the resolution for the dedicated scope (see also 13.3).

Figure F.2 – Scopes within a ConnectionConfigurationSet

To reduce the overall size of the DataTypes defined in this Clause (i.e. ConnectionConfigurationSetConfDataType), NodeId, AliasName and RelativePath are used instead of their portable version. The scope of those identifiers is defined by the related ServerAddressConfDataType structure, containing a Namespace array. The NamespaceIndex of a node identifier is used as an index into the Namespace array of the related ServerAddressConfDataType.

A ConnectionManager can map NodeId and RelativePath contained in the DataTypes to their portable versions using the NamespaceUri from the Namespace array when it loads the ConnectionConfigurationSet from the data structure.

F.1.2.3 SelectionListType

There is no generic DataType defined to represent a SelectionListType Variable. A generic definition would create additional overhead since the values can have different DataTypes.

To simplify the handling of SelectionListType, each Variable that is of SelectionListType is mapped to:

A Structure field with the corresponding DataType representing the current value. The field name is constructed from the Variable name (<Variable name>).

A Structure field with an array of the corresponding DataType representing the additional selection options (selectable values associated with the selection list – the list can contain only the current value if this selection list currently does not provide for modifications). The field name is constructed from the Variable name with a ‘Selection’ suffix (<Variable name>Selection).

A Structure field with DataType Boolean indicates if the list of selectable values is editable by a Client. The field is omitted if the specification requires that RestrictToList is set to TRUE (i.e. no values can be entered; only a selection is possible). The field name is constructed from the Variable name with a ‘Modify’ suffix (<Variable name>Modify).

F.1.2.4 Extensibility

Structured DataTypes can only be extended by subtyping. This is a problem if Structures are embedded into other Structures, e.g., the ConnectionConfigurationSet-related Structure has an array of AutomationComponent-related Structures. Therefore, each Structure has an additional field with an array of KeyValuePairs that can be used for potential future standardised or vendor-specific extensions.

F.1.2.5 Optional fields

Connection configuration and communication flow-related configuration Structures use Structures with optional fields to handle the optional Variables.

In other configuration Structures, AllowSubtypes is needed. Since AllowSubtypes cannot be combined with IsOptional, optional handling is done with empty arrays or null values for the used DataType.

F.1.3 ConnectionConfigurationSetConfDataType

This Structure DataType is used to hold the information for a ConnectionConfigurationSet.

It is semantically equivalent to the ConnectionConfigurationSetType as defined in 6.8.2, with the exception that the elements ConnectionConfigurationSetStateMachine, Edit, and Lock, as defined in the ConnectionConfigurationSetType, are not part of this DataType. If this DataType is converted to an Object, the ConnectionConfigurationSetStateMachine shall be in State Ready, the Edit shall be set to False, and the Lock shall be assigned to the ConnectionManager.

The ConnectionConfigurationSetConfDataType is formally defined in Table F.1.

Table F.1 – ConnectionConfigurationSetConfDataType structure
Name Type Description Allow
Subtypes
ConnectionConfigurationSetConfDataTypeStructureSubtype of Structure defined in OPC 10000-5
BrowseName0:StringString part of the BrowseName of the ConnectionConfigurationSet.False
ConnectionConfigurationSetFolder0:String[]

Optional path of the ConnectionConfigurationSet folder used to group ConnectionConfigurationSets, where each entry in the String array represents one level in the folder hierarchy.

If no grouping is needed, the parameter is a null or empty String array.

False
Connections4:ConnectionConfigurationConfDataType[]A list of Connection configurations to be established.False
CommunicationFlows4:CommunicationFlowConfigurationConfDataType[]A list of communication model-specific configurations to apply to Connections.True
ServerAddresses4:ServerAddressConfDataType[]A list of addressing information for AutomationComponents.False
AutomationComponentConfigurations4:AutomationComponentConfigurationConfDataType[]A list of AutomationComponents used for Connection establishment.False
RollbackOnError0:BooleanIndicates the behaviour that should be followed when there is an error on Connection establishment. If this Property is TRUE and an error occurs during the Connection establishment sequence, processing of the set will stop, and all established Connections that are part of this set shall be closed.False
SecurityKeyServer4:SecurityKeyServerAddressConfDataType

The location of the SKS to be used for PubSub security configuration of this ConnectionConfigurationSet, including SecurityGroups and PubSubKeyPushTargets.

If the optional SKS configuration is to be omitted, the field shall be set to null.

False
Version0:UInt32The version of the ConnectionConfigurationSet.False
ConnectionConfigurationSetProperties0:KeyValuePair[]The KeyValuePair array provides additional configuration properties for the ConnectionConfigurationSet.False

The ConnectionConfigurationSetConfDataType representation in the AddressSpace is formally defined in Table F.2.

Table F.2 – ConnectionConfigurationSetConfDataType definition
Attribute Value
BrowseName4:ConnectionConfigurationSetConfDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.4 ConnectionConfigurationConfDataType

This Structure DataType holds the information for a Connection configuration.

It is semantically equivalent to the ConnectionConfigurationType as defined in 6.10.2, except that the element ProcessingResult, as defined in the ConnectionConfigurationType, is not part of this DataType. If this DataType is converted to an Object, the ProcessingResult shall be set to Good.

The ConnectionConfigurationConfDataType is formally defined in Table F.3.

Table F.3 – ConnectionConfigurationConfDataType structure
Name Type Description Optional
ConnectionConfigurationConfDataTypeStructureSubtype of Structure defined in OPC 10000-5
BrowseName0:StringBrowseName of the ConnectionConfigurationFalse
Endpoint14:ConnectionEndpointConfigurationConfDataTypeThe configuration information for the first endpoint of the Connection.False
Endpoint24:ConnectionEndpointConfigurationConfDataTypeThe configuration information for the optional second endpoint of the Connection.True
ConnectionProperties0:KeyValuePair[]The KeyValuePair array provides additional optional properties to configure the ConnectionConfigurationSet.True

The ConnectionConfigurationConfDataType representation in the AddressSpace is formally defined in Table F.4.

Table F.4 – ConnectionConfigurationConfDataType definition
Attribute Value
BrowseName4:ConnectionConfigurationConfDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.5 ConnectionEndpointConfigurationConfDataType

This Structure DataType holds the information for a ConnectionEndpoint configuration, including its parameters.

It is semantically equivalent to the ConnectionEndpointConfigurationType as defined in 6.11.2 and the ConnectionEndpointParameterType as defined in 6.12.2.

The ConnectionEndpointConfigurationConfDataType is formally defined in Table F.5.

Table F.5 – ConnectionEndpointConfigurationConfDataType structure
NameTypeDescriptionOptional
ConnectionEndpointConfigurationConfDataTypeStructureSubtype of Structure defined in OPC 10000-5
FunctionalEntityNode4:NodeIdentifier

FunctionalEntityNode specifies the identifier of the FunctionalEntity to configure for the Connection.

If a RelativePath is specified, the path shall be relative to FxRoot.

False
FunctionalEntityNodeSelection4:NodeIdentifier[]Selection list options for FunctionalEntityNode.True
FunctionalEntityNodeModify0:BooleanFlag indicating if the FunctionalEntityNode options can be modified.True
Name0:String BrowseName of the ConnectionEndpoint to create in the AutomationComponent.False
NameSelection0:String[]Selection list options for the endpoint name. True
NameModify0:BooleanFlag indicating if the Name options can be modified.True
ConnectionEndpointTypeId0:NodeId ConnectionEndpointTypeId specifies the well-known NodeId of the type definition, which shall be used to create the ConnectionEndpoint. This can be any of the subtypes of the ConnectionEndpointType (for example, PubSubConnectionEndpointType).False
InputVariableIds4:NodeIdentifier[]

InputVariableIds specifies a list of node identifiers to be used as inputs. If InputVariableIds is present, it shall contain at least one element.

If the SubscribedDataSetData is configured, the size and order of the variables shall match the target variables in the SubscribedDataSetData.

If the array is null or empty, the optional InputVariableIds node is not available.

If a RelativePath is specified, the path shall be relative to the FunctionalEntityNode specified in the ConnectionEndpointConfigurations.

True
OutputVariableIds4:NodeIdentifier[]

OutVariableIds specifies a list of node identifiers to be used as outputs. If OutputVariableIds is present, it shall contain at least one element.

If the PublishedDataSetData is configured, the size and order of the variables shall match the source variables in the PublishedDataSetData.

If the array is null or empty, the optional OutputVariableIds node is not available.

If a RelativePath is specified, the path shall be relative to the FunctionalEntityNode specified in the ConnectionEndpointConfigurations.

True
IsPersistent0:Boolean IsPersistent, if TRUE, specifies that the created ConnectionEndpoint shall be persistent.False
CleanupTimeout0:Duration CleanupTimeout specifies the value to be used for the clean-up timeout. A negative number indicates an infinite timeout. A zero indicates an immediate clean-up.False
IsPreconfigured0:Boolean IsPreconfigured, if TRUE, specifies that the ConnectionEndpoint is preconfigured.False
CommunicationLinks0:Structure

CommunicationLinks specifies the configuration data related to this ConnectionEndpoint within the CommunicationModelConfiguration.

If this field is set, it shall contain a subtype of 2:Communication LinkConfigurationDataType.

True
PreconfiguredPublishedDataSet0:StringIf it is not an empty string, it specifies the name of a preconfigured PublishedDataSet to be used for connecting the OutputVariables.True
PublishedDataSetData0:PublishedDataSetDataTypeIf not null, it specifies a PublishedDataSet to be used for connecting the OutputVariables.True
PreconfiguredSubscribedDataSet0:String

If it is not an empty string, it specifies the name of a preconfigured StandaloneSubscribedDataSet to be used for connecting the InputVariables.

If the OutputVariableIds are not configured with NodeIds, the source variable NodeIds shall be null. They must be filled in by the ConnectionManager after getting the NodeIds from the AutomationComponent during connection establishment.

True
SubscribedDataSetData0:StandaloneSubscribedDataSetDataType

If not null, it specifies a SubscribedDataSet to be used for connecting the InputVariables. If the InputVariableIds are not configured with NodeIds, the target variable NodeIds shall be null. They must be filled in by the ConnectionManager after getting the NodeIds from the AutomationComponent during connection establishment.

If the InputVariableIds are not configured with NodeIds, the target variable NodeIds shall be null. They must be filled in by the ConnectionManager after getting the NodeIds from the AutomationComponent during connection establishment.

True
ExpectedVerificationVariablesNodeIdentifierValuePair[]

Specifies the Variables and values to be verified.

If a RelativePath is specified as Key, the path shall be relative to FunctionalEntityNode.

If the array is null or empty or the field is not present, no Variables are verified.

True
ControlGroupsNodeIdentifier[]

Specifies the ControlGroups to be controlled.

If a RelativePath is specified as Key, the path shall be relative to FunctionalEntityNode.

If the array is null or empty or the field is not present, no ControlGroups are controlled.

True
ConfigurationDataNodeIdentifierValuePair[]

Specifies the parameters to apply for the configuration of the FunctionalEntityNode.

If a RelativePath is specified as Key, the path shall be relative to FunctionalEntityNode.

If the array is null or empty or the field is not present, no parameters are set.

True
EndpointProperties0:KeyValuePair[]The KeyValuePair array provides additional configuration properties for the endpoint.True
AutomationComponentIndex0:Int32Reference to the related AutomationComponent in the AutomationComponentConfigurations array of the connection set structure.False
OutboundFlowIndex0:Int32

Reference to the related communication flow in the CommunicationFlows array of the connection set structure.

Any negative number indicates that no outbound is configured.

True
InboundFlowIndex0:Int32 [2]Reference to the related communication flow in the CommunicationFlows array (Publisher configuration) of the connection set structure (first index in the array) and to the contained SubscriberConfiguration (second index in the array).True

The ConnectionEndpointConfigurationConfDataType representation in the AddressSpace is formally defined in Table F.6.

Table F.6 – ConnectionEndpointConfigurationConfDataType definition
Attribute Value
BrowseName4:ConnectionEndpointConfigurationConfDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.6 CommunicationFlowConfigurationConfDataType

This abstract Structure DataType holds the information for an information flow.

It is semantically equivalent to the CommunicationFlowConfigurationType as defined in 6.13.2.

The CommunicationFlowConfigurationConfDataType is formally defined in Table F.7.

Table F.7 – CommunicationFlowConfigurationConfDataType structure
Name Type Description Optional
CommunicationFlowConfigurationConfDataTypeStructureSubtype of Structure defined in OPC 10000-5
BrowseName0:String BrowseName of the information flow.False
FlowProperties0:KeyValuePair[]The KeyValuePair array provides additional configuration properties for the flow.True

The FlowProperties KeyValuePair array allows setting of optional configuration properties that extend the parameters defined for the CommunicationFlowConfigurationConfDataType.

The NamespaceIndex of the QualifiedName in the KeyValuePair for properties defined in this document shall be the namespace that has index 4 in this document. The Name of the QualifiedName is the property key from Table F.8. The DataType of the Value in the KeyValuePair shall be the DataType defined in Table F.8.

Table F.8 formally defines the CommunicationFlowConfigurationConfDataType configuration properties.

Table F.8 – CommunicationFlowConfigurationConfDataType properties
Key DataType Description
4:PubSubConnectionAddressNetworkAddressDataType

Allows the configuration of the PubSubConnection Address for Publishers of a unidirectional connection without heartbeat or other cases where the Address configuration in the flow does not include the information needed to set the Address in the PubSubConnection.

One example is a unidirectional connection without heartbeat using UDP unicast.

The CommunicationFlowConfigurationConfDataType representation in the AddressSpace is formally defined in Table F.9.

Table F.9 – CommunicationFlowConfigurationConfDataType definition
Attribute Value
BrowseName4:CommunicationFlowConfigurationConfDataType
IsAbstractTrue
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.7 PubSubCommunicationFlowConfigurationConfDataType

This Structure DataType contains the configuration needed for both the publishing and subscribing of an information flow.

It is semantically equivalent to the PubSubCommunicationFlowConfigurationType as defined in 6.13.2.

The PubSubCommunicationFlowConfigurationConfDataType is formally defined in Table F.10.

Table F.10 – PubSubCommunicationFlowConfigurationConfDataType structure
Name Type Description Optional
PubSubCommunicationFlowConfigurationConfDataTypeStructureSubtype of CommunicationFlowConfigurationConfDataType defined in F.1.4
Address4:AddressSelectionDataType Address specifies the destination network address to be used for transmission of NetworkMessages by the Publisher of the information flow.True
TransportProfileUri0:StringOptional TransportProfileUri specifies the transport protocol mapping and the message mapping to be used. If TransportProfileUri is omitted, the default transport protocol for the Address shall be used.True
TransportProfileUriSelection0:String[]Selection list options for TransportProfileUri.True
TransportProfileUriModify0:BooleanFlag indicating if the TransportProfileUri options can be modified.True
HeaderLayoutUri0:StringOptional HeaderLayoutUri specifies the UADP header formats for both NetworkMessages and DataSetMessages. If HeaderLayoutUri is omitted, a fixed layout for periodic data shall be used.True
HeaderLayoutUriSelection0:String[]Selection list options for HeaderLayoutUri.True
HeaderLayoutUriModify0:BooleanFlag indicating if the HeaderLayoutUri options can be modified.True
PublishingInterval0:Duration PublishingInterval specifies the interval to be used for publishing NetworkMessages.True
PublishingIntervalSelection0:Duration[]Selection list options for PublishingInterval.True
PublishingIntervalModify0:BooleanFlag indicating if the PublishingInterval options can be modified.True
Qos4:CommunicationFlowQosDataTypeThe optional Qos specifies the Quality of Service to be used for the information flow.True
QosSelection4:CommunicationFlowQosDataType[]Selection list options for Qos.True
QosModify0:BooleanFlag indicating if the Qos options can be modified.True
SecurityMode0:MessageSecurityModeThe optional SecurityMode specifies the security mode to be used for the information flow.True
SecurityModeSelection0:MessageSecurityMode[]Selection list options for SecurityMode.True
SecurityModeModify0:BooleanFlag indicating if the SecurityMode options can be modified.True
SecurityGroupId0:StringThe optional SecurityGroupId specifies the security group to be used for the information flow.True
SecurityGroupIdSelection0:String[]Selection list options for SecurityGroupId.True
SecurityGroupIdModify0:BooleanFlag indicating if the SecurityGroupId options can be modified.True
SubscriberConfigurations4:SubscriberConfigurationConfDataType[]Defines the configuration for Subscriber(s) of the information flow.True

The PubSubCommunicationFlowConfigurationConfDataType representation in the AddressSpace is formally defined in Table F.11.

Table F.11 – PubSubCommunicationFlowConfigurationConfDataType definition
Attribute Value
BrowseName4:PubSubCommunicationFlowConfigurationConfDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 4:CommunicationFlowConfigurationConfDataType defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.8 SubscriberConfigurationConfDataType

This structure DataType describes the Subscriber-specific information for the Subscriber of an information flow.

It is semantically equivalent to the SubscriberConfigurationType as defined in 6.13.3.3.

The SubscriberConfigurationConfDataType is formally defined in Table F.12.

Table F.12 – SubscriberConfigurationConfDataType structure
Name Type Description Optional
SubscriberConfigurationConfDataTypeStructureSubtype of Structure defined in OPC 10000-5
BrowseName0:String BrowseName of the flow.False
Address4:AddressSelectionDataType Address specifies the network address to be used for the reception of NetworkMessages at the Subscriber of the information flow.True
MessageReceiveTimeout0:Duration MessageReceiveTimeout specifies the maximum acceptable time between DataSetMessages received by the Subscriber.False
MessageReceiveTimeoutSelection0:Duration[]Selection list options for MessageReceiveTimeout.True
MessageReceiveTimeoutModify0:BooleanFlag indicating if the MessageReceiveTimeout options can be modified.True
ReceiveQos4:ReceiveQosSelectionDataTypeThe optional ReceiveQos specifies the Quality of Service to be used for the Subscriber of the information flow. It shall only be present if Qos is present in the parent Object.True
SubscriberProperties0:KeyValuePair[]The KeyValuePair array provides additional configuration properties for the flow.True

The SubscriberConfigurationConfDataType representation in the AddressSpace is formally defined in Table F.13.

Table F.13 – SubscriberConfigurationConfDataType definition
Attribute Value
BrowseName4:SubscriberConfigurationConfDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.9 AutomationComponentConfigurationConfDataType

This Structure DataType holds the information related to the AutomationComponent participating in a Connection.

It is semantically equivalent to the AutomationComponentConfigurationType as defined in 6.13.2.

The AutomationComponentConfigurationConfDataType is formally defined in Table F.14.

Table F.14 – AutomationComponentConfigurationConfDataType structure
Name Type Description Allow Subtypes
AutomationComponentConfigurationConfDataTypeStructureSubtype of Structure defined in OPC 10000-5
BrowseName0:String BrowseName of the AutomationComponent.False
AutomationComponentNode4:NodeIdentifier AutomationComponentNode specifies the AutomationComponent that is to be used for establishing Connections. If a RelativePath is specified, the path shall be relative to FxRoot.False
AutomationComponentNodeSelection4:NodeIdentifier[]Selection list options for AutomationComponentNode.False
AutomationComponentNodeModify0:BooleanFlag indicating if the AutomationComponentNode options can be modified.False
CommandBundleRequired0:Boolean CommandBundleRequired, when TRUE, specifies that the ConnectionManager shall bundle commands to this AutomationComponent.False
AssetVerification4:AssetVerificationConfDataType[]The Asset verification parameters for Assets associated with the AutomationComponent. If the optional AssetVerification is not available, the field is null.False
CommunicationModelConfig4:CommunicationModelConfigurationDataTypeProvides the ConfigurationData specific to the communication model utilised by the Connections. If the optional CommunicationModelConfig is to be omitted, the field shall be set to null.True
AutomationComponentProperties0:KeyValuePair[]The KeyValuePair array provides additional configuration properties for the AutomationComponent.False
ServerAddressIndex0:Int32Reference to the related Server in the ServerAddresses array of the connection set structure.False

The AutomationComponentConfigurationConfDataType representation in the AddressSpace is formally defined in Table F.15.

Table F.15 – AutomationComponentConfigurationConfDataType definition
Attribute Value
BrowseName4:AutomationComponentConfigurationConfDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.10 SecurityKeyServerAddressConfDataType

This Structure DataType holds the information for the SecurityKeyServer.

The SecurityKeyServerAddressConfDataType is formally defined in Table F.16.

Table F.16 – SecurityKeyServerAddressConfDataType definition
Name Type Description Optional
SecurityKeyServerAddressConfDataTypeStructureSubtype of Structure defined in OPC 10000-5
Address0:UriString Address is specified as a DiscoveryUrl of the server to connect to for connection establishment.False
AddressSelection0:UriString[]Selection list options for Address.True
AddressModify0:BooleanFlag indicating if the Address options can be modified.True
SecurityPolicyUri0:StringSecurityPolicyUri is a string that contains the security policy to use when establishing the secure communication.False
SecurityPolicyUriSelection0:String[]Selection list options for SecurityPolicyUri.True
SecurityPolicyUriModify0:BooleanFlag indicating if the SecurityPolicyUri options can be modified.True
ServerUri0:UriString

ServerUri is a string that reflects the ApplicationUri of the Server. It can be used to cryptographically verify the Server.

The ServerUri can also be a null string, in which case it will not be used to validate the Server.

False
ServerUriSelection0:UriString[]Selection list options for ServerUri.True
ServerUriModify0:BooleanFlag indicating if the ServerUri options can be modified.True
UsePushModel0:BooleanIf TRUE, use the SKS push model. If FALSE, use the SKS pull model.False
SecurityGroups0:SecurityGroupDataType[]Defines the security groups to be applied at the SKS for PubSub security configuration of this ConnectionConfigurationSet.True
PubSubKeyPushTargets0:PubSubKeyPushTargetDataType[]Defines the push key targets to be applied at the SKS for PubSub security configuration of this ConnectionConfigurationSet.True
SksProperties0:KeyValuePair[]The KeyValuePair array provides additional configuration properties for the SecurityKeyServer.True

The SecurityKeyServerAddressConfDataType representation in the AddressSpace is formally defined in Table F.17.

Table F.17 – SecurityKeyServerAddressConfDataType definition
Attribute Value
BrowseName4:SecurityKeyServerAddressConfDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.11 ServerAddressConfDataType

This Structure DataType holds the information for the Server address.

It is semantically equivalent to the ServerAddressType as defined in 9.2.2, except that the field Namespaces is added to the ServerAddressConfDataType. For the handling of this field, see F.1.2.2.

The ServerAddressConfDataType is formally defined in Table F.18.

Table F.18 – ServerAddressConfDataType structure
Name Type Description Optional
ServerAddressConfDataTypeStructureSubtype of Structure defined in OPC 10000-5
BrowseName0:String BrowseName of the Server address.False
Address0:UriString Address is specified as a DiscoveryUrl of the server to connect to for connection establishment.False
AddressSelection0:UriString[]Selection list options for Address.True
AddressModify0:BooleanFlag indicating if the Address options can be modified.True
SecurityMode0:MessageSecurityMode SecurityMode is the MessageSecurityMode to be used for establishing a secure communication to the Address.False
SecurityModeSelection0:MessageSecurityMode[]Selection list options for SecurityMode.True
SecurityModeModify0:BooleanFlag indicating if the SecurityMode options can be modified.True
SecurityPolicyUri0:String SecurityPolicyUri is a string that contains the security policy to use when establishing the secure communication.False
SecurityPolicyUriSelection0:String[]Selection list options for SecurityPolicyUri.True
SecurityPolicyUriModify0:BooleanFlag indicating if the SecurityPolicyUri options can be modified.True
ServerUri0:UriString

ServerUri is a string that reflects the ApplicationUri of the Server. It can be used to cryptographically verify the Server.

The ServerUri can also be a null string, in which case it will not be used to validate the Server.

False
ServerUriSelection0:UriString[]Selection list options for ServerUri.True
ServerUriModify0:BooleanFlag indicating if the ServerUri options can be modified.True
ServerProperties0:KeyValuePair[]The KeyValuePair array provides additional configuration properties for the Server.True
Namespaces0:String[]

Namespace table for translation of NodeIds and RelativePaths related to this Server.

For further details, see F.1.2.2.

False

The ServerAddressConfDataType representation in the AddressSpace is formally defined in Table F.19.

Table F.19 – ServerAddressConfDataType definition
Attribute Value
BrowseName4:ServerAddressConfDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.12 AssetVerificationConfDataType

The AssetVerificationDataConfType is used to store the information needed for Asset verification.

It is semantically equivalent to the AssetVerificationType as defined in 6.15.2.

The AssetVerificationConfDataType is formally defined in Table F.20.

Table F.20 – AssetVerificationConfDataType structure
Name Type Description Optional
AssetVerificationConfDataTypeStructureSubtype of Structure defined in OPC 10000-5
AssetToVerify4:NodeIdentifier

Specifies the expected Asset to be verified.

If a RelativePath is specified, the path shall be relative to AutomationComponentNode.

False
VerificationMode2:AssetVerificationModeEnumThe mode to use for the verification (compatibility and/or identity).False
ExpectedVerificationResult2:AssetVerificationResultEnumThe expected level of compatibility that this Asset shall provideFalse
ExpectedVerificationVariables4:NodeIdentifierValuePair[]

The variables to be verified for compatibility and/or identity.

If a RelativePath is specified, the path shall be relative to the expected Asset.

False
ExpectedAdditionalVerificationVariables4:NodeIdentifierValuePair[]

The additional variables to be verified for compatibility and/or identity.

If a RelativePath is specified, the path shall be relative to the expected Asset.

False
AssetProperties0:KeyValuePair[]The KeyValuePair array provides additional configuration properties for the Asset verification.True

The AssetVerificationConfDataType representation in the AddressSpace is formally defined in Table F.21.

Table F.21 – AssetVerificationConfDataType definition
Attribute Value
BrowseName4:AssetVerificationConfDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.13 CommunicationModelConfigurationDataType

The CommunicationModelConfigurationDataType is formally defined in Table F.22.

It is semantically equivalent to the CommunicationModelConfigurationType as defined in 6.16.2.

Table F.22 – CommunicationModelConfigurationDataType structure
Name Type Description
CommunicationModelConfigurationDataTypeStructureSubtype of Structure defined in OPC 10000-5

The CommunicationModelConfigurationDataType representation in the AddressSpace is formally defined in Table F.23.

Table F.23 – CommunicationModelConfigurationDataType definition
Attribute Value
BrowseName4:CommunicationModelConfigurationDataType
IsAbstractTrue
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.14 PubSubCommunicationModelConfigurationDataType

The PubSubCommunicationModelConfigurationDataType is formally defined in Table F.24.

It is semantically equivalent to the PubSubCommunicationModelConfigurationType as defined in 6.16.3.2.

Table F.24 – PubSubCommunicationModelConfigurationDataType structure
Name Type Description
PubSubCommunicationModelConfigurationDataTypeStructureSubtype of CommunicationModelConfigurationDataType defined in F.1.13.
PubSubConfiguration0:PubSubConfiguration2DataType PubSub configuration for the addressed Server when establishing Connections.
TranslationTable4:NodeIdTranslationDataType[] NodeIds contained in the PubSubConfiguration, which use the special namespace “http://opcfoundation.org/UA/FX/CM/Translation/”, are not valid NodeIds but placeholders which shall be resolved before the ConnectionManager can use the PubSubConfiguration for connection establishment.
ConfigurationReferences0:PubSubConfigurationRefDataType[] ConfigurationReferences points to elements within the PubSubConfiguration and indicates whether they are to be added, matched, modified, or removed.

The PubSubCommunicationModelConfigurationDataType representation in the AddressSpace is formally defined in Table F.25.

Table F.25 – PubSubCommunicationModelConfigurationDataType definition
Attribute Value
BrowseName4:PubSubCommunicationModelConfigurationDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of CommunicationModelConfigurationDataType defined in F.1.13
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.15 NodeIdentifier

The NodeIdentifier is used to store an identifier, where the identifier can be NodeId, Alias String, or a RelativePath.

It is semantically equivalent to the PortableNodeIdentifier as defined in 10.36, except it uses the optimisation as described in F.1.2.2.

The NodeIdentifier DataType is formally defined in Table F.26.

Table F.26 – NodeIdentifier union
Name Type Description
NodeIdentifierUnionSubtype of Union defined in OPC 10000-5
Node0:NodeId

The NodeId of the Node.

The NamespaceIndex of the NodeId relates to the Namespaces in the ServerAddressConfDataType (see F.1.11) of the related Server.

Alias0:StringThe AliasName of the Node.
IdentifierBrowsePath0:RelativePath

The IdentifierBrowsePath to the Node. The starting Node of the IdentifierBrowsePath shall be specified where this type is used.

A NamespaceIndex in the RelativePath relates to the Namespaces in the ServerAddressConfDataType (see F.1.11) of the related Server.

The NodeIdentifier representation in the AddressSpace is formally defined in Table F.27.

Table F.27 – NodeIdentifier definition
Attribute Value
BrowseName4:NodeIdentifier
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Union defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.16 NodeIdentifierValuePair

The NodeIdentifierValuePair is used to provide a key-value pair where the key is a Variable Node.

It is semantically equivalent to the PortableKeyValuePair as defined in 10.35 with the optimisation as described in F.1.2.2.

The NodeIdentifierValuePair DataType is formally defined in Table F.28.

Table F.28 – NodeIdentifierValuePair structure
Name Type Description
NodeIdentifierValuePairStructureSubtype of Structure defined in OPC 10000-5
Key4:NodeIdentifierThe Key to the Variable.
ArrayIndex0:UInt32[]

If Key refers to a Variable with ValueRank >= 1, the ArrayIndex specifies the index for a specific value referenced by Key (Not the entire array, but a specific element in it). The ArrayIndex is required to have the same dimension as the dimension of the node.

If Key is not of array type, or if no specific index shall be referenced, then the array shall be null or empty.

Value0:BaseDataTypeThe value associated with the key/array item.

The NodeIdentifierValuePair representation in the AddressSpace is formally defined in Table F.29.

Table F.29 – NodeIdentifierValuePair definition
Attribute Value
BrowseName4:NodeIdentifierValuePair
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.17 NodeIdTranslationConfDataType

This NodeIdTranslationConfDataType is used to provide table entries for the conversion of NodeId to NodeIdentifier (see F.1.15).

It is semantically equivalent to the NodeIdTranslationDataType as defined in 10.33 with the optimisation as described in F.1.2.2.

The NodeIdTranslationConfDataType is formally defined in Table F.30.

Table F.30 – NodeIdTranslationConfDataType structure
Name Type Description
NodeIdTranslationConfDataTypeStructureSubtype of Structure defined in OPC 10000-5
NodePlaceholder0:NodeId NodeId to be converted to the result of resolving the NodeIdentifier.
Node4:NodeIdentifierSpecifies the NodeIdentifier corresponding to the NodeId of the NodePlaceholder.

The NodeIdTranslationConfDataType representation in the AddressSpace is formally defined in Table F.31.

Table F.31 – NodeIdTranslationConfDataType definition
Attribute Value
BrowseName4:NodeIdTranslationConfDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.18 AddressSelectionDataType

The AddressSelectionDataType holds the selection list for a network address (see F.1.2.3). It allows the address selection to be optional, where this DataType is used (see F.1.7 and F.1.8).

The AddressSelectionDataType is formally defined in Table F.32.

Table F.32 – AddressSelectionDataType structure
Name Type Description Allow Subtypes
AddressSelectionDataTypeStructureSubtype of Structure defined in OPC 10000-5
Address0:NetworkAddressDataTypeNetwork address configured.True
AddressSelection0:NetworkAddressDataType[]Selection list options for Address.True
AddressModify0:BooleanFlag indicating if the Address options can be modified.False

The AddressSelectionDataType representation in the AddressSpace is formally defined in Table F.33.

Table F.33 – AddressSelectionDataType definition
Attribute Value
BrowseName4:AddressSelectionDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration

F.1.19 ReceiveQosSelectionDataType

The ReceiveQosSelectionDataType holds the selection list for a receive QoS configuration (see F.1.2.3). It allows making the receive QoS selection optional, where this DataType is used (see F.1.7 and F.1.8).

The ReceiveQosSelectionDataType is formally defined in Table F.34.

Table F.34 – ReceiveQosSelectionDataType structure
Name Type Description Allow Subtypes
ReceiveQosSelectionDataTypeStructureSubtype of Structure defined in OPC 10000-5
ReceiveQos0:ReceiveQosDataType[]The ReceiveQos configuration.True
ReceiveQosSelection0:BaseDataTypeSelection list options for ReceiveQos. The field will contain a matrix of subtypes of ReceiveQosDataType. If the field is not provided, it is null.False
ReceiveQosModify0:Boolean Flag indicating if the ReceiveQos options can be modified.False

The ReceiveQosSelection is of BaseDataType and thus requires a subtype to be used. The flag AllowSubtypes is only set if the type can be used as well as subtypes.

The ReceiveQosSelectionDataType representation in the AddressSpace is formally defined in Table F.35.

Table F.35 – ReceiveQosSelectionDataType definition
Attribute Value
BrowseName4:ReceiveQosSelectionDataType
IsAbstractFalse
References NodeClass BrowseName DataType TypeDefinition ModellingRule
Subtype of the 0:Structure defined in OPC 10000-5
ConformanceUnits
UAFX ConnectionManager File Configuration