The parameter PublisherId defines the Publisher to receive NetworkMessages from.

If the value is null, the parameter shall be ignored and all received NetworkMessages pass the PublisherId filter.

Valid DataTypes are UInteger and String.

The parameter WriterGroupId with DataType UInt16 defines the identifier of the corresponding WriterGroup.

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

The parameter DataSetWriterId with DataType UInt16 defines the DataSet selected in the Publisher for the DataSetReader.

If the value is 0 (null), the parameter shall be ignored and all received DataSetMessages pass the DataSetWriterId filter.

The parameter DataSetMetaData provides the information necessary to decode DataSetMessages from the Publisher. If the DataSetMetaData changes in the Publisher and the MajorVersion was changed, the DataSetReader needs an update of the DataSetMetaData for further operation. If the update cannot be retrieved in the duration of the MessageReceiveTimeout, the State of the DataSetReader shall change to Error_3. The related PublishedDataSet is defined in 6.2.2. The DataSetMetaDataType is defined in 6.2.2.1.2. The options for retrieving the update of the DataSetMetaData are described in 5.2.3.

The parameter DataSetFieldContentMask with DataType DataSetFieldContentMask indicates the fields of a DataValue included in the DataSetMessages.

The DataSetFieldContentMask DataType is defined in 6.2.3.2.

The parameter MessageReceiveTimeout is the maximum acceptable time between two DataSetMessages. If there is no DataSetMessage received within this period, the DataSetReader State shall be changed to Error_3 until the next DataSetMessage is received. The DataSetMessages can be data or keep alive messages.

The MessageReceiveTimeout is related to the Publisher side parameters PublishingInterval, KeepAliveTime and KeyFrameCount.

The parameter is defined in 6.2.4.2.

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

The parameter is defined in 6.2.4.3.

The parameter shall be null if the SecurityMode is INVALID_0.

The parameter is defined in 6.2.4.4.

The parameter shall be null if the SecurityMode is INVALID_0.

The DataSetReaderProperties parameter is an array of DataType KeyValuePair that specifies additional properties for the configured DataSetReader. The KeyValuePair DataType is defined in OPC 10000-5 and consists of a QualifiedName and 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.

This Structure DataType is used to represent the DataSetReader parameters. The DataSetReaderDataType is 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.

This Structure DataType is an abstract base type for transport specific DataSetReader parameters. The DataSetReaderTransportDataType is formally defined in Table 37.

Table 37 – DataSetReaderTransportDataType Structure

Name

Type

Description

DataSetReaderTransportDataType

Structure

The DataSetReaderTransportDataType Structure representation in the AddressSpace is 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.

This Structure DataType is an abstract base type for message mapping specific DataSetReader parameters. The DataSetReaderMessageDataType is formally defined in Table 39.

Table 39 – DataSetReaderMessageDataType Structure

Name

Type

Description

DataSetReaderMessageDataType

Structure

The DataSetReaderMessageDataType Structure representation in the AddressSpace is 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.