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 in order 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 the Add button to add a new script configuration.
Click the Details button to configure the script.
- Active
Activate the script by checking this field.
- Id
Id of the script. The id is used as reference.
- Name
Name of the script configuration, shown in the ribbon
- Description
Description of the script.
- Script Name
Name of the script in MIKE Workbench to execute.
- Ribbon Page Name
The name of the ribbon page where the button of the script is shown.
- Group Name
Group name sets the group of the script 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 script is not shown in the ribbon.
- Check Item
- 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, 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
Specify the theme where the script should be shown. If no theme is specified, the script is shown on all themes.
- Show on Web
Check box indicating whether the script is available in MIKE OPERATIONS Web.