Configure the Tetra File-Log Agent in the Cloud

You can configure the Tetra File-Log Agent by using either of the following methods:

Enter configuration details in the Management Console on the machine where the Tetra File-Log Agent is installed.

-or-
Enter configuration details in the Cloud Configuration window by completing the following instructions.

Prerequisites

The following is required to configure a Tetra File-Log Agent in the cloud:

A Tetra File-Log Agent v4.1.0 or higher installed on a host server that meets all of the hardware, software, and networking requirements. For installation instructions, see the latest installation guide.
The Agent's Receive Commands option must be set to Yes. If not, then you must enter the required configuration details in the local Agent Management Console.

Configure the Tetra File-Log Agent in the Cloud Configuration Window

To configure the Tetra File-Log Agent in the Cloud Configuration window, do the following:

Sign in to the TDP.
In the left navigation menu, choose Data Sources. Then, select Agents. The Agents page appears.
Select the name of the Agent that you want to configure. The Agent's Details page appears.
One the Agent Details page, select the Configuration tab.
On the Configuration tab, you can edit the following Tetra File-Log Agent settings:

For Start Date, enter the date you want to begin using the configuration.
For File Change Interval (Seconds), enter the minimum time a file in the configured path must remain unchanged before it can be uploaded. The default is 30 seconds.
For Scan Interval (seconds), enter the frequency that you want to have between when paths are rescanned for new or changed files. The default is 30 seconds.

📘
NOTE
For Tetra File-Log Agent v4.4.x and earlier, there's only a File Change Interval (Seconds) setting.

Then, set the Path Configurations and File Watcher settings. For more information about each setting, see the latest Tetra File-Log Agent installation guide.

Choose Overwrite Local with Existing Cloud Configuration.

📘
NOTE
If a Cloud/Local Configuration is Out of Sync message displays, then the Agent's cloud and local configurations are different. To review the differences, choose the Review Cloud Configuration and Review Local Configuration buttons. Based on the differences, you can decide to push the configuration or reject it.

Path Configuration Options

Parameter	Description
Status	Indicates if a path is accessible or not (valid or invalid)
File change interval (in seconds)	Determines the amount of idle time before the agent uploads the file and scans the file path to detect changes
Path	Shows the folder paths that are monitored by File Watcher
Watch Mode	Provides two modes: File mode monitors files to see if they've been updated, and Folder mode monitors the folder directory to check for changes
Patterns	Glob pattern to filter the file or folder
Source Type	(Required) Defines the file's data source and triggers the file's associated pipeline
Labels	Added in TDP 3.5 Displays path level labels (name/value pairs). User may select from existing label names or add new label names. Note: (For TDP v4.3.2 and higher)Five labels are applied by default, but can be removed: vendor, software, instrument_type, and instrument_model, and instrument_serial_number. Pre-defined values for these five labels are fetched from Tetra Catalog. Users may select from those values or enter their own if the value is not present in the dropdown.
Metadata	Optional, immutable key/value pairs attached as native Amazon Simple Storage Service (Amazon S3) metadata to the underlying Amazon S3 object
Tag	Optional, immutable strings attached as native Amazon S3 metadata to the underlying Amazon S3 object
Archive/Delete	(For FLA v4.3 and later) If File Watch Mode is set to file, then the following read-only Archive information appears: -Archive files to folder (toggle)—indicates if archive settings are activated or not -Archive to—shows the root folder where archived files are stored -Archive time and unit—shows the amount of time after successful file upload -Delete file from archive permanently (toggle)—indicates if delete settings are activated or not -Delete time and unit—shows the amount of time that after a file has been archived and when it becomes eligible to be deleted
Fetch OS file / folder owner	(For FLA v4.3 and later)Fetch the OS file (or folder if the File Watch Mode is Folder) creator information and add as a metadata to the file during upload

Documentation Feedback

Do you have questions about our documentation or suggestions for how we can improve it? Start a discussion in TetraConnect Hub. For access, see Access the TetraConnect Hub.

📘
NOTE
Feedback isn't part of the official TetraScience product documentation. TetraScience doesn't warrant or make any guarantees about the feedback provided, including its accuracy, relevance, or reliability. All feedback is subject to the terms set forth in the TetraConnect Hub Community Guidelines.

Updated 3 days ago