Search

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

115 result(s) for NetworkMessage

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

2.1.22 NetworkMessage

NetworkMessage DataSetMessages and header to facilitate delivery, routing, security, and filtering Note 1 to entry: The Publisher hands off the NetworkMessage to the Message Oriented Middleware (transport layer) to deliver ... 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 at the head and tail
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 ... delivery by the Publisher . The Subscriber receives the DataSetMessage as the payload of a NetworkMessage from the Publisher with additional headers that may be supplied by the Message Oriented Middleware
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

3.1.4 DataSetReader

entry: A DataSetReader is the component that extracts a DataSetMessage from a NetworkMessage received from the Message Oriented Middleware and decodes the DataSetMessage to a DataSet for further processing
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

3.1.5 DataSetWriter

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

5.1 General

Message Oriented Middleware . The "messages" in Figure 2 represent NetworkMessages . Each NetworkMessage includes header information (e.g. identification and security data) and one or more DataSetMessages (the payload
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.2.1 General

DataSetMessage . One or more DataSetMessages are combined to form the payload of a NetworkMessage . Figure 3 illustrates the use of DataSets for publishing. Figure 3 - DataSet in the process
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.2.2 DataSetClass

shall be in the corresponding field of the DataSetMetaData . When all DataSetMessages of a NetworkMessage are created from DataSets that are instances of the same DataSetClass, the DataSetClassId of this ... class can be provided in the NetworkMessage header
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.2.3 DataSetMetaData

configuration Methods defined in the PubSub configuration model. The Subscriber receives the DataSetMetaData as NetworkMessage from the Publisher . This may require an option for the Subscriber to request this NetworkMessage ... between Publisher and Subscriber if the configuration changes. The DataSetMetaData is sent as a NetworkMessage from the Publisher to the Subscriber before DataSetMessages with changed content are sent. The used
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.3.1 General

mean the application data (the payload) supplied by the Publisher and the term NetworkMessage to mean the message handed off and received from a specific Message Oriented Middleware . DataSetMessages ... described in 7.3 . Subclauses 5.3.2 to 5.3.4 provide an abstract definition of DataSetMessage and NetworkMessage . The concrete structure depends on the message mapping and is described in 7.2 . DataSetMessages
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.3.3 DataSetMessage

contract defines the fields contained in the DataSetMessage . The header settings for DataSetMessage and NetworkMessage define the communication contract between Publisher and Subscriber . A heartbeat DataSetMessage is a key frame
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.3.4 NetworkMessage

NetworkMessage The NetworkMessage is a container for messages of different MessageTypes defined in 7.2 . A NetworkMessage can contain an array of DataSetMessages and includes information shared between DataSetMessages . This information ... encrypted. How and where the values for promoted fields are inserted depends on the NetworkMessage format and the used protocol. The NetworkMessage header is not encrypted to enable efficient filtering
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.3.7 SecurityGroup

used to encrypt and decrypt NetworkMessages and to generate and check signatures on a NetworkMessage . A Security Key Service (SKS) manages SecurityGroups and maintains a mapping between Roles and their
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.3.8 Topics

Topics A Topic is a string associated with a NetworkMessage that can be used to logically organize NetworkMessages published to a Message Oriented Middleware . Topics are most commonly used with
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.1.2 Message sending

DataSetMessage . DataSetMessages from DataSetWriters in one WriterGroup can be inserted into a single NetworkMessage . The creation of a DataSetMessage is guided by the following parameters: The DataSetFieldContentMask (see 6.2.4.2 ) controls ... values that match the configured propagated fields. Next is the creation of the NetworkMessage . It uses the data provided from the previous step together with the PublisherId (see 6.2.7.1 ) defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.2.1 General

prepared to receive messages that they do not understand or are irrelevant. Each NetworkMessage provides unencrypted data in the NetworkMessage header to support identifying and filtering of relevant Publishers, DataSetMessages ... DataSetClasses or other relevant message content (see 5.3 ). If a NetworkMessage is signed or signed and encrypted, the Subscriber will need the proper security keys (see 5.3.5 ) to verify
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.2.2 Message reception

using MQTT. Once subscribed, the Subscriber will start listening. The sequence starts when a NetworkMessage is received. The Subscriber may have configured filters (like a PublisherId, DataSetWriterId or a DataSetClassId ... that it can drop all messages that do not match the filter. Once a NetworkMessage has been accepted, it is decrypted and decoded. The security parameters are the same
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.3 Actions

response messages for UADP message mapping are definied in 7.2.4.5.9 and 7.2.4.5.10 . The Action NetworkMessage , request and response messages for JSON message mapping are defined in 7.2.5.6 . The MQTT Topic
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.6.1 General

Oriented Middleware as used in this document is any infrastructure supporting sending and receiving NetworkMessage s between distributed applications. OPC UA does not define a Message Oriented Middleware , rather
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.6.2.1 General

General With this option, OPC UA PubSub relies on the network infrastructure to deliver NetworkMessage s to one or more receivers. Network devices - like network routers, switches, or bridges
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.6.2.2 Broker-less model with OPC UA UDP

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 would use the values
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

5.4.6.3.1 General

other applications. All the communication is passed through the Broker . The Broker routes the NetworkMessage s to the right applications based on business criteria ("queue name", "routing ... Publisher and Subscriber lifetimes do not have to overlap. The Publisher application can push NetworkMessage s to the Broker and terminate. The NetworkMessage s will be available for the Subscriber
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.1 Overview

PublishedDataSet . A PublishedDataSet can have multiple DataSetWriters . WriterGroup parameters are necessary for creating a NetworkMessage . Each writer group can have one or more DataSetWriters . Some of these parameters are used ... grouped here since they are the same for all DataSetMessages in a single NetworkMessage . PubSubConnection parameters represent settings needed for the transport protocol. One connection can have a number
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.3.3 DataSetClassId

included in the DataSetMetaData . The NetworkMessageContentMask controls the availability of the DataSetClassId in the NetworkMessage
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.5.3 SecurityGroupId

SecurityGroup . The SecurityGroup defines the SecurityPolicy and the security keys used for the NetworkMessage security. The PubSubGroup defines the SecurityMode for the NetworkMessages sent by the group
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.5.5 MaxNetworkMessageSize

NetworkMessages created by the WriterGroup . It refers to the size of the complete NetworkMessage including padding and signature without any additional headers added by the transport protocol mapping ... size of a NetworkMessage exceeds the MaxNetworkMessageSize, the behaviour depends on the message mapping. The transport protocol mappings defined in 7.3 may define restrictions for the maximum value of this
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.6.2 PublishingInterval

PublishingInterval . All Events that occur between two PublishingIntervals shall be buffered until the next NetworkMessage is sent. If the number of Events exceeds the buffer capability of the DataSetWriter
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.6.7.1 WriterGroupDataType

defined for the transport mapping, the field shall be null. True MessageSettings WriterGroupMessageDataType NetworkMessage mapping specific WriterGroup parameters. The abstract base type is defined in 6.2.6.7.3 . The concrete subtypes
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.7.1 PublisherId

Publisher within a Message Oriented Middleware . It can be included in sent NetworkMessage for identification or filtering. The value of the PublisherId is typically shared between PubSubConnections but the assignment
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.8.1 General

symmetric to a WriterGroup and it is not related to a particular NetworkMessage . The NetworkMessage related filter settings are on the DataSetReaders
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.8.2.1 ReaderGroupDataType

defined for the transport mapping, the field shall be null. True MessageSettings ReaderGroupMessageDataType NetworkMessage mapping specific ReaderGroup parameters. The abstract base type is defined in 6.2.8.2.3 . The concrete subtypes
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.2.11.2.2 Action execution sequence

within the context of a RequestorId and CorrelationData . Each Action request in a single NetworkMessage has a different RequestId . Multiple NetworkMessages with the same RequestorId and CorrelationData may be sent ... Multiple Responses may be sent in the same NetworkMessage if the corresponding requests have the same RequestorId and CorrelationData . The grouping of requests in NetworkMessages does not affect the grouping
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.1.1 Relationship of Timing parameters

Timing parameters The PublishingInterval , the SamplingOffset the PublishingOffset and the timestamp in the NetworkMessage header shall use the same time base. If an underlying network provides a synchronized global clock
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.1.3 DataSetOrdering

value of their corresponding DataSetWriterIds and only one DataSetMessage is sent per NetworkMessage . If DataSetOrdering is Undefined any ordering between DataSets and their distribution into NetworkMessages is allowed. Ordering ... each PublishingInterval . If DataSetOrdering is set to AscendingWriterId, the Publisher shall fill up each NetworkMessage with DataSets with an ascending order of the related DataSetWriterIds as long as the accumulated
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.1.4 NetworkMessageContentMask

included in the NetworkMessages produced by the WriterGroup . The DataType for the UADP NetworkMessage mapping is UadpNetworkMessageContentMask . The DataType UadpNetworkMessageContentMask is formally defined in Table 97 . Table 97 - UadpNetworkMessageContentMask values ... Value Bit No. Description PublisherId 0 The PublisherId is included in the NetworkMessage s. GroupHeader 1 The GroupHeader is included in the NetworkMessages . WriterGroupId 2 The WriterGroupId field is included
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.1.5 SamplingOffset

DataType Duration defines the time in milliseconds for the offset of creating the NetworkMessage in the PublishingInterval cycle. Any negative value indicates that the optional parameter is not configured ... Publisher shall calculate the time before the PublishingOffset that is necessary to create the NetworkMessage in time for sending at the PublishingOffset . The Duration DataType is a subtype of Double
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.1.6 PublishingOffset

time in milliseconds for the offset in the PublishingInterval cycle of sending the NetworkMessage to the network. Any negative value indicates that the PublishingOffset is not configured and the timing ... multiple NetworkMessages If all DataSets of a group are transferred with a single NetworkMessage , the scalar value or the first value in the array defines the offset for sending
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.1.7 UadpWriterGroupMessageDataType structure

UadpWriterGroupMessageDataType structure This Structure DataType is used to represent the UADP NetworkMessage mapping specific WriterGroup parameters. It is a subtype of WriterGroupMessageDataType defined in 6.2.6.7.3 . The UadpWriterGroupMessageDataType is formally defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.3.1 General

General The configuration of the DataSetWriters in a WriterGroup can result in a fixed NetworkMessage layout where all DataSets have a static position between NetworkMessages . In this case the parameters ... NetworkMessageNumber and DataSetOffset provide information about the static position of the DataSetMessage in a NetworkMessage Subscribers can rely on. If the value of one of the two parameters
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.3.3 ConfiguredSize

DataType UInt16 defines the fixed size in bytes a DataSetMessage uses inside a NetworkMessage . The default value is 0 and it indicates a dynamic length. If a DataSetMessage would ... used for different reasons. One reason is the reservation of space inside a NetworkMessage by setting ConfiguredSize to a higher value than the assigned DataSet actually requires. Modifications (e.g. extensions
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.3.4 NetworkMessageNumber

NetworkMessageNumber The parameter NetworkMessageNumber with the DataType UInt16 is the number of the NetworkMessage inside a PublishingInterval in which this DataSetMessage is published. The default value is 0 and indicates ... that the number of the NetworkMessage is not fixed. The NetworkMessage shall have a fixed layout if the PayloadHeader flag in the NetworkMessageContentMask is false. If the NetworkMessage layout
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.3.5 DataSetOffset

parameter DataSetOffset with the DataType UInt16 is the offset in bytes inside a NetworkMessage at which the DataSetMessage is located, relative to the beginning of the NetworkMessage . The default value ... indicates that the position of the DataSetMessage in a NetworkMessage is not fixed. If the DataSetWriter is disabled and the DataSetOffset is not 0, the valid flag of the DataSetFlags1
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.4.1 GroupVersion

VersionTime defines the expected value in the field GroupVersion in the header of the NetworkMessage . The default value 0 is defined as null value, and means this parameter shall
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.4.2 NetworkMessageNumber

NetworkMessageNumber The parameter NetworkMessageNumber with DataType UInt16 is the number of the NetworkMessage inside a PublishingInterval in which this DataSetMessage is published. The default value 0 is defined as null ... value, and means this parameter shall be ignored. The NetworkMessage shall have a fixed layout if the PayloadHeader flag in the NetworkMessageContentMask is false
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.4.3 DataSetOffset

with DataType UInt16 defines the offset in bytes for the DataSetMessage inside the corresponding NetworkMessage relative to the beginning of the NetworkMessage . The default value 0 is defined as null ... value, and means that the position of the DataSetMessage in a NetworkMessage is not fixed. This parameter should be set if the PayloadHeader flag in the NetworkMessageContentMask is false
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.1.4.8 ReceiveOffset

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

6.3.2.1.1 NetworkMessageContentMask

included in the NetworkMessages produced by the WriterGroup . The DataType for the JSON NetworkMessage mapping is JsonNetworkMessageContentMask . The DataType JsonNetworkMessageContentMask is formally defined in Table 107 . Table 107 - JsonNetworkMessageContentMask values ... Value Bit No. Description NetworkMessageHeader 0 The JSON NetworkMessage header is included in the NetworkMessages . If this bit is false, bits 3 and 4 shall be 0. DataSetMessageHeader
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.2.1.2 JsonWriterGroupMessageDataType structure

JsonWriterGroupMessageDataType structure This Structure DataType is used to represent the JSON NetworkMessage mapping specific WriterGroup parameters. It is a subtype of WriterGroupMessageDataType defined in 6.2.6.7.3 . The JsonWriterGroupMessageDataType is formally defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.3.2.3.1 DataSetMessageContentMask

included in the DataSetMessage s. If the WriterGroup name is included in the NetworkMessage header, it shall not be included in the DataSetMessage s. MinorVersion 10 If this flag
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.4.1.2.4 DiscoveryMaxMessageSize

bytes for NetworkMessages created for discovery. It refers to the size of the complete NetworkMessage including padding and signature without any additional headers added by the transport protocol mapping ... size of a NetworkMessage exceeds the DiscoveryMaxMessageSize, the behaviour depends on the message mapping. The default value is 0 and defines that the default size for the transport protocol
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.4.1.3.1 MessageRepeatCount

MessageRepeatCount The MessageRepeatCount with DataType Byte defines how many times every NetworkMessage is repeated. The default value is 0 and disables the repeating
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

6.4.1.3.2 MessageRepeatDelay

MessageRepeatDelay The MessageRepeatDelay with DataType Duration defines the time between NetworkMessage repeats in milliseconds. The parameter shall be ignored if the parameter MessageRepeatCount
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.1 General

mappings and transport protocol mappings that can be used to implement them. DataSetMessage mappings, NetworkMessage mappings and transport protocol mappings are combined together to create transport profiles defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.2 MessageTypes

structure of each supported MessageType . The mechanism for identifying the MessageType associated with a NetworkMessage is specific to the message mapping. The mapping to UADP messages is defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.2 MessageType mapping

MessageType mapping The mapping of MessageTypes to UADP NetworkMessage type and the reference to the detailed definition is listed in Table 153 . Table 153 - UADP MessageType mapping MessageType UADP NetworkMessage
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.4.1 General

General The UADP NetworkMessage header and other parts of the NetworkMessage are shown in Figure 32 . When using security, the payload and the Padding field are encrypted and after that ... whole NetworkMessage is signed if signing and encryption is active. The NetworkMessage shall be signed without being encrypted if only the signing is active. The UADP NetworkMessage does not provide
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.4.2 NetworkMessage layout

NetworkMessage layout The encoding of the UADP NetworkMessage is specified in Table 154 . The NetworkMessageContentMask setting of the Publisher controls the flags in the fields UADPFlags and ExtendedFlags1 . The SecurityMode ... shall not change until the configuration of the Publisher is changed. Table 154 - UADP NetworkMessage Name Type Description UADPVersion Bit[0-3] Bit range 0-3: Version of the UADP
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.4.3.1 General

General The security algorithms used and the length of the KeyNonce for the UADP NetworkMessage depend on the selected SecurityPolicy . The algorithms are defined by SymmetricEncryptionAlgorithm and SymmetricSignatureAlgorithm
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.4.3.2 AES-CTR

Byte [8] The first 8 bytes of the Nonce in the SecurityHeader of the NetworkMessage . For AES-CTR mode the length of the SecurityHeader Nonce shall be 8 Bytes. BlockCounter ... Byte [4] The counter for each encrypted block of the NetworkMessage. The counter is a 32-bit big endian integer (the opposite of the normal encoding for UInt32 values
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.4.4 UADP Chunk NetworkMessage

UADP Chunk NetworkMessage If a NetworkMessage payload with a DataSetMessage need to be split across multiple NetworkMessages, the chunks are sent in multiple NetworkMessages . The PayloadHeader of each NetworkMessage contains ... payload header defined in Table 158 . The Payload of each NetworkMessage contains the payload defined in Table 159 . A chunk NetworkMessage can only contain chunked payload of one DataSetMessage
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
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.5.2 DataSet payload header

DataSet payload header Name Type Description Count Byte Number of DataSetMessages contained in the NetworkMessage . The NetworkMessage shall contain at least one DataSetMessage if the NetworkMessage type is DataSetMessage payload ... DataSetWriterIds UInt16 [Count] List of DataSetWriterIds contained in the NetworkMessage . The size of the list is defined by the Count . The DataSetWriterId identifies the PublishedDataSet and the DataSetWriter responsible
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.5.3 DataSet payload

UADPFlags is false. DataSetMessages DataSetMessage [Count] DataSetMessages contained in the NetworkMessage . The size of the list is defined by the Count in the DataSet payload header. The type of encoding
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.5.4 DataSetMessage header

DataSetMessage header The DataSetMessage header structure and the relation to other parts in a NetworkMessage is shown in Figure 34 . Figure 34 - DataSetMessage header structure The encoding of the DataSetMessage
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.6.3 Discovery announcement header

Discovery announcement header The NetworkMessage flags used with the discovery announcement messages shall use the following bit values. UADPFlags bits 5 and 6 shall be false, bits ... shall be true ExtendedFlags2 bit 1 shall be false and the NetworkMessage type shall be discovery announcement The setting of the flags ensures a known value for the first three
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.6.12.1 General

General The NetworkMessage flags used with the discovery probe messages shall use the following bit values. UADPFlags bits 5 and 6 shall be false, bits 4 and 7 shall ... ensures a known value for the first three bytes plus the PublisherId in the NetworkMessage on the Publisher as receiver. The actual security settings for the NetworkMessage are indicated
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.4.6.12.4 Publisher information probe message

elements encoded as Int32 value. For DataSetMetaData probes, the Publisher sends one discovery announcement NetworkMessage for each requested DataSetWriterId . For DataSetWriter configuration probes, the DataSetWriters that belong to one WriterGroup
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.2 MessageType mapping

MessageType mapping The mapping of MessageTypes to JSON NetworkMessage MessageTypes and the reference to the detailed definition is listed in Table 183 . Table 183 - JSON NetworkMessage MessageType mapping MessageType JSON ... NetworkMessage MessageType Specification Reference DataSetMessage ua-data Defined in 7.2.5.3 and 7.2.5.4 . DataSetMetaData ua-metadata Defined in 7.2.5.5.2 . ApplicationDescription ua-application Defined in 7.2.5.5.3 . ServerEndpoints ua-endpoints Defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.3 NetworkMessage containing DataSetMessages

NetworkMessage containing DataSetMessages Each JSON NetworkMessage can contain one or more JSON DataSetMessages . The JSON NetworkMessage is a JSON object with the fields defined in Table 184 . Table 184 - JSON ... NetworkMessage definition Name Type Description MessageId String A globally unique identifier for the message. The unique identifier can be created by converting a Guid to a String or through another
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.4.1 Message content

converted to a String without leading zeros. The value shall be omitted if the NetworkMessage header is present. WriterGroupName String The name of the WriterGroup which created the DataSetMessage ... JsonDataSetMessageContentMask . The value shall be omitted if the WriterGroupName is contained in the NetworkMessage header. SequenceNumber UInt32 Sequence number for each new DataSetMessage as defined in 7.2.3 . The presence
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.5.2 DataSetMetaData

fields in a DataSetMessage are used to correlate a DataSetMessage with a DataSetMetaData. A NetworkMessage with MessageType DataSetMetaData is a JSON object with the fields defined in Table 188 . Table ... scope of a Publisher . WriterGroupName String The name of the WriterGroup which created the NetworkMessage . This value is mandatory. DataSetWriterName String The name of the DataSetWriter. This value is mandatory
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.5.3 ApplicationDescription

ApplicationDescription A NetworkMessage with MessageType ApplicationDescription is a JSON object with the fields defined in Table 189 . All fields are encoded using CompactEncoding OPC UA JSON Data Encoding defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.5.4 ServerEndpoints

ServerEndpoints A NetworkMessage with MessageType ServerEndpoints is a JSON object with the fields defined in Table 190 . All fields are encoded using CompactEncoding OPC UA JSON Data Encoding defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.5.5 Status

Status A NetworkMessage with MessageType Status is a JSON object with the fields defined in Table 191 . Table 191 - JSON Status definition Name Type Description MessageId String A globally unique
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.5.6 PubSubConnection

PubSubConnection A NetworkMessage with MessageType PubSubConnection is a JSON object with the fields defined in Table 192 . All fields are encoded using CompactEncoding OPC UA JSON Data Encoding defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.5.7 ActionMetaData

ActionMetaData A NetworkMessage with MessageType ActionMetaData is a JSON object with the fields defined in Table 193 . All fields are encoded using CompactEncoding OPC UA JSON Data Encoding defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.5.8 ActionResponder

ActionResponder A NetworkMessage with MessageType ActionResponder is a JSON object with the fields defined in Table 193 . All fields are encoded using CompactEncoding OPC UA JSON Data Encoding defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.6.1 Action NetworkMessage

Action NetworkMessage Each JSON Action NetworkMessage can contain one or more JSON Request or Response messages. A JSON Action NetworkMessage is a JSON object with the fields defined in Table ... JSON Data Encoding defined in OPC 10000-6 . Table 195 - JSON Action NetworkMessage definition Name Type Description MessageId String A globally unique identifier for the message. This value is mandatory
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.6.2 ActionRequest

ActionRequest A NetworkMessage with MessageType "ua-action-request" contains a JSON array with ActionRequest messages. A ActionRequest message is a JSON object with the fields defined in Table ... JsonDataSetMessageContentMask . The value shall be omitted if the WriterGroupName is contained in the NetworkMessage header. MetaDataVersion ConfigurationVersionDataType The version of the ActionMetaData Request which describes the contents of the Payload
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.2.5.6.3 ActionResponse

ActionResponse A NetworkMessage with MessageType "ua-action-response" contains a JSON array with ActionResponse messages. An ActionResponse message is a JSON object with the fields defined in Table ... JsonDataSetMessageContentMask . The value shall be omitted if the WriterGroupName is contained in the NetworkMessage header. MetaDataVersion ConfigurationVersionDataType The version of the ActionMetaData Response which describes the contents of the Payload
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.3.2.1 General

additional headers to a MTU size. The number of frames used for a UADP NetworkMessage influences the probability that UADP NetworkMessages get lost. Note: The MaxNetworkMessageSize that fits into ... plus additional headers shall be limited to 65535 Byte. The transport of a UADP NetworkMessage in a UDP packet is defined in Table 198 . Table 198 - UADP message transported over
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.3.3 OPC UA Ethernet

network interface and not of the address. The transport of a UADP NetworkMessage in an Ethernet II frame is defined in Table 200 . Table 200 - UADP message transported over Ethernet ... Name Description Frame Header The frame header with an EtherType of 0xB62C. UADP NetworkMessage The UADP NetworkMessage is sent as Ethernet payload. Frame Footer The frame footer
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.3.4.8 Message header

fields which are assumed to be a MQTT User Property and if the NetworkMessage contains only one DataSetMessage . The MQTT message header shall include additional promoted fields of the DataSet ... UADP message mapping the promoted fields are also included in the UADP NetworkMessage . Promoted fields shall always be included in the header even if the DataSetMessage body is a delta
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

7.3.4.9.2 UADP message mapping

mapping defined in 7.2.3 . It is expected that the software used to receive UADP NetworkMessage can process the body without needing to know how it was transported. If the encoded
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

8.3.2 GetSecurityKeys Method

keys are discarded for some reason. An unplanned key rotation is indicated in the NetworkMessage header before the next key is used to give the Subscriber some time to fetch
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.11.9 PubSubDiagnosticsWriterGroupType

from PubSubDiagnosticsType SentNetworkMessages Mandatory Basic Information Sent NetworkMessages FailedTransmissions Mandatory Basic Error Error on NetworkMessage transmission EncryptionErrors Optional Advanced Error Error on signing or encrypting NetworkMessage The Object LiveValues contains
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.11.10 PubSubDiagnosticsReaderGroupType

Mandatory Basic Information Received and processed NetworkMessages ReceivedInvalidNetwork‌Messages Optional Advanced Error Invalid format of NetworkMessage Header DecryptionErrors Optional Advanced Error Decryption or signature check errors The Object LiveValues contains
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.13.2 PubSubTransportLimitsExceedEventType

PubSubTransportLimitsExceedEventType This EventType indicates that a NetworkMessage could not be published because it exceeds the limits of transport. The PubSubTransportLimitsExceedEventType is formally defined in Table 334 . Table 334 - PubSubTransportLimitsExceedEventType definition ... PubSubStatusEventType . The Actual Property has the size in bytes of the actual NetworkMessage . The Maximum Property has the maximum size of NetworkMessages in bytes allowed by the transport
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.1.13.3 PubSubCommunicationFailureEventType

PubSubCommunicationFailureEventType This EventType indicates that a NetworkMessage could not be published because of a communication failure. The PubSubCommunicationFailureEventType is formally defined in Table 335 . Table 335 - PubSubCommunicationFailureEventType definition Attribute Value
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

9.2.1.2 UadpDataSetWriterMessageType

UADP The DataSetMessageContentMask is defined in 6.3.1.3.2 . The ConfiguredSize is defined in 6.3.1.3.2 . The NetworkMessage is defined in 6.3.1.3.4 . The DataSetOffset is defined
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.1.2 Overview

data layout in the published messages is static. This implies the following: Each NetworkMessage contains the same number of DataSetMessages The sequence of the DataSetMessages within a NetworkMessage ... verify that a received message matches the expected message layout. Fields of the NetworkMessage header and the GroupHeader will be used for this purpose. PublisherId and WriterGroupId identify the WriterGroup
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.1.4 Header layout for NetworkMessages

A.2.1.4 Header layout for NetworkMessages A UADP NetworkMessage header shall contain the following fields according to this header layout: Version / Flags ExtendedFlags1 PublisherId GroupFlags WriterGroupId GroupVersion NetworkMessageNumber SequenceNumber Additional restrictions ... datatype for the PublisherId shall be UInt16 or UInt64 The NetworkMessage header layout is shown in Figure A.1 . Figure A.1 - UADP NetworkMessage header layout Table A.1 shows the configuration
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.1.5 Header layout for NetworkMessages with integrity (signing)

layout defined in A.2.1.4 but with additional security level 'signing but no encryption'. The NetworkMessage header layout with signing is shown in Figure A.2 . Figure A.2 - UADP NetworkMessage header layout ... with integrity (signing) Table A.3 shows the configuration for the NetworkMessage header with signing. The table contains only the added or modified rows from Table A.1 . Table A.3 - UADP NetworkMessage
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.1.6 Header layout for NetworkMessages with integrity and confidentiality (signing and encryption)

header layout defined in A.2.1.4 but with additional security level 'signing and encryption'. The NetworkMessage header layout with signing is shown in Figure A.3 . Figure A.3 - UADP NetworkMessage header layout ... with integrity and confidentiality Table A.4 shows the configuration for the NetworkMessage header with signing and encryption. The table contains only the added or modified rows from Table A.1 . Table
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.1.8 Example fixed message layout without security

Example fixed message layout without security Figure A.5 shows an example for a UADP NetworkMessage with fixed layout as defined in A.2.1.3 and A.2.1.7 . The configuration ensures that every NetworkMessage ... future extension of DataSetMessage[0] without effect on the size of the complete NetworkMessage or the position of other DataSetMessages in this NetworkMessage . By setting-specific values for KeyFrameCount
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.1.9 Example fixed message layout with integrity

Example fixed message layout with integrity Figure A.6 shows an example for a UADP NetworkMessage with fixed layout and security activated (signing, no encryption) as defined in A.2.1.5 and A.2.1.7
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.2.2 Overview

A.2.2.2 Overview With the header layout described in this section, the NetworkMessage header only identifies the Publisher and the contained DataSetMessages . In contrast to the fixed layout, more header fields
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.2.4 Header layout for NetworkMessages

A.2.2.4 Header layout for NetworkMessages A UADP NetworkMessage header shall consist of the following fields according to this header layout: Version / Flags ExtendedFlags1 PublisherId PayloadHeader Additional restrictions: The datatype ... using the local MAC address (48 bit) as part of the PublisherId . The NetworkMessage header layout is shown in Figure A.7 . Figure A.7 - UADP NetworkMessage header layout Table A.7 shows
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.2.5 Header layout for NetworkMessages with integrity (signing)

layout defined in A.2.2.4 but with additional security level 'Signing but no encryption'. The NetworkMessage header layout with signing is shown in Figure A.8 . Figure A.8 - UADP NetworkMessage header layout ... with integrity (signing) Table A.9 shows the configuration for the NetworkMessage header with signing. The table contains only the added or modified rows from Table A.7 . Table A.9 - UADP NetworkMessage
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.2.6 Header layout for NetworkMessages with integrity and confidentiality (signing and encryption)

header layout defined in A.2.2.4 but with additional security level 'Signing and encryption'. The NetworkMessage header layout with signing and encryption is shown in Figure A.9 . Figure A.9 - UADP NetworkMessage ... header layout with integrity and confident Table A.10 shows the configuration for the NetworkMessage header with signing and encryption. The table contains only the added or modified rows from Table
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.2.2.8 Example dynamic message layout with different DataSetMessage types

message layout with different DataSetMessage types Figure A.11 shows an example for a UADP NetworkMessage with dynamic layout. As defined in A.2.2.3 and A.2.2.7 only the layout of the NetworkMessage ... number, the type, the length, and the order of DataSetMessages can vary from one NetworkMessage to the next. Figure A.11 - Example for dynamic message layout without security
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.3.2.2 Overview

A.3.2.2 Overview A minimal message has the following settings: Each NetworkMessage contains one DataSetMessage The NetworkMessage header is not included The DataSetMessage header is not included The DataSet field encoding
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.3.3.2 Overview

A.3.3.2 Overview A single DataSet message has the following settings: Each NetworkMessage contains one DataSetMessage The NetworkMessage header is not included The DataSetMessage header is included, the header fields
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

A.3.4.2 Overview

A.3.4.2 Overview A minimal message has the following settings: Each NetworkMessage contains an array of DataSetMessages The NetworkMessage header is included, the header fields can be configured The DataSetMessage header
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

B.2.5.2 UADP message mapping

mapping defined in 7.2.3 . It is expected that the software used to receive UADP NetworkMessage can process the body without needing to know how it was transported. When sending such
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

B.3.1 General

exceed the Broker limits depends on the MessageMapping . For MessageMappings that support chunking, the NetworkMessage is broken into multiple chunks. The chunk size plus the AMQP header should not exceed
OPC-10000-14 – OPC Unified Architecture - Part 14: PubSub

B.3.7 Message header

value of "ua-data" specifies the body contains a UADP or JSON NetworkMessage . A value of "ua-metadata" specifies a body that contains a UA Binary
OPC-10000-17 – OPC Unified Architecture - Part 17: Alias Names

D.3.2 Header layout for NetworkMessages

D.3.2 Header layout for NetworkMessages A UADP NetworkMessage header shall consist of the following fields according to this header layout: Version / Flags ExtendedFlags1 PublisherId DataSetClassId Additional restrictions: The datatype ... using the local MAC address (48 Bit) as part of the PublisherId . The NetworkMessage header layout is shown in Figure D.2 . Figure D.2 - UADP NetworkMessage header layout Table D.5 shows
OPC-10000-17 – OPC Unified Architecture - Part 17: Alias Names

D.3.3 Header layout for NetworkMessages with integrity (signing)

layout defined in D.3.2 but with additional security level 'Signing but no encryption'. The NetworkMessage header layout with signing is shown in Figure D.3 Figure D.3 - UADP NetworkMessage header layout ... with integrity (signing) Table D.6 shows the configuration for the NetworkMessage header with signing. The table contains only the added or modified rows from Table D.5 . Table D.6 - UADP NetworkMessage
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

5.5.6.2.3 Multiple Connections using unicast network messages

using unicast NetworkMessages . This use case is called aggregated because a single NetworkMessage aggregates multiple DataSetMessages (one per logical connection). Aggregation reduces the required network bandwidth
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

5.5.6.2.4 Multiple Connections using multicast network messages

bandwidth usage in specific topologies, AC_A can aggregate published data into a single NetworkMessage , which is sent via multicast to the associated AutomationComponents ... turn, AC_B and AC_C publish an individual NetworkMessage back to AC_A. Multicast can also help with scaling issues in the device (less processing of network messages
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

5.5.6.2.5 DataSetMetaData

combining the ConfigurationVersions of all Publishers belonging to a WriterGroup is transmitted with the NetworkMessage . Any mismatch between the transmitted version and the one configured at the Subscriber will cause
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

C.3 Usage of OPC UA safety Variables in Connections

output Variables, including the data related to the SafetyProvider and SafetyConsumer, share the same NetworkMessage . Figure C.4 - Example of a logical connection with bidirectional safety data exchange
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

E.1.3.2 Multiple logical connections - two AutomationComponents

between two AutomationComponents . Often, traffic between two AutomationComponents will be optimized to use one NetworkMessage . EndpointA1 and EndpointA2 share PubSubCommunicationFlowConfiguration Flow1 with a ToOutboundFlow Reference and share SubscriberConfiguration SubA with ... ToInboundFlow Reference to ensure the same set of parameters for the outbound and inbound NetworkMessage . The same applies to EndpointB1 and EndpointB2. A variant of this scenario is illustrated
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

E.5 Interaction with an SKS

known. The pull can be triggered on the Subscriber by the reception of a NetworkMessage using a new key from the Publisher . The Subscriber keeps a certain number of future
OPC-10000-81 – OPC Unified Architecture - Part 81: UAFX Connecting Devices and Information Model

E.6.2 ConnectionConfigurationSet and WriterGroup

WriterGroup As defined in OPC 10000-14 , a WriterGroup defines the Publisher of a NetworkMessage . It is recommended that the PubSubConfiguration contains a WriterGroup for each instance of PubSubCommunicationFlowConfigurationType