The DataSetWriterIdwith DataType UInt16defines the unique ID of the DataSetWriterfor a PublishedDataSet. It is used to select DataSetMessagesfor aPublishedDataSeton the Subscriberside.

It shall be unique across all DataSetWritersfor a PublisherId.

All values, except for 0, are valid DataSetWriterIds. The value 0 is defined as null value.

A DataSet field consists of a value and related metadata. In most cases the value comes with status and timestamp information.

This DataTypedefines flags to include DataSetfield related information like status and timestamp in addition to the value in the DataSetMessage.

The DataSetFieldContentMaskis formally defined in Table 14.

The handling of bad status for different field representations is defined in Figure 21and Table 16.

Table 14– DataSetFieldContentMask Values

Value

Bit No.

Description

DataSetfields can be represented as RawData, Variant or DataValue as described in 5.3.2.

If none of the flags are set, the fields are represented as Variant.

If the RawDataflag is set, the fields are represented as RawDataand all other bits are ignored.

If one of the bits 0 to 4 is set, the fields are represented as DataValue.

StatusCode

0

The DataValuestructure field StatusCodeis included in the DataSetMessages.

If this flag is set, the fields are represented as DataValue.

SourceTimestamp

1

The DataValuestructure field SourceTimestampis included in the DataSetMessages.

If this flag is set, the fields are represented as DataValue.

ServerTimestamp

2

The DataValuestructure field ServerTimestampis included in the DataSetMessages.

If this flag is set, the fields are represented as DataValue.

SourcePicoSeconds

3

The DataValuestructure field SourcePicoSecondsis included in the DataSetMessages.

If this flag is set, the fields are represented as DataValue. This flag is ignored if the SourceTimestampflag is not set.

ServerPicoSeconds

4

The DataValuestructure field ServerPicoSecondsis included in the DataSetMessages.

If this flag is set, the fields are represented as DataValue. This flag is ignored if the ServerTimestampflag is not set.

RawData

5

If this flag is set, the values of the DataSetare encoded as Structureand all other field related flags shall be ignored.

The RawDatarepresentation is handled like a Structure DataTypewhere the DataSetfields are handled like Structurefields and fields with Structure DataTypeare handled like nested structures. All restrictions for the encoding of Structure DataTypesalso apply to the RawData Field Encoding. Fields shall not have an abstract DataType or shall have a fixed ValueRank. Fields shall have dimensions defined if the DataTypeis Stringor ByteStringor if it is an array. This includes Structurefields with such fields. The flag shall be ignored and the fields shall be represented as Variantif the fields do not fulfil these requirements.

The DataSetFieldContentMaskrepresentation in the AddressSpaceis defined in Table 15.

Table 15– DataSetFieldContentMask Definition

Attributes

Value

BrowseName

DataSetFieldContentMask

IsAbstract

False

References

NodeClass

BrowseName

DataType

Subtype of UInt32 defined in OPC 10000-5.

HasProperty

Variable

OptionSetValues

LocalizedText [ ]

The DataSetFieldContentMaskdefines different options that influence the information flow from Publisherto Subscriberin the case of a Bad Value Status or other error situations. Figure 21depicts the parameters and the information flow from DataSetfield to DataSetMessagecreation on Publisherside and the decoded DataSet field on the Subscriber side. The DataSetFieldContentMask controls the representation of the DataSet fields in a DataSetMessage.

image024.png

Figure 21– PubSub Information Flow dependency to field representation

The representation of the DataSetfields in a DataSetMessageon the Publisherside and the decoding back to the DataSetfields on the Subscriberside is defined in Table 16. The representation on the Publisherside depends on the field representation defined in the DataSetFieldContentMask.

Table 16– DataSetMessage field representation options

DataSet Publisher

Field

DataSetMessage

DataSet Subscriber

Value

Status(4)

Value

Status(4)

Value

Status(4)

Value 1

Good_*

Variant

Value 1

N/A (1)

Value 1

N/A (1)

Value 1

Uncertain_*

Value 1

Value 1

Null

Bad_*

Bad_* (1)

Null

Bad_*

Value 1

Good_*

DataValue

Value 1

Good_*

Value 1

Good_*

Value 1

Uncertain_*

Value 1

Uncertain_*

Value 1

Uncertain_*

Null

Bad_*

Null

Bad_*

Null

Bad_*

Value 1

Good_*

RawData

Value 1

N/A

Value 1

N/A

Value 1

Uncertain_*

Value 1(2)

Value 1

Null

Bad_*

DefaultValue(3)

DefaultValue

Note 1: A bad status is transferred instead of a value. An uncertain status is not transferred for a field. If the status field is included in the DataSetMessageheader, the status is set to uncertain if one of the fields has an uncertain status.

Note 2: If the worst status for one or more fields is uncertain, the DataSetMessagestatus shall be set to Uncertain.

Note 3: If the worst status for one or more fields is bad, the DataSetMessagestatus shall be set to Bad.

Note 4: If no specific StatusCodeis used, the grouping into severity Good, Uncertainor Badis used. In this case, the resulting Statusmatches the input Status.

The KeyFrameCountwith DataType UInt32is the multiplier of the PublishingIntervalthat defines the maximum number of times the PublishingIntervalexpires before a key frame message with values for all published Variablesis sent. The delta frame DataSetMessagescontains just the changed values. If no changes exist, the delta frame DataSetMessageshall not be sent. If the KeyFrameCountis set to 1, every message contains a key frame.

For PublishedDataSetslike PublishedDataItemsthat provide cyclic updates of the DataSet, the value shall be greater or equal to 1. For non-cyclic PublishedDataSets,like PublishedEvents,that provide event based DataSets, the value shall be 0.

The DataSetWriterPropertiesparameter is an array of DataType KeyValuePairthat specifies additional properties for the configured DataSetWriter. 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.

This Structure DataTypeis used to represent the DataSetWriterparameters. The DataSetWriterDataTypeis formally defined in Table 17.

Table 17– DataSetWriterDataType Structure

Name

Type

Description

DataSetWriterDataType

Structure

name

String

The name of the DataSetWriter.

enabled

Boolean

The enabled state of the DataSetWriter.

dataSetWriterId

UInt16

Defined in 6.2.3.1.

dataSetFieldContentMask

DataSetFieldContentMask

Defined in 6.2.3.2.

keyFrameCount

UInt32

Defined in 6.2.3.3.

dataSetName

String

The name of the corresponding PublishedDataSet.

dataSetWriterProperties

KeyValuePair[]

Defined in 6.2.3.4.

transportSettings

DataSetWriterTransportDataType

Transport mapping specific DataSetWriterparameters. The abstract base type is defined in 6.2.3.5.2. The concrete subtypes are defined in the sections for transport mapping specific parameters.

messageSettings

DataSetWriterMessageDataType

DataSetMessagemapping specific DataSetWriterparameters. The abstract base type is defined in 6.2.3.5.3. The concrete subtypes are defined in the sections for message mapping specific parameters.

This Structure DataTypeis an abstract base type for transport mapping specific DataSetWriterparameters. The abstract DataTypedoes not define fields.

The DataSetWriterTransportDataType Structurerepresentation in the AddressSpaceis defined in Table 18.

Table 18– DataSetWriterTransportDataType Definition

Attributes

Value

BrowseName

DataSetWriterTransportDataType

IsAbstract

True

References

NodeClass

BrowseName

IsAbstract

Description

Subtype of Structure defined in OPC 10000-5.

HasSubtype

DataType

BrokerDataSetWriterTransportDataType

FALSE

Defined in 6.4.2.3.7.

This Structure DataTypeis an abstract base type for message mapping specific DataSetWriterparameters. The abstract DataTypedoes not define fields.

The DataSetWriterMessageDataType Structurerepresentation in the AddressSpaceis defined in Table 19.

Table 19– DataSetWriterMessageDataType Structure

Attributes

Value

BrowseName

DataSetWriterMessageDataType

IsAbstract

True

References

NodeClass

BrowseName

IsAbstract

Description

Subtype of Structure defined in OPC 10000-5.

HasSubtype

DataType

UadpDataSetWriterMessageDataType

FALSE

Defined in 6.3.1.2.6.

HasSubtype

DataType

JsonDataSetWriterMessageDataType

FALSE

Defined in 6.3.2.2.2.