9.1.4.5 DataSet Folder
9.1.4.5.1 DataSetFolderType
The DataSetFolderType is formally defined in Table 258.
| Attribute | Value | ||||
| BrowseName | DataSetFolderType | ||||
| IsAbstract | False | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| Subtype of FolderType defined in OPC 10000-5. | |||||
| Organizes | Object | <DataSetFolderName> | DataSetFolderType | OptionalPlaceholder | |
| HasComponent | Object | <PublishedDataSetName> | PublishedDataSetType | OptionalPlaceholder | |
| HasComponent | Method | AddPublishedDataItems | Defined in 9.1.4.5.2. | Optional | |
| HasComponent | Method | AddPublishedEvents | Defined in 9.1.4.5.3. | Optional | |
| HasComponent | Method | AddPublishedDataItemsTemplate | Defined in 9.1.4.5.4. | Optional | |
| HasComponent | Method | AddPublishedEventsTemplate | Defined in 9.1.4.5.5. | Optional | |
| HasComponent | Method | RemovePublishedDataSet | Defined in 9.1.4.5.6. | Optional | |
| HasComponent | Method | AddDataSetFolder | Defined in 9.1.4.5.7. | Optional | |
| HasComponent | Method | RemoveDataSetFolder | Defined in 9.1.4.5.8. | Optional | |
| Conformance Units | |||||
| PubSub Model Base | |||||
The DataSetFolderType ObjectType is a concrete type and can be used directly.
Instances of the DataSetFolderType can contain PublishedDataSets or other instances of the DataSetFolderType. This can be used to build a tree of Folder Objects used to group the configured PublishedDataSets.
The PublishedDataSetType Objects are added as components to the instance of the DataSetFolderType. An instance of a PublishedDataSetType is referenced only from one DataSetFolder. If the DataSetFolder is deleted, all referenced PublishedDataSetType Objects are deleted with the folder.
PublishedDataSetType Objects may be configured with product-specific configuration tools or added and removed through the Methods AddPublishedDataItems, AddPublishedEvents and RemovePublishedDataSet. The PublishedDataSetType is defined in 9.1.4.2.1.
9.1.4.5.2 AddPublishedDataItems Method
This Method is used to create a PublishedDataSets Object of type PublishedDataItemsType and to add it to the DataSetFolderType Object. The configuration parameters provided with this Method are further described in the PublishedDataItemsType defined in 9.1.4.3.1 and the PublishedDataSetType defined in 9.1.4.2.
The 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 is created from meta-data of the Variables referenced in VariablesToAdd and the settings in FieldNameAliases and FieldFlags.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
AddPublishedDataItems (
[in] String Name,
[in] String[] FieldNameAliases,
[in] DataSetFieldFlags[] FieldFlags,
[in] PublishedVariableDataType[] VariablesToAdd,
[out] NodeId DataSetNodeId,
[out] ConfigurationVersionDataType ConfigurationVersion,
[out] StatusCode[] AddResults
);
| Argument | Description |
| Name | Name of the Object to create. |
| FieldNameAliases | The names assigned to the selected Variables for the fields in the DataSetMetaData and in the DataSetMessages for tagged message encoding. The size and the order of the array shall match the VariablesToAdd. The string shall be used to set the name field in the 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. The size and the order of the array shall match the VariablesToAdd. The flag is used to set the corresponding field in the FieldMetaData that is part of the DataSetMetaData. |
| VariablesToAdd | Array of Variables to add to PublishedData and the related configuration settings. Successfully added variables are appended to the end of the list of published variables configured in the PublishedData Property. Failed variables are not added to the list. The PublishedVariableDataType is defined in 6.2.3.7.1. |
| DataSetNodeId | NodeId of the created PublishedDataSets Object. |
| ConfigurationVersion | Returns the initial configuration version of the DataSet. |
| AddResults | The result codes for the variables to add. Variables exceeding the maximum number of items in the Object are rejected with Bad_TooManyMonitoredItems. |
Method Result Codes
| ResultCode | Description |
| Bad_InvalidState | The current state of the Object does not allow a configuration change. |
| Bad_BrowseNameDuplicated | A data set Object with the name already exists. |
| Bad_UserAccessDenied | The Session user is not allowed to configure the Object. |
| Bad_InvalidArgument | The Server is not able to apply the Name. The Name may be too long or may contain invalid characters. |
Operation Result Codes
| ResultCode | Description |
| Bad_NodeIdInvalid | See OPC 10000-4 for the description of this result code. |
| Bad_NodeIdUnknown | See OPC 10000-4 for the description of this result code. |
| Bad_IndexRangeInvalid | See OPC 10000-4 for the description of this result code. |
| Bad_IndexRangeNoData | See OPC 10000-4 for the description of this result code. If the ArrayDimensions have a fixed length that cannot change and no data exists within the range of indexes specified, Bad_IndexRangeNoData is returned in AddVariables. Otherwise if the 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 number of items for the PublishedDataItemsType object. |
| Bad_DuplicateName | The passed field name alias already exists. |
Table 259 specifies the AddressSpace representation for the AddPublishedDataItems Method.
| Attribute | Value | ||||
| BrowseName | AddPublishedDataItems | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| HasProperty | Variable | OutputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model PublishedDataSet |
9.1.4.5.3 AddPublishedEvents Method
This Method is used to add a PublishedEventsType Object to the DataSetFolderType Object. The configuration parameters provided with this Method are further described in the PublishedEventsType defined in 9.1.4.4.1 and the PublishedDataSetType defined in 9.1.4.2.
The settings in the 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 is created from metadata of the selected Event fields and the settings in FieldNameAliases and FieldFlags.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
AddPublishedEvents (
[in] String Name,
[in] NodeId EventNotifier,
[in] String[] FieldNameAliases,
[in] DataSetFieldFlags[] FieldFlags,
[in] SimpleAttributeOperand[] SelectedFields,
[in] 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 of the OPC UA Server from which Events are collected. |
| FieldNameAliases | The names assigned to the selected fields in the DataSetMetaData and in the DataSetMessages for tagged message encoding. The size and the order of the array shall match the SelectedFields. The string is used to set the name field in the FieldMetaData that is part of the DataSetMetaData. |
| FieldFlags | The field flags assigned to the selected fields in the DataSetMetaData. The size and the order of the array shall match the SelectedFields. The flag is used to set the corresponding field in the FieldMetaData that is 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 in OPC 10000-4. |
| Filter | The filter applied to the Events. It allows the reduction of the DataSets generated from Events through a filter like filtering for a certain EventType. The ContentFilter DataType is defined in OPC 10000-4. |
| ConfigurationVersion | Returns the initial configuration version of the PublishedDataSets. |
| DataSetNodeId | NodeId of the created PublishedDataSets Object. |
Method Result Codes
| ResultCode | Description |
| Bad_InvalidState | The current state of the Object does not allow a configuration change. |
| Bad_NodeIdExists | A data set Object with the name already exists. |
| Bad_NodeIdUnknown | The Event notifier node is not known in the Server. |
| Bad_EventFilterInvalid | The Event filter is not valid. |
| Bad_UserAccessDenied | The Session user is not allowed to configure the Object. |
| Bad_InvalidArgument | The Server is not able to apply the Name. The Name may be too long or may contain invalid characters. |
Table 260 specifies the AddressSpace representation for the AddPublishedEvents Method.
| Attribute | Value | ||||
| BrowseName | AddPublishedEvents | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| HasProperty | Variable | OutputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model PublishedDataSet Events |
9.1.4.5.4 AddPublishedDataItemsTemplate Method
This Method is used to create a PublishedDataSets Object of type PublishedDataItemsType and to add it to the DataSetFolderType Object. The configuration parameters provided with this Method are further described in the PublishedDataItemsType defined in 9.1.4.3.1 and the PublishedDataSetType defined in 9.1.4.2.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
AddPublishedDataItemsTemplate (
[in] String Name,
[in] DataSetMetaDataType DataSetMetaData,
[in] PublishedVariableDataType[] VariablesToAdd,
[out] NodeId DataSetNodeId,
[out] StatusCode[] AddResults
);
| Argument | Description |
| Name | Name of the Object to create. |
| DataSetMetaData | The DataSetMetaData predefined by the caller. The initial setting shall not be changed by the Publisher. If the dataSetClassId of the DataSetMetaData is not null, the DataSetClassId Property of the PublishedDataSetType shall be created and initialized with the dataSetClassId value. The name of the PublishedDataSet Object is defined by the name in the DataSetMetaData. |
| VariablesToAdd | Array of variable settings for the data acquisition for the fields in the DataSetMetaData. The size of the array shall match the size of the fields array in the DataSetMetaData. The substituteValue in the VariablesToAdd entries shall be configured. For failed variables the publishedVariable field of entry in the resulting PublishedData Property shall be set to a null NodeId. If there is no Variable available for a field in the DataSetMetaData the publishedVariable field for the entry shall be set to a null NodeId. The PublishedVariableDataType is defined in 6.2.3.7.1. |
| DataSetNodeId | NodeId of the created PublishedDataSets Object. |
| AddResults | The result codes for the variables to add. |
Method Result Codes
| ResultCode | Description |
| Bad_InvalidState | The current state of the Object does not allow a configuration change. |
| Bad_BrowseNameDuplicated | A data set Object with the name already exists. |
| Bad_UserAccessDenied | The Session user is not allowed to configure the Object. |
| Bad_InvalidArgument | The VariablesToAdd parameter does not match the array size of the fields in the DataSetMetaData or the configuration of the VariablesToAdd contains invalid settings. |
| Bad_TooManyMonitoredItems | The Object cannot be created since the number of items in the PublishedDataSet exceeds the capabilities of the Publisher. |
Operation Result Codes
| ResultCode | Description |
| Bad_NodeIdInvalid | See OPC 10000-4 for the description of this result code. |
| Bad_NodeIdUnknown | See OPC 10000-4 for the description of this result code. |
| Bad_IndexRangeInvalid | See OPC 10000-4 for the description of this result code. |
| Bad_IndexRangeNoData | See OPC 10000-4 for the description of this result code. If the ArrayDimensions have a fixed length that cannot change and no data exists within the range of indexes specified, Bad_IndexRangeNoData is returned in AddVariables. Otherwise if the 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 number of items for the PublishedDataItemsType Object. |
| Bad_DuplicateName | The passed field name alias already exists. |
Table 261 specifies the AddressSpace representation for the AddPublishedDataItemsTemplate Method.
| Attribute | Value | ||||
| BrowseName | AddPublishedDataItemsTemplate | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| HasProperty | Variable | OutputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model PublishedDataSet |
9.1.4.5.5 AddPublishedEventsTemplate Method
This Method is used to add a PublishedEventsType Object to the DataSetFolderType Object. The configuration parameters provided with this Method are further described in the PublishedEventsType defined in 9.1.4.4.1 and the PublishedDataSetType defined in 9.1.4.2.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
AddPublishedEventsTemplate (
[in] String Name,
[in] DataSetMetaDataType DataSetMetaData,
[in] NodeId EventNotifier,
[in] SimpleAttributeOperand[] SelectedFields,
[in] ContentFilter Filter,
[out] NodeId DataSetNodeId
);
| Argument | Description |
| Name | Name of the Object to create. |
| DataSetMetaData | The DataSetMetaData predefined by the caller. The initial setting shall not be changed by the Publisher. If the dataSetClassId of the DataSetMetaData is not null, the DataSetClassId Property of the PublishedDataSetType shall be created and initialized with the dataSetClassId value. The name of the PublishedDataSet Object is defined by the name in the DataSetMetaData. |
| EventNotifier | The NodeId of the Object in the event notifier tree of the OPC UA Server 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 match the size of the fields array in the DataSetMetaData. If there is no Event field available for a field in the DataSetMetaData the browsePath field for the SimpleAttributeOperand entry shall be set to null. The SimpleAttributeOperand DataType is defined in OPC 10000-4. |
| Filter | The filter applied to the Events. It allows the reduction of the DataSets generated from Events through a filter like filtering for a certain EventType. The ContentFilter DataType is defined in OPC 10000-4. |
| DataSetNodeId | NodeId of the created PublishedDataSets Object. |
Method Result Codes
| ResultCode | Description |
| Bad_InvalidState | The 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 in the Server. |
| Bad_EventFilterInvalid | The Event filter is not valid. |
| Bad_UserAccessDenied | The Session user is not allowed to configure the Object. |
| Bad_InvalidArgument | The Server is not able to apply the Name. The Name may be too long or may contain invalid characters. |
Table 262 specifies the AddressSpace representation for the AddPublishedEventsTemplate Method.
| Attribute | Value | ||||
| BrowseName | AddPublishedEventsTemplate | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| HasProperty | Variable | OutputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model PublishedDataSet Events |
9.1.4.5.6 RemovePublishedDataSet Method
This Method is used to remove a PublishedDataSetType Object from the DataSetFolderType Object.
A successful removal of the PublishedDataSetType Object removes all associated DataSetWriter Objects. Before the Objects are removed, their state is changed to Disabled.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
RemovePublishedDataSet (
[in] NodeId DataSetNodeId
);
| Argument | Description |
| DataSetNodeId | NodeId of the PublishedDataSets Object to remove from the Server. The DataSetId is either returned by the AddPublishedDataItems or AddPublishedEvents Methods or can be discovered by browsing the list of configured PublishedDataSets in the PublishSubscribe Object. |
Method Result Codes
| ResultCode | Description |
| Bad_NodeIdUnknown | The 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 the AddressSpace representation for the RemovePublishedDataSet Method.
| Attribute | Value | ||||
| BrowseName | RemovePublishedDataSet | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model PublishedDataSet |
9.1.4.5.7 AddDataSetFolder Method
This Method is used to add a DataSetFolderType Object to a DataSetFolderType Object.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
AddDataSetFolder (
[in] String Name,
[out] NodeId DataSetFolderNodeId
);
| Argument | Description |
| Name | Name of the Object to create. |
| DataSetFolderNodeId | NodeId of the created DataSetFolderType Object. |
Method Result Codes
| ResultCode | Description |
| Bad_BrowseNameDuplicated | A folder Object with the name already exists. |
| Bad_InvalidArgument | The Server is not able to apply the Name. The Name may be too long or may contain invalid characters. |
| Bad_UserAccessDenied | The Session user is not allowed to add a folder. |
Table 264 specifies the AddressSpace representation for the AddDataSetFolder Method.
| Attribute | Value | ||||
| BrowseName | AddDataSetFolder | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| HasProperty | Variable | OutputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model PublishedDataSet |
9.1.4.5.8 RemoveDataSetFolder Method
This Method is used to remove a DataSetFolderType Object from the parent DataSetFolderType Object.
A successful removal of the DataSetFolderType Object removes all associated PublishedDataSetType Objects and their associated DataSetWriter Objects. Before the Objects are removed, their state is changed to Disabled.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
RemoveDataSetFolder (
[in] NodeId DataSetFolderNodeId
);
| Argument | Description |
| DataSetFolderNodeId | NodeId of the DataSetFolderType Object to remove from the Server. |
Method Result Codes
| ResultCode | Description |
| Bad_NodeIdUnknown | The DataSetFolderNodeId is unknown. |
| Bad_UserAccessDenied | The Session user is not allowed to delete a data set. |
Table 265 specifies the AddressSpace representation for the RemoveDataSetFolder Method.
| Attribute | Value | ||||
| BrowseName | RemoveDataSetFolder | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model PublishedDataSet |