6 PubSub communication parameters ToC Previous Next

6.3 Message mapping configuration parameters ToC Previous Next

6.3.2 JSON message mapping ToC Previous Next

6.3.2.1 JSON NetworkMessage Writer ToC

6.3.2.1.1 NetworkMessageContentMask ToC

The parameter NetworkMessageContentMask defines the optional header fields to be 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 92.

Table 92 – 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 1    The JSON DataSetMessage header is included in each DataSetMessage.If this bit is false then the DataSetMessageContentMask for the DataSetWriters is ignored (see 6.3.2.3.1).
SingleDataSetMessage 2 Each JSON NetworkMessage contains only one DataSetMessage.
PublisherId 3 The PublisherId is included in the NetworkMessages.
DataSetClassId 4    The DataSetClassId is included in the NetworkMessages.The NetworkMessage can only contain DataSetMessages with the same DataSetClassId. If DataSetMessages have different DataSetClassIds they must be sent in individual NetworkMessages.
ReplyTo 5 Reserved.

The JsonNetworkMessageContentMask representation in the AddressSpace is defined in Table 93.

Table 93 – JsonNetworkMessageContentMask definition

Attribute Value        
BrowseName JsonNetworkMessageContentMask        
IsAbstract False        
References Node Class BrowseName DataType TypeDefinition Others
Subtype of UInt32 defined in OPC 10000-5          
HasProperty Variable OptionSetValues LocalizedText [] PropertyType  
Conformance Units          
PubSub Parameters JSON          

6.3.2.1.2 JsonWriterGroupMessageDataType structure ToC Model

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 in Table 94.

Table 94 – JsonWriterGroupMessageDataType structure

Name Type Description
JsonWriterGroupMessageDataType Structure Subtype of WriterGroupMessageDataType defined in 6.2.6.7.3.
   networkMessageContentMask JsonNetworkMessageContentMask Defined in 6.3.2.1.1.

Its representation in the AddressSpace is defined in Table 95.

Table 95 – JsonWriterGroupMessageDataType definition

Attributes Value
BrowseName JsonWriterGroupMessageDataType
IsAbstract False
Subtype of WriterGroupMessageDataType defined in 6.2.6.7.3.  
Conformance Units  
PubSub Parameters JSON  

6.3.2.2 JSON ReaderGroup Parameters ToC

There are no JSON specific message mapping parameters defined for the ReaderGroup.

6.3.2.3 JSON DataSetMessage Writer ToC

6.3.2.3.1 DataSetMessageContentMask ToC

The DataSetMessageContentMask defines the flags for the content of the DataSetMessage header. The JSON message mapping specific flags are defined by the JsonDataSetMessageContentMask DataType.

The JsonDataSetMessageContentMask DataType is formally defined in Table 96.

Table 96 – JsonDataSetMessageContentMask values

Value Bit No. Description
DataSetWriterId 0 If this flag is set, a DataSetWriterId shall be included in the DataSetMessage header.
MetaDataVersion 1 If this flag is set, the ConfigurationVersion is included in the DataSetMessage header.
SequenceNumber 2 If this flag is set, the DataSetMessageSequenceNumber is included in the DataSetMessage header.
Timestamp 3 If this flag is set, a timestamp shall be included in the DataSetMessage header.
Status 4 If this flag is set, an overall status is included in the DataSetMessage header.
MessageType 5 If this flag is set, the message type is included in the DataSetMessage header.
DataSetWriterName 6 If this flag is set, a DataSetWriterName shall be included in the DataSetMessage header.
ReversibleFieldEncoding 7 If this flag is set, the DataSetMessage fields are encoded in the reversible JSON encoding and in the non-reversible JSON encoding otherwise.

The JsonDataSetMessageContentMask representation in the AddressSpace is defined in Table 97.

Table 97 – JsonDataSetMessageContentMask definition

Attribute Value        
BrowseName JsonDataSetMessageContentMask        
IsAbstract False        
References Node Class BrowseName DataType TypeDefinition Others
Subtype of UInt32 defined in OPC 10000-5          
HasProperty Variable OptionSetValues LocalizedText [] PropertyType  
Conformance Units          
PubSub Parameters JSON          

6.3.2.3.2 JsonDataSetWriterMessageDataType structure ToC Model

This Structure DataType is used to represent JSON DataSetMessage mapping specific DataSetWriter parameters. It is a subtype of the DataSetWriterMessageDataType defined in 6.2.4.5.3.

The JsonDataSetWriterMessageDataType is formally defined in Table 98.

Table 98 – JsonDataSetWriterMessageDataType structure

Name Type Description
JsonDataSetWriterMessageDataType Structure Subtype of DataSetWriterMessageDataType defined in 6.2.4.5.3.
   dataSetMessageContentMask JsonDataSetMessageContentMask Defined in 6.3.2.3.1.

Its representation in the AddressSpace is defined in Table 99.

Table 99 – JsonDataSetWriterMessageDataType definition

Attributes Value
BrowseName JsonDataSetWriterMessageDataType
IsAbstract False
Subtype of DataSetWriterMessageDataType defined in 6.2.4.5.3.  
Conformance Units  
PubSub Parameters JSON  

6.3.2.4 JSON DataSetMessage Reader ToC Model

6.3.2.4.1 NetworkMessageContentMask ToC Model

The NetworkMessageContentMask with DataType JsonNetworkMessageContentMask indicates the optional header fields included in the received NetworkMessages. The JsonNetworkMessageContentMask DataType is defined in 6.3.2.1.1.

6.3.2.4.2 DataSetMessageContentMask ToC Model

The DataSetMessageContentMask with the DataType JsonDataSetMessageContentMask indicates the optional header fields included in the DataSetMessages.

The JsonDataSetMessageContentMask DataType is defined in 6.3.2.3.1.

6.3.2.4.3 JsonDataSetReaderMessageDataType structure ToC Model

This Structure DataType is used to represent JSON DataSetMessage mapping specific DataSetReader parameters. It is a subtype of the DataSetReaderMessageDataType defined in 6.2.9.13.3.

The JsonDataSetReaderMessageDataType is formally defined in Table 100.

Table 100 – JsonDataSetReaderMessageDataType structure

Name Type Description
JsonDataSetReaderMessageDataType Structure Subtype of DataSetReaderMessageDataType defined in 6.2.9.13.3.
   networkMessageContentMask JsonNetworkMessageContentMask Defined in 6.3.2.4.1.
   dataSetMessageContentMask JsonDataSetMessageContentMask Defined in 6.3.2.4.2.

Its representation in the AddressSpace is defined in Table 101.

Table 101 – JsonDataSetReaderMessageDataType definition

Attributes Value
BrowseName JsonDataSetReaderMessageDataType
IsAbstract False
Subtype of DataSetReaderMessageDataType defined in 6.2.9.13.3.  
Conformance Units  
PubSub Parameters JSON  

Previous Next