Install Agent as a Windows Service

<< Click to Display Table of Contents >>

EQuIS 7  >>  Enterprise > EQuIS Live > Installation and Configuration >

Install Agent as a Windows Service

This document applies to EQuIS Live Agents that can be installed as Windows Services:

File Processor

Hardware Monitor

LoggerNet

MIS

 

Uninstall

 

If a previous version of the agent is installed as a service, uninstall the service from a Command Prompt, run as an Administrator, change to the folder where the agent's executable is installed (e.g., C:\Program Files\EarthSoft\EQuIS Live\LoggerNet Agent\) and uninstall the service (e.g., EarthSoft.Live.Agents.LoggerNet.exe uninstall). Also, uninstall the agent's executable from windows (e.g., Name = EarthSoft EQuIS Live LoggerNet).

 

Install Executable

 

1.Download the the appropriate version of the agent (.zip) from the EarthSoft Community Center Downloads Dashboard (Products > EQuIS Live).

2.Unblock the downloaded ZIP file.

3.Extract the downloaded ZIP file.

4.Run the .msi file (e.g., EarthSoft_EQuIS Live LoggerNet_Live_7.0_x64.msi).

5.Next > ☑ I accept the terms of the License Agreement > Next > select the installation folder (e.g., C:\Program Files\EarthSoft\EQuIS Live\LoggerNet Agent\) > Next > Install > Finish.

 

Database Connection

 

1.Open the agent's *.config file (e.g., C:\Program Files\EarthSoft\EQuIS Live\LoggerNet Agent\EarthSoft.Live.Agents.LoggerNet.exe.config) in a text editor (e.g., Notepad++).

2.In the <connectionStrings> section, find the item with name="databaseConnection".

3.Set the connectionString values (e.g., Data Source = sql-038-equisonline-com.database.windows.net; User ID = live.logger; Password = ********; Database = DBNAME).

 

Note: The connectionString requires an SQL (e.g., Microsoft SQL Server) login. An Application-Level Security (ALS) login (aka EQuIS Enterprise login) cannot be used to connect to the database.

 

4.Set the providerName to either EarthSoft.Common.Data.SqlConnection (Microsoft SQL Server).

5.Save and close the *.config file.

 

App Settings

 

You may change one or more app settings in the agent's *.config file. See the agent's help page for a list of available app settings (e.g., LoggerNet app settings).

 

All EQuIS Live Agents that can be installed as Windows Services support the following app settings:

 

Setting

Example(s)

Description

serviceNameSuffix

A

If this setting is not empty, the agent will append this suffix to the executable name when installing the Windows Service. For example, multiple instances of this service can be run at the same time on the same computer, each with different app settings. (If this setting is not available in the *.config file, you can add it.)

useNetworkLicenses

true or false

If this setting is false, the agent will use local licenses. If this setting is true, the agent will use network licenses.

 

The log4net.config file contains the agent's logging settings, e.g. log to file (RollingLogFileAppender) %env{temp}/equislogs/{process}.log (<file type="log4net.Util.PatternString" value="%env{temp}/equislogs/{process}.log" />), using logging level all (i.e., <level value="all" />).

 

Register

 

1.Use local licenses or network licenses:

a.Open the agent's *.config file.

b.Go to the <appSettings> section.

c.Set the useNetworkLicenses value to false to use local licenses, or to true to use network licenses.

d.Save and close the *.config file.

2.Open a Command Prompt, run as an Administrator.

3.Change to the folder where the agent's executable is installed (e.g., C:\Program Files\EarthSoft\EQuIS Live\LoggerNet Agent\).

4.Execute the register command to display the Registration screen, e.g.:
 
EarthSoft.Live.Agents.LoggerNet.exe register
 

6.Go to the Workstation Licenses tab to enter a local license, or to the Network Licenses tab to enter a network license.

7.Copy the Computer ID or Server ID value, and request an EQuIS Live license key from the EarthSoft Help Desk.

 

Note: You can also use an EQuIS Enterprise Gold (Live), or EQuIS Enterprise Platinum, license.

 

8.After receiving the appropriate license keys, copy and paste them into the New Key Codes box, click Save Key(s), and OK.

 

Note: Local licenses are saved in the agent's *.config file, in the licenses section, and network licenses are saved in the database, in the ST_LICENSE table.

 

Install Agent as Windows Service

 

Install the service from a Command Prompt, run as an Administrator:

 

Change to the folder where the agent's executable is installed (e.g., C:\Program Files\EarthSoft\EQuIS Live\LoggerNet Agent\) and install the service by running a command line on the executable. Below is an example of a command line for installing the LoggerNet Agent as a Windows Service:

 

EarthSoft.Live.Agents.LoggerNet.exe install

 

Review Windows Service

 

1.Open Windows Services (e.g., use Windows shortcut keys Win + R to launch Run > type services.msc into the dialog box > press the Enter key).

2.Find the service (e.g., EarthSoft.Live.Agents.LoggerNet).

3.Verify its Startup Type (e.g., it should be Automatic if you want the agent to start up with the operating system, and not require any user interaction).

4.Verify its Log On As account. The account should be able to connect to the database (specified in the agent's *.config file), and read and write to all the files and folders that the agent will use. For example, the agent's executable folder (e.g., C:\Program Files\EarthSoft\EQuIS Live\LoggerNet Agent\), the agent's watched files and folders (if the agent watches files and folders), and the agent's log folder (specified in the agent's log4net.config file).

 

Start Windows Service

 

Note: Some agents may require additional setup before being started (e.g., you may add data logger(s) before starting LoggerNet).

 

You can start the service from Windows Services, or from a Command Prompt, run as an Administrator: change to the folder where the agent's executable is installed (e.g., C:\Program Files\EarthSoft\EQuIS Live\LoggerNet Agent\) and start the service (e.g., EarthSoft.Live.Agents.LoggerNet.exe start).

 

Command Line Options

 

All EQuIS Live Agents that can be installed as Windows Services support the following command line options:

 

Option

Description

[none]

Run the agent as a console process. (Note: The agent must be started manually, by the user, when the computer is restarted, if it is run as a console process, and not a Windows Service.)

help

Show the agent's command line options and their descriptions.

install

Install the agent as a Windows Service.

register

Show the EarthSoft Registration screen to view / save license keys.

start

Install (if not installed) and start the agent as a Windows Service.

status

Show the status of the agent's Windows Service (only applicable if the executable has been installed as a Windows Service).

stop

Stop the agent's Windows Service (only applicable if the service is running).

uninstall

Stop (if running) and uninstall the agent's Windows Service (only applicable if the executable has been installed as a Windows Service).