Local Application
Installation
Local installation of eWater Run Manager requires the following additional software to be installed:
- eWater Source version 4.9.0.9971 or later
- .Net NET Framework 4.8
- .NET Core 23.1.13 19 Runtime & Hosting Bundle (or later 2 later 3.1.x Hosting Bundle release with security updates)
- Visual C++ 2013 Runtime
eWater Run Manager is distributed as a ZIP file that should be extracted to your local drive: eWaterRunManager_681.zip. It's now available as a toolkit product: https://toolkit.ewater.org.au/Tools/Run Manager
Configuration
The eWater Run Manager application contains a number of sub-directories. Two of these, the Agent and Run Manager sub-directories, contain configuration files called appSettings.json. These files can be opened in a text editor and allow you to configure the Run Manager settings.
The default settings are already configured for local use, however the user will need to specify or review the eWater Source installation directory setting. This setting is the SourceDirectory setting in the Agent's appSettings.json configuration file. Generally, all other settings should be left at their default values. The Run Manager will need to be restarted for configuration changes to take effect.
| Warning |
|---|
When entering file paths, back slashes, "\", must be escaped with an additional back slash, i.e. "\\". |
Agent Settings file (inside Agent folder):
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"PollingPeriodMs": "10000",
"SourceDirectory": "C:\\eWater\\Source\\4.9.0.9947\\",
"AdditionalPlugins": [
"Plugins\\CommunityPlugins\\SourcePlugin.SubSource.dll",
"Plugins\\UrbanDeveloper\\UrbanDeveloper.dll"
]
} |
- PollingPeriodMs - How often an agent will poll the server requesting a job/task
- SourceDirectory - The directory containing the version of Source to run
- AdditionalPlugins - List of plugins to be loaded by the Source when running jobs; paths should be relative to the SourceDirectory path
eWater Run Manager settings file (inside Run Manager folder):
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"BaseUrl": "http://localhost:5051",
"LaunchBrowserOnStart": true,
"AgentEndpoints": ["Local"]
}
|
- BaseUrl - The browsable URL for the local version of Source Cloud
- LaunchBrowserOnStart - Whether to open the Run Manager web application in your default web browser when "Source.Web.exe" starts
- AgentEndpoints - Use Local agents
Launching eWater Run Manager
Launch the eWater Run Manager application by executing Source.Web.exe, located in the Run Manager folder. If the LaunchBrowserOnStart setting is true this will launch the local eWater Run Manager application in your default web browser. Otherwise open a web browser and open the URL specified in the BaseUrl setting, default is "http://localhost:5051".
| Warning |
|---|
If you have used a previous version of eWater Run Manager your web browser may cache the old version of the website and fail to update when you run a new version. To refresh the version displayed you will need to do a 'hard refresh' on the eWater Run Manager webpage after starting a new version. In Firefox and Chrome, the default shortcut for a hard refresh is Ctrl + F5. |
Shutting down eWater Run Manager
When Run Manager is started by executing Source.Web.exe a commandline window will be opened which displays various logging information. If you need to close Run Manager you should not simply close the commandline window as this will not close all processes. Instead, use the Shut Down eWater Run Manager button on the options page.