PubSubConfiguration – OPC Unified Architecture

6.2.12 PubSubConfiguration

6.2.12.1 PubSubConfigurationDataType

This Structure DataType is used to represent the PubSub configuration of an OPC UA Application. The PubSubConfigurationDataType is formally defined in Table 86.

Table 86 – PubSubConfigurationDataType structure

Name	Type	Description
PubSubConfigurationDataType	Structure
PublishedDataSets	PublishedDataSetDataType[]	The PublishedDataSets contained in the configuration. The PublishedDataSetDataType is defined in 6.2.3.5.
Connections	PubSubConnectionDataType[]	The PubSubConnections contained in the configuration. The PubSubConnectionDataType is defined in 6.2.7. The connection includes WriterGroups and ReaderGroups.
Enabled	Boolean	The enabled state of the PubSub configuration. This Enable state corresponds to the PubSub Status of the PublishSubscribe Object.

Its representation in the AddressSpace is defined in Table 87.

Table 87 – PubSubConfigurationDataType definition

Attributes	Value
BrowseName	PubSubConfigurationDataType
IsAbstract	False
Subtype of Structure defined in OPC 10000-5.
Conformance Units
PubSub Parameters Configuration

If the PubSub configuration is stored in a file, the UABinaryFileDataType and the related definitions in OPC 10000-5 shall be used to encode the file content. The structure of the UABinaryFileDataType file with typical values for a PubSub configuration is described in Table 88.

Table 88 – PubSubConfiguration file content

Field	Type	Typical Values
Namespaces	String[]	Namespace URIs for namespace indices used in the body. Examples are NodeIds contained in PublishedDataSets. The OPC UA namespace is skipped. The DataTypes used for configuration are defined in the OPC UA namespace.
structureDataTypes	StructureDescription[]	Null or empty DataTypes used for configuration are defined by OPC UA. The DataTypes used in DataSetMetaData are described in the DataTypeSchemaHeader of the associated DataSetMetaData. This field is only used if KeyValuePairs for configuration properties contain Structure DataTypes not defined by OPC UA.
enumDataTypes	EnumDescription[]	Null or empty DataTypes used for configuration are defined by OPC UA. The DataTypes used in DataSetMetaData are described in the DataTypeSchemaHeader of the associated DataSetMetaData. This field is only used if KeyValuePairs for configuration properties contain Structure DataTypes not defined by OPC UA.
simpleDataTypes	SimpleTypeDescription[]	Null or empty DataTypes used for configuration are defined by OPC UA. The DataTypes used in DataSetMetaData are described in the DataTypeSchemaHeader of the associated DataSetMetaData. This field is only used if KeyValuePairs for configuration properties contain Structure DataTypes not defined by OPC UA.
schemaLocation	String	Null or empty
fileHeader	KeyValuePair[]	Null or empty
Body	BaseDataType	PubSubConfigurationDataType Structure The PubSub configuration represented by the PubSubConfigurationDataType.

6.2.12.2 SecurityGroupDataType

This Structure DataType is used to represent the configuration of a SecurityGroup in a PubSub configuration of an OPC UA Application.

If the SecurityPolicyUri or the KeyLifetime of an existing SecurityGroup are modified, all existing keys of the SecurityGroup are invalidated. The behaviour is described for the InvalidateKeys Method in 8.4.2.

The SecurityGroupDataType is formally defined in Table 89.

Table 89 – SecurityGroupDataType structure

Name	Type	Description
SecurityGroupDataType	Structure
Name	String	Name of the SecurityGroup.
SecurityGroupFolder	String[]	Optional path of the SecurityGroupFolders used to group SecurityGroups where each entry in the String array represents one level in a folder hierarchy. If no grouping is needed the parameter is a null or empty String array.
KeyLifetime	Duration	The lifetime of a key in milliseconds. If the last available key expires and the Publisher does not receive a new key in two times the KeyLifetime it shall go into Error state and shall stop sending messages secured with the expired key. If a Subscriber receives messages for a key longer than two times the KeyLifetime it shall stop processing messages with the expired key.
SecurityPolicyUri	String	The SecurityPolicy used for the SecurityGroup.
MaxFutureKeyCount	UInt32	The maximum number of future keys returned by the Method GetSecurityKeys.
MaxPastKeyCount	UInt32	The maximum number of historical keys stored by the SKS.
SecurityGroupId	String	The identifier for the SecurityGroup. The SecurityGroupId shall match the Name field.
RolePermissions	RolePermissionType[]	The permissions that apply to the security key access through GetSecurityKeys for the SecurityGroup.
GroupProperties	KeyValuePair[]	Specifies additional properties for the security group.

Its representation in the AddressSpace is defined in Table 90.

Table 90 – SecurityGroupDataType definition

Attributes	Value
BrowseName	SecurityGroupDataType
IsAbstract	False
Subtype of Structure defined in OPC 10000-5.
Conformance Units
PubSub Parameters Configuration2

6.2.12.3 PubSubKeyPushTargetDataType

This Structure DataType is used to represent the configuration of a PubSubKeyServicePushTarget in a PubSub configuration of an OPC UA Application. The PubSubKeyPushTargetDataType is formally defined in Table 91.

Table 91 – PubSubKeyPushTargetDataType structure

Name	Type	Description
PubSubKeyPushTargetDataType	Structure
ApplicationUri	String	ApplicationUri of the Server that is the target of a push.
PushTargetFolder	String[]	Optional path of the PubSubKeyPushTargetFolder used to group the push targets where each entry in the String array represents one level in a folder hierarchy. If no grouping is needed the parameter is a null or empty String array.
EndpointUrl	String	URL of the Endpoint of the Server that is the target of a push.
SecurityPolicyUri	String	The security policy the SKS shall use to establish a SecureChannel to the push target.
UserTokenType	UserTokenPolicy	The type of user toke to be used for the connection to the push target. The default is Anonymous.
RequestedKeyCount	UInt16	The number of keys that are to be pushed on each update. The minimum setting for this is three
RetryInterval	Duration	The interval the SKS shall use to retry pushing keys after an error appeared
PushTargetProperties	KeyValuePair[]	Specifies additional properties for the push target
SecurityGroups	String[]	List of security groups related to the push target

Its representation in the AddressSpace is defined in Table 92.

Table 92 – PubSubKeyPushTargetDataType definition

Attributes	Value
BrowseName	PubSubKeyPushTargetDataType
IsAbstract	False
Subtype of Structure defined in OPC 10000-5.
Conformance Units
PubSub Parameters Configuration2

6.2.12.4 PubSubConfiguration2DataType

This Structure DataType is used to represent the extended PubSub configuration of an OPC UA Application. It is a subtype of the PubSubConfigurationDataType defined in 6.2.12.1.

The PubSubConfiguration2DataType is formally defined in Table 93.

Table 93 – PubSubConfiguration2DataType structure

Name	Type	Description
PubSubConfiguration2DataType	Structure	Subtype of PubSubConfigurationDataType defined in 6.2.12.1.
SubscribedDataSets	StandaloneSubscribed‌DataSetDataType[]	The standalone SubscribedDataSets contained in the configuration. The StandaloneSubscribedDataSetDataType is defined in 6.2.10.5.
DataSetClasses	DataSetMeta‌DataType[]	DataSetClasses supported by the Publisher.
DefaultSecurityKeyServices	EndpointDescription[]	The default SecurityKeyServices used for the PubSub configuration. The value is as default if not overwritten in the groups or DataSetReaders. The general definition for the SecurityKeyServices parameter is in 6.2.5.4.
SecurityGroups	SecurityGroupDataType[]	The SecurityGroups contained in the configuration. The SecurityGroupDataType is defined in 6.2.12.2.
PubSubKeyPushTargets	PubSubKeyPushTarget DataType[]	The PubSubKeyPushTargets contained in the configuration. The PubSubKeyPushTargetDataType is defined in 6.2.12.3.
ConfigurationVersion	VersionTime	The ConfigurationVersion reflects the time of the last change.
ConfigurationProperties	KeyValuePair[]	The configurationProperties is an array of DataType KeyValuePair that specifies additional properties for the PubSub configuration. The KeyValuePair type is defined in OPC 10000-5 and consists of a QualifiedName and a value of BaseDataType. The mapping of the namespace, name, and value to concrete functionality may be defined by transport protocol mappings, future versions of this document or vendor-specific extensions.

Its representation in the AddressSpace is defined in Table 94.

Table 94 – PubSubConfiguration2DataType definition

Attributes	Value
BrowseName	PubSubConfiguration2DataType
IsAbstract	False
Subtype of PubSubConfigurationDataType defined in 6.2.12.1.
Conformance Units
PubSub Parameters Configuration2