UA Part 14: PubSub - 6.2.10 SubscribedDataSet parameters

This Structure DataTypeis an abstract base type for SubscribedDataSetparameters. A SubscribedDataSetdefines the metadata for the subscribed DataSetand the information for the processing of DataSetMessages. See 5.4.2.2for an introduction to the processing options for received DataSetMessages.

The SubscribedDataSetDataTypeis formally defined in Table 55.

Table 55– SubscribedDataSetDataType structure

Name	Type	Description
SubscribedDataSetDataType	Structure

The SubscribedDataSetDataType Structurerepresentation in the AddressSpaceis defined in Table 56.

Table 56– SubscribedDataSetDataType definition

Attributes	Value
BrowseName	SubscribedDataSetDataType
IsAbstract	True
Subtype of Structure defined in OPC 10000-5.
Conformance Units
PubSub Parameters Discovery Extended

6.2.10.2 TargetVariables

6.2.10.2.1 General

The SubscribedDataSetoption TargetVariablesdefines a list of Variablemappings between received DataSetfields and target Variablesin the Subscriber AddressSpace. The FieldTargetDataTypeis defined in 6.2.10.2.3. Target Variablesshall only be used once within the same TargetVariableslist.

6.2.10.2.2 TargetVariablesDataType

This Structure DataTypeis used to represent TargetVariablesspecific parameters. It is a subtype of the SubscribedDataSetDataTypedefined in 6.2.10.1.

The TargetVariablesDataTypeis formally defined in Table 57.

Table 57– TargetVariablesDataType structure

Name	Type	Description
TargetVariablesDataType	Structure
TargetVariables	FieldTargetDataType[]	Defined in 6.2.10.2.3.

Its representation in the AddressSpace is defined in Table 58.

Table 58– TargetVariablesDataType definition

Attributes	Value
BrowseName	TargetVariablesDataType
IsAbstract	False
Subtype of SubscribedDataSetDataTypedefined in 6.2.10.1.
Conformance Units
PubSub Parameters SubscribedDataSet

6.2.10.2.3 FieldTargetDataType

This DataTypeis used to provide the metadata for the relation between a field in a DataSetMessageand a target Variablein a DataSetReader. The FieldTargetDataTypeis formally defined in Table 59.

Table 59– FieldTargetDataType structure

Name	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 range used to extract parts of an array out of the received data. It is used to identify a single element of an array, or a single range of indexes for arrays for the received DataSetfield. If a range of elements is specified, the values are returned as a composite. The first element is identified by index 0 (zero). The NumericRangetype is defined in OPC 10000-4. This parameter is null if the specified Attribute is not an array. However, if the specified Attribute is an array, and this parameter is null, then the complete array is used. The resulting data array size of this NumericRangeshall match the resulting data array size of the writeIndexRange NumericRangesetting. If the resulting array size is one and the target node ValueRankis scalar, the value shall be applied as scalar value.
TargetNodeId	NodeId	The NodeIdof the Variableto which the received DataSetMessagefield value is written.
AttributeId	IntegerId	Id of the Attributeto write e.g. the Value Attribute. This shall be a valid AttributeId. The Attributes are defined in OPC 10000-3. The IntegerId DataType is defined in OPC 10000-4. The IntegerIdsfor the Attributesare defined in OPC 10000-6.
WriteIndexRange	NumericRange	The index range used for writing received data to the target node. It is used to identify a single element of an array, or a single range of indexes for arrays for the write operation to the target Node. If a range of elements is specified, the values are written as a composite. The first element is identified by index 0 (zero). The NumericRangetype is defined in OPC 10000-4. This parameter is null if the specified Attributeis not an array. However, if the specified Attributeis an array, and this parameter is null, then the complete array is used.
OverrideValueHandling	OverrideValueHandling	The value is used to define the override value handling behaviour if the State of the DataSetReaderis not Operationalor if the corresponding field in the DataSetcontains a Bad StatusCode. The handling of the OverrideValuein different scenarios is defined in 6.2.11. The OverrideValueHandlingenumeration DataTypeis defined in 6.2.10.2.4.
OverrideValue	BaseDataType	This value is used if the OverrideValueHandling is set to OverrideValueand the State of the DataSetReaderis not Operationalor if the corresponding field in the DataSetcontains a Bad StatusCode. The handling of the OverrideValuein different scenarios is defined in 6.2.11. This Value shall match the DataTypeof the target Node. If a writeIndexRangeis configured, the Value shall match the resulting size of the writeIndexRange. For example if the writeIndexRangeis “5:7”, the overrideValue must be an array with length 3.

Its representation in the AddressSpace is defined in Table 60.

Table 60– FieldTargetDataType definition

Attributes	Value
BrowseName	FieldTargetDataType
IsAbstract	False
Subtype of Structure defined in OPC 10000-5.
Conformance Units
PubSub Parameters SubscribedDataSet

6.2.10.2.4 OverrideValueHandling

The OverrideValueHandlingis an enumeration that specifies the possible options for the handling of Override values. The possible enumeration values are described in Table 61.

Table 61– OverrideValueHandling values

Name	Value	Description
Disabled	0	The override value handling is disabled.
LastUsableValue	1	In the case of an error, the last usable value is used. If no last usable value is available, the default value for the data type is used.
OverrideValue	2	In the case of an error, the configured override value is used.

The OverrideValueHandlingrepresentation in the AddressSpaceis defined in Table 62.

Table 62– OverrideValueHandling definition

Attribute	Value
BrowseName	OverrideValueHandling
IsAbstract	False
References	Node Class	BrowseName	DataType	TypeDefinition	Others
Subtype of Enumeration defined in OPC 10000-5
HasProperty	Variable	EnumStrings	LocalizedText []	PropertyType
Conformance Units
PubSub Parameters SubscribedDataSet

6.2.10.3 SubscribedDataSetMirror

6.2.10.3.1 General

The SubscribedDataSetoption SubscribedDataSetMirrordefines an Objectin the Subscriber AddressSpacewith a mirror Variablefor each DataSetfield in the received DataSetMessages.

6.2.10.3.2 ParentNodeName

This parameter with DataType Stringdefines the BrowseNameand DisplayNameof the parent Nodefor the Variablesrepresenting the fields of the subscribed DataSet.

6.2.10.3.3 RolePermissions

This parameter with DataType RolePermissionTypedefines the value of the RolePermissionsAttribute to be set on the parent Node. This value is also used as RolePermissionsfor all Variablesof the DataSetmirror.

6.2.10.3.4 SubscribedDataSetMirrorDataType

This Structure DataTypeis used to represent SubscribedDataSetMirrorspecific parameters. It is a subtype of the SubscribedDataSetDataTypedefined in 6.2.10.1.

The SubscribedDataSetMirrorDataTypeis formally defined in Table 63.

Table 63– SubscribedDataSetMirrorDataType structure

Name	Type	Description
SubscribedDataSetMirrorDataType	Structure
ParentNodeName	String	Defined in 6.2.10.3.1.
RolePermissions	RolePermissionType[]	Defined in 6.2.10.3.3.

Its representation in the AddressSpace is defined in Table 64.

Table 64– SubscribedDataSetMirrorDataType definition

Attributes	Value
BrowseName	SubscribedDataSetMirrorDataType
IsAbstract	False
Subtype of SubscribedDataSetDataTypedefined in in 6.2.10.1.
Conformance Units
PubSub Parameters SubscribedDataSet Mirror

6.2.10.4 StandaloneSubscribedDataSetRefDataType

This Structure DataTypereferences a standalone subscribed DataSet. It is a subtype of the SubscribedDataSetDataTypedefined in 6.2.10.1.

The StandaloneSubscribedDataSetRefDataTypeis formally defined in Table 65.

Table 65– StandaloneSubscribedDataSetRefDataType structure

Name	Type	Description
StandaloneSubscribedDataSetRefDataType	Structure
DataSetName	String	The name of the corresponding standalone subscribed DataSet.

Its representation in the AddressSpace is defined in Table 66.

Table 66– StandaloneSubscribedDataSetRefDataType definition

Attributes	Value
BrowseName	StandaloneSubscribedDataSetRefDataType
IsAbstract	False
Subtype of SubscribedDataSetDataType defined in 6.2.10.1.
Conformance Units
PubSub Parameters SubscribedDataSet Standalone

6.2.10.5 StandaloneSubscribedDataSetDataType

This Structure DataTypeis define a standalone subscribed DataSet. It is a subtype of the SubscribedDataSetDataTypedefined in 6.2.10.1.

The StandaloneSubscribedDataSetDataTypeis formally defined in Table 67.

Table 67– StandaloneSubscribedDataSetDataType structure

Name	Type	Description	Allow Subtypes
StandaloneSubscribedDataSetDataType	Structure
Name	String	Name of the standalone SubscribedDataSet. It is recommended to use a human readable name. The name of the standalone SubscribedDataSetshall be unique in the Subscriber.
DataSetFolder	String[]	Optional path of the SubscribedDataSetfolder used to group SubscribedDataSetswhere each entry in the Stringarray represents one level in a folder hierarchy. If no grouping is needed the parameter is a null or empty Stringarray.
DataSetMetaData	DataSetMetaDataType	Defined in 6.2.9.4. A Publishermust be configured to send DataSetMessagesthat comply with the DataSetMetaDatain the standalone subscribed DataSet.
SubscribedDataSet	SubscribedDataSet‌DataType	The SubscribedDataSet specific parameters. The abstract base type and the concrete subtypes are defined in 6.2.10. The StandaloneSubscribedDataSetDataTypeand the StandaloneSubscribedDataSetRefDataTypesubtypes shall not be used in this structure field.	True

Its representation in the AddressSpace is defined in Table 68.

Table 68– StandaloneSubscribedDataSetDataType definition

Attributes	Value
BrowseName	StandaloneSubscribedDataSetDataType
IsAbstract	False
Subtype of SubscribedDataSetDataType defined in 6.2.10.1.
Conformance Units
PubSub Parameters SubscribedDataSet Standalone