Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


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
maxLevel

4

3
excludeContents


Local Cloud Setup

Installation

Local Cloud requires the following software to be installed:

Local Cloud itself is distributed as a ZIP file that should be extracted to your local drive. 

The locations of the Local Cloud executables can be configured by the user, but it is easiest if they are placed in the following directory structure:

  • /Root Folder
    • /Source Cloud build01
      • /Agent
      • /Source Cloud
    • /TimeseriesCycleCreator

Subsequent releases of the Local Cloud can be placed in the same root directory without needing to replace the Time Series Cycle Creator, e.g.:

Configuration

Inside the Agent and Source Cloud directories are files called "appSettings.json". These files can be opened in a text editor and allow you to configure the Source Cloud settings. If you use the directory structure illustrated above, the only setting that will require editing is the location of the eWater Source installation directory.

Source Cloud settings file:

Code Block
languagejava
titleSource Cloud appsettings.json
{
  "BaseUrl": "http://localhost:5051",
  "UseEmbeddedDatabase": true,
  "MaxLocalAgents": 4,
  "LocalAgentExe": "..\\Agent\\SourceCloudAgent.exe",
  "TimeseriesCycleCreatorExe": "..\\..\\TimeseriesCycleCreator\\TimeseriesCycleCreator.exe"
}
  • BaseUrl - The browseable URL for the local version of Source CloudUseEmbeddedDatabase - Whether to use the embedded database or not
  • 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
languagejava
titleAgent appsettings.json
{
  "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.

Source Cloud Dashboard

Description of the Source Cloud Dashboard TBA.

Job Creation