Published Action defines the signature of an Action as a combination of ActionRequest and ActionResponse messages and a list of targets with an optional mapping to OPC UA Methods.
The Action targets, ActionRequest and ActionResponse information is the input to the ActionMetaData.
The parameter RequestDataSetMetaData defines the content of the ActionRequest.
The DataSetMetaData parameter of the PublishedDataSet defines the content of the ActionResponse.
The parameter ActionTargets provides a list of Action targets with the same signatures that can be executed based on the published Action definition.
The parameter RequestDataSetMetaData defines the payload of ActionRequest messages.
The payload of the ActionResponse messages is defined by the DataSetMetaData parameter of the PublishedDataSetDataType. The fields Name and ConfigurationVersion of the DataSetMetaData and the RequestDataSetMetaData in one PublishedDataSet shall be identical.
The parameter ActionTargets defines the list of Action targets that can be invoked with the signature defined by the ActionMetaData.
The DataType ActionTargetDataType represents the configuration information for one Action target. The ActionTargetDataType is formally defined in Table 24.
Table 24 – ActionTargetDataType structure
|
Name |
Type |
Description |
|
ActionTargetDataType |
Structure |
|
|
ActionTargetId |
UInt16 |
The numeric identifier assigned to the Action target which is unique within one ActionMetaData. It is used to address the Action target in combination with the PublisherId and the DataSetWriterId. |
|
Name |
String |
Name of the Action target. |
|
Description |
LocalizedText |
Description of the Action target. The default value is a null or empty LocalizedText. |
Its representation in the AddressSpace is defined in Table 25.
Table 25 – ActionTargetDataType definition
|
Attributes |
Value |
|
BrowseName |
ActionTargetDataType |
|
IsAbstract |
False |
|
Subtype of Structure defined in OPC 10000-5. |
|
|
Conformance Units |
|
|
PubSub Parameters PublishedDataSet Action |
|
This Structure DataType is used to represent PublishedAction specific parameters. It is a subtype of the PublishedDataSetSourceDataType defined in 6.2.3.6.
The PublishedActionDataType is formally defined in Table 26.
Table 26 – PublishedActionDataType structure
|
Name |
Type |
Description |
|
PublishedActionDataType |
Structure |
Subtype of PublishedDataSetSourceDataType defined in 6.2.3.6. |
|
RequestDataSetMetaData |
DataSetMetaDataType |
Defined in 6.2.3.10.2. |
|
ActionTargets |
ActionTargetDataType[] |
Defined in 6.2.3.10.3. |
Its representation in the AddressSpace is defined in Table 27.
Table 27 – PublishedActionDataType definition
|
Attributes |
Value |
|
BrowseName |
PublishedActionDataType |
|
IsAbstract |
False |
|
Subtype of PublishedDataSetSourceDataType defined in 6.2.3.6. |
|
|
Conformance Units |
|
|
PubSub Parameters PublishedDataSet Action |
|
The parameter ActionMethods defines a list of Object and Method pairs as source for the Action defined in the parameter ActionMethods.
The DataType ActionMethodDataType represents the configuration information for one Object and Method pair. The ActionMethodDataType is formally defined in Table 28.
Table 28 – ActionMethodDataType structure
|
Name |
Type |
Description |
|
ActionMethodDataType |
Structure |
|
|
ObjectId |
NodeId |
The NodeId shall be that of the Object on which the Method is invoked. The NodeId of an ObjectType is valid as ObjectId if the Method is only defined on the ObjectType. The namespace of the NodeId shall be added to the namespaces in the RequestDataSetMetaData. |
|
MethodId |
NodeId |
NodeId of the Method to invoke. If the ObjectId is the NodeId of an Object, it is allowed to use the NodeId of a Method that is the target of a HasComponent Reference from the ObjectType of the Object. The namespace of the NodeId shall be added to the namespaces in the RequestDataSetMetaData. |
Its representation in the AddressSpace is defined in Table 29.
Table 29 – ActionMethodDataType definition
|
Attributes |
Value |
|
BrowseName |
ActionMethodDataType |
|
IsAbstract |
False |
|
Subtype of Structure defined in OPC 10000-5. |
|
|
Conformance Units |
|
|
PubSub Parameters PublishedDataSet Action |
|
This Structure DataType is used to represent Action source Method information for PublishedAction. It is a subtype of the PublishedActionDataType defined in 6.2.3.10.4.
The PublishedActionMethodDataType is formally defined in Table 30.
Table 30 – PublishedActionMethodDataType structure
|
Name |
Type |
Description |
|
PublishedActionMethodDataType |
Structure |
Subtype of PublishedActionDataType defined in 6.2.3.10.4. |
|
ActionMethods |
ActionMethodDataType[] |
Defined in 6.2.3.10.5. If the Action targets are mapped to OPC UA Methods, the size and order of the array shall match the ActionTargets array in the PublishedActionDataType base type. |
Its representation in the AddressSpace is defined in Table 31.
Table 31 – PublishedActionMethodDataType definition
|
Attributes |
Value |
|
BrowseName |
PublishedActionMethodDataType |
|
IsAbstract |
False |
|
Subtype of PublishedActionDataType defined in 6.2.3.10.4. |
|
|
Conformance Units |
|
|
PubSub Parameters PublishedDataSet Action |
|