Skip to content

Tools, Scripts and Jobs

Tools

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

A range of 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 on the ‘Details’ button to configure the tool.

Item Description
Active
Activate the tool by checking this field.		 ./MIKEOPERATIONS-Configuration4/image4.png
Id
Id of the tool.

The id is used as a reference.		 ./MIKEOPERATIONS-Configuration4/image5.png
Name
Name of the tool configuration shown in the ribbon		 ./MIKEOPERATIONS-Configuration4/image6.png./MIKEOPERATIONS-Configuration4/image7.png
Description
Description of the tool.		 ./MIKEOPERATIONS-Configuration4/image8.png
Tool Name
Name of the tool to execute in MIKE Workbench.		 ./MIKEOPERATIONS-Configuration4/image9.png
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.		 ./MIKEOPERATIONS-Configuration4/image9.png
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.		 ./MIKEOPERATIONS-Configuration4/image9.png
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.
    		•  ./MIKEOPERATIONS-Configuration4/image9.png
    Ribbon Page Name
    The name of the ribbon page where the button of the tool is shown.    		 ./MIKEOPERATIONS-Configuration4/image10.png./MIKEOPERATIONS-Configuration4/image11.png
    Group Name
    Group name sets the group of the tool in the ribbon.    		 ./MIKEOPERATIONS-Configuration4/image12.png ./MIKEOPERATIONS-Configuration4/image13.png
    Ribbon Item Type
    Ribbon item type controls the type of control added to the ribbon.
  • Check Item
    A simple 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.
    		•  ./MIKEOPERATIONS-Configuration4/image14.png
    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 have an initial size of 32x32 pixels. Images without a postfix have a size of 16x16 pixels.

    The initial size has an impact on the quality of the image when displayed in MIKE OPERATIONS.    		 ./MIKEOPERATIONS-Configuration4/image15.png
    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.    		 ./MIKEOPERATIONS-Configuration4/image16.png
    Theme
    Select a Theme for 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 for the tool, the ribbon item of the tool will be displayed no matter what theme is selected in the ribbon.    		 ./MIKEOPERATIONS-Configuration4/image17.png
    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.    		 ./MIKEOPERATIONS-Configuration4/image18.png
    Chart Type
    The type of the chart in the Chart View.    		 ./MIKEOPERATIONS-Configuration4/Fig7.png
    Color
    Color is the color of the line or bars (for step accumulated time series) of the time series.    		 ./MIKEOPERATIONS-Configuration4/Fig8.png
    Line Style
    Line Style is the line style of the time series in the Chart View.    		 ./MIKEOPERATIONS-Configuration4/Fig9.png
    Marker Style
    The style of the point marker in the Chart View.    		 ./MIKEOPERATIONS-Configuration4/Fig10.png
    Size
    Size is the line thickness of lines or marker in the Chart View.    		 ./MIKEOPERATIONS-Configuration4/Fig11.png
    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.
    		•  ./MIKEOPERATIONS-Configuration4/Fig12.png
    Custom Marker Color
    Color of the marker when “Custom Marker Color” is selected in “Marker Color Style”.    		 ./MIKEOPERATIONS-Configuration4/Fig13.png
    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.    		 ./MIKEOPERATIONS-Configuration4/Fig14.png
    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.    		 ./MIKEOPERATIONS-Configuration4/Fig15.png
    ./MIKEOPERATIONS-Configuration4/Fig16.png
    Chart Area Index
    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.    		 ./MIKEOPERATIONS-Configuration4/Fig17.png
    ./MIKEOPERATIONS-Configuration4/Fig18.png
    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 support use of placeholders so that values are set when executing the tool.

    Note that placeholders are only supported for string properties and when the tool allows specification of placeholder tags in the property.

    Some tools run validation when typing the property value. In this case placeholders are not supported.    		 ./MIKEOPERATIONS-Configuration4/image19.png

    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. Empty refers to the first station in selected list of stations.

    The following is a sample of setting a tool property value with placeholders:
    /Simulations/[Configuration.Name]

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

    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.
    Configuration Name The 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.

    Scripts

    MIKE Workbench contains a script manager for making Python scripts. These scripts can be configured to be executed from the ribbon of MIKE OPERATIONS.

    Script configured must NOT require parameters to be executed.

    Create and configure scripts from the General Settings page by clicking the ’Scripts’ button.

    The dialog will display the scripts configured.

    Click on the ‘New’ button to add a new script configuration.

    Click on the ‘Details’ button to configure the script.

    Item Description
    Active
    Activate the script by checking this field.    		 ./MIKEOPERATIONS-Configuration4/image23.png
    Id
    Id of the script.
    The id is used as a reference.    		 ./MIKEOPERATIONS-Configuration4/image24.png
    Name
    Name of the script configuration shown in the ribbon.    		 ./MIKEOPERATIONS-Configuration4/image25.png ./MIKEOPERATIONS-Configuration4/image26.png
    Description
    Description of the script.    		 ./MIKEOPERATIONS-Configuration4/image27.png
    Script Name
    Name of the script in MIKE Workbench to execute.    		 ./MIKEOPERATIONS-Configuration4/image28.png
    Ribbon Page Name
    The name of the ribbon page where the button of the script is shown.    		 ./MIKEOPERATIONS-Configuration4/image29.png ./MIKEOPERATIONS-Configuration4/image30.png
    Group Name
    Group name sets the group of the script in the ribbon.    		 ./MIKEOPERATIONS-Configuration4/image31.png ./MIKEOPERATIONS-Configuration4/image32.png
    Ribbon Item Type
    Ribbon item type controls the type of control added to the ribbon.
  • Check Item
    A simple 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 script is not shown in the ribbon.
    		•  ./MIKEOPERATIONS-Configuration4/image33.png
    Resource Image Name
    Resource images are a list of built in images for scripts.

    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 have an initial size of 32x32 pixels.

    Images without a postfix have a size of 16x16 pixels.

    The initial size has an impact on the quality of the image when displayed in MIKE OPERATIONS.    		 ./MIKEOPERATIONS-Configuration4/image34.png
    Document Image Path
    Document Image Path is for additional user images placed in the Document Manager in MIKE Workbench.

    Images specified in this path will overwrite the image specified in the Resource Image Path.    		 ./MIKEOPERATIONS-Configuration4/image35.png
    Theme
    Specify the theme where the script should be shown.

    If no theme is specified, the script is shown on all themes.    		 ./MIKEOPERATIONS-Configuration4/image36.png
    Show on Web
    Check box indicating whether the script is available in MIKE OPERATIONS Web.    		 ./MIKEOPERATIONS-Configuration4/image18.png

    Jobs

    Job links can be added to the ribbon of MIKE OPERATIONS.

    Create and configure jobs from the General Settings page by clicking on the ’Jobs’ button.

    The dialog will display the configured jobs.

    Click on the ‘New’ button to add a new job configuration.

    Click on the ‘Details’ button to configure the job.

    Item Description
    Active
    Activate the job by checking this field.    		 ./MIKEOPERATIONS-Configuration4/image40.png
    Id
    Id of the job. The id is used as a reference.    		 ./MIKEOPERATIONS-Configuration4/image41.png
    Name
    Name of the job configuration shown in the ribbon    		 ./MIKEOPERATIONS-Configuration4/image42.png
    Description
    Description of the job.    		 ./MIKEOPERATIONS-Configuration4/image44.png
    Job Path
    Name of the job in MIKE Workbench to execute.    		 ./MIKEOPERATIONS-Configuration4/image45.png
    Execution Type
    The execution of a job can be performed locally or remotely.    		 ./MIKEOPERATIONS-Configuration4/image46.png
    Host Name
    The name of the computer where the job will be executed.

    This field is only enabled when the Execution Type = ‘Remotely’.    		 ./MIKEOPERATIONS-Configuration4/image47.png
    Targets
    Select the targets to execute on the job.

    If no targets are specified, the Default Target is used.    		 ./MIKEOPERATIONS-Configuration4/image48.png
    Allow Execute
    Checking this checkbox will allow the job to be executed from the ribbon of MIKE OPERATIONS.

    Click on the Execute button to run the job.    		 ./MIKEOPERATIONS-Configuration4/image49.png ./MIKEOPERATIONS-Configuration4/image50.png
    Show Status
    Checking this checkbox, will show the status of previous job runs in the ribbon of MIKE OPERATIONS.    		 ./MIKEOPERATIONS-Configuration4/image51.png ./MIKEOPERATIONS-Configuration4/image52.png
    Ribbon Page Name
    The name of the ribbon page where the button of the job is shown.    		 ./MIKEOPERATIONS-Configuration4/image53.png ./MIKEOPERATIONS-Configuration4/image54.png
    Group Name
    Group name sets the group of the job in the ribbon.    		 ./MIKEOPERATIONS-Configuration4/image55.png ./MIKEOPERATIONS-Configuration4/image56.png
    Ribbon Item Type
    Ribbon item type controls the type of control added to the ribbon.

    For jobs, only “Item” is supported, as the job execution and job status is displayed as a dropdown button in the ribbon.    		 ./MIKEOPERATIONS-Configuration4/image57.png
    Resource Image Name
    Resource images are a list of built in images for jobs.

    Clicking on 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 have an initial size of 32x32 pixels.

    Images without a postfix have a size of 16x16 pixels.

    The initial size has an impact on the quality of the image when displayed in MIKE OPERATIONS.    		 ./MIKEOPERATIONS-Configuration4/image58.png
    Document Image Path
    Document Image Path is for additional user images placed in the Document Manager in MIKE Workbench.

    Images specified in this path will overwrite the image specified in the Resource Image Name.    		 ./MIKEOPERATIONS-Configuration4/image59.png
    Theme Specify the theme where the job item should be shown. If no theme is specified, the job item is shown on all themes. ./MIKEOPERATIONS-Configuration4/image60.png
    Show on Web
    Check box indicating whether the job is available in MIKE OPERATIONS Web.    		 ./MIKEOPERATIONS-Configuration4/image18.png

    Properties

    The properties dialog shows the properties of the job. Job properties can be changed and are saved in MIKE Workbench with the name of the configuration and the id of the job configuration.

    Job property values support using placeholders so that values are set when executing the Job.

    Note that placeholders are only supported for string properties and when the job allows specifying placeholder tags in the property.

    Some jobs are doing validation when typing the property value. In this case placeholders are not supported.

    Click on the ‘Properties’ button to configure the properties of the job.

    Item Description
    Name
    The name of the property on the job in the job manager in MIKE Workbench.    		 ./MIKEOPERATIONS-Configuration4/image62.png
    Property Type
    The type of the property. The type is for making input controls for specifying the properties when executing the job.

    The job properties support the following input control types:
  • Text
    Will show a simple text input control.
  • Number Will show an input control where only numbers can be specified.
  • Boolean
    Will show a check box.
  • Email
    Will show a text box where the e-mail adress
  • Url
    Will show a text box where the url will be shown as a link.
  • List
    Will show a combo box with the values of the list. Specify the list values in the “Value” column as a comma separated string.

    Coordinates
    Job properties of type coordinates, is handled differently in the Desktop version and in the web version. In the desktop version, the property will be a text field with an icon indicating that the field is for coordinates.

    Coordinates can in this case be written or pasted here. It is possible to copy coordinates of a specific point on the map, using the context menu of the map.

    On MO Web, the coordinates field will provide a button for getting the coordinates when clicking the map.
    		•  ./MIKEOPERATIONS-Configuration4/image63.png ./MIKEOPERATIONS-Configuration4/image64.png./MIKEOPERATIONS-Configuration4/image65.png
    Value
    The value of the property. The value supports placeholders.

    By default, the value will be taken from the value of the job property in the job manager in MIKE Workbench.

    For Lists, specify a comma separate string for the items in the list.    		 ./MIKEOPERATIONS-Configuration4/image66.png

    Job Property Value Placeholders

    Job property values support using placeholders.

    Job 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 setting a job property value with placeholders.
    /Simulations/[Configuration.Name]

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

    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.
    timestep The current date time.
    Configuration Name The configuration name.
    Description Description of the configuration.
    CurrentDateTime The current Date time selected.
    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.
    ObservationPeriod Id The Id of the Observation period.
    Name The name of the observation period.
    Description Description of the observation period.

    Web

    Web links can be added to the ribbon of MIKE OPERATIONS.

    Create and configure web links from the General Settings page by clicking on the ‘Web’ button.

    The dialog will display the web links configured.

    Click on the ‘New’ button to add a new web link to the configuration.

    Click on the ‘Details’ button to configure the web links.

    Item Description
    Active
    Activate the web link by checking this field.    		 ./MIKEOPERATIONS-Configuration4/image70.png
    Id
    Id of the web link.
    The id is used as a reference.    		 ./MIKEOPERATIONS-Configuration4/image71.png
    Name
    Name of the web link shown in the ribbon.    		 ./MIKEOPERATIONS-Configuration4/image72.png./MIKEOPERATIONS-Configuration4/image73.png
    Description
    Description of the web link.    		 ./MIKEOPERATIONS-Configuration4/image74.png
    Web browser
    Specify the web browser used.
  • Default
    Open the default web browser in a new window.
  • Embedded
    Open the web link in an embedded web browser (Internet Explorer), so that the web browser can be docked.
    		•  ./MIKEOPERATIONS-Configuration4/image75.png
    Url
    The web address of the web page to show.    		 ./MIKEOPERATIONS-Configuration4/image76.png
    Ribbon Page Name
    The name of the ribbon page where the button of the web link is shown.    		 ./MIKEOPERATIONS-Configuration4/image77.png ./MIKEOPERATIONS-Configuration4/image78.png
    Group Name
    Group name sets the group of the web link in the ribbon.    		 ./MIKEOPERATIONS-Configuration4/image79.png
    Ribbon Item Type
    Ribbon item type controls the type of control added to the ribbon.
  • Check Item
    A simple 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 script is not shown in the ribbon.
    		•  ./MIKEOPERATIONS-Configuration4/image81.png
    Resource Image Name
    Resource images are a list of built in images for web links.

    Clicking on 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 have an initial size of 32x32 pixels.

    Images without a postfix have a size of 16x16 pixels.

    The initial size has an impact on the quality of the image when displayed in MIKE OPERATIONS.    		 ./MIKEOPERATIONS-Configuration4/image82.png
    Document Image Path
    Document Image Path is for additional user images placed in the Document Manager in MIKE Workbench.

    Images specified in this path will overwrite the image specified in the Resource Image Path.    		 ./MIKEOPERATIONS-Configuration4/image83.png
    Theme
    Specify the theme where the web link should be shown.

    If no theme is specified, the web link is shown on all themes.    		 ./MIKEOPERATIONS-Configuration4/image36.png