Jobs

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

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

The dialog will display the configured jobs.

Click the New button to add a new job configuration.

Click the Details button to configure the job.

• Active
  Activate the job by checking this field.
  
• Id
  Id of the job. The id is used as reference.
  
• Name
  Name of the job configuration, shown in the ribbon
  
• Description
  Description of the job.
  
• Job Path
  Name of the job in MIKE Workbench to execute.
  
• Execution Type
  The execution of a job can be performed locally or remotely.
  
• Host Name
  The name of the computer where the job will be executed. This field is only enabled when the Execution Type = Remotely.
  
• Targets
  Select the targets to execute on the job.
  If no targets are specified, the Default Target is used.
  
• Allow Execute
  Checking this checkbox, will allow the job to be executed from the ribbon of MIKE OPERATIONS.
  Click the Execute button to run the job.
  
  
• Show Status
  Checking this checkbox, will show the status of previous job runs in the ribbon of MIKE OPERATIONS.
  
  
• Ribbon Page Name
  The name of the ribbon page where the button of the job is shown.
  
• Group Name
  Group name sets the group of the job in the ribbon.
  
• 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.
  
• Resource Image Name
  Resource images are a list of built in images for jobs.
  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 Name.
  
• Theme
  Specify the theme where the job item should be shown. If no theme is specified, the job item is shown on all themes.
  
• Show on Web
  Check box indicating whether the job is available in MIKE OPERATIONS Web.
  

Properties

The properties dialog show 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 supports using placeholders so that values are set when executing the Job.

Note that placeholders are only supported for string properties and when the job is allowing to specify placeholder tags in the property.

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

Click the Properties button to configure the properties of the job.

• Name
  The name of the property on the job in the job manager of MIKE Workbench.
  
• 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.
  • Selection:
    Job properties of type Selection are hidden properties. The property will contain a semicolon separated list of selected features, identified by both the id of the feature type and the id of the feature.
    E.g FT1.2030;FT1.4020.
    This property is useful when creating a job with a run script task for handling selected features.
    
• 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 of MIKE Workbench.
  For Lists, specify a comma separate string for the items in the list.
  

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 place holders.

/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.
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	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.