Job Manager Tools¶

Properties of a tool (if any) can be found in the Properties Window in MIKE Workbench.

Job export tool¶

The tool is used to export an overview of job schedules to files on the disk or to a spreadsheet in the database.

Tool Info
Display Name	Job export tool
API Name	Job export tool
Tools Explorer	/Output Tools/Job export tool
NuGet Package	`DHI.MikeOperations.JobManager.Tools.JobExport`
Assembly name (.dll)	`DHI.Solutions.JobManager.Tools.JobExportTool.dll`
API Reference	`DHI.Solutions.JobManager.Tools.JobExportTool.IJobExportTool`
Input Items	One or more jobs
Output Items	A string

Tool Properties

Display Name	API Name	Description
Export Settings
Export to	ExportFormat	Gets or sets the export format option. Excel - Create an Excel file Spreadsheet - Create a Spreadsheet in the MIKE OPERATIONS database.
Group	Group	Gets or sets the group of the spreadsheet to create when using the export option Spreadsheet. *Note that the property is only available when: ExportFormat=Spreadsheet*
Name	SpreadSheetName	Gets or sets the name of the spreadsheet. *Note that the property is only available when: ExportFormat=Spreadsheet*
Output path	ExportPath	Gets or sets the export path when using the export option Excel. *Note that the property is only available when: ExportFormat=Excel*
Overwrite option	DuplicateNameOption	Gets or sets the dublicate name option for handling a file with the same name is already present in the folder. CreateAndReplace - Create and replace the spreadsheet DontCreate - Don't create the spreadsheet CreateButRename - Create but rename the spreadsheet

Code Sample

IronPythonCPythonC#

import clr
clr.AddReference("DHI.Solutions.JobManager.Tools.JobExportTool")
from DHI.Solutions.JobManager.Tools.JobExportTool import *

# Get the tool.
tool = app.Tools.CreateNew("Job export tool")
# Add input items.
tool.InputItems.Add(<One or more jobs>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

import clr
clr.AddReference("DHI.Solutions.JobManager.Tools.JobExportTool")
from DHI.Solutions.JobManager.Tools.JobExportTool import *

# Get the tool.
tool = DHI.Solutions.JobManager.Tools.JobExportTool.IJobExportTool(app.Tools.CreateNew("Job export tool"))
# Add input items.
tool.InputItems.Add(<One or more jobs>)
# Set tool properties before executing the tool.
tool.Execute()
# Read the output from the list of output items.
output = tool.OutputItems

// Get the tool.
var tool = application.Tools.CreateNew("Job export tool") as DHI.Solutions.JobManager.Tools.JobExportTool.IJobExportTool;
// Add input items.
tool.InputItems.Add(<One or more jobs>);
// Set tool properties before executing the tool.
tool.Execute();
// Read the output from the list of output items.
output = tool.OutputItems;

Runtime.config

What tools to load during application startup, is specified in the XML file Runtime.config in the plugins section of the manager.

The XML below shows the tool plugin information found in the Runtime.config file.

<Plugin
  Name="DHI.Solutions.JobManager.Tools.JobExportTool.JobExportTool"
  Type="DHI.Solutions.Generic.ITool"
  Assembly="DHI.Solutions.JobManager.Tools.JobExportTool.dll" />