Note: This is documentation for version 5.12 of Source. For a different version of Source, select the relevant space by using the Spaces menu in the toolbar above

Accessing the Run Manager

Owned by rachelb (Deactivated)
Last updated: 12 Oct 2023 by TeamcityVersion comment

The Run Manager is accessed via a web browser interface regardless of whether it is installed as a local application or accessed on the cloud. It is optimised for use with Google Chrome.

Cloud Application

For authorised users, the Run Manager Cloud application can be accessed by visiting https://runmanager.ewater.org.au/ via your web browser.

To use the Run Manager Cloud, you must log in. This will occur automatically if you are logged in to eWater's Toolkit in your web browser. If not, you must log in manually using your Toolkit credentials (see Profile).

The Run Manager Cloud Application is currently configured to use multiple verisons of Source and has two plugins available:

  • UrbanDeveloper
  • SubSource

Before running a project on Run Manager it is always recommended to save the projects using a supported version to avoid needing to upgrade the project during the run. This is particularly important for any of the multi-run jobs.

Contents

Local Application

Installation

Local installation of eWater Run Manager requires the following additional software to be installed:

eWater Run Manager is distributed as a ZIP file that should be extracted to your local drive. 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.

When entering file paths, back slashes, "\", must be escaped with an additional back slash, i.e. "\\".

Agent Settings file (inside Agent folder):

Agent appsettings.json
{
  "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):

eWater Run Manager appsettings.json
{
  "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".

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.