The ResourceUriparameter of DataType Stringenables the transport implementation to look up a configured key from the corresponding KeyCredentialConfigurationTypeinstance defined in OPC 10000-12to use for authenticating access to the broker at the connection level or for queues configured below the connection.

If null, no authentication or anonymous authentication shall be assumed as default unless authentication settings are provided on a subordinated WriterGroupor a DataSetWriterto authenticate access to individual queues.

The parameter AuthenticationProfileUriof DataType Stringallows the selection of the authentication protocol used by the transport implementation. This maps to the ProfileUri Propertyin the KeyCredentialConfigurationTypeinstance selected through the ResourceUriand AuthenticationProfileUri Strings.

This parameter is optional. If more than one ProfileUridescribing the protocol to use for authentication is configured and this value is null, the transport will choose one. If the transport cannot fine a suitable authentication mechanism in the ProfileUriarray, the transport sets the Stateof the PubSubConnectionis set to Error_3.

This Structure DataTypeis used to represent the Broker specific transport mapping parameters for the PubSubConnection. It is a subtype of the ConnectionTransportDataTypedefined in 6.2.6.4.

The BrokerConnectionTransportDataTypeis formally defined in Table 68.

Table 68– BrokerConnectionTransportDataType Structure

Name

Type

Description

BrokerConnectionTransportDataType

Structure

resourceUri

String

Defined in 6.4.2.1.1.

authenticationProfileUri

String

Defined in 6.4.2.1.2.

The QueueNameparameter with DataType Stringspecifies the queue in the Brokerthat receives NetworkMessagessent by the Publisher. This could be the name of a queue or topic defined in the Broker.

The ResourceUriproperty of DataType Stringallows the transport implementation to look up the configured key from the corresponding KeyCredentialConfigurationTypeinstance defined in OPC 10000-12to use for authenticating access to the specified queue.

If this Stringis not null, it overrides the ResourceUriof the PubSubConnectionauthentication settings.

The parameter AuthenticationProfileUriof DataType Stringallows the selection of the authentication protocol used by the transport implementation for authenticating access to the specified queue.

If this Stringis not null, it overrides the AuthenticationProfileUriof the PubSubConnectiontransport settings defined in 6.4.2.1.2.

The RequestedDeliveryGuaranteeparameter with DataType BrokerTransportQualityOfServicespecifies the delivery guarantees that shall apply to all NetworkMessagespublished by the WriterGroupunless otherwise specified on the DataSetWritertransport settings. The DataType BrokerTransportQualityOfServiceis defined in 6.4.2.2.5.

The value NotSpecified_0 is not allowed on the WriterGroup. If the selected delivery guarantee cannot be applied, the WriterGroupshall set the state to Error_3.

The BrokerTransportQualityOfServiceEnumeration DataTypeis formally defined in Table 71.

The mapping of quality of service to the broker transport specific implementation is defined in 7.3.4.5for AMQP and 7.3.5.5for MQTT.

Table 69– BrokerTransportQualityOfService Values

Value

Description

NotSpecified_0

The value is not specified and the value of the parent object shall be used.

BestEffort_1

The transport shall make the best effort to deliver a message. Worst case this means data loss or data duplication are possible.

AtLeastOnce_2

The transport guarantees that the message shall be delivered at least once, but duplication is possible. Readers must de-duplicate based on message id or sequence number.

AtMostOnce_3

The transport guarantees that the message shall be sent once, but if it is lost it is not sent again.

ExactlyOnce_4

The transport handshake guarantees that the message shall be delivered to the broker exactly once and not more or less.

This Structure DataTypeis used to represent the Broker specific transport mapping parameters for WriterGroups. It is a subtype of the WriterGroupTransportDataTypedefined in 6.2.5.6.2.

The BrokerWriterGroupTransportDataTypeis formally defined in Table 70.

Table 70– BrokerWriterGroupTransportDataType Structure

Name

Type

Description

BrokerWriterGroupTransportDataType

Structure

queueName

String

Defined in 6.4.2.2.1.

resourceUri

String

Defined in 6.4.2.2.2.

authenticationProfileUri

String

Defined in 6.4.2.2.3.

requestedDeliveryGuarantee

BrokerTransportQualityOfService

Defined in 6.4.2.2.4.

The QueueNameparameter with DataType Stringspecifies the queue in the Brokerthat receives NetworkMessagessent by the Publisherfor the DataSetWriter. This could be the name of a queue or topic defined in the Broker. This parameter is only valid if the NetworkMessagesfrom the WriterGroupcontain only one DataSetMessage.

If this Stringis not null, it overrides the QueueNameof the WriterGrouptransport settings.

The ResourceUriproperty of DataType Stringallows the transport implementation to look up the configured key from the corresponding KeyCredentialConfigurationTypeinstance defined in OPC 10000-12to use for authenticating access to the specified queue.

If this Stringis not null, it overrides the ResourceUriof the WriterGroup authentication settings.

The parameter AuthenticationProfileUriof DataType Stringallows the selection of the authentication protocol used by the transport implementation for authenticating access to the specified queue.

If this Stringis not null, it overrides the AuthenticationProfileUriof the WriterGroup transport settings.

The RequestedDeliveryGuaranteeparameter with DataType BrokerTransportQualityOfServicespecifies the delivery guarantees that shall apply to all messages published by the DataSetWriter. The DataType BrokerTransportQualityOfServiceis defined in 6.4.2.2.5.

If the value is not NotSpecified_0, it overrides the RequestedDeliveryGuaranteeof the WriteGrouptransport settings.

If the selected delivery guarantee cannot be applied, the DataSetWritershall set the state to Error_3.

For message mappings like UADP, the Subscriberneeds access to the DataSetMetaDatato process received DataSetMessages. The Publisher can provide the DataSetMetaDatathrough a dedicated queue.

The parameter MetaDataQueueNamewith the DataType Stringspecifies the Brokerqueue that receives messages with DataSetMetaDatasent by the Publisherfor this DataSetWriter. This could be the name of a queue or topic defined in the Broker.

Specifies the interval in milliseconds with Data Type Duration at which the Publisher shall send the DataSetMetaData to the MetaDataQueueName. A value of 0 or any negative value shall be interpreted as infinite interval.

The broker transport shall publish all messages with an expiration time that is equal or greater than this value.

If the update time is infinite, a broker transport shall attempt to negotiate message retention if possible. In this case the DataSetMetaDatais only sent if the ConfigurationVersionof the corresponding DataSetMetaDatais changed and DataSetWritersshall try to negotiate AtLeastOnce_2 or ExactlyOnce_4 delivery guarantees with the broker for any DataSetMetaDatasent to ensure meta data is available to readers.

The DataSetWriterPropertiessettings apply also to DataSetMetaDatasent to the queue named through the MetaDataQueueNameparameter.

This Structure DataTypeis used to represent the Broker specific transport mapping parameters for DataSetWriters. It is a subtype of the DataSetWriterTransportDataTypedefined in 6.2.3.5.2.

The BrokerDataSetWriterTransportDataTypeis formally defined in Table 71.

Table 71– BrokerDataSetWriterTransportDataType Structure

Name

Type

Description

BrokerDataSetWriterTransportDataType

Structure

queueName

String

Defined in 6.4.2.3.1.

resourceUri

String

Defined in 6.4.2.3.2.

authenticationProfileUri

String

Defined in 6.4.2.3.3.

requestedDeliveryGuarantee

BrokerTransportQualityOfService

Defined in 6.4.2.3.4.

metaDataQueueName

String

Defined in 6.4.2.3.5.

metaDataUpdateTime

Duration

Defined in 6.4.2.3.6.

The QueueNameparameter with DataType Stringspecifies the queue in the Brokerwhere the DataSetReadercan receive NetworkMessageswith the DataSet of interest sent by the Publisher. This could be the name of a queue or topic defined in the Broker. This parameter is only valid if the NetworkMessagesfrom the WriterGroupcontain only one DataSetMessage.

The ResourceUriproperty of DataType Stringallows the transport implementation to look up the configured key from the corresponding KeyCredentialConfigurationTypeinstance defined in OPC 10000-12to use for authenticating access to the specified queue.

If this Stringis not null, it overrides the ResourceUriof the PubSubConnectionauthentication settings.

The parameter AuthenticationProfileUriof DataType Stringallows the selection of the authentication protocol used by the transport implementation for authenticating access to the specified queue.

If this Stringis not null, it overrides the AuthenticationProfileUriof the PubSubConnectiontransport settings defined in 6.4.2.1.2.

The RequestedDeliveryGuaranteeparameter with DataType BrokerTransportQualityOfServicespecifies the delivery guarantees the DataSetReadernegotiates with the broker for all messages received. The DataType BrokerTransportQualityOfServiceis defined in 6.4.2.2.5.

The value NotSpecified_0 is not allowed on the DataSetReader. If the selected delivery guarantee cannot be applied, the DataSetReadershall set the state to Error_3.

The parameter MetaDataQueueNamewith the DataType Stringspecifies the Brokerqueue that provides messages with DataSetMetaDatasent by the Publisherfor the DataSetof interest. This could be the name of a queue or topic defined in the Broker.

This Structure DataTypeis used to represent the Broker specific transport mapping parameters for DataSetWriters. It is a subtype of the DataSetReaderTransportDataTypedefined in 6.2.8.11.2.

The BrokerDataSetReaderTransportDataTypeis formally defined in Table 72.

Table 72– BrokerDataSetReaderTransportDataType Structure

Name

Type

Description

BrokerDataSetReaderTransportDataType

Structure

queueName

String

Defined in 6.4.2.4.1.

resourceUri

String

Defined in 6.4.2.4.2.

authenticationProfileUri

String

Defined in 6.4.2.4.3.

requestedDeliveryGuarantee

BrokerTransportQualityOfService

Defined in 6.4.2.4.4.

metaDataQueueName

String

Defined in 6.4.2.4.5.