Feature Configuration
Feature Type Thresholds¶
Click on the Thresholds button to manage the thresholds for the feature type.
Thresholds are shared by all the time series configured for the feature type.
Use the ‘Move up’ and ‘Move down’ buttons to change the order of the thresholds.
The threshold with the lowest value must be placed first.
Item | Description |
---|---|
New Threshold Click on the ‘New’ button to create a new threshold on the feature type. |
|
Image Image displays the image as it will look on the map, in tooltips and in the Table View. |
|
Name Give the threshold a name. The name is used both as a reference and as display name in MIKE OPERATIONS. |
|
Themes Select the theme(s) where the thresholds should be used. The thresholds are only used if the theme is selected. If no themes are selected, the thresholds are always used for threshold calculation. |
|
Color Specify the color of the threshold image. |
|
Symbol Specify the symbol type of the image. Bitmap requires that an image path is specified in ‘Document Image Path’. Only point feature types will use this property. |
|
Size Specify the image size. Only point feature types will use this property. |
|
Document Image Path For Symbol type “Bitmap”, a custom image can be specified for the threshold. The size of the image is determined by the Size field. Document Image Path specifies the path in the Document Manager of MIKE Workbench. Note that Document Image Path will override the image specified in Resource Image Name. |
|
Resource Image Name For Symbol type ‘Bitmap’, a built in list of images can be selected as image for the threshold. Images with a ‘_32’ postfix have an initial size of 32x32 pixels. Images without a postfix have a size of 16x16 pixels. The size of the image is determined by the Size field. The initial size has an impact on the quality of the image when displayed in MIKE OPERATIONS. Note that Document Image Path will override the image specified in Resource Image Name. |
|
Alert Click on the Alert checkbox if a time series value should cause an alert when the threshold value is exceeded. |
|
Messages Alert messages can be configured clicking the ‘Messages’ button. |
Alert Message Setup¶
Alert messages can be configured in the alert message setup form by clicking the ‘Message’ button for the threshold.
Alert messages, mails, and SMS messages are by default generated with the message setup from each threshold.
Messages of the threshold with the highest rank (from the end) will be used.
All messages support placeholders, so that field values can be inserted into the message text.
Item | Description |
---|---|
Mail Subject The mail message subject. (The Mail Message Placeholder [simulation.TimeOfForecast] shows the actual time of forecast – available Message Placeholders are listed below) |
|
Mail Body The mail message body. (The Mail Message Placeholder [simulation.TimeOfForecast] shows the actual time of forecast – available Message Placeholders are listed below) |
|
SMS Message The SMS Message text. Use ‘%0a’ as a newline. E.g. ‘The first line%0aThe second line’. |
Message Placeholders¶
Mail messages support placeholders for data, defined messages and static .NET properties.
Mail massage placeholders all have the format [Message.\
For (Empty) only the field name is specified. Empty refers to the
first feature in the generated list.
The following text are samples of message texts with placeholders:
[WarningLevel.Name] alert for simulation of [Simulation.SimulationStartDate] for the following stations.
[Message.MSG1].
Properties for static .NET properties are supported e.g. [System.DateTime.Now].
Note that placeholders are case sensitive.
The table below shows the available data placeholders.
Table | Field | Description |
---|---|---|
(Empty) | Id | Id of the first feature. |
Name | Name of the first feature. | |
Description | Description of the first feature. | |
Value | Value of the first feature. | |
Unit | Unit of the first feature. | |
timestep | The date and time of the current time step in the format yyyy-MM-ddThh-mm-ss | |
Configuration | Name | The configuration name. |
Description | Description of the configuration. | |
CurrentDateTime | The current date time of the | |
ScenarioMode | True if in scenario mode. | |
ScenarioName | Scenario name in scenario mode. | |
ModelSetupPath | The full path to the model setup. | |
ForecastScenarioName | The name of the forecast scenario. | |
GeneralSettingsSpreadsheetPath | The full path of the general settings spreadsheet path. | |
ContactSpreadsheetPath | The full path to the contact spreadsheet. | |
ScenarioTemplatesSpreadsheetPath | The full path to the scenario template spreadsheet path. | |
CheckoutScenarioPath | The path where scenarios in scenario mode is placed. | |
SourceCoordinateSystem | The map source coordinate system. | |
FavoriteBackgroundMap | Name of the favorite background map. | |
Simulation | Name | Name of the simulation. |
Status | Status of the simulation. | |
SimulationStartDate | The simulation Start Date. The placeholder is not changed if no simulation is available. | |
SimulationEndDate | The simulation end date. The placeholder is not changed if no simulation is available. | |
TimeOfForecast | The time of forecast. The placeholder is not changed if no simulation is available. | |
TimeOfSimulationRun | The time of simulation run. The placeholder is not changed if no simulation is available. | |
WarningLevel | Name | Name of the threshold. |
Color | Color of the threshold. | |
Value | Threshold value exceeded. | |
ObservationPeriod | Id | The Id of the Observation period. |
Name | The name of the observation period. | |
Description | Description of the observation period. |
Feature Type Items¶
When a spreadsheet for a dynamic feature type has been created, items of the feature type can be maintained in the backstage view.
A page for each dynamic feature type will be displayed.
Item | Description |
---|---|
Id Id of the item. The id must match the Display attribute of the feature class specified on the feature class (if defined). This will identify the feature of the feature class matching the item in the spreadsheet so that threshold colors and time series can be associated with the feature of the feature class. For point layers, the geometry of a feature can be defined by setting the x- and y-coordinates of the feature. This means that feature types with a point layer do not require a feature class to be specified if x- and y-coordinates are specified. Keep the length of id’s below 50 characters, as this field has been limited to 50 characters due to performance considerations. |
|
Name Name of the item displayed on map tool tips, navigation pane, and time series. |
|
Description Description of the item. |
|
Active Activate or deactivate the item. Deactivated items are not shown in the navigation panel and the map. |
|
Documents Click on the “Documents” button to associate documents of any type to an item. Documents must be imported into the documents manager of MIKE Workbench. Documents associated with an item will be shown as links in the “Documents View” when selecting an item in the navigation pane or the map. |
|
Groups Groups can be used as filter groups to display only groups with a certain name. Groups can be filtered selecting the groups in the navigation pane. |
|
‘Go to’ Themes Select themes to apply when double clicking an item on the map or in the navigation panel. Note that sub themes (child themes) selected as “Go to themes”, will be applied, only if the parent theme of the sub theme is applied in the ribbon. This means that more child themes can be selected as “Go to themes”. In this case, the child theme of the selected parent theme will be applied. |
|
‘Go to’ filter groups Specify groups filters to apply when double clicking an item on the map or in the navigation panel. |
|
‘Zoom to’ Layers Select the layers to “Zoom to” when double clicking an item on the map or in the navigation panel. All stations of the layer defines the zoom extent. |
|
Fixed Resource Image Specify a fixed image to display on the map and in the navigation panel for the item. Note that “Fixed resource images” can only be applied for feature types with point feature layers, and when the feature type does not have a Feature Class specified. |
|
Thresholds Specify the threshold values for the item. Thresholds are maintained on the feature type. Note that there is a set of threshold values for each time series definition of the feature type. |
|
Time Series Select time series and/or input- and output-time series to show when selecting the item. For time series where only a path is specified (Time Series Type = Time Series), placeholders are supported. This means that configuration names and observation periods can be part of the time series name or path. E.g. “/Telemetry/[ObservationPeriod.Name]/WL7160_abs.dfs0” will look for a time series where the observation period name is part of the path to the time series. Please refer to the section about placeholders for more information about supported placeholders. |
|
Custom Data Specify custom data for the item. The available custom data are defined in the General Settings page. |
Observation Periods¶
Observation periods will handle the time period to view when showing time series.
When more than one time series has been created, it is possible to select what observation period to use when showing the time series.
Observation periods are maintained from the General Settings page through the Observation Periods button.
Click on the Details button to configure the Observation Period.
Item | Description |
---|---|
Active Activate the observation period by checking this field. |
|
Id Id of the observation period. The id is used as a reference. |
|
Name Name of the observation period shown in the Observation Period selector form. |
|
Description Description about the observation period. |
|
Group Group in the observation period navigation panel where the observation period should be placed. If the group is not specified, the name of the observation period is used in the navigation panel. Note that for period types “Fixed Dates” and “Relative to Now”, the navigation panel group is set to “Event” and “Relative to Now”, respectively. |
|
Observation Period Type |
|
Relative Period For relative periods (Relative to ToF and Relative to Now), the relative period is defined here. Time Zone can be specified only for Observation Period Type = “Relative to Now”. The time zone specified is used to determine the current time used to derive the Start and End dates of the observation period. |
|
Fixed Dates Specify the period to use for period types “Fixed Dates” and “Relative to Date”. |
|
Relative to Date Specify the length of each period for observation period type “Relative to Date”. Each period will have the length of a day, a week, a month or a year. |
|
Time Series Evaluation Period Specify the evaluation period for threshold calculation for instantaneous and accumulated time series (step_accumulated, mean_step_accumulated, reverse_mean_step_accumulated and accumulated). |
|
Threshold Time Step Specify the length of each threshold time step. This will also be the time step used when increasing and decreasing time in MIKE OPERATIONS. Defines the unit of the time steps. Defines the length of the time steps. The number of time steps to extend the observation period with before and after the start dates. The query period defines the period used to get data from the database on a time series. Extend the period to make sure that time steps are available for interpolation. |
|
Update interval (minutes) The interval where the threshold database cache should be updated. 5 minutes means that the database threshold cache will be updated when selecting the observation period and the existing cache in the database is older than 5 minutes. |
|
Update Specific Times Specific times where the threshold database cache should be updated. (e.g. “20:00;10:00”). The cache will be updated when selecting the observation period and one of the times has been exceeded. E.g if the latest database threshold cache was updated at 20:13 and the current time has exceeded 10:00. |
|
Update Period Period relative to the observation period where the threshold database cache of the observation period should be updated. |
Contacts¶
In order to send alert mails and SMS messages, contact must be created, specifying e-mail addresses and phone numbers to use for alerts.
Contacts can be created and maintained from the General Settings page of the Application Menu.
Click on the ‘Contacts' button to display and maintain the contacts spreadsheet specified in the Contacts Spreadsheet Path.
Item | Description |
---|---|
Active The active checkbox is used to enable or disable Contacts. |
|
Id and Name Give the contact an id and a name. |
|
Description Description is optional, and can contain more lines of text. |
|
E-mail Specify the e-mail address to use for sending alert e-mails. |
|
Language Specify the language used by the contact, used by alert messages and notifications. |
|
Mobile Phone The mobile phone number is the phone number transferred as argument to the SMS Batch file when sending alert SMS messages. |
|
Subscriptions A contact can subscribe to alert messages, so that the contact gets notified when an event occurs. The following alert types are supported: Filter groups can be applied for a contact subscription, so that the contact only gets alerts for stations belonging to a specified filter group. |
Mail Setup¶
In order to send alert mails, a mail account must be configured in MIKE OPERATIONS.
The mail account is setup by clicking the Mail Setup in General Settings.
Item | Description |
---|---|
Server Name The SMTP host name. |
|
Port Number The SMTP port number. Note that sending mails using implicit SSL is not supported. This is normally indicated when using port number 465. This means that port 465 is not supported. |
|
Use SSL Encryption Is SSL enabled? |
|
User Name SMTP domain and user name. |
|
Password SMTP user password. |
|
Name Name shown as from name. |
|
E-mail Address The from (i.e. sender) e-mail address. |
Groups (Filter)¶
Groups are filters, so that features can be filtered in the UI according to the filter groups specified for each feature.
E.g. data quality, area and/or location.
Item | Description |
---|---|
Active Activate the group by checking this field. |
|
Id Id of the group. The id is used as a reference. |
|
Name Name of the group as displayed in the application. |
|
Description Description of the group. |
|
Parent Filter groups support nesting. This means that each filter group can have a parent, specifying where in a hierarchy the filter group is placed. When specifying a parent, selecting filter groups uses a tree like selection control in the navigation panel. |
|
Row count For displaying top or lower count of the features in the Table view according to their threshold value for the specified time. A positive value indicates the top values and a negative value indicates the lower values (E.g. 10 shows the top 10 rows and -5 displays the lower 5 values). |
Set the groups that each feature belongs to in the details view of each feature type (selected from the left part of the application menu, below ‘General Setting’)
Filter groups are selected in the Table View.
Units¶
For any time series type, the units and decimals can be specified.
Click on the ‘Units’ button to display the time series units setup form.
Units are ‘Display Units’. This means e.g. that all water level time series are shown in meters with 2 decimals in the sample above.
More sets of units can be defined. The unit sets defined can be selected in the ribbon.
Item | Description |
---|---|
Unit set The unit set where the unit conversion should be used. The default unit set used is the unit set with no name. This set is also used as the units defining the threshold units. This also means that when defining unit sets, a unit set with no name must always be present. |
|
Value Type The value type of the time series that the unit applies to. The unit will apply to all value types when selecting “All value types”. Using value types is useful when displaying accumulated time series (Show accumulated time series). |
|
Time Series Type The type of the time series. Select the time series type from the combo box. |
|
Display Unit The unit to display for the selected time series type. The time series type defines the available units. |
|
Decimals The number of decimals to show for values of time series of the specified type. |