Share
 
 

Setup Page

ICMLive functionality is only available if the ICMLive option is enabled on your licence.

This page of a manifest is used to specify a default run, an alert definition list and run parameters.

Manifest - Setup page

Page description

Field

Description

Default run

The default run may contain multiple simulations.

Default alert definition list

The list of alerts, as specified in an alert definition list, that are to be used for a run.

Verification alert definition list

The list of alerts, as specified in an alert definition list, that to be used for verification of a run.

Parent manifest

The manifest that is to act as a parent.

Use in conjunction with the Parent run trigger to trigger full runs in the current 'child' manifest when an alert occurs in the parent run. See Alert Triggered Runs for further information.

Choose the baseline sim

Dropdown of all simulations included in the Default run.

Select the simulation to be used as the baseline simulation.

The baseline sim is used for all full runs and observed runs. Other simulations associated with the default run may be run as variant simulations when triggered by an alert.

Run schedule

Run schedule parameters:

Field Description
Start full runs at

Time at which the Innovyze Live Server is to start performing full model runs.

Start observed runs at

Time at which the Innovyze Live Server is to start performing observed model runs.

Delay time for data collection

Length of time to be allowed for external data to be loaded.

Full run frequency

Frequency at which a full run is initiated by the Innovyze Live Server.

Tip: Specifying this parameters is only compulsory if no External trigger file is defined.
Observed run frequency

Frequency at which an observed run is initiated by the Innovyze Live Server.

Triggered full run frequency

How often a full run is initiated by Innovyze Live Server, once the alert trigger has been set. When the alert trigger has been set, observed runs will stop and there will be full runs at the specified Triggered full run frequency. These runs will use the Triggered forecast period if it is specified instead of the Forecast period.

Full run trigger

Dropdown of all categories defined in the selected Alert definition list.

Select the alert category which is to act as the trigger for full runs. See Alert Triggered Runs for further information.

Hindcast period

A run will have a start time and an end time. The run duration (end time – start time) is equal to hindcast period + forecast period. The hindcast is typically the time in which measured data values are input to the model (e.g. known telemetry values will be fed to the model).

Forecast period

Time for which model predictions are required. Data can still be fed to the model during this time, and will typically be rainfall radar forecast data.

If a Triggered forecast period is set, this will be used instead of the Forecast period for a Full run trigger run during the specified Triggered full run frequency.

Save state offset prior to origin

Controls whether the model state is to be saved before the run origin.

The run origin is the time at which the hindcast ends and the forecast begins. When this option is selected, the state of the model is typically saved in the hindcast, at a point where measured data values are known to be present and correct. After this time, the measured data values may not be present for all parts of the model or they may, potentially, have inaccuracies.

Don't use saved states older than Each full run uses the state from an older run, in order to provide a starting point for the simulation. When this option is enabled, saved states are not to be used from runs older than this value, relative to the hindcast start.

External trigger file

Path of the trigger file to be used to externally initiate simulations in ICMLive Operator Client (optional). See Externally Triggered Runs.

Note: Automatic runs cannot be externally triggered in ICMLiveOperator Client if the manifest mode of operation is set to Manual runs only.

External trigger files may be any valid windows path, including network paths. Some examples are given below:

  • C:/temp/run_me1.txt
  • D:\implementation\triggers\A1.xml

  • \\ukwal1s01\users\data\smithj\triggers\mytriggerfile.xml

A blankfield indicates that ICMLive Operator Client users will not be able to generate externally triggered runs.

Run variants

Frequency with which variant simulations will be run:

  • Never - do not run variant simulations
  • Always - run variant simulation every time a run is initiated
  • Variant trigger - only run variant simulations when an alert of category specified as the Variant run trigger occurs.
Variant run trigger

Dropdown list of all categories defined in the selected Alert definition list.

Select the alert category which is to act as the trigger for variant runs. See Alert Triggered Runs for further information.

Parent run trigger

Dropdown list of all categories defined in the Alert definition list specified in the Parent manifest.

Select the alert category which is to act as the trigger for child runs. See Alert Triggered Runs for further information.

Trigger expire delay

A time that specifies the delay added to any run triggers (full, variant or parent) after which the run frequency will return to normal full-run frequency.

A trigger can only be delayed if the Run triggers persist (manual reset only) box is unchecked.

See Alert triggers expiry time for further information.

Verification frequency The frequency at which verification should be performed.
Triggered verification frequency The frequency at which verification should be performed when the Triggered full run frequency is in operation.
Enable preprocessor TSD updates

Determines whether or not the preprocessor should perform TSD updates for automatic runs (including verification runs). Default is On, which ensures that all live runs will have the most up to date time series data available.

If the Data Loader is installed and running then it will also perform updates according to its set schedule eg, every 30 minutes. However, use of the Data Loader to perform TSD updates in conjunction with the preprocessor can cause performance issues. Therefore, this option can be turned off.

Triggered forecast period

Time for which model predictions are required during the specified Triggered full run frequency for a Full run trigger run.

If a Triggered forecast period is not set, the specified Forecast period will be used.

Run triggers persist (manual reset only)

Indicates whether or not the run frequency is returned to the normal full-run frequency manually. If checked (default), the run frequency can only be changed manually by the user.

If unchecked, then the run frequency returns to normal automatically, after the time specified by the Trigger expire delay field.

Mode of operation

The following modes are available:

Normal - Manifest schedule to run as specified.

Manual runs only - Runs can only be generated manually by the user in ICMLive Operator Client (these runs can be full runs or observed runs).

Ignore alert triggers - Alert triggers will be ignored. Users may wish to select this option if there is a spurious alert that keeps triggering full model runs unnecessarily.

Tip: Changing the mode of operation of existing manifests may be permissioned and therefore this field will be read-only to users who have not been granted appropriate rights.
Sims run on

Supports the running of automatic simulations and alerts on a specified device.

A dropdown of the system device options:

  • Default- The manifest will use the Live Server system default device. This is the default manifest runon device.
  • Any computer- The Live Server will instruct its local sim agent to schedule, via the coordinator, the simulation or alert to run on any compatible computer that is available for work. This is equivalent to specifying SimControl.RunOn=* in the Server Configuration Manager (see Live Server Administration Guide for further details).
  • Server computer- The Live Server will instruct its local sim agent to schedule the simulation or alert to run only on its local sim agent. This is equivalent to specifying SimControl.RunOn=. in the Server Configuration Manager (see Live Server Administration Guide for further details).

Alternatively, you can overwrite the above options to define any device to be used as the runon device for the manifest. A device may be either a computer name or group name defined by the sim agent coordinator. When this type of device is configured, the Live Server will instruct its local sim agent to schedule, via the coordinator, the simulation or alert to run only on the device specified here.

Note:
  • In any of the Run Schedule fields, for which there is a default value, and the current value is removed (deleted or cut) by the user, then InfoWorks ICM automatically sets the blank field to 0h. This is to prevent InfoWorks ICM from automatically overwriting the field with the default value when the manifest is saved.
  • In the Run Schedule section, times and time periods should be specified using d, h and m for days, hours and minutes e.g. start full runs at 09:00 would be specified as 9h. Delay time for data collection of 15 minutes would be specified as 15m.

Alert triggers expiry time

The manifest includes a Trigger expire delay parameter which allows you to specify the number of minutes after a run has been triggered, for that trigger to expire, and for the run to return to its normal run schedule.

After a run, InfoWorks ICM checks the manifest to see if any alert categories are set as triggers (full, variant and parent). For each category, it finds the latest alert end time in that category and adds the Trigger expire delay to that time in order to calculate the time at which the alert could expire (become inactive and run frequency to return to the normal run schedule).

If one of the triggers occurs, then the following information is recorded in the appropriate manifest :

  • a run has been triggered
  • when it will expire
  • the run ID that triggered it
  • run ID of the last run to update the trigger expire time

If the manifest is already triggered, then the new expiry time is compared to that already in the manifest. If it is later, then the time is updated (it is never brought forward) and the run ID that updated the expire time recorded.

If the run origin is after the expiry time for a trigger, then it is reset, and the run frequency returns to a lower state.

Note:
  • The variant triggered state is higher than the full run trigger state. If the variant trigger expires but the full run trigger is set, then the new state will be triggered full frequency but without variants. If the manifest has its variant trigger set, the setting and resetting of the full run trigger will make no difference.
  • If any of the children included in a manifest in a current run have a parent trigger configured, and this has occurred in the run, then the child’s full run trigger will be set or updated. A parent will only reset a child’s full run trigger if the child has a parent trigger configured but not a full run trigger. If the child has a full run trigger configured, then the run of the child will determine when that expires.
Parent topic: Manifest

Was this information helpful?