Configuration

This section explains each of the properties in the configuration blade.
General
Property
Description
Collection
This associates the Agent to a specific Collection (default to that of the current Data Stream).
Polling Interval (seconds)
A timespan to specify how often should the Agent check for new data/changes or update its cache.
Refer to Collections and Stream Hosts to understand more about Collections.
Connection
Once the Server Url is provided, the Agent will attempt to connect to the Litmus Edge OPC UA Server and retrieve its available Endpoints. Selecting an Endpoint will populate the Security dropdown with the available User Security Policies for the Endpoint.
Property
Description
Use Variables
Tick to select saved Server Url, User Name, Password, Tags File Path, and File Name variables; or enter the text manually.
Server Url
The Url of the OPC UA Server to connect to.
Endpoint
The Endpoint of the OPC UA Server to connect to. Each Endpoint follows a different Protocol, Security Mode, Security Policy, and Message Encoding.
Auto Accept Server Certificate
Tick to auto accept the certificate during server authentication.
Security
The authentication options are: 
Anonymous - none
UserName - basic
Certificate - the Agent generates its own Certificate and uses it to authenticate (go to the Litmus Edge portal to configure the certificate as trusted for Litmus Edge OPC UA Server Connections)
User Name
The User Name used to authenticate with the server (applies to UserName Security only).
Password
The Password used to authenticate with the server (applies to UserName Security only).
Tags Selection
The method used to navigate/specify the tags to retrieve the data.
Property
Description
Tags Input
Using Dot Notation: the branch name and each child branch are separated by a dot.
Using Drill Down: select each level of the branch.
Using Stream Host CSV File: specify the tags information using a CSV file stored on the Stream Host. Use this option when running the Data Stream on multiple Stream Hosts, each pointing to a different OPC UA instance. Although the tag path can differ for each OPC instance, the number of tags, alias, and data type must be the same in all the CSV files on all the Stream Hosts.
Template File
Download this template, modify it to represent your tags, and place it on the Stream Host (applies to Using Stream Host CSV File option only).
Tags File Path
Absolute path to the directory on the Stream Host where the tags CSV file is located (applies to Using Stream Host CSV File Tags Input only).
File Name
Full name of the CSV file including the file extension (applies to Using Stream Host CSV File Tags Input only).
If the Tags File Path or File Name differs from one Stream Host to another, utilize variables and refer here for instructions to override them on each Stream Host. 
Specify Branch
When the Connection details are completed, the Agent attempts to authenticate with the OPC UA Server. If successful, the Address Space of the Server is made available to the Agent, allowing the navigation of Branches. This section applies to Using Dot Notation and Using Drill Down Tags Input only.
Property
Description
Branch Path
The dot-separated Branch path to the Node where the Tag values are retrieved (applies to Using Dot Notation Tags Input only).

A path that is invalid or does not exist will not display any available Tags. 
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 Tag values are retrieved - limited to 10 Levels (applies to Using Drill Down Tags Input only). 
Tags
The Tags Grid is editable for Using Dot Notation and Using Drill Down Tags Input only. When Using Stream Host CSV File, the Tags Grid should not be edited as it displays the tag information specified in the CSV file. Any changes that are required should be made to the file.
Property
Description
Available Tags
The shortcut to add available Tags to the Tags Grid (applies to Using Dot Notation and Using Drill Down Tags Input only).
Once the Branch is provided, the Agent retrieves the available Tags for that Branch - you can deselect any that you don't want to be added to the Tags Grid.
Add Selected Tags
Tick to add the Available Tags selection to the Tags Grid (applies to Using Dot Notation and Using Drill Down Tags Input only).
Tags Grid (Tag, Alias, Type)
The grid defines the output payload:
Tag: The Branch Path of the Tag including its name.
Alias: The name used as the column or attribute name in the output payload.
Type: The data type used as the column or attribute data type in the output payload. The options are String, Integer, Double, Boolean, DateTime, or Array. Select Array for Tags with a complex data type, such as a JSON formatted string.

Selecting a Type that does not match the Tag value will cause an error on the published data stream e.g., selecting "Double" for text. 
Endpoints
Name
Description
Output
An event per poll will be made available on this endpoint, with attributes matching the configured Tags Grid - as well as a timestamp.
Error
Errors encountered during the execution of this Agent will be published on this endpoint.
CSV File Template
Download this template, modify it to represent your tags, and place it on the Stream Host (applies to Using Stream Host CSV File option only).
File
Link
Template
LitmusTags.csv

Property	Description
Collection	This associates the Agent to a specific Collection (default to that of the current Data Stream).
Polling Interval (seconds)	A timespan to specify how often should the Agent check for new data/changes or update its cache.

Property	Description
Use Variables	Tick to select saved Server Url, User Name, Password, Tags File Path, and File Name variables; or enter the text manually.
Server Url	The Url of the OPC UA Server to connect to.
Endpoint	The Endpoint of the OPC UA Server to connect to. Each Endpoint follows a different Protocol, Security Mode, Security Policy, and Message Encoding.
Auto Accept Server Certificate	Tick to auto accept the certificate during server authentication.
Security	The authentication options are: Anonymous - none UserName - basic Certificate - the Agent generates its own Certificate and uses it to authenticate (go to the Litmus Edge portal to configure the certificate as trusted for Litmus Edge OPC UA Server Connections)
User Name	The User Name used to authenticate with the server (applies to UserName Security only).
Password	The Password used to authenticate with the server (applies to UserName Security only).

Property	Description
Tags Input	Using Dot Notation: the branch name and each child branch are separated by a dot. Using Drill Down: select each level of the branch. Using Stream Host CSV File: specify the tags information using a CSV file stored on the Stream Host. Use this option when running the Data Stream on multiple Stream Hosts, each pointing to a different OPC UA instance. Although the tag path can differ for each OPC instance, the number of tags, alias, and data type must be the same in all the CSV files on all the Stream Hosts.
Template File	Download this template, modify it to represent your tags, and place it on the Stream Host (applies to Using Stream Host CSV File option only).
Tags File Path	Absolute path to the directory on the Stream Host where the tags CSV file is located (applies to Using Stream Host CSV File Tags Input only).
File Name	Full name of the CSV file including the file extension (applies to Using Stream Host CSV File Tags Input only).

Property	Description
Branch Path	The dot-separated Branch path to the Node where the Tag values are retrieved (applies to Using Dot Notation Tags Input only). A path that is invalid or does not exist will not display any available Tags. 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 Tag values are retrieved - limited to 10 Levels (applies to Using Drill Down Tags Input only).

Property	Description
Available Tags	The shortcut to add available Tags to the Tags Grid (applies to Using Dot Notation and Using Drill Down Tags Input only). Once the Branch is provided, the Agent retrieves the available Tags for that Branch - you can deselect any that you don't want to be added to the Tags Grid.
Add Selected Tags	Tick to add the Available Tags selection to the Tags Grid (applies to Using Dot Notation and Using Drill Down Tags Input only).
Tags Grid (Tag, Alias, Type)	The grid defines the output payload: Tag: The Branch Path of the Tag including its name. Alias: The name used as the column or attribute name in the output payload. Type: The data type used as the column or attribute data type in the output payload. The options are String, Integer, Double, Boolean, DateTime, or Array. Select Array for Tags with a complex data type, such as a JSON formatted string. Selecting a Type that does not match the Tag value will cause an error on the published data stream e.g., selecting "Double" for text.

Name	Description
Output	An event per poll will be made available on this endpoint, with attributes matching the configured Tags Grid - as well as a timestamp.
Error	Errors encountered during the execution of this Agent will be published on this endpoint.

File	Link
Template	LitmusTags.csv

Last modified 6d ago