Tools¶
Properties of a tool (if any) can be specified in the Properties window in MIKE WORKBENCH.
Generic ftp download¶
Tool for downloading files from a FTP site.
| Tool Info | Generic ftp download |
|---|---|
| Tools Explorer | /Web tools/Generic ftp download |
| NuGet Package | DHI.MikeOperations.Core.Tools.FTPDownload |
| API Reference | DHI.Solutions.Generic.UI.Tools.GenericFTPDownload.IGenericFTPDownloadTool |
| Input Items | No input items required |
| Output Items | No output items |
Tool Properties
| Display Name | Name | Description |
|---|---|---|
| Server Address/FTP Folder | ServerAddress | Gets or sets the server address. |
| User name | UserName | Gets or sets the username to use for downloading from FTP. |
| Password | Password | Gets or sets the password of the user used for downloading files from FTP. |
| Local download folder | LocalDownloadFolder | Gets or sets the local folder to download to. |
| Download file older than | DownloadFileOlderThan | Gets or sets the date of files to download to. Files older then this date will be downloaded. |
| Download file newer than | DownloadFileNewerThan | Gets or sets the date from where files should be downloaded. Files newer than this date will be downloaded. |
| Name pattern | NamePattern | Gets or set the pattern of file names to download. |
| Protocol Type | ProtocolType | Gets or set the protocol to use for downloading. |
| Host | Host | Gets or sets the host to use for downloading for ProtocolType SFTP. |
| SSH Host Key Fingerprint | SshHostKeyFingerprint | Gets or sets the host key fingerprint for protokol SFTP. |
| Private Key File | PrivateKeyFile | Gets or sets the private key file to use for protokol SFTP. |
| Private Key Passphrase | PrivateKeyPassphrase | Gets or sets the key password phrase to use for protokol SFTP. |
| Overwrite | Overwrite | Gets or sets a value indicating whether existing local files should be overwritten during download. |
| Delete remote file | DeleteRemoteFile | Gets or sets a value indicating whether files should be deleted from the FTP site after they have been downloaded. |
Code Sample
// Get the tool.
var tool = application.Tools.CreateNew("Generic ftp download") as DHI.Solutions.Generic.UI.Tools.GenericFTPDownload.IGenericFTPDownloadTool;
# Get the tool.
tool = app.Tools.CreateNew("Generic ftp download")
# Get the tool.
tool = DHI.Solutions.Generic.UI.Tools.GenericFTPDownload.IGenericFTPDownloadTool(app.Tools.CreateNew("Generic ftp download"))
To list¶
The ToList tool. Displays the output of tools to a ListView
| Tool Info | To list |
|---|---|
| Tools Explorer | /Obsolete Tools/To list |
| NuGet Package | DHI.MikeOperations.Core.Tools.ToList |
| API Reference | DHI.Solutions.Generic.UI.Tools.ToList.ToList |
| Input Items | No input items required |
| Output Items | No output items |
Tool Properties
The tool has no properties.
Code Sample
// Get the tool.
var tool = application.Tools.CreateNew("To list") as DHI.Solutions.Generic.UI.Tools.ToList.ToList;
# Get the tool.
tool = app.Tools.CreateNew("To list")