Search

Scope: Core (OPC-10000-*) All specs

122 result(s) for DataSet

OPC-10000-1 – OPC Unified Architecture - Part 1: Overview and Concepts

2.1.12 DataSet

DataSet list of named data values Note 1 to entry: A DataSet typically consists of Event fields or Variable values
OPC-10000-1 – OPC Unified Architecture - Part 1: Overview and Concepts

2.1.13 DataSetMessage

DataSetMessage payload of a NetworkMessage created from a DataSet Note 1 to entry: The DataSetMessage is an immutable payload of the NetworkMessage handed off to the Message Oriented Middleware (transport
OPC-10000-1 – OPC Unified Architecture - Part 1: Overview and Concepts

2.1.22 NetworkMessage

DataSetMessage is used to mean the message as supplied by the Publisher for a DataSet and the term NetworkMessage is used to mean the DataSetMessage plus sections for annotation
OPC-10000-2 – OPC Unified Architecture - Part 2: Security Model

4.6 SecurityPolicies

Clients . For the Publish Subscribe communications pattern, the SecurityPolicy is associated with a published DataSet and all Subscribers utilize the same SecurityPolicy . Since computing power increases every year, specific algorithms
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

3.1.2 DataSetClass

DataSetClass template declaring the content of a DataSet Note 1 to entry: A DataSetClass is used to type DataSets for use in several Publishers and for filtering in Subscribers
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

3.1.3 DataSetMetaData

DataSetMetaData data describing the content and semantic of a DataSet
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

3.1.4 DataSetReader

NetworkMessage received from the Message Oriented Middleware and decodes the DataSetMessage to a DataSet for further processing in the Subscriber
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

3.1.5 DataSetWriter

them through a Message Oriented Middleware Note 1 to entry: A DataSetWriter encodes a DataSet to a DataSetMessage and includes the DataSetMessage into a NetworkMessage for publishing through a Message
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

3.1.8 PublishedDataSet

PublishedDataSet configuration of application-data to be published as DataSet Note 2 to entry: The Responder sends a response to Requestor when the Action completes. Note 1 to entry
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

3.1.10 SubscribedDataSet

received DataSets Note 1 to entry: A SubscribedDataSet can be a mapping of DataSet fields to Variables in the Subscriber AddressSpace
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.1 General

General Clause 5 describes the general OPC UA PubSub concepts. The DataSet constitutes the payload of messages provided by the Publisher and consumed by the Subscriber . The DataSet is described ... PubSub communication model supports many other scenarios; for example, a Publisher may send a DataSet to multiple Message Oriented Middleware and a Subscriber may receive messages from multiple Publishers . Figure
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.2.1 General

General A DataSet can be thought of as a list of name and value pairs representing an Event or a list of Variable Values . A DataSet can be created from ... sample of Variable Values . The configuration of this application-data collector is called PublishedDataSet . DataSet fields can be defined to represent any information, for example, they could be internal Variables
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.2.2 DataSetClass

from a DataSetClass . Such a DataSetClass acts as template declaring the content of a DataSet . The DataSetClass is identified by a globally unique id - the DataSetClassId (see 6.2.3.3 ). The DataSetMetaData
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.2.3 DataSetMetaData

DataSetMetaData DataSetMetaData describes the content and semantics of a DataSet . The structure description includes overall DataSet attributes (e.g. name and version) and a set of fields with their name ... Subscribers use the DataSetMetaData for decoding the values of a DataSetMessage to a DataSet . Subscribers may use name and data type for further processing or display of the published data
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.3.2 DataSetMessage field

DataSetMessage field A DataSetMessage field is the representation of a DataSet field in a DataSetMessage . A DataSet field contains the actual value as well as additional information about the value ... like status and timestamp. A DataSet field can be represented as a DataValue , as a Variant or as a RawData in the DataSetMessage field. The representation depends on the DataSetFieldContentMask
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.3.3 DataSetMessage

DataSetMessage A DataSetMessage is created from a DataSet . It consists of a header and the encoded fields of the DataSet . Depending on the configured DataSetMessageContentMask , a DataSetMessage may exist ... delta frame DataSetMessages. A key frame DataSetMessage includes values for all fields of the DataSet. A delta frame DataSetMessage only contains the subset that changed since the previous DataSetMessage
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.1.1 General

logical component of a Publisher . See 5.4.1.2 for further information about the DataSet writing process. If the Publisher is an OPC UA Server , it can expose the Publisher configuration
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.1.2 Message sending

creating and sending messages and the parameters required to accomplish it. The components, like DataSet collection or DataSetWriter should be considered abstract. They may not exist in every Publisher ... parameters are defined in Clause 6 . The first step is the collection of data ( DataSet ) to be published. The configuration for such a collection is called PublishedDataSet . The PublishedDataSet also
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.2.1 General

relevant, it will be forwarded to the corresponding DataSetReader for decoding into a DataSet . See 5.4.2.2 for further information about this DataSet reading process. The resulting DataSet is then further
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.2.2 Message reception

DataSetReader . Here, the DataSetMetaData is used to decode the DataSetMessage content to a DataSet . The DataSetMetaData in particular provides the complete field syntax including the name, data type, and other ... Subscribers OPC UA AddressSpace . The configuration of SubscribedDataSetMirror is used if the received DataSet fields should be represented as Variables in the Subscribers OPC UA AddressSpace but the Variables
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.6.2.2 Broker-less model with OPC UA UDP

group can publish DataSets at the defined publishing interval. In each publishing interval, a DataSet is collected for a PublishedDataSet which can be a list of sampled data items ... Publisher OPC UA Address Space . For each DataSet a DataSetMessage is created. The DataSetMessages are sent in a NetworkMessage to the IP multicast address. OPC UA Applications like HMI applications
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.6.3.2 Broker-based model

queues or topics. Each group may have one or more DataSetWriters that format a DataSet as required for the messaging protocol. A DataSet can be collected from a list ... Event fields and/or selected Variables . Such a configuration is called PublishedDataSet . Each DataSet is sent as a separate DataSetMessage serialized with a format that depends on the DataSetWriter . One DataSetMessage
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.1 Overview

decoding of the DataSetMessages of interest. SubscribedDataSet parameters define the processing of the decoded DataSet in the Subscriber for one DataSetReader . PublishSubscribe is the overall management of the PubSub groupings
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.3.1 Overview

content of a DataSetMessage and the configuration of the information source for a DataSet . See 5.2 for the introduction to DataSets , 5.3 for the introduction to DataSetMessages ... application specific. The custom PublishedDataSet source DataType defined in 6.2.3.9 indicates if the DataSet is cyclic or acyclic. Cyclic DataSets are sent as key frame or delta frame DataSetMessages . Acyclic
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.3.2.1 General

General DataSetMetaData describe the content and semantic of a DataSet . The order of the fields in the DataSetMetaData shall match the order of DataSet fields when they are included
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.3.2.3 DataSetMetaDataType

subtype of DataTypeSchemaHeader and is used to provide the metadata for a DataSet . The DataSetMetaDataType is formally defined in Table 5 . Table 5 - DataSetMetaDataType structure Name Type Description DataSetMetaDataType Structure ... Subtype of DataTypeSchemaHeader defined in OPC 10000-5 . Name String Name of the DataSet . Description LocalizedText Description of the DataSet . The default value is a null or empty LocalizedText . Fields
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.3.2.4 FieldMetaData

This Structure DataType is used to provide the metadata for a field in a DataSet . The FieldMetaData is formally defined in Table 7 . Table 7 - FieldMetaData structure Name Type Description ... Structure Name String Name of the field. The name shall be unique in the DataSet . Description LocalizedText Description of the field. The default value shall be a null or empty
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.3.2.5 DataSetFieldFlags

DataSetFieldFlags This DataType defines flags for DataSet fields. The DataSetFieldFlags is formally defined in Table 9 . Table 9 - DataSetFieldFlags Values Value Bit No. Description PromotedField 0 The flag indicates ... header even if the DataSetMessage payload is a delta frame and the DataSet field is not included in the delta frame. In this case the last sent value is sent
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.3.2.6 ConfigurationVersionDataType

Structure DataType is used to indicate configuration changes in the information published for a DataSet . The ConfigurationVersionDataType is formally defined in Table 11 . Table 11 - ConfigurationVersionDataType structure Name Type Description ... MajorVersion VersionTime The majorVersion reflects the time of the last major change of the DataSet content. The VersionTime DataType is defined in OPC 10000-4 . To assure interoperability, the Subscriber
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.3.4 ExtensionFields

ExtensionFields parameter allows the configuration of fields with values to be included in the DataSet when the existing AddressSpace of the Publisher does not provide the necessary information. The ExtensionFields
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.3.5 PublishedDataSetDataType

PublishedDataSet shall be unique in the Publisher . DataSetFolder String[] Optional path of the DataSet folder used to group PublishedDataSets where each entry in the String array represents one level ... DataSet folder hierarchy. If no grouping is needed the parameter is a null or empty String array. DataSetMetaData DataSetMetaDataType Defined in 6.2.3.2 . ExtensionFields KeyValuePair[] Defined in 6.2.3.4 . DataSetSource PublishedDataSetSourceDataType Defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.3.7.1 PublishedData

PublishedData The parameter PublishedData defines the content of a DataSet created from Variable Values and therefore the content of the DataSetMessage sent by a DataSetWriter . The sources of the DataSet ... index may change after configuration changes. Changes are indicated by the ConfigurationVersion of the DataSet and applications working with the index shall always check the ConfigurationVersion before using the index
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.3.8.2 SelectedFields

SelectedFields The parameter SelectedFields defines the selection of Event fields contained in the DataSet generated for an Event and sent through the DataSetWriter . The SimpleAttributeOperand DataType is defined ... DataType of the selected Event field in the EventType defines the DataType of the DataSet field. Event fields can be null or the field value can be a StatusCode
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.4.2 DataSetFieldContentMask

DataSetFieldContentMask A DataSet field consists of a value and related metadata. In most cases the value comes with status and timestamp information. This DataType defines flags to include DataSet field ... Table 34 and Table 35 . Table 32 - DataSetFieldContentMask Values Value Bit No. Description DataSet fields can be represented as RawData, Variant or DataValue as described in 5.3.2 . If none
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.4.3 KeyFrameCount

every message contains a key frame. For PublishedDataSets that provide cyclic updates of the DataSet , the value shall be greater than or equal to 1. PublishedDataItems or custom sources with
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.6.2 PublishingInterval

KeyFrameCount of all DataSetWriters in the WriterGroup shall be 0. For cyclic PublishedDataSets one DataSet is produced for one PublishedDataSet in a PublishingInterval . If no new DataSet is available
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.9.3 DataSetWriterId

DataSetWriterId 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
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.10.1 SubscribedDataSetDataType

abstract base type for SubscribedDataSet parameters. A SubscribedDataSet defines the metadata for the subscribed DataSet and the information for the processing of DataSetMessages . See 5.4.2.2 for an introduction
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.10.2.1 General

General The SubscribedDataSet option TargetVariables defines a list of Variable mappings between received DataSet fields and target Variables in the Subscriber AddressSpace . The FieldTargetDataType is defined in 6.2.10.2.3 . Target Variables
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.10.2.3 FieldTargetDataType

Type Description FieldTargetDataType Structure DataSetFieldId Guid The unique ID of the field in the DataSet . The fields and their unique IDs are defined in the DataSetMetaData Structure . ReceiverIndexRange NumericRange Index ... array, or a single range of indexes for arrays for the received DataSet field. If a range of elements is specified, the values are returned as a composite. The first
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.10.3.1 General

SubscribedDataSetMirror defines an Object in the Subscriber AddressSpace with a mirror Variable for each DataSet field in the received DataSetMessages
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.10.3.2 ParentNodeName

DisplayName of the parent Node for the Variables representing the fields of the subscribed DataSet
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.10.3.3 RolePermissions

parent Node. This value is also used as RolePermissions for all Variables of the DataSet mirror
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.10.4 StandaloneSubscribedDataSetRefDataType

StandaloneSubscribedDataSetRefDataType This Structure DataType references a standalone subscribed DataSet . It is a subtype of the SubscribedDataSetDataType defined in 6.2.10.1 . The StandaloneSubscribedDataSetRefDataType is formally defined in Table 75 . Table 75 - StandaloneSubscribedDataSetRefDataType ... Name Type Description StandaloneSubscribedDataSetRefDataType Structure DataSetName String The name of the corresponding standalone subscribed DataSet . Its representation in the AddressSpace is defined in Table 76 . Table 76 - StandaloneSubscribedDataSetRefDataType definition Attributes
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.10.5 StandaloneSubscribedDataSetDataType

StandaloneSubscribedDataSetDataType This Structure DataType is define a standalone subscribed DataSet . It is a subtype of the SubscribedDataSetDataType defined in 6.2.10.1 . The StandaloneSubscribedDataSetDataType is formally defined in Table 77 . Table ... configured to send DataSetMessages that comply with the DataSetMetaData in the standalone subscribed DataSet . SubscribedDataSet SubscribedDataSet‌DataType The SubscribedDataSet specific parameters. The abstract base type and the concrete subtypes are defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.11.1 Published data items

Figure 25 - PubSub information flow The mapping of source value and status to the DataSet in the Publisher depends on the substitute value. The dependencies are defined in Table ... Table 79 - Source to message input mapping Source Substitute Value DataSet Publisher side Value (b) Status (a) Value Status (a) Value 1 Good_* Value 2 Value 1 Good_* Value
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.1.2 GroupVersion

NetworkMessageContentMask of this WriterGroup ; Offset of any DataSetWriter in this WriterGroup ; MinorVersion of the DataSet of any DataSetWriter in this WriterGroup ; DataSetFieldContentMask of any DataSetWriter in this WriterGroup ; DataSetMessageContentMask
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.1.3 DataSetOrdering

DataSets with an ascending order of the related DataSetWriterIds as long as the accumulated DataSet sizes will not exceed the MaxNetworkMessageSize . The different options are shown in Figure 30 . Figure
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.3.3 ConfiguredSize

space inside a NetworkMessage by setting ConfiguredSize to a higher value than the assigned DataSet actually requires. Modifications (e.g. extensions) of the DataSet would then not change the required bandwidth
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.4.4 DataSetClassId

DataSetClassId The parameter DataSetClassId with DataType Guid defines a DataSet class related filter. If the value is null, the DataSetClassId filter is not applied
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.4.7 PublishingInterval

PublishingInterval with DataType Duration indicates the rate the Publisher sends NetworkMessages related to the DataSet . The start time for the periodic execution of the Subscriber shall be calculated according
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.4.8 ReceiveOffset

PublishingInterval cycle for the expected receive time of the NetworkMessage for the DataSet from the network. Any negative value indicates that the ReceiveOffset is not configured and the timing inside
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.2.4.4 DataSetClassId

DataSetClassId The parameter DataSetClassId with DataType Guid defines a DataSet class related filter. If the value is null or the parameter is not set, the DataSetClassId filter is not applied
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.4.2.6.5 MetaDataQueueName

Broker queue that provides messages with DataSetMetaData sent by the Publisher for the DataSet of interest. This could be the name of a queue or topic defined in the Broker
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.2 MessageTypes

PubSub MessageTypes MessageType Description DataSetMessage Application data or events supplied by the Publisher as DataSet . DataSetMetaData Discovery message with content and semantics of a DataSetMessage ApplicationDescription Discovery message with
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.1 General

Subscriber may not support all security policies. The capabilities related to processing different DataSet encodings is defined in OPC 10000-7 . The fields in the following protocol definition tables
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.4.4 UADP Chunk NetworkMessage

DataSetWriterId identifies the PublishedDataSet and the DataSetWriter responsible for sending Messages for the DataSet . A Subscriber can skip DataSetMessages from DataSetWriters it does not expect DataSetMessages from. Table 159 - Chunked
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.5.1 General

General The UADP DataSet payload header and other parts of the NetworkMessage are shown in Figure 33 . Different types of DataSetMessage can be combined in on NetworkMessage . Figure 33 - UADP ... DataSet payload
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.5.2 DataSet payload header

DataSet payload header The encoding of the UADP DataSet payload header is specified in Table 160 . The payload header is unencrypted. This header shall be omitted ... UADPFlags is false. Table 160 - UADP DataSet payload header Name Type Description Count Byte Number of DataSetMessages contained in the NetworkMessage . The NetworkMessage shall contain at least one DataSetMessage
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.5.3 DataSet payload

DataSet payload The DataSet payload is defined in Table 161 . The payload is encrypted. Table 161 - UADP DataSet payload Name Type Description Sizes UInt16 [Count] List of byte sizes ... DataSetMessages . The size of the list is defined by the Count in the DataSet payload header. If the payload size exceeds 65535, the DataSetMessages shall be allocated to separate NetworkMessages
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.5.4 DataSetMessage header

processed by the Subscriber . Bit range 1-2: Field Encoding 00 The DataSet fields are encoded as Variant The Variant can contain a StatusCode instead of the expected DataType ... Encoding The RawData field encoding is defined in 7.2.4.5.11 . 10 DataValue Field Encoding The DataSet fields are encoded as DataValue . This option is set if the DataSet is configured
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.5.5 Data Key Frame DataSetMessage

Frame DataSetMessage structure Name Type Description FieldCount UInt16 Number of fields of the DataSet contained in the DataSetMessage . The FieldCount shall be omitted if RawData field encoding ... EncodingFlags defined in 7.2.4.5.4 . DataSetFields BaseDataType [FieldCount] The field values of the DataSet. The field encoding depends on the DataSetFlags1.Field Encoding of the DataSetMessage Header defined in 7.2.4.5.4 . The default
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.5.7 Event DataSetMessage

Event DataSetMessage structure Name Type Description FieldCount UInt16 Number of fields of the DataSet contained in the DataSetMessage . DataSetFields BaseDataType [FieldCount] The field values of the DataSet. The fields
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.5.9 Action request message

Action execution is defined in 6.2.11.2 . FieldCount UInt16 Number of fields of the DataSet contained in the DataSetMessage . DataSetFields BaseDataType [FieldCount] The field values of the ActionRequest DataSet. The fields
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.5.10 Action response message

Action execution is defined in 6.2.11.2 . FieldCount Uint16 Number of fields of the DataSet contained in the DataSetMessage . DataSetFields BaseDataType [FieldCount] The field values of the ActionResponse DataSet. The fields
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.5.11 RawData field encoding

encoding of the DataSetMessage fields is handled like a Structure DataType where the DataSet fields are handled like Structure fields and fields with Structure DataType are handled like nested structures ... encoding of Structure DataTypes also apply to the RawData Field Encoding . A DataSet field is encoded in the DataType and ValueRank specified in the DataSetMetaData for the DataSet . The following
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.6.4 DataSetMetaData

DataSetMetaData The encoding of the DataSet metadata message structure is specified in Table 170 . It contains the current layout and DataSetMetaData for the DataSet . The ConfigurationVersion in the DataSetMessage header ... send this message without a corresponding discovery probe if the DataSetMetaData changed for the DataSet . Table 170 - DataSetMetaData announcement message structure Name Type Description DataSetWriterId UInt16 DataSetWriterId of the DataSet
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.6.9 DataSetWriter configuration announcement message

contains the current configuration of the WriterGroup and the DataSetWriter for the DataSet . The Publisher shall send this message without a corresponding discovery probe if the configuration of the WriterGroup ... encoded as Int32 value. DataSetWriterConfig WriterGroupDataType The current WriterGroup and DataSetWriter settings for the DataSet related to the DataSetWriterId . The WriterGroupDataType is defined in 6.2.6.7 . The field DataSetWriters
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.3 NetworkMessage containing DataSetMessages

JSON object containing the set of name/value pairs defined for a single DataSet . If the JSON encoded NetworkMessage size exceeds the Broker limits the message is dropped and a PubSubTransportLimitsExceeded
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.4.1 Message content

event based DataSetMessage contains name and value for all fields of the DataSet . A delta frame DataSetMessage contains only name and value for the changed fields. DataSetWriter s may periodically ... Status StatusCode The overall status of the DataSetMessage. The dependencies to the status of DataSet fields are defined in Table 35 . The presence of the value depends on the setting
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.4.2 VerboseEncoding

VerboseEncoding is the payload of DataSetMessages . The VerboseEncoding and the following rules for DataSet field encoding ensure that Subscribers without OPC UA knowledge get messages without OPC UA specific information ... VerboseEncoding is the recommended default encoding for DataSetMessages. This specification defines a DataSet field encoding for the VerboseEncoding which simplifies the encoding of Variants and ExtensionObjects by omitting UaType
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.4.3 VerboseEncoding and abstract type handling

VerboseEncoding and abstract type handling By default, DataSet fields can only be decoded to the original DataType by inferring the schema from the JSON message or if the DataSetMetaData describing ... DataSet fields is available (i.e. from the DataSetMetaData messages). Additional information in the payload is required to fully reverse the payload to the original DataTypes for DataSet fields
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.5.1 General

exchange of additional information not contained in the DataSetMessages like Properties for the DataSet fields
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.5.2 DataSetMetaData

that shall appear in the Payload of a DataSetMessage. When the DataSetMetaData of a DataSet changes, the DataSetWriter may be configured to publish the updated value through the mechanism defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.3.4.8 Message header

only one DataSetMessage . The MQTT message header shall include additional promoted fields of the DataSet as a list of MQTT User Property name-value pairs. DataSet fields with the PromotedField ... header even if the DataSetMessage body is a delta frame and the DataSet field is not included in the delta frame. In this case the last known value is sent
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.1 General

published through one connection and one group and one DataSetReader used to subscribe one DataSet . Figure 44 depicts the information flow and the related ObjectTypes from the PubSub Information ... Variables or Events . An Event notification or a snapshot of the Variables comprises a DataSet . A DataSet is the content of a DataSetMessage created by a DataSetWriter . Examples of concrete
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.4.1 Overview

content of a DataSetMessage and the configuration of the information source for a DataSet . See 5.2 for the introduction to DataSets , 5.3 for the introduction to DataSetMessages ... parameters for sending of DataSetMessages . Figure 46 depicts the ObjectTypes of the published DataSet model and their components. Figure 46 - Published DataSet overview Instances of the DataSetFolderType are used
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.4.2.1 PublishedDataSetType

configurable DataSets . Derived types like PublishedDataItemsType and PublishedEventsType define how to collect the DataSet to be published. For PublishedDataItemsType this is a list of monitored Variables used to create cyclic ... defines the content and metadata of the PublishedDataSetType Object . If the content of the DataSet is defined by a product-specific configuration and the source of the DataSet
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.4.2.2 ExtensionFieldsType

allows the configuration of fields with values to be included in the DataSet in case the existing AddressSpace of the Publisher does not provide the necessary information. Table 248 - ExtensionFieldsType ... through the Methods AddExtensionField and RemoveExtensionField . An ExtensionField is not automatically included in the DataSet . The ExtensionField can be added to the DataSet after creation. Metadata that normally appear
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.4.3.2 AddVariables Method

VariablesToAdd, [out] ConfigurationVersionDataType NewConfigurationVersion, [out] StatusCode[] AddResults ); Argument Description ConfigurationVersion Configuration version of the DataSet . The configuration version shall match the entire current configuration version of the Object when ... configuration version did not match the current state of the object. Bad_NotWritable The DataSet is based on a DataSetClass and the size of the PublishedData array cannot be changed
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.4.3.3 RemoveVariables Method

VariablesToRemove, [out] ConfigurationVersionDataType NewConfigurationVersion, [out] StatusCode[] RemoveResults ); Argument Description ConfigurationVersion Configuration version of the DataSet . The configuration version and the indices passed through VariablesToRemove shall match the entire current configuration ... DataSetMetaData of the PublishedDataSetType . NewConfigurationVersion Returns the new configuration version of the DataSet . RemoveResults The result codes for each of the variables to remove. Method Result Codes ResultCode Description
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.4.4.1 PublishedEventsType

change of the Filter does not affect the ConfigurationVersion since the content of the DataSet does not change
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.4.4.2 ModifyFieldSelection Method

PromotedFields, [in] SimpleAttributeOperand[] SelectedFields [out] ConfigurationVersionDataType NewConfigurationVersion ); Argument Description ConfigurationVersion Configuration version of the DataSet . The configuration version shall match the entire current configuration version of the Object when ... part of the DataSetMetaData . SelectedFields The selection of Event fields contained in the DataSet generated for an Event and sent through the DataSetWriter . The SimpleAttributeOperand DataType is defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.4.5.2 AddPublishedDataItems Method

settings in the VariablesToAdd are used to configure the data acquisition for the DataSet and are used to initialize the PublishedData Property of the PublishedDataItemsType . The DataSetMetaData of the PublishedDataSetType ... FieldMetaData that is part of the DataSetMetaData . The name shall be unique in the DataSet . FieldFlags The field flags assigned to the selected Variables for the fields in the DataSetMetaData
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.4.5.3 AddPublishedEvents Method

EventNotifier, SelectedFields and Filter are used to configure the data acquisition for the DataSet and are used to initialize the corresponding Properties of the PublishedEventsType . The DataSetMetaData of the PublishedDataSetType ... ContentFilter Filter, [out] ConfigurationVersionDataType ConfigurationVersion, [out] NodeId DataSetNodeId ); Argument Description Name Name of the DataSet Object to create. EventNotifier The NodeId of the Object in the event notifier tree
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.4.5.4 AddPublishedDataItemsTemplate Method

length of the array is dynamic, the Publisher shall insert this status in a DataSet if no data exists within the range. Bad_TooManyMonitoredItems The Server has reached its maximum
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.4.5.5 AddPublishedEventsTemplate Method

from which Events are collected. SelectedFields The selection of Event Fields contained in the DataSet generated for an Event and sent through the DataSetWriter . The size of the array shall ... current state of the Object does not allow a configuration change. Bad_NodeIdExists A DataSet Object with the name already exists. Bad_NodeIdUnknown The Event notifier node is not known
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.4.5.6 RemovePublishedDataSet Method

DataSetNodeId is unknown. Bad_NodeIdInvalid The DataSetNodeId is not a NodeId of a published DataSet . Bad_UserAccessDenied The Session user is not allowed to delete a PublishedDataSetType . Table 263 specifies
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.6.4 AddDataSetWriter Method (Deprecated)

name may be too long or may contain invalid characters. Bad_DataSetIdInvalid The DataSet specified for the DataSetWriter creation is invalid. Bad_BrowseNameDuplicated An Object with the name already exists
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.7.2 DataSetWriterType

Property shall be present for PublishedDataSets that provide cyclic updates of the DataSet . The DataSetWriterProperties is defined in 6.2.4.4 . The transport protocol mapping specific setting settings are provided
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.8.2 DataSetReaderType

Table 291 . The SubscribedDataSetType defined in 9.1.9.1 describes the processing of the received DataSet in a Subscriber . Table 291 - DataSetReaderType definition Attribute Value BrowseName DataSetReaderType IsAbstract False References Node Class ... PubSubDiagnosticsDataSetReaderType is defined in 9.1.11.12 . The SubscribedDataSet Object contains the metadata for the subscribed DataSet and the information for the processing of a DataSetMessage . The SubscribedDataSetType and the available subtypes
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.8.5 CreateTargetVariables Method

ConfigurationVersion, [in] FieldTargetDataType[] TargetVariablesToAdd, [out] StatusCode[] AddResults ); Argument Description ConfigurationVersion Configuration version of the DataSet . The configuration version passed through CreateTargetVariables shall match the current configuration version in DataSetMetaData Property ... ConfigurationVersionDataType is defined in 6.2.3.2.6 . TargetVariablesToAdd The list of target Variables to write received DataSet fields to. The FieldTargetDataType is defined in 6.2.10.2.3 . The succeeded targets are added
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.8.6 CreateDataSetMirror Method

used to set the SubscribedDataSet to SubscribedDataSetMirrorType used to represents the fields of the DataSet as Variables in the Subscriber Address Space . This Method creates an Object below the SubscribedDataSet ... DisplayName of the parent Node for the Variables representing the fields of the subscribed DataSet . RolePermissions Value of the RolePermissions Attribute to be set on the parent Node. This value
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.9.1 SubscribedDataSetType

SubscribedDataSetType This ObjectType defines the metadata for the subscribed DataSet and the information for the processing of DataSetMessages . See 5.4.2.2 for an introduction to the processing options for received DataSetMessages
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.9.2.1 TargetVariablesType

TargetVariablesType This ObjectType defines the metadata for the subscribed DataSet and the information for the processing of DataSetMessages . The TargetVariablesType is formally defined in Table 297 . Table 297 - TargetVariablesType definition
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.9.2.2 AddTargetVariables Method

ConfigurationVersion, [in] FieldTargetDataType[] TargetVariablesToAdd, [out] StatusCode[] AddResults ); Argument Description ConfigurationVersion Configuration version of the DataSet . The configuration version passed through AddDataConnections shall match the current configuration version in DataSetMetaData Property ... ConfigurationVersionDataType is defined in 6.2.3.2.6 . TargetVariablesToAdd The list of target Variables to write received DataSet fields to. The FieldTargetDataType is defined in 6.2.10.2.3 . The succeeded connections are added
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.9.2.3 RemoveTargetVariables Method

ConfigurationVersion, [in] UInt32[] TargetsToRemove, [out] StatusCode[] RemoveResults ); Argument Description ConfigurationVersion Configuration version of the DataSet . The configuration version passed through RemoveTargetVariables shall match the current configuration version in DataSetMetaData Property
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.9.3 SubscribedDataSetMirrorType

information for the processing of DataSetMessages as mirror Variables. For each field of the DataSet a mirror Variable is created in the Subscriber AddressSpace . The SubscribedDataSetMirrorType is formally defined ... SubscribedDataSet into the mirror mode. The mirror Object shall reference Variables for each DataSet field in the DataSetMetaData with HasComponent . The name, DataType , ValueRank and ArrayDimensions of the Variables shall
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.9.4.2 AddSubscribedDataSet Method

AddSubscribedDataSet Method This Method is used to add a new standalone subscribed DataSet Object to an instance of the DataSet Folder . The Client shall be authorized to modify the configuration ... Signature AddSubscribedDataSet ( [in] StandaloneSubscribedDataSetDataType SubscribedDataSet, [out] NodeId SubscribedDataSetNodeId ); Argument Description SubscribedDataSet The standalone subscribed DataSet to add. SubscribedDataSetNodeId The NodeId of the new standalone subscribed DataSet Object. Method Result Codes
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.9.4.3 RemoveSubscribedDataSet Method

RemoveSubscribedDataSet Method This Method is used to remove a standalone subscribed DataSet Object from a subscribed DataSet Folder . If a DataSetReader is connected, the DataSetReader is removed too. The Client ... Server . Signature RemoveSubscribedDataSet ( [in] NodeId SubscribedDataSetNodeId ); Argument Description SubscribedDataSetNodeId NodeId of the standalone subscribed DataSet to remove from the folder. Method Result Codes ResultCode Description Bad_NodeIdUnknown The SubscribedDataSetNodeId
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.9.5 StandaloneSubscribedDataSetType

StandaloneSubscribedDataSetType This ObjectType represents a Subscriber defined standalone DataSet . A standalone subscribed DataSet can exist without DataSetReader and is used to define a DataSet from the Subscriber side. A DataSetReader ... configured and connected to the standalone DataSet if a Publisher provides the DataSetMessages defined by the DataSetMetaData in the standalone DataSet . The StandaloneSubscribedDataSetType is formally defined in Table 306 . Table
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.11.11 PubSubDiagnosticsDataSetWriterType

Optional Info StatusCode Status of last DataSetMessage MajorVersion Optional Info UInt32 MajorVersion used for DataSet MinorVersion Optional Info UInt32 MinorVersion used for DataSet
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.1.2 Overview

WriterGroupId identify the WriterGroup . The NetworkMessageNumber is important for WriterGroups which distribute their DataSet s over more than one NetworkMessage , and the GroupVersion allows the Subscriber to verify the expected ... layout of the DataSetMessages and their DataSet fields
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.1.8 Example fixed message layout without security

sent has the same layout of header fields and also the same layout of DataSet fields. This allows a highly efficient encoding and decoding of the message because the offset ... that the size of each DataSetMessage is constant. This can be achieved by avoiding DataSet fields of types with variable size, or by using the parameter ConfiguredSize . In this example
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.1.9 Example fixed message layout with integrity

encryption) as defined in A.2.1.5 and A.2.1.7 . The layout of all header fields and DataSet fields is constant like described in A.2.1.8 . Additional to this the SecurityHeader is activated
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

B.3.7 Message header

QualifiedName is the ApplicationUri . The AMQP message header includes additional promoted fields of the DataSet as a list of name-value pairs. DataSet fields with the PromotedField flag ... header even if the DataSetMessage body is a delta frame and the DataSet field is not included in the delta frame. In this case the last known value is sent
OPC-10000-17 – OPC Unified Architecture - Part 17: Alias Names

A.2 AliasNames used within a single Server

standardized naming scheme. The model also includes a configuration for a PubSub DataSet (see OPC 10000-14 ) that provides the Variables defined in the well. The AliasName model includes
OPC-10000-17 – OPC Unified Architecture - Part 17: Alias Names

D.1.2 PubSub multicast messages

optional extension, the Server shall be configured to be a Publisher with a fixed DataSet message sent to a multicast address. The DataSet shall consist of a single instance that ... change in the size of the AliasNameCategory array. This Publisher shall provide a fixed DataSet with a pre-defined DataSetClassId . This Publisher shall generate messages as defined in D.3 . These
OPC-10000-17 – OPC Unified Architecture - Part 17: Alias Names

D.2.2 AliasUpdateDataType

D.2.2 AliasUpdateDataType This structure is used to define a DataSet. This DataSet is used to indicate a Server has had changes to one or more AliasNameCategories , where an AliasName
OPC-10000-18 – OPC Unified Architecture - Part 18: Role-Based Security

5.2.4 UserManagementDataType

This Structure DataType is used to provide the metadata for a field in a DataSet . The UserManagementDataType is formally defined in Table 26 . Table 26 - UserManagementDataType structure Name Type Description
OPC-10000-25 – OPC Unified Architecture - Part 25: Object Serialization

5.3 Semantic Property handling

part of data change Notifications . In PubSub scenarios, if the metadata of the subscribed DataSet changes, the Client receives a new ConfigurationVersion in the DataSetMetaData of the affected DataSet . Considering
OPC-10000-25 – OPC Unified Architecture - Part 25: Object Serialization

6.3.7 CustomMetaDataProperties Property

CustomMetaDataProperties Property DataSetMetaData describe the content and the semantics of a DataSet . Subscribers use this metadata to interpret the DataSet from the DataSetMessage and can evaluate the Properties field ... serialized in a PubSub scenario. If the SerializedData Variable is used in a published DataSet , the KeyValuePairs of the CustomMetaDataProperties Property shall be added to the Properties field
OPC-10000-25 – OPC Unified Architecture - Part 25: Object Serialization

A.5 Semantic Property Metadata in PubSub Scenarios

FieldMetaData structure (see OPC 10000-14 ) describing the SerializedData Variable if added to a DataSet . As shown in A.4 , the SerializationConfiguration excludes the metadata Properties attached to the EnergyMeasurementType Objects
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

5.5.6.2.5 DataSetMetaData

error scenario, PubSub provides the DataSetMetaData . DataSetMetaData describes the content and semantics of a DataSet . In addition, the DataSetMetaData provides the details defining the contract between the Publisher
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

5.7 AliasNames and OPC UA FX

AliasNames are most commonly used for configuration management, but can also be used for DataSet /topic discovery and many other uses. Figure 15 - AliasName model overview
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

6.2.4.2 EstablishConnections signature

CommunicationLinks does not match the ConnectionEndpoint . Bad_ConfigurationError The version of the DataSet related to the DataSetReader and/or DataSetWriter referenced by the CommunicationLinks does not match the expected version
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

6.2.7 PublisherCapabilitiesType

established to one or more of the FunctionalEntities whose variables are present in the DataSet . An empty array indicates that no preconfigured PublishedDataSets are defined by this instance. PreconfiguredDataSetOnly
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

6.2.8 SubscriberCapabilitiesType

established to one or more of the FunctionalEntities whose variables are present in the DataSet . An empty array indicates that no preconfigured StandaloneSubscribedDataSets are defined by this instance. PreconfiguredDataSetOnly
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

6.6.3 PubSubConnectionEndpointType definition

InputVariables are referenced, the referenced DataSetReader shall be associated with a null DataSet (heartbeat). If present, the ToDataSetWriter Reference (see 11.22 ) shall point to the DataSetWriter with which this ConnectionEndpoint ... OutputVariables are referenced, the referenced DataSetWriter shall be associated with a null DataSet to publish the heartbeat. The Status is determined based on the Status of the referenced DataSetReader
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

D.3.6.2 Using preconfigured DataSets

Figure D.21 , assumes that the module can only exchange data using a preconfigured DataSet containing all four channels. In this case, a possible Information Model would organise the Variables ... exchanged using the preconfigured PublishedDataSet . Figure D.21 - Sample for analogue input module - pre-configured DataSet only This has the consequence that a ConnectionEndpoint established on that FunctionalEntity can only
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

D.3.6.3 Using preconfigured and customised DataSets

DataSets The second variant assumes that the module can exchange data using a preconfigured DataSet containing all four channels, but also allows data to be exchanged using a customised DataSet ... data can be exchanged using the preconfigured PublishedDataSet , but in addition using a customised DataSet . A customised PublishedDataSet will be created during the establishment of a connection. Figure D.23 - Sample
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

E.4.7 PubSub DataSets

range of published messages. The UADP communication includes header information that describes the overall DataSet . It can include information like a timestamp and/or status information (see Figure E.17 ). Figure E.17 ... communication options selected. It is a fixed structure where all items defined in the DataSet have a value that is returned in every message. The message only contains the values