UA Part 14: PubSub - 6.2.8 DataSetReader Parameters

6.2.8 DataSetReader Parameters

6.2.8.1 PublisherId

The parameterPublisherIddefines the Publisherto receive NetworkMessagesfrom.

If the value is null, the parameter shall be ignored and all received NetworkMessagespass the PublisherIdfilter.

Valid DataTypesare UIntegerand String.

6.2.8.2 WriterGroupId

The parameterWriterGroupId with DataType UInt16defines the identifier of the corresponding WriterGroup.

The default value 0 is defined as null value, and means this parameter shall be ignored.

6.2.8.3 DataSetWriterId

The parameterDataSetWriterIdwith DataType UInt16 defines the DataSetselected in the Publisherfor the DataSetReader.

If the value is 0 (null), the parameter shall be ignored and all received DataSetMessagespass the DataSetWriterIdfilter.

6.2.8.4 DataSetMetaData

The parameterDataSetMetaDataprovides the information necessary to decode DataSetMessagesfrom the Publisher. If the DataSetMetaDatachanges in the Publisherand the MajorVersionwas changed, the DataSetReaderneeds an update of the DataSetMetaDatafor further operation. If the update cannot be retrieved in the duration of the MessageReceiveTimeout, the Stateof the DataSetReadershall change to Error_3. The related PublishedDataSetis defined in 6.2.2. The DataSetMetaDataTypeis defined in 6.2.2.1.2. The options for retrieving the update of the DataSetMetaDataare described in 5.2.3.

6.2.8.5 DataSetFieldContentMask

The parameterDataSetFieldContentMaskwith DataType DataSetFieldContentMaskindicates the fields of a DataValueincluded in the DataSetMessages.

The DataSetFieldContentMaskDataType is defined in 6.2.3.2.

6.2.8.6 MessageReceiveTimeout

The parameterMessageReceiveTimeoutis the maximum acceptable time between two DataSetMessages. If there is no DataSetMessagereceived within this period, the DataSetReader Stateshall be changed to Error_3 until the next DataSetMessageis received. The DataSetMessagescan be data or keep alive messages.

The MessageReceiveTimeoutis related to the Publisherside parameters PublishingInterval, KeepAliveTimeand KeyFrameCount.

6.2.8.7 SecurityMode

The parameter is defined in 6.2.4.2.

This parameter overwrites the corresponding setting on the ReaderGroupif the value is not INVALID_0.

6.2.8.8 SecurityGroupId

The parameter is defined in 6.2.4.3.

The parameter shall be null if the SecurityModeis INVALID_0.

6.2.8.9 SecurityKeyServices

The parameter is defined in 6.2.4.4.

The parameter shall be null if the SecurityModeis INVALID_0.

6.2.8.10 DataSetReaderProperties

The DataSetReaderPropertiesparameter is an array of DataType KeyValuePairthat specifies additional properties for the configured DataSetReader. The KeyValuePair DataTypeis defined in OPC 10000-5and consists of a QualifiedNameand a value of BaseDataType.

The mapping of the name and value to concrete functionality may be defined by transport protocol mappings, future versions of this specification or vendor specific extensions.

6.2.8.11 DataSetReader Structure

6.2.8.11.1 DataSetReaderDataType

This Structure DataTypeis used to represent the DataSetReaderparameters. The DataSetReaderDataTypeis formally defined in Table 36.

Table 36– DataSetReaderDataType Structure

Name	Type	Description
DataSetReaderDataType	Structure
name	String	The name of the DataSetReader.
enabled	Boolean	The enabled state of the DataSetReader.
publisherId	BaseDataType	Defined in 6.2.8.1.
writerGroupId	UInt16	Defined in 6.2.8.2.
dataSetWriterId	UInt16	Defined in 6.2.8.3.
dataSetMetaData	DataSetMetaDataType	Defined in 6.2.8.4.
dataSetField‌ContentMask	DataSetFieldContentMask	Defined in 6.2.8.5.
messageReceiveTimeout	Duration	Defined in 6.2.8.6.
keyFrameCount	UInt32
headerLayoutUri	String
securityMode	MessageSecurityMode	Defined in 6.2.8.7.
securityGroupId	String	Defined in 6.2.8.8.
securityKeyServices	EndpointDescription[]	Defined in 6.2.8.9.
dataSetReaderProperties	KeyValuePair[]	Defined in 6.2.8.10.
transportSettings	DataSetReaderTransportDataType	Transport specific DataSetReader parameters. The abstract base type is defined in 6.2.8.11.2. The concrete subtypes are defined in the sections for transport mapping specific parameters
messageSettings	DataSetReaderMessageDataType	DataSetMessage mapping specific DataSetReader parameters. The abstract base type is defined in 6.2.8.11.3. The concrete subtypes are defined in the sections for message mapping specific parameters.
subscribedDataSet	SubscribedDataSetDataType	The SubscribedDataSet specific parameters. The abstract base type and the concrete subtypes are defined 6.2.9.

6.2.8.11.2 DataSetReaderTransportDataType

This Structure DataTypeis an abstract base type for transport specific DataSetReaderparameters. The DataSetReaderTransportDataTypeis formally defined in Table 37.

Table 37– DataSetReaderTransportDataType Structure

Name	Type	Description
DataSetReaderTransportDataType	Structure

The DataSetReaderTransportDataType Structurerepresentation in the AddressSpaceis defined in Table 38.

Table 38– DataSetReaderTransportDataType Definition

Attributes	Value
BrowseName	DataSetReaderTransportDataType
IsAbstract	True
References	NodeClass	BrowseName	IsAbstract	Description
Subtype of Structure defined in OPC 10000-5.
HasSubtype	DataType	BrokerDataSetReaderTransportDataType	FALSE	Defined in 6.4.2.4.6.

6.2.8.11.3 DataSetReaderMessageDataType

This Structure DataTypeis an abstract base type for message mapping specific DataSetReaderparameters. The DataSetReaderMessageDataTypeis formally defined in Table 39.

Table 39– DataSetReaderMessageDataType Structure

Name	Type	Description
DataSetReaderMessageDataType	Structure

The DataSetReaderMessageDataType Structurerepresentation in the AddressSpaceis defined in Table 40.

Table 40– DataSetReaderMessageDataType Definition

Attributes	Value
BrowseName	DataSetReaderMessageDataType
IsAbstract	True
References	NodeClass	BrowseName	IsAbstract	Description
Subtype of Structure defined in OPC 10000-5.
HasSubtype	DataType	UadpDataSetReaderMessageDataType	FALSE	Defined in 6.3.1.3.10.
HasSubtype	DataType	JsonDataSetReaderMessageDataType	FALSE	Defined in 6.3.2.3.3.