Changes
Created page with "{{ActivityInfoBox | title = Configure OPC UA Variable | name = ConfigureOPCUAVariable | image = [[File:UI_Activity_ConfigureOPCUAVariable.png|220px]] | imagecaption = Configur..."
{{ActivityInfoBox
| title = Configure OPC UA Variable
| name = ConfigureOPCUAVariable
| image = [[File:UI_Activity_ConfigureOPCUAVariable.png|220px]]
| imagecaption = ConfigureOPCUAVariable (Expanded)
| purpose = Configure a single OPC UA variable
| category = UBIK OPC UA Interface
| returns = True if successful
| version = 2.4.1+
}}
The ConfigureOPCUAVariable registers a single variable within an [[CreateOPCUAConnection (Activity)|OPC UA Connection]]. Only registered variables can be accessed later on with [[AccessOPCUAVariable (Activity)|AccessOPCUAVariable]] activities.
==Arguments==
{| class="wikitable sortable" | width = "50%"
|-
! Argument!! Type !! Direction !! !! Purpose
|- align="left"
| BrowsePath|| String|| In || Specifies the browse path of the item on the server e.g. "/2:Plant1/2:Machine1/2:Unit1/2:Sensor1"). For a more detailed descriptions please refer to the OPC UA specification.
|- align="left"
| AutoRead|| Bool|| In || Specifies the variable to be read from the server automatically after a connection to the server has been established.
|- align="left"
| Subscribe|| Bool|| In || Specifies that the variable should automatically be entered into a subscription with the server to be updated with any changes to its value.
|- align="left"
| Interval|| TimeSpan|| In || Specifies the publishing interval to be used for the subscription. All variables using the same publishing interval are grouped together in a subscription for each publishing interval.
|- align="left"
| IndexRange|| OpcUaIndexRange|| In || For arrays, specifies the index range to be read or written. If left null, the entire array will be transferred.
|- align="left"
| Result|| Boolean|| Out || True if successful, false if failed
|}
==Usage==
This activity is used to configure a single variable for later access within an OPC scope, only configured variables will be accessible.
==Example==
The ConfigureOPCUAVariable activity, as used in the larger example "Read value from OPC variable":
[[File:UI_Activity_CreateOPCUAConnection_Example.png|x700px]]
==See also==
* [[Workflow Designer]]
* [[CreateOPCUAConnection (Activity)]]
* [[CreateOPCUAScope (Activity)]]
[[Category:Workflows]] [[Category:Activities]] [[Category:Interfacing]] [[Category:OPC]]
| title = Configure OPC UA Variable
| name = ConfigureOPCUAVariable
| image = [[File:UI_Activity_ConfigureOPCUAVariable.png|220px]]
| imagecaption = ConfigureOPCUAVariable (Expanded)
| purpose = Configure a single OPC UA variable
| category = UBIK OPC UA Interface
| returns = True if successful
| version = 2.4.1+
}}
The ConfigureOPCUAVariable registers a single variable within an [[CreateOPCUAConnection (Activity)|OPC UA Connection]]. Only registered variables can be accessed later on with [[AccessOPCUAVariable (Activity)|AccessOPCUAVariable]] activities.
==Arguments==
{| class="wikitable sortable" | width = "50%"
|-
! Argument!! Type !! Direction !! !! Purpose
|- align="left"
| BrowsePath|| String|| In || Specifies the browse path of the item on the server e.g. "/2:Plant1/2:Machine1/2:Unit1/2:Sensor1"). For a more detailed descriptions please refer to the OPC UA specification.
|- align="left"
| AutoRead|| Bool|| In || Specifies the variable to be read from the server automatically after a connection to the server has been established.
|- align="left"
| Subscribe|| Bool|| In || Specifies that the variable should automatically be entered into a subscription with the server to be updated with any changes to its value.
|- align="left"
| Interval|| TimeSpan|| In || Specifies the publishing interval to be used for the subscription. All variables using the same publishing interval are grouped together in a subscription for each publishing interval.
|- align="left"
| IndexRange|| OpcUaIndexRange|| In || For arrays, specifies the index range to be read or written. If left null, the entire array will be transferred.
|- align="left"
| Result|| Boolean|| Out || True if successful, false if failed
|}
==Usage==
This activity is used to configure a single variable for later access within an OPC scope, only configured variables will be accessible.
==Example==
The ConfigureOPCUAVariable activity, as used in the larger example "Read value from OPC variable":
[[File:UI_Activity_CreateOPCUAConnection_Example.png|x700px]]
==See also==
* [[Workflow Designer]]
* [[CreateOPCUAConnection (Activity)]]
* [[CreateOPCUAScope (Activity)]]
[[Category:Workflows]] [[Category:Activities]] [[Category:Interfacing]] [[Category:OPC]]
