Source Cloud - Draft Documentation

Installation

Local

Software Requirements

Setup

Installation

Download both Source Cloud and the Time Series Cycle Creator (TSCC) from Teamcity: https://teamcity.ewater.org.au/project.html?projectId=SourceCloud

• Source Cloud
  • Find the desired build and download all artefacts as a zip, extract to a folder (eg. Source Cloud build63)
• TSCC
  • Find the desired build (typically the latest one on release) and downlaod all artefacts as a zip, extract contents to the same level as the previous source cloud folder

Any subsequent versions of Source Cloud can be placed in the same directory without getting another version of the TSCC

So your folder structure should look something like:

• Root Folder
  • Source Cloud build63
    
    • Agent
    • Source Cloud
  • Source Cloud build64
    
    • Agent
    • Source Cloud
  • TimeseriesCycleCreator

Configuration

Inside the Agent and Source Cloud are files called "appSettings.json". These files allow you to configure settings with Source Cloud

Source Cloud settings file:

{
  "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 number of maximum versions of Source to be running for a given job
• TimeseriesCycleCreatorExe - The location of the executable for the TSCC

Agent Settings file:

{
  "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

Single Project Runner

Application

This runner is for running single .rsproj files that have been configured ahead of time using Running configurations.

Instructions

Click "Choose .rsproj" and select the Source Project you wish to run. It must be a Source Project that contains project metadata (the "ProjectMetadata.xml" file inside the .rsproj). It may take a few seconds for the file to upload and parse the metdata.

Select which Scenario/Running Configuration you'd like to run and then enter a name for the job. Finally git the "Queue" button.

Replication Runner

Application

This runner is for running a single .rsproj file that has reload on run, relative path time series data that are to be regenerated with the Time Series Cycle Creator

Instructions

Click "Choose project zip" and select the .zip file that contains your Replicate Project. The Source Project file inside the zip be a Source Project that contains project metadata (the "ProjectMetadata.xml" file inside the .rsproj). It may take a few seconds for the file to upload and parse the metdata.

Select which Scenario/Running Configuration you'd like to run. 

Fill in the data for the TSCC:

• Number of Replicates - 
• Start Cycle Date - 
• Start Year Replicates - 
• Cycle Time Step -

Enter a name for the job. Finally git the "Queue" button.

Insight Runner