Configuration
This section explains each of the properties in the configuration blade.
General Properties
Collection
This associates the Agent to a specific Collection (default to that of the current Data Stream).
Refer to Collections and Stream Hosts to understand more about Collections.
Settings Properties
Once the Server is provided, the Agent will attempt to connect to the specified OPC DA Server.
Use Variables
Tick to select the (manual) Server Url, Username, and Password variables; or enter the text manually.
Server
Select from the list of accessible OPC DA servers.
Specify Server Manually
Tick to manually enter the Server URL (or use a variable), or select an accessible OPC DA server from the Server.
Server Url
The OPC DA Server to connect to (applies when Specify Server Manually is ticked).
Use Authentication
Tick to use basic authentication.
Username
The name of the user used to authenticate with the server (applies when Use Authentication is ticked).
Password
The password used to authenticate with the server (applies when Use Authentication is ticked).
Specify Quality
Tick to add an "Item Quality" property to the Mapping Grid to specify the quality (Good/Bad) of the updated data.
Specify Time Stamp
Tick to add an "Item Timestamp" property to the Mapping Grid to specify the timestamp of the updated data.
Enable Tag Browsing
Tick to use tag browsing to specify the Items to update; or enter the Mapping Grid values manually.
Browse Tags/Items
The method used to navigate/specify the Items to update (applies when Enable Tag Browsing is ticked).
When the Connection details are completed, the Agent attempts to authenticate with the OPC DA Server. If successful, the Address Space of the Server is made available to the Agent, allowing the navigation of branches for the Branch Path and Levels.
Browse Type
The method used to navigate to the Node where the Item values are retrieved:
Using Dot Notation: the branch name and each child branch are separated by a dot.
Using Drill Down: select each level of the branch.
Branch Path
The dot-separated Branch path to the Node where the Item values are retrieved (applies to Using Dot Notation Browse Type only). A path that is invalid or does not exist will not display any available Items.
Do not use dots (.) in the Branch names to ensure the Address Space is traversed correctly.
Level 1 (up to Level 10)
Select the Branch path to the Node where the Item values are retrieved - limited to 10 Levels (applies to Using Drill Down Browse Type only).
Items Properties
A wizard used to populate the Items to update in the Mapping Grid (applies when Enable Tag Browsing is ticked).
Item Name Filter
Filter items by specified value.
Use * as wild card character.
Available Item
The available Item values for the branch, specified at any Level or with a Branch Path.
Add Selected Item
Tick to add the Available Item selection to the Mapping Grid.
Data Mapping Properties
Mapping Grid (Item Name, Item Value, Item Quality, Item Timestamp)
The grid defines the output payload and the values to be published:
Item Name: The Branch Path of the Item including its name where the Item Value will be published.
Item Value: The column or attribute of the input payload that contains the value to publish. Assigning an Item Value that does not match the Type of that Item will cause an error on the published data stream e.g., selecting "Double" for text.
Item Quality: The column or attribute of the input payload that contains the (Good/Bad) quality (applies when Specify Quality is ticked).
Item Timestamp: The column or attribute of the input payload that contains the timestamp that the value changed (applies when Specify Time Stamp is ticked).
Before configuring the Action Agent, please ensure that its input endpoint is connected to a parent Agent which will be sending data to it.
Endpoints
Input
This endpoint is used to receive data from the parent Agent.
Output
Events received from the parent Agent are published to the OPC DA server and made available to this endpoint with unchanged attributes and data.
Error
Errors encountered during the execution of this Agent will be published on this endpoint.
Last updated
