Tools

MIKE Workbench contains a range of tools able to be executed on time series.

These tools can be configured to be executed from the ribbon of MIKE OPERATIONS.

The output of the tool will be displayed as a chart in case the output of the tool is a time series.

Create and configure tools from the General Settings page by clicking the Tools button.

The dialog will display the tools configured.

Click the Add button to add a new tool configuration.

Click the Details button to configure the tool.

• Active
  Activate the tool by checking this field.
  
• Id
  Id of the tool. The id is used as reference.
  
• Name
  Name of the tool configuration, shown in the ribbon
  
• Description
  Description of the tool.
  
• Tool Name
  Name of the tool in MIKE Workbench to execute.
  
• Execute on Time Changed
  Specify if the tool should be executed when the date time changes in the UI.
  When checked, the Date Time Property Name and the Date Time Property Value of the tool should be specified.
  This will animate (update) the chart shown for the tool when the current time changes.
  
• Date Time Property Name
  Specifies what property of the tool contains the current date time.
  The value specified in Date Time Property Value will be passed to the tool in this tool property.
  
• Date Time Property Value
  The value to pass to the tool in the selected Date Time Property Name, when the current date is changing.
  
  • Current Date Time
    The current date time of type DateTime.
  • Seconds after ToF
    Number of seconds after Time of Forecast.
  • TimeSpan after ToF
    The current date time as a time span (type TimeSpan) after Time of Forecast.
• Ribbon Page Name
  The name of the ribbon page where the button of the tool is shown.
  
• Group Name
  Group name sets the group of the tool 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.
  • 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 (default)
    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 tool is not shown in the ribbon.
• Resource Image Name
  Resource images are a list of built in images for tools.
  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 tool. When selecting themes in the ribbon, the ribbon item of the tool will be displayed if it belongs to the theme selected.
  If no theme is specified on the tool, the ribbon item of the tool will be displayed no matter what theme is selected in the ribbon.
  
• Show on Web
  Check box indicating whether the tool is available in MIKE OPERATIONS Web.
  Note that tools are currently not supported in MIKE OPERATIONS Web. Use jobs for executing tools in MO Web.
  
• Properties
  The properties tab page will show the properties of the tool. Tool properties can be changed and is saved in MIKE Workbench with the name of the configuration and the id of the tool configuration.
  Tool property values supports using placeholders so that values are set when executing the tool.
  Note that placeholders are only supported for string properties and when the tool is allowing to specify placeholder tags in the property.
  Some tools are doing validation when typing the property value. In this case placeholders are not supported.
  

Chart Styles

As a tool output can contain more time series, 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.
• 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.
  

Annotation Lines

Annotation lines are lines added to the chart, without showing the line in the legend.

Click Annot. Lines to configure the annotation lines.

• Color
  Color defines the color of the annotation line.
  
• Line Style
  Line Style defines the line style of the annotation line.
  
• Size
  Size is the line thickness of the annotation line.
  
• Value
  Value defines the fixed value of the annotation line in the chart view.
  
• Secondary Axis
  Checking the secondary axis check box tells that the annotation line should be applied to the secondary y-axis (right hand side).
  
  
• Label
  Specifying a label, will display a label above the annotation line in the chart view.
  
   

Tool Property Value Placeholders

Tool property values support using placeholders.

Tool property value placeholders, all have the format [Table.Field] for (Empty) only the field name is specified though. Empty refers to the first station in selected list of stations.

The following is a sample of a setting a tool property value with place holders.

/Simulations/[Configuration.Name]

Static .Net placeholders are supported e.g. [System.DateTime.Now].

Note

Note that placeholders are case sensitive.

The table below shows the available 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.
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	Date time used for generation.
	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.