6 PubSub communication parameters ToC Previous Next

6.2 Common configuration parameters ToC Previous Next

6.2.12 PubSubConfiguration ToC Previous Next

6.2.12.1 PubSubConfigurationDataType ToC Model

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

Table 71 – PubSubConfigurationDataType structure

Name Type Description
PubSubConfigurationDataType Structure  
   publishedDataSets PublishedDataSetDataType[] The PublishedDataSets contained in the configuration. The PublishedDataSet is defined in 0.
   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 72.

Table 72 – 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 73.

Table 73 – 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 emptyDataTypes   used for configuration are defined by OPC UA.
enumDataTypes EnumDescription[]    Null or emptyDataTypes   used for configuration are defined by OPC UA.
simpleDataTypes SimpleTypeDescription[]    Null or emptyDataTypes   used for configuration are defined by OPC UA.
schemaLocation String Null or empty
fileHeader KeyValuePair[] Null or empty
Body BaseDataType    PubSubConfigurationDataType   StructureThe PubSub configuration represented by the PubSubConfigurationDataType.

6.2.12.2 SecurityGroupDataType ToC Model

This Structure DataType is used to represent the configuration of a SecurityGroup in a PubSub configuration of an OPC UA Application. The SecurityGroupDataType is formally defined in Table 74.

Table 74 – SecurityGroupDataType structure

Name Type Description
SecurityGroupDataType Structure  
   name String Name of the SecurityGroup.
   securityGroupFolder String[]    Optional path of the SecuritGroupFolders 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.
   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.
   rolePermissions RolePermissionType[] The permissions that apply to the SecurityGroup.
   groupProperties KeyValuePair[] Specifies additional properties for the security group.

Its representation in the AddressSpace is defined in Table 75.

Table 75 – 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 ToC Model

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 76.

Table 76 – 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 77.

Table 77 – 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 ToC Model

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 78.

Table 78 – PubSubConfiguration2DataType structure

Name Type Description
PubSubConfiguration2DataType Structure Subtype of PubSubConfigurationDataType defined in 6.2.12.1.
   subscribedDataSets StandaloneSubscribedDataSetDataType[] The standalone SubscribedDataSets contained in the configuration. The StandaloneSubscribedDataSetDataType is defined in 6.2.10.5.
   dataSetClasses DataSetMetaDataType[] 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 79.

Table 79 – PubSubConfiguration2DataType definition

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

Previous Next