Feature Types¶
Feature types are the central point of the MIKE OPERATIONS configuration. Feature Types contains information about layers to display and specifies relations between Feature Classes, observation time series and model input and output.
Feature Type Spreadsheet¶
The feature type spreadsheet is automatically created in MIKE Workbench when making a new configuration.
The spreadsheet is named Feature Types and placed in the spreadsheet manager under the configuration folder as shown below.
Create a Feature Type¶
When creating a Feature Type, a new tab item is displayed in the application menu, for each active feature type.
Here all point features, multiline features and polygon features can be configured; specifying thresholds, time series and model object references. From MIKE Workbench, it is also possible to edit the entire feature type spreadsheets.
In the Feature Type list, click the New button.
This will create a new line in the list of feature types.
Click the Details button to enter the details form of the Feature Type.
The Details form shows all properties of the Feature Type.
- Active
The Active checkbox is used to enable or disable the feature type.
Disabling the feature type will hide the feature type all over MIKE OPERATIONS.
- Id and Name
Give the feature type an Id and a Name.
Id is used as reference in spreadsheets. The name is used as display name in MIKE OPERATIONS.
- Description
Description is optional and can contain more lines of text.
The description field will be shown in tool tips.
- Layer Type
The Layer Type, defines the type of layer on the map.
- Static Feature Layer
Static Feature layers are fixed feature layers placed in the GIS Manager of MIKE Workbench. The colours of the static feature layers are determined by the default symbology of the layer specified in MIKE Workbench. - Static Raster Layer
Static Raster layers are fixed raster layers placed in the GIS Manager of MIKE Workbench.
The colours of the static raster layers are determined by the default symbology of the layer specified in MIKE Workbench. - Dynamic Feature Layer
Dynamic Feature layers are layers where colors are determined by thresholds setup on each feature of the feature class specified.
Feature Types of this type must have a spreadsheet specified, where information of the feature types features can be stored. - Traces Raster Layer
The Traces Raster Layer is supported in MIKE OPERATIONS Web.
Note that traces layers are not visible in the desktop version of MIKE OPERATIONS.
- Mesh Raster Layer (Web)
The Mesh Raster Layer is only supported in MIKE OPERATIONS Web. The layer shows the items of a dfsu file (2D or 3D), as well of vectors of the dfsu file.
Symbology of dfsu file can be configured in a XML file with the following name pattern<dfsu file name> .<item name>.symbology.xml
A sample XML file can be created, using the remote file provider for dfs2 files in the GIS manager of MW. Change the symbology of the dfs2 file and save it as a workspace default. - Particle File Layer (Web)
Shows a XML Particle File on MIKE OPERATIONS Web. - Grid Raster Layer (Web)
The Grid Raster Layer is only supported in MIKE OPERATIONS Web. The layer shows the items of a dfs2 file (2D or 3D), as well of vectors of the dfs2 file.
Symbology of dfs2 file can be configured in a XML file with the following name pattern<dfsu file name> .<item name>.symbology.xml
A sample XML file can be created, using the remote file provider for dfs2 files in the GIS manager of MW. Change the symbology of the dfs2 file and save it as a workspace default.
- Static Feature Layer
- Visibility
The visibility of the layer. Changing this property will determine in what views the feature layer is visible.
- Always
The layer is shown in both the ribbon and the navigation panel. - Map
The layer is shown in the ribbon only. - Navigation Panel
The layer is only shown in the navigation panel.
- Always
- Show at Startup
How the feature type should be displayed on the map when starting up.
- Default
By default, the feature type will be displayed on the map if the feature type is of the layer type Dynamic Feature Layer. - Yes
The feature layer will be displayed on the map at startup. - No
The feature layer will not be displayed on the map at startup.
- Default
- Spreadsheet Path
Spreadsheet Path is the path in the Spreadsheet Manager of the MIKE Workbench to the spreadsheet containing all MIKE OPERATIONS information about the feature type and its features.
Spreadsheets are created with the Create Spreadsheet functionality.
To create a new spreadsheet, click the Create Spreadsheet button.
- Ribbon Page Name
The name of the ribbon page where the button of the feature type is shown.
- Group Name
Group Name sets the group of the feature type in the ribbon.
- Ribbon Item Type
Ribbon Item Type controls the type of control added to the ribbon.
- Check Item
A simply check item. - Gallery Check Item
A Check Item added to a gallery of items (default). - Menu Check Item
A Menu Item added to a menu.
The path of the menu is specified in the Group name field, separating each sub menu entry with a vertical bar|
. E.g.My Group|Menu button name|First parent menu|Second parent menu
.
Images of each menu item can be specified by adding Feature Types for each sub menu.
- Item
A simple Item like Check Item without check mark functionality. - Menu Item
A Menu Item like Menu Check Item without check mark functionality. - Hidden (Always on)
The feature type is not shown in the ribbon, but is always shown on the map control.
- Check Item
- Resource Image Name
Resource images are a list of built-in images for Feature Types, Layers and Thresholds.
Clicking the dropdown, will display the available images.
The selected image will be used where the feature type is displayed, E.g. in the ribbon, in tooltips and the Table View.
Images with a_32
postfix, has an initial size of 32x32 pixels. Images without a postfix, has a size of 16x16 pixels.
The initial size has an impact on the quality of the image when displayed in MIKE OPERATIONS.
- Document Image Path
Document Image Path is for additional user images placed in the Document Manager of the MIKE Workbench.
Images specified in this path will overwrite the image specified in the Resource Image Path.
- Theme
Select a Theme of the feature type. When selecting themes in ribbon, the layer will be displayed if it belongs to the theme selected.
If no theme is specified, the layer will be displayed for any theme selected.
- Show on Web
Check box indicating whether the layer is shown in MIKE OPERATIONS Web.
- Feature Class Path
Feature Class Path is the path to the feature class in the GIS Manager of MIKE Workbench.
MIKE OPERATIONS supports feature types containing points, without specifying the feature class. This is because point features contain coordinates in the spreadsheet.
For polygon and line feature types, the Feature Class is mandatory.
- Id Attribute Name
Id Attribute Name specifies the name of the attribute of the feature class specified in Feature Class Path, containing the id of each feature. The value of the Attribute for each feature, must match the value of the Id in the spreadsheet.
- Raster Path
Path to a raster when using static raster layers.
The raster can be a temporal raster containing more time steps.
The time step of the temporal raster shown, will follow the current data time of the configuration.
- Traces X-Path
Path to a raster defining the path for the x-coordinates of a traces layer. Displaying traces layers are available in MIKE OPERATIONS Web only.
- Traces Y-Path
Path to a raster defining the path for the x-coordinates of a traces layer. Displaying traces layers are available in MIKE OPERATIONS Web only.
- Layer File Path
The path on disk to the file for the following layer types:
- Mesh Raster Layer (Web)
- Particle File Layer (Web)
- Grid Raster Layer (Web)
When showing one of the layer types above, all items of the file will be available in the ribbon as a drop down menu in MIKE OPERATIONS Web.
- Vector Scale Factor
Factor for scaling the size of the vectors of dfsu and dfs2 files on MIKE OPERATIONS Web.
The default value is 1000.
- Map Label Type
For dynamic feature types, a label can be shown on the map.
The following label can be shown:- None (default)
No label is shown on the map. - Name
The name of the station. - Value
The current threshold value of the station. - Name and value
Both name and threshold value is shown.
- None (default)
- Layer Transparency
For dynamic feature layers, the layer transparency can be specified.
The transparency can take values in the range 0 to 100. Where 0 is not transparent and 100 is completely transparent.
The default value is -1. This means that for polygon layers the layer transparency is set to 60. For line and point layers, the layer transparency is set to 0.
For static layers, the layer transparency can be set using the default symbology of the layer.
- Time Series Button
Click the Time Series button of the feature type to configure the time series of the feature type.
(Click twice - first select then open)
- Thresholds Button
Click the Thresholds button of the feature type to configure the thresholds of the feature type.
!!! note Click twice on the Thresholds button (first select the row/control then open). - Period Interval Unit (Scenario Mode only)
Period Interval Unit, specifies the unit of the scenario period interval used in scenario mode for changing the input time series.
- All time steps
All time steps of the input time series being changed are shown. - Minutes
Rows for input time series are specified in minutes. The period length is specified in Period Interval. - Hours
Rows for input time series are specified in hours. The period length is specified in Period Interval. - Days
Rows for input time series are specified in days. The period length is specified in Period Interval. - Months
Rows for input time series are specified in months. The period length is specified in Period Interval. - Custom Period
The period intervals of the input time series are specified in the Tabular Data View when in scenario mode. This option supports changing time series as both values and factors.
- All time steps
- Period Interval (Scenario Mode only)
Specifying period intervals for custom period.
Specifies the period length of the scenario input time series in scenario mode.
This setting is not available for Unit All time steps.
Time Series¶
In order to display time series in Chart View and in the Time Series View for feature types, time series must be configured on each feature type.
Use the up and down buttons to sort the time series in the time series and chart views.
Click the Details button, to configure the Time Series.
- New Time Series
Click the New button to create a new Time Series on the Feature Type.
- Active
The Active checkbox is used to enable or disable the time series.
Disabling a time series will hide the time series in Charts and Tables.
- Id and Name
Give the time series an id and a name.
Id is used as reference in spreadsheets. The name is used as display name in MIKE OPERATIONS.
- Description
Description is optional, and can contain more lines of text.
Description is only for additional information about the time series, and will not be display elsewhere.
- Themes
Specify the theme where the time series is visible.
If no theme is selected, the time series is displayed on all themes.
- Time Series Type
Time Series Type can have 7 different values
- Time Series – Specifies that the time series is a simple observation time series. Observation time series are references with the path in the Time Series manager of MIKE Workbench.
- Model Input Time Series is time series used as input to the specified model referenced with the model object and the model object variable.
- Model Output Time Series is results from the model specified referenced with the model object and the model object variable.
- Spatial Model Output Time Series - is spatial output from the model, like flood maps.
- Skill Scores – is skill scores calculated using R-Statistics, based on collected historical observations and simulations.
- Confidence Interval – is confidence intervals calculated using R-Statistics, based on collected historical observations and simulations.
- Goodness of Fit – is goodness of fit calculated using R-Statistics, based on collected historical observations and simulations.
Note that only Model Input Time Series can be changed when working with scenarios in MIKE OPERATIONS.
- Add Accumulated Time Series
For step accumulated time series, it is possible to display the accumulated time series for the given time series.
Check to display the accumulated time series in the chart view.
- Display Relative Values
If z-values have been specified for the station, and if this check box has been checked for the time series, values in MIKE OPERATIONS will be displayed as relative values (value – z-value).
- Time Step Interval
Specify how time steps for the time series should be resampled and displayed.
- Simulation
Use the time steps intervals of the latest simulation. - All time steps
All time steps of the time series will be displayed. - Custom
Use custom time steps specified by the two fields: Custom Time Step Unit and Custom Time Step Length.
- Simulation
- Custom Time Step Unit and Length
Specifies the unit and length of the time steps used for the time series.
- Enable Edit
When checking the Enable Edit field, the time series can be edited from the time series view.
Right click the column to edit and select Edit Time Series from the context menu.
Note that Enable Edit is only supported for time series type Time Series. - Enable Change Log
Enables the change log forcing users to write log a text with the change, when editing the time series from the time series view when enabling edit.
Ensemble¶
Select the Ensemble group to configure how to display ensemble time series for the time series type.
- Ensemble Extraction Mode
Time series will be extracted according to the Ensemble Extraction Mode.
The following modes are supported:- Extract all – Extracts all time series in the ensemble.
- Extract selection – Extracts the time series specified in the Member selection field.
- Maximum – Displays the maximum value of each time step for all time series in the ensemble.
- Mean – Extracts the mean value for each time step, of all time series in the ensemble.
- Minimum - Displays the minimum value of each time step for all time series in the ensemble.
- Quantile – Displays the quantile values for each time step of all time series in the ensemble.
- Standard deviation – Extracts the standard deviation for each time step.
- Exceedance – Extracts the ratio of ensemble members exceeding the specified value for each time step.
- Non exceedance - Extracts the ratio of ensemble members not exceeding the specified value for each time step.
- Member selection
Comma separated list of members to include in the selection (e.g.1,2,6
).
Member selection is only used in mode Extract selection.
- Probability
Sets the probability for the quantile statistics option. Probability is a comma separated string with the quantile percent values (e.g.10,25,90
). Percent values must use decimal points.
Probability is used for EnsembleExtractionMode = Quantile only.
- Exceedance Constant
Sets the Exceedance Constant value option.
Exceedance Constant is used for Extraction Mode = Exceedance and Non exceedance.
Chart Styles¶
As time series can contain more series (e.g. an ensemble), the style of each time series can be configured clicking the Chart styles button.
The chart styles are applied to time series in the same order as appearing in the list of chart styles.
Click New to create a new chart style, and Details to configure the chart style.
- Chart Type
The type of the chart in the Chart View.
- Color
Color is the color of the line or bars (for step accumulated time series) of the time series.
- Line Style
Line Style is the line style of the time series in the Chart View.
- Marker Style
The style of the point marker in the Chart View.
The size of the marker will be set to the size of the line multiplied by 5.
- Size
Size is the line thickness of lines or marker in the Chart View.
-
Marker Color Style
Configure the marker color style.
- Line Color
The marker will have the same color as the line. - Threshold Color
The marker will have the color as the threshold at the time where the marker is placed on the chart. - Custom Color
The marker will have a fixed color defined in the Custom Marker Color property.
- Line Color
-
Custom Marker Color
Color of the marker when Custom Marker Color is selected in Marker Color Style.
- Chart Area Index
The chart area index, defines in what chart area the time series should be displayed.
The index will not define the order of the chart areas, as the order is defined by the order of the time series in the list of time series.
- Show Vertical Lines
Shows vertical lines in the chart for every x-value.
The marker color defines the color of the vertical line.
Vertical lines are applied when there is only one time series in the chart area.
- Use X-Axis Point Labels
X-axis labels and a fixed x-axis grid are shown for every x-value of the time series.
Additional label lines are added if comments have been specified on the time steps. To have more label lines, the comment of the time step should be separated by a semicolon.
Note that vertical lines are applied when there is only one time series in the chart area.
Scenario¶
Any input time series can be changed in scenario mode. Simply check the Support Scenario Mode check box, to make the input time series editable in Scenario Mode.
- Support Scenario Mode
Check this checkbox, if the input time series should be editable in Scenario Mode and available when creating Scenario Templates.
Checking this checkbox for Output Time Series and Observation Time Series will not make the time series editable; only display the time series in Scenario Mode.
- Time Series Stop Value (Scenario Mode only)
Stop values used when creating input time series to make sure that the input time series covers the entire forecast period.
- Promote Scenario
Input time series supporting scenario mode, can be promoted to the time series mapped to the related input time series of the forecast scenario.
Promote Scenario of the input time series can have the following values:- No
The input time series cannot be promoted. - Forecast
The forecast period of the input time series is promoted. - Hindcast
The hindcast period of the input time series is promoted. - Simulation
The entire simulation period of the input time series is promoted.
- No
Statistics¶
MIKE Workbench and MIKE OPERATIONS support displaying analysis calculated by R-Statistics.
When analysis has been performed from MIKE Workbench, the results can be displayed in MIKE OPERATIONS.
- Statistics Results
For Skill Scores and Goodness of Fit calculations, analysis results are saved in spreadsheet in the MIKE Workbench.
Specify the Results Spreadsheet by clicking the eclipse button of the input control.
- Error model
For Confidence Intervals, the results of the analysis are saved as error models in the document manager of the MIKE Workbench.
Select the error model from the Error model drop down box.
- Measure Selection
For each statistics type, a list of available measures can be selected. Select the measures to be displayed for each station in the check box list.
- Reference Time Series
Specify the reference time series used as base for the statistics.
Feature Type Thresholds¶
Click the Thresholds button to manage the thresholds for the feature type.
Thresholds are shared by all the time series configured on 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.
- New Threshold
Click the New button to create a new threshold on the feature type.
- Image
Image displays the image as it will look in on the map, in tooltips and in the Table View.
- Name
Give the threshold a name.
The name is used both as reference and as display name in MIKE OPERATIONS.
- Themes
Select the theme(s) where the thresholds should be used.
The thresholds is only used if the theme is selected.
If no themes are selected, the threshold 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, has an initial size of 32x32 pixels. Images without a postfix, has 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 the Alert checkbox if a time series value should cause an alert when the threshold value is exceeded (used in the publication, see next section).
- Messages
Alert messages can be configured clicking the Messages button.
(used in the publication, see next section)
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 place holders, so that field values can be inserted into the message text.
- Mail Subject
The mail message subject.
(The Mail Message Place Holder[simulation.TimeOfForecast]
shows the actual time of forecast – available Message Place Holders are listed below).
- Mail Body
The mail message body.
(The Mail Message Place Holder[simulation.TimeOfForecast]
shows the actual time of forecast – available Message Place Holders are listed below)
- SMS Message
The SMS Message text.
Use%0a
as a newline. E.g.The first line%0aThe second line
.
Message Place Holders¶
Mail messages support placeholders for data, defined messages and static .Net properties.
Mail massage placeholders, all have the format [Message.<Message name>]
or [Table.Field]
for (Empty) only the field name is specified though.
Empty refers to the first feature in the generated list.
The following text is samples of a message texts with place holders.
[WarningLevel.Name] alert for simulation of [Simulation.SimulationStartDate] for the following stations.
[Message.MSG1].
Properties for static .NET API properties are supported e.g. [System.DateTime.Now]
.
Note
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. | |
(Empty) | Description | |
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 | |
Application | ActiveUser | The current user (login). |
ActiveWorkspace | The active workspace (schema of the database). | |
LoggedInUserRole | The user role of the user (workspace_lead, workspace_member, workspace_reviewer). | |
ActiveConnection | The active connection. | |
Database | The current database name. | |
Configuration | Name | |
Description | Description of the configuration. | |
CurrentDateTime | The current date time of the configuration. | |
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.
- 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 is 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 de activate the item. Deactivated items are not shown in the navigation panel and on the map.
- Documents
Click 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 what extent 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 e.g. 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 a section about placeholders for more information about what placeholders are supported.
- Custom Data
Specify custom data for the item.
The available custom data are defined in the General Settings Page.