Live File Processor Agent Windows Service

Installation and Setup

Follow these steps to install, configure, and start this agent as a Windows Service.

Before using this agent, a databaseConnection connectionString, and a configKey value, need to be defined in the *.config file. The configKey value correlates to the ST_CONFIG.CONFIG_KEY entry for a Live File Processor instance.

Note: Users can also change the common app settings, for all EQuIS Live Agents that can be installed as Windows Services, listed here.

1.As an Administrator, open the EarthSoft.Live.Agents.File Processor.exe.config file in a text editor (e.g., Notepad++).

2.Define each instance of the Agent as an appSettings in the *.config file for the values of configKey and serviceNameSuffix.

3.Save and close the *.config file.

See the example below:

Live-File_Processor_Agent_appSettings_Example

Tip: If running multiple instances of this agent:

1.Set the configKey and the serviceNameSuffix to the same value.

2.Add the value from Step 1 to the agent's folder name.

Step 2 allows for easier identification of which service, and agent folder/exe, uses which ST_CONFIG.CONFIG_KEY.

Continuous Data Loading

When the agent starts, it connects to the EQuIS Live database and watches each processor's folderWatcherPath for file changes. When the agent detects a new file, or new data in an existing file, it automatically loads the data.

Command Line Options

EarthSoft.Live.Agents.File Processor.exe supports the following command line options:

Option	Description
db2json	Save the ST_CONFIG table settings to an EarthSoft.Live.FileProcessor.YYYYMMDDTHHMMSS.config.json file. (A databaseConnection connectionString, and a configKey value, need to be defined in the EarthSoft.Live.Agents.File Processor.exe.config file first.) e.g., db2json or db2json "HOBO\|In-Situ-5\|Landtec" Not specifying a processor will save all the ST_CONFIG table settings to the *.json file.
json2db	Add (or update) the EarthSoft.Live.FileProcessor.config.json file (example) settings to the ST_CONFIG table. (A databaseConnection connectionString, and a configKey value, need to be defined in the EarthSoft.Live.Agents.File Processor.exe.config file first.) e.g., json2db or json2db "HOBO\|In-Situ-5\|Landtec" Not specifying a processor will add all *.json file settings to the ST_CONFIG table. Note: This command saves the original ST_CONFIG table settings (for all processors) to an EarthSoft.Live.FileProcessor.YYYYMMDDTHHMMSS.config.json file first. To restore the original settings, rename EarthSoft.Live.FileProcessor.YYYYMMDDTHHMMSS.config.json to EarthSoft.Live.FileProcessor.config.json (rename the original EarthSoft.Live.FileProcessor.config.json file first) and run json2db.
loaddata	Load data for all files that were added to the watched folder(s), or changed, while the agent was not running. e.g., loaddata or loaddata "HOBO\|In-Situ-5\|Landtec" Not specifying a processor will load data for all processors.

Option

Description

db2json

Save the ST_CONFIG table settings to an EarthSoft.Live.FileProcessor.YYYYMMDDTHHMMSS.config.json file. (A databaseConnection connectionString, and a configKey value, need to be defined in the EarthSoft.Live.Agents.File Processor.exe.config file first.)

e.g., db2json or db2json "HOBO|In-Situ-5|Landtec"

Not specifying a processor will save all the ST_CONFIG table settings to the *.json file.

json2db

Add (or update) the EarthSoft.Live.FileProcessor.config.json file (example) settings to the ST_CONFIG table. (A databaseConnection connectionString, and a configKey value, need to be defined in the EarthSoft.Live.Agents.File Processor.exe.config file first.)

e.g., json2db or json2db "HOBO|In-Situ-5|Landtec"

Not specifying a processor will add all *.json file settings to the ST_CONFIG table.

Note: This command saves the original ST_CONFIG table settings (for all processors) to an EarthSoft.Live.FileProcessor.YYYYMMDDTHHMMSS.config.json file first. To restore the original settings, rename EarthSoft.Live.FileProcessor.YYYYMMDDTHHMMSS.config.json to EarthSoft.Live.FileProcessor.config.json (rename the original EarthSoft.Live.FileProcessor.config.json file first) and run json2db.

loaddata

Load data for all files that were added to the watched folder(s), or changed, while the agent was not running.

e.g., loaddata or loaddata "HOBO|In-Situ-5|Landtec"

Not specifying a processor will load data for all processors.

Common command line options for all EQuIS Live Agents that can be installed as Windows Services are listed here.