| Warning |
|---|
This draft documentation is in progress and is visible to eWater Internal and Melbourne Water only |
Overview
Overview of Source Cloud TBA...
Source Cloud can be installed as a local application, or accessed via the cloud.
Contents
| Table of Contents | ||||
|---|---|---|---|---|
|
Local Cloud Setup
Installation
Local Cloud requires the following software to be installed:
- eWater Source version 4.5.0 or later
- .NET Core 2.1 Runtime & Hosting Bundle
Local Cloud itself is distributed as a ZIP file that should be extracted to your local drive.
Configuration
The Source Cloud application contains a number of sub-directories. Two of these, the Agent and Source.Web sub-directories, contain configuration files called appSettings.json. These files can be opened in a text editor and allow you to configure the Source Cloud settings. Generally, the only setting that the user will need to modify is the eWater Source installation directory, which is located in the Agent's appSettings.json configuration file.
Source Cloud settings file:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"BaseUrl": "http://localhost:5051",
"MaxLocalAgents": 4,
"LocalAgentExe": "..\\Agent\\SourceCloudAgent.exe",
"TimeseriesCycleCreatorExe": "..\\..\\TimeseriesCycleCreator\\TimeseriesCycleCreator.exe"
}
|
- BaseUrl - The browseable URL for the local version of Source Cloud
- MaxLocalAgents - The maximum number of Source instances to be running for a given job
- TimeseriesCycleCreatorExe - The location of the executable for the TSCC
Agent Settings file:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"PollingPeriodMs": "10000",
"ServerBaseUrl": "http://localhost:5051",
"SourceDirectory": "C:\\Source\\Source_4.5.0.7410\\"
} |
- PollingPeriodMs - How often agent will poll the server requesting for a job/task
- ServerBaseUrl - The URL to contact the server on
- SourceDirectory - The directory containing the version of Source to run
Launch Local Cloud
Launch the Local Cloud application by SourceCloud.exe, which is located in the /SourceCloud directory. This will launch the Local Cloud application in your default web browser.
| Warning |
|---|
Your web browser may cache old versions of the Source Cloud website and fail to update when you run a new version. To ensure that this does not happen, always do a 'hard refresh' on the Source Cloud webpage after installing a new version. In Firefox and Chrome, the shortcut for a hard refresh is Ctrl-F5. |
Source Cloud Dashboard
Description of the Source Cloud Dashboard TBA.
Job Creation
Access
The process of launching the Run Manager application is described in Accessing the Run Manager.
Run Manager Interface
The Run Manager is accessed via a web browser interface (for both the Cloud and Local applications). The Run Manager Toolbar (Figure 1) is located at the top of the browser window and has the following items:
- Home: dashboard display of all jobs
- Create: creates new jobs
- Profile: you login details
- Options: server configuration and AWS costs
Figure 1. The Run Manager Toolbar.
