Baseline property sheet

The Baseline property sheet is used to view and edit baseline parameters.

IMPORTANT: Click the Save button on the bottom right corner of the dialog to commit edits.

This page is used to specify a name for the baseline, a default simulation and run scheduling parameters. ClosedShow image

Default Model page of the Baseline property sheet

Item Description
Baseline Name Used throughout the system, for all users. It can be changed at any time. The software will enforce uniqueness. A new name will be visible to all users.
Default Simulation Provides a default set of data. If the control room operator makes no modifications and if there are no live data updates made, simulations will use the default data as used by the specified simulation.
Enable in IWLive Operator Implements scheduling and makes the baseline available in the IWLive Operator program. This option will be enabled only when the baseline has been checked in.
Enable in IWLive Server Implements automated scheduling in IWLive Server. This option will be enabled only when IWLive Server is detected and when the baseline has been checked in.
Run Schedule

Used to schedule timing of simulations and management of results.

Start time

The time at which the first simulation will be run (before latency is applied)

Run every

Interval at which simulations are run.

e.g. run every 5 hours

Duration

Run duration - used to calculate the number of timesteps to run the simulation for.

Live data latency

Length of delay before performing the run in order to allow live data to be retrieved from external telemetry sources.

Tidy up after

Main results from runs older than the time specified here will be deleted.

Warnings will be unaffected.

Archive after

Warnings and main results from runs older than the time specified here will be deleted.

Results and warnings can be regenerated.

Delete after

Runs older than the time specified here will be deleted.

Automatic verification

Controls whether comparison of metered data against model results is to be performed automatically (via the IWLive Pro Server) or manually (via the IWLive Pro Operator interface).

Available options are:

  • No verification - no automatic verification will occur.
  • Verify at end - runs will be automatically verified once, at the end of each run.
  • Verify at interval -runs will be automatically verified at certain intervals. The interval can be set in the Verification interval field below.

Verification interval

Enabled when Automatic verification is set to Verify at interval.

Enter an interval using the hh:mm format (e.g. 00:10 to schedule verification every 10 minutes).

 

This page is used to specify data items alternative to the ones used by the default simulation specified on the Default Model page. ClosedShow image

Switch Options page of the Baseline property sheet

The items to be used in the IWLive projection run will be selected based on the current weather forecast.

Note: All switch options must pass validation against the network in the default simulation selected on the Default Model page.

Item Description
Control ~
Electricity Tariff Electricity Tariffs must contain the same tariff labels as the default simulation Electricity Tariff.
Demand Diagram Demand Diagrams must contain the same demand categories as the default simulation Demand Diagram.
Energy CO2 Factors Energy CO2 Factors must contain the same GHG factor regimes as the default simulation Energy CO2 Factor.
Demand Scaling Demand Scalings must contain the same area codes as the default simulation Demand Scaling.
UPC Scenario ~
Switch configuration
IWLive Switch Controller The IWLive Switch Controller object is used to set up links to weather feeds and to set up calendar data.
Edit Script (button) Click to display the Switch Script dialog used to view and edit ruby scripts that define when switch objects are to be used based on weather feed data.

 

This page is used to select the live data configuration items containing links to the telemetry data associated with objects in the network. ClosedShow image

Live Data Options page of the Baseline property sheet

Item Description
Live Data Configuration More than one Live Data Configuration may be selected.
Copy verification feeds from live data points ~
Initialise fields tab from verification feeds ~

 

The fields page is populated when a valid default simulation is set on the Default Model page.

This page is used to specify updates to be made to controls in the network prior to running a simulation. Updates to demand scaling, demand patterns (inside demand diagrams) and electricity tariffs are also specified here.

Changes may be made by:

  • updating from live data
  • setting user specified values
  • setting from previous projection runs (water quality only).

Data in this page can be entered manually or updated in bulk from CSV files using the Open Data Import Centre.

Closed Show image

Fields page of the Baseline property sheet

Item Availability Description

Object Type

  

Select the type of object to set updates for.

This dropdown list contains all the available network object types, and entries for demand scaling, demand patterns and electricity tariffs. Demand scaling, demand patterns and electricity tariffs can be specified here using user-defined values or a link to a live data feed. This allows IWLive Pro projection runs to use updated demand scaling / patterns / electricity tariffs.

Object ID

 Available to all object types with the exception of Demand Scaling, Demand Scaling (Category in Area), Demand Pattern and Electricity Tariff

Select the object ID.

This displays the settings for individual fields for the selected object.

Area

 Available when Object Type is set to Demand Scaling (Category in Area)

Select an area code.

Tariff

 Available when Object Type is set to Electricity Tariff

Select an electricity tariff.

Radio buttons

 Available when Object Type is set to Demand Scaling ClosedShow image

Demand Scaling options

Scaling Ratio - Select to display demand using scaling ratios.

Adjusted Demand - Select to display demand in absolute values.

Demand Category - Select to apply scale factors to demand grouped by demand category.

Demand Area - Select to apply scale factors to demand grouped by area code.

Note that demand scaling values are reset whenever one radio button is selected or deselected in order to maintain setting integrity.

Exclude

 Available for most object types (disabled for Demand Pattern, Demand Scaling and Electricity Tariff)

If checked, it will not be possible to view this field in IWLive Pro or set this field from IWLive Pro.

Default

  

Value to be used when Mode of operation is set to Use default and in some instances when values fall outside of the allowable range defined by the Min and Max fields (see below).

These values are initially set from the control or parameter associated with the default simulation set on the Default Model page.

A user defined value may be entered.

If the field consists of a time varying profile (for example, transfer node flows or demand patterns), click the button to display a profile editor. The profile editor contains a grid of time varying values, where the Date & Time field is in the format dd:hh::mm and is the relative time from the start date time of the control data. A graph of the profile may also be displayed depending on the parameter being viewed. ClosedShow image

Min

This field is disabled for non-numeric fields

Minimum allowable value for field initially set by InfoWorks WS Pro. However, a user defined value may be entered.

Behaviour is as follows if values fall outside of the allowable range:

  • Mode of operation set to Normal, with updating from live data - if the acquired live values fall outside of the allowable range defined by the Min and Max fields, the Default value will be used instead. If this occurs, IWLive Pro will report the data origin as 'Missing live data'.
  • Mode of operation set to Override - if an override value falls outside of the allowable range defined by the Min and Max fields, the specified min/max value will be used instead.
  • Mode of operation set to Forecast - values outside the allowable range defined by the Min and Max fields will be discarded and a message written to the baseline error log. In this case, the Default value will be used instead.

(If Mode of operation is set to Default, default values are always used.)

Max

 This field is disabled for non-numeric fields

Maximum allowable value for field initially set by InfoWorks WS Pro. However, a user defined value may be entered.

Behaviour is as follows if values fall outside of the allowable range:

  • Mode of operation set to Normal, with updating from live data - if the acquired live values fall outside of the allowable range defined by the Min and Max fields, the Default value will be used instead. If this occurs, IWLive Pro will report the data origin as 'Missing live data'.
  • Mode of operation set to Override - if an override value falls outside of the allowable range defined by the Min and Max fields, the specified min/max value will be used instead.
  • Mode of operation set to Forecast - values outside the allowable range defined by the Min and Max fields will be discarded and a message written to the baseline error log. In this case, the Default value will be used instead.

(If Mode of operation set to Default, default values are always used.)

Readonly

 Available for most object types (disabled for Demand Pattern, Demand Scaling and Electricity Tariff)

Check this option to prevent editing of the field in IWLive Pro.

Updatable from live data

  

Check this option to update the field from live data prior to running the simulation.

Live data feed 1

  

Dropdown list of live data configuration objects specified in the Live Data Options page.

Select the live data configuration containing links to the telemetry point associated with the currently selected network object, demand scaling, demand pattern or electricity tariff.

Live data feed 2

  

Dropdown list of live data configuration objects specified in the Live Data Options page.

Select the live data configuration containing links to the telemetry point associated with the currently selected network object, demand scaling, demand pattern or electricity tariff.

Live data feeds

 Available for BalanceNet Volume Constraints only

Closed

Click the Ellipsis button button to open the live data feeds editor where live data feeds can be associated with BalanceNet volume constraints.
Mode of operation

Defines the method to be used to update the field.

Normal operation

 Not available for Demand Patterns and Electricity Tariffs

Update value from telemetry if Updatable from live data option is selected. If update from telemetry is not successful, use default value.

If Updatable from live data option is not selected, the value will be taken from the Default Simulation specified on the Default Model page.

Use default

  

Use value specified in the Default field.

Use override

  

Use value specified in the Override field.

Forecast

 Not available for BalanceNet volume constraints field (pump stations, pipes and meters)

This mode of operation is primarily intended for transfer nodes in the context of demand scaling and for demand patterns in IWLive Pro.

Use to obtain a value or series of values from the telemetry (Live Data) for a specified number of days or weeks in the past or in the future.

Selecting this option will enable the Forecast unit and Forecast value options (see below).

Preceding projection

 Available for Water Quality runs only

Use value from preceding projection run to initialise the age of water (Initial Age of Water) and concentration (Initial Concentration). If there is no preceding projection run or if the start of the new projection run is after the end of the previous projection run, the default value is used and the data flag is set to Default due to missing value.

Demand pattern mode

  

Define the demand pattern mode. There are four available options:

  • 24 Hour Pattern - Retrieve 24 hours of pattern data from telemetry.
  • 7 Day Pattern - Retrieve 7 days of pattern data from telemetry.
  • Universal 24 Hour Pattern - Retrieve 24 hours of pattern data from telemetry, starting on the 1st of January, 1900.
  • Universal 7 Day Pattern - Retrieve 7 days of pattern data from telemetry, starting on the 1st of January, 1900.

Ignore validation limits

 Enabled when Mode of operation is set to Use override

Check this option to ignore values set in the Min and Max fields.

Override value

  

Specify a value to be used when Mode of operation is set to Use override.

Note: If an override value is below the Min value or above the Max value (see above), IWLive Pro will take the override into account but will clamp the value so it is within the allowable range.

Forecast unit

 Enabled when Mode of operation is set to Forecast

Used in conjunction with Forecast value to specify a time offset for the telemetry data to be used.

Specify the unit to be used (days or weeks).

Forecast value

 Enabled when Mode of operation is set to Forecast

Used in conjunction with Forecast unit to specify a time offset for the telemetry data to be used.

  • Negative values - use telemetry data for times in the past.

    For example, Forecast value = -1, Forecast unit = Days will use telemetry data timestamped one day before the start time of the run.

  • Value of zero - use current telemetry data.

    Telemetry data timestamped from start time of run will be used.

  • Positive value - use telemetry data for times in the future.

    For example, Forecast value = 1, Forecast unit = Weeks will use telemetry data timestamped one week after the start time of the run.

DemandWatch

 Enabled when Object Type is set to Demand Scaling, and only for areas for which Updatable from live data has been enabled

Check this option to indicate that the specified live data feed originates from DemandWatchComprehensive pattern-based water demand forecasting application software for real-time, near-optimal control and management of water distribution networks..

The integration with DemandWatch is performed in the Fields tab of the baseline, by setting values for the Demand Scaling and Demand Scaling (Category in Area) object types. Instructions are given here.

DemandWatch Mode

Enabled when Object Type is set to Demand Scaling (Category in Area), and only for categories used in areas for which Updatable from live data and DemandWatch have been enabled

This field will be disabled (greyed out) for categories that are irrelevant to the area selected in the Area dropdown list. It will also be automatically defaulted to None.

Available options are:

  • None
  • Assign to nodes
  • Subtract from demand flow

Setting delay

  

For use in response runs in IWLive Pro.

The time it will take for an action in response to an event to be performed (for example, visiting a valve to change the setting).
Resetting to default values

All the values in a row can be reset to the default values of the corresponding control by selecting a row in the Fields grid and choosing the Reset row to default values option from the context menu.

Important note about pump stations

Pump stations have an extra field called Pump Station Live Control. Pump Station Live Control is an array of control statements ordered by time that override any rules or controls (for example, UPC settings) that may have been specified when runs were set up. Values entered in Pump Station Live Control are only applied to runs performed in InfoWorks WS Pro that are to be used in IWLive Pro.

The Live Control parameter is different from the other fields in that it allows users to change a value after time zero, as opposed to at initialisation time. Please note that you will need to enter a duration.

Important note about BalanceNet runs

Edits to BalanceNet constraints of pumping stations, meters and pipes is performed in the Fields tab of the Baseline by setting values in the Flow Constraints Editor. To display the editor, click the ellipsis button button adjacent to the BalanceNet Volume Constraints field.

It is possible to update BalanceNet volume constraints from live data. For this, the Updatable from live data option must be enabled for the BalanceNet Volume Constraints field and one or more live data feeds must be specified in the Live Data Feeds Editor that get displayed when the Ellipsis button button of the Live Data Feeds column is clicked.

This page is used to set links to metered data to be compared with model results. Verification can be used to check how well the model is performing, and also to identify potential areas that may have unidentified leakage, or slow-to-emerge problems.

Automated verification is enabled on the Default Model page. Ad hoc verification can be implemented in the IWLive Pro operator program.

Data in this page can be entered manually, or updated in bulk from CSV files using the Open Data Import Centre.

Closed Show image

Verification page of the Baseline property sheet

Item Description
Object Type The types of object available for setting up verification.
Object ID

The IDs of specific objects that can be set up for verification.

Tip: If there are many Object IDs to choose from, it will be easier to click the ellipsis button and use the Select dialog.
Results field The results fields available for the selected object.
Live data feed Contains dropdowns of the names of the live data feeds specified in the live data object (if it is present on the Live Data Options page).
Important note about PressureWatch and QualWatch

Only live data feeds linked to the following results fields of the Verification page will be used in the building of PressureWatch / QualWatch models:

  • Pressure, Flow or Level for PressureWatch
  • Concentration for QualWatch

This page is used to set the themes, layers and labels to be displayed when viewing the network model region in IWLive Pro. ClosedShow image

Display Options page of the Baseline property sheet

Item Description
Layer List

Load the layer list to be displayed by default when viewing simulation results in IWLive Pro.

The layers present in the selected layer list will always be loaded by default. Additional layers can be added via the Layer control context menu option of the GeoPlan window (available in both InfoWorks WS Pro and IWLive Pro).
Theme

Load the theme(s) to be displayed by default when viewing simulation results in IWLive Pro.

The default warning theme that will be applied to network objects in IWLive Pro is set in IWLive Pro.
Warning Template List

Load the warning template(s) to be displayed by default when viewing simulation results in IWLive Pro.

When creating incident runs and response runs in IWLive Pro, the user will be able to choose from the warning templates specified in this list.
Projection Warning Template Load one warning template into this box. This is the warning template that will be used for IWLive Pro projection runs.
Polygon This is used to specify a bounding polygon for the baseline, or an area within the baseline that is defined by a polygon outline (sub network polygon). All polygons present in the default model network will be listed. Select a sub network polygon to be used as the bounding polygon, or select the Default option to automatically generate a bounding polygon from network extents. If you want to divide the network into smaller areas or zones that will be easier to manage in IWLive Pro, select the sub network polygon defining the area of interest. This polygon will have to be assigned to a polygon id on the Zone Options page so that it will act as a zone in IWLive Pro.
Selection List You can optionally load one or more selection lists into this box. These selection lists will be available to pick from in IWLive Pro for bulk export of simulation results. Export settings are implemented in the Export Style database object.
Label List You can load one or more label lists into this box. These label lists will be available for selection in IWLive Pro for loading onto the Map view.

 

The Zone Options page is used to configure a theme and layer to be displayed when viewing zones in IWLive Pro. Zones are user-defined polygons that can be used to divide networks into smaller more manageable areas, usually based on hydraulic boundaries. By associating each polygon to one of the listed area codes, users make these polygons act as zones, and therefore define different zones of operation.

ClosedShow image

Zone Options page of the Baseline object

Item Description
Layer List Set up zone display options in IWLive Pro by dragging a layer list from the Model Group window and dropping it into this box.
Theme Set up zone display options in IWLive Pro by dragging a warning theme from the Model Group window and dropping it into this box.
Area Code / Polygon ID grid
Area Code This column is automatically populated with a list of unique area codes from all the area codes used for nodes and pipes within the network.
Polygon ID Assign a polygon id to the different area codes. Each cell is a dropdown list containing all the polygons present in the network.
context menu The View zone grid context menu item zooms the GeoPlan to the zone selected in the grid row.

 

This page is used to configure the Pump Results window of the IWLive Pro Operator program. The Pump Results window displays an overview of the on/off state as well as the electricity tariff for a selection of pump stations.

Note: Which pump stations are displayed in the Pump Results window can also be controlled in the Operator by selecting the Results display mode. Settings entered on the Pump Overview page will override the Results display mode selected in the Operator.

If no pump station selection list and no theme are selected on this page, the overview displayed in IWLive Pro will encompass all the pump stations in the network. Moreover, if no electricity tariff theme is being applied, the results will be displayed in IWLive Pro using thick green bands for pump stations that are on and narrow red bands for pump stations that are off. See the IWLive Pro Help for more information.

ClosedShow image

Pump Overview page of the Baseline property sheet

Item Description
Pump Station Selection List Load a selection list containing the required pump stations.
Electricity Tariff Theme Load an electricity tariff theme.

 

This page is used to configure alarms that will trigger projection runs in IWLive Pro. These alarms can be used to alert the user about interesting occurrences in the data coming from external sources (for example, SCADA). Examples:

  • An alarm raised (alarm ON) whenever a certain value goes below or above a certain level.
  • Projection runs automatically triggered at a frequency defined by the user.

ClosedShow image

Trigger Feeds page of the Baseline property sheet

Item

Description

Enable projection runs triggered by alarms

When checked, enables triggering of projection runs in IWLive Pro.

This option is unchecked by default.

Minimum triggered run repetition (min)

Indicates how often the triggered runs will be performed if the alarm condition stays true.

IMPORTANT: It is highly recommended to set this value to be less than the value entered for the Run Every field of the Default Model page, which relates to scheduled runs.

Live data trigger feeds

These parameters are used to configure alarms that will trigger projection runs in IWLive Pro.

Alarm Name

Name of the alarm (should be unique).

Enable

 Check this option to enable the alarm so its condition is evaluated.

It may be useful to disable alarms whenever incoming SCADA values are known to be incorrect or if they are missing.

Feed Name

Name of the feed.

This dropdown list contains all the available feeds, as specified in the Live Data Feed page of the live data object.

Tip: If more than one live data configuration object is selected on the Live Data Options page, only feeds from the first live data configuration will be available from the Feed Name dropdown list.

Test Criterion

Available comparison operators:

  • <
  • <=
  • =
  • >=
  • >

Critical Value

Fixed value, which combined with the test criterion constitutes the condition of the alarm that will be evaluated.

Time Window

Time period during which the alarm condition is to be evaluated.

This is typically between now and the preceding N minutes.

Critical Percentage

Defines the minimum amount of time that the alarm must be ON within the time window for a projection run to be triggered. This value is expressed as a percentage of the time window total duration.

A critical percentage of 50% indicates that the alarm condition must be true during at least half the time of the time window for projection runs to be triggered.

 

This page is used to specify one or more solute data objects for water quality simulations.

ClosedShow image

Water Quality page of the Baseline property sheet

The solute data objects specified in this page can be used when creating new water quality incident or response runs in IWLive Pro Operator. IWLive Pro projection runs use the solute data from the default simulation (simulation specified on the Default Model page of the baseline property sheet). If the base simulation has a solute object then that will always be available and will be used in projection runs. This allows alternatives to be offered when the user creates incident or response runs.

Closed

This page is used to create, manage and run PressureWatch / QualWatch models. PressureWatch and QualWatch are real-time water network monitoring and anomaly detection modules. See PressureWatch and QualWatch for more information.

ClosedShow image

Watch Configuration page of the Baseline property sheet

Note

Most fields present in this dialog are editable for checked out baselines only (unless stated otherwise). They are read-only for checked-in baselines.

Item Description

Active on IWLive Pro Server

Active model - Defines the model that will be run by the IWLive Pro Server.

Configure IWLive Pro Server - Click this button to display the PressureWatch / QualWatch Server Configuration dialog where settings can be entered for the running of PressureWatch / QualWatch models.

Activate - Always available

Enable this option to activate the active model. This means that if the IWLive Pro Server is running, it will also run the PressureWatch / QualWatch model and generate PressureWatch / QualWatch forecasts and write them into the export database.

Note

The IWLive Pro server only runs the active model. In other words, only one PressureWatch / QualWatch model can be run for a single baseline.

New models

New model - Click this button to create a new PressureWatch / QualWatch model. This displays the PressureWatch / QualWatch Model dialog where the new model can be configured.

Import Model file - Click this button to display a standard File Open dialog. Select a PressureWatch / QualWatch file (.job extension) and click Open.

Copy - Copy the model currently selected in the Model to modify dropdown list. Selecting this option will open the PressureWatch / QualWatch Model dialog of the copied model. Edit as required.

Manage existing models

Model to modify - Contains the available PressureWatch / QualWatch models. Select a model.

View / Edit - Always available

Click this button to display the PressureWatch / QualWatch Model dialog for the model currently selected in the Model to modify drop down list.

Delete - Delete the model currently selected in the Model to modify dropdown list.

Important

The Delete button should be used with care as deletion is immediate.

Set as active model - Click this button to set the currently selected model as active model. The model will appear in the Active model box.

 

Using baselines

Baseline Validation Messages

About version controlled objects

Open Data Import Centre dialog

IWLive switch controller

Integrating with DemandWatch