6 PubSub communication parameters ToC Previous Next

6.2 Common configuration parameters ToC Previous Next

6.2.7 PubSubConnection parameters ToC Previous Next

6.2.7.1 PublisherId ToC

The PublisherId is a unique identifier for a Publisher within a Message Oriented Middleware. It can be included in sent NetworkMessage for identification or filtering. The value of the PublisherId is typically shared between PubSubConnections but the assignment of the PublisherId is vendor specific.

The PublisherId parameter is only relevant for the Publisher functionality inside a PubSubConnection. The filter setting on the Subscriber side is contained in the DataSetReader parameters.

Valid DataTypes are UInteger and String. A zero UInteger and a Null or empty String are invalid PublisherIds.

The unique identifier for an OPC UA Application is the ApplicationUri. It is recommended to use the ApplicationUri String as a default PublisherId for broker based transport protocols.

The default PublisherId for datagram transport protocols has a DataType of UInt64. If the default PublisherId is created by the OPC UA Application, it is recommended to set the first 6 bytes with the MAC address of one of the network interfaces and to set the two remaining bytes to the OPC UA Server port of the OPC UA Application.

The default PublisherId is used if it is not assigned by a configuration tool.

6.2.7.2 TransportProfileUri ToC

The TransportProfileUri parameter with DataType String indicates the transport protocol mapping and the message mapping used.

The possible TransportProfileUri values are defined as URI of the transport protocols defined as PubSub transport Facet in OPC 10000-7.

6.2.7.3 Address ToC

The Address parameter contains the network address information for the communication middleware. The different Structure DataTypes used to represent the Address are defined in 6.2.7.5.3.

6.2.7.4 ConnectionProperties ToC

The ConnectionProperties parameter is an array of DataType KeyValuePair that specifies additional properties for the configured connection. 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.

6.2.7.5 PubSubConnection structure ToC Model

6.2.7.5.1 PubSubConnectionDataType ToC Model

This Structure DataType is used to represent the configuration parameters for PubSubConnections. The PubSubConnectionDataType is formally defined in Table 38.

Table 38 – PubSubConnectionDataType structure

Name Type Description
PubSubConnectionDataType Structure  
   name String    The name of the PubSubConnection. The name shall be unique across a PubSubConfiguration.It is recommended to use a human readable name.
   enabled Boolean The enabled state of the PubSubConnection.
   publisherId BaseDataType Defined in 6.2.7.1.
   transportProfileUri String Defined in 6.2.7.2.
   address NetworkAddressDataType    Defined in 6.2.7.3. The NetworkAddressDataType is defined in 6.2.7.5.3.
   connectionProperties KeyValuePair[] Defined in 6.2.7.4.
   transportSettings ConnectionTransportDataType    Transport mapping specific PubSubConnection parameters. The abstract base type is defined in 6.2.7.5.2. The concrete subtypes are defined in the subclauses for transport mapping specific parameters.If no concrete subtype is defined for the transport mapping, the field shall be null.
   writerGroups WriterGroupDataType[] The WriterGroups contained in the PubSubConnection. The WriterGroup is defined in 6.2.6.
   readerGroups ReaderGroupDataType[] The ReaderGroups contained in the PubSubConnection. The ReaderGroup is defined in 6.2.8.

Its representation in the AddressSpace is defined in Table 39.

Table 39 – PubSubConnectionDataType definition

Attributes Value
BrowseName PubSubConnectionDataType
IsAbstract False
Subtype of Structure defined in OPC 10000-5.  
Conformance Units  
PubSub Parameters Discovery Extended  

6.2.7.5.2 ConnectionTransportDataType ToC Model

This Structure DataType is an abstract base type for transport mapping specific PubSubConnection parameters. The abstract DataType does not define fields.

The ConnectionTransportDataType Structure representation in the AddressSpace is defined in Table 40.

Table 40 – ConnectionTransportDataType definition

Attributes Value      
BrowseName ConnectionTransportDataType      
IsAbstract True      
References NodeClass BrowseName IsAbstract Description
Subtype of Structure defined in OPC 10000-5.        
HasSubtype DataType DatagramConnectionTransportDataType FALSE Defined in 6.4.1.2.2.
HasSubtype DataType BrokerConnectionTransportDataType FALSE Defined in 6.4.2.2.3.
Conformance Units        
PubSub Parameters Discovery Extended        

6.2.7.5.3 NetworkAddressDataType ToC Model

Subtypes of this abstract Structure DataType are used to represent network address information. The NetworkAddressDataType is formally defined in Table 41.

Table 41 – NetworkAddressDataType structure

Name Type Description
NetworkAddressDataType Structure  
   networkInterface String    The name of the network interface used for the communication relation.   The default value is an empty String. In this case the network interface used is determined by the address provided by the subtypes of this Structure.The name can be an IP address, MAC address or the system specific name of the interface.

The NetworkAddressDataType Structure representation in the AddressSpace is defined in Table 42.

Table 42 – NetworkAddressDataType definition

Attributes Value      
BrowseName NetworkAddressDataType      
IsAbstract True      
References NodeClass BrowseName IsAbstract Description
Subtype of Structure defined in OPC 10000-5.        
HasSubtype DataType NetworkAddressUrlDataType False Defined in 6.2.7.5.4.
Conformance Units        
PubSub Parameters Discovery Extended        

6.2.7.5.4 NetworkAddressUrlDataType ToC Model

This Structure DataType is used to represent network address information in the form of an URL String. The NetworkAddressUrlDataType is formally defined in Table 43.

Table 43 – NetworkAddressUrlDataType structure

Name Type Description
NetworkAddressUrlDataType Structure Subtype of NetworkAddressDataType defined in 6.2.7.5.3.
   url String The address string for the communication relation in the form on an URL String.

The NetworkAddressUrlDataType Structure representation in the AddressSpace is defined in Table 44.

Table 44 – NetworkAddressUrlDataType definition

Attributes Value    
BrowseName NetworkAddressUrlDataType    
IsAbstract False    
References NodeClass BrowseName IsAbstract
Subtype of NetworkAddressDataType defined in 6.2.7.5.3.      
Conformance Units      
PubSub Parameters Discovery Extended      

Previous Next