Introduction
The Workflow Navigator (WN) is a helpful tool for understanding the hierarchical structure of your workflows and all underlying modules, module instances, and incoming/outgoing time series. It can also highlight the usage of specific time series throughout your configuration, allowing you to trace where data is produced and (re)used. The WN displays workflows in a clickable tree structure, enabling you to navigate and drill down into a workflow towards the time series level and even inspect the series in a graph or spatial plot.
Opening the Workflow Navigator
The Workflow Navigator (WN) can be started in two ways:
From the Delft-FEWS Explorer - Map:
- Use the <F12> menu and select option "K".
From the Delft-FEWS Explorer Taskbar:
- When configured as an <explorerTask>.
Ad 1. Starting WN from the <F12> Menu
When you start the WN from the <F12> menu, all available (visible) workflows will be visualized in the tree structure. The WN itself opens in a "Workflow Navigator" tab and can be docked or undocked like all other tabs.
Ad 2. Starting WN from the Taskbar
When you start the WN from the Explorer taskbar, it will 'listen' to the selected workflow in, for example, your topology (forecast tree). Only that workflow will be visible in the Workflow Navigator tab.
Logging
All relevant logging will appear in the Delft-FEWS Explorer log panel. From version 2018.02 (and higher), the log panel has been removed from the Workflow Navigator tab and is now centrally available in the Delft-FEWS Explorer log panel.
Usage of the Workflow Navigator
Workflows in a tree-structure
The Workflow Navigator (WN) presents the structure of workflows in a clickable tree format. By selecting nodes within this tree, it expands, revealing the different components (steps) of the workflows, each identifiable based on its configuration files. Navigating deeper into this structure allows users to access all related configuration files and inspect them, right down to the input and output time series of individual 'steps' within the selected workflow. When a what-if is selected, the properties defined in the what-if are displayed.
Hovering over a node in the structure reveals a tooltip displaying the corresponding configuration file. Additionally, for transformation elements configured in the <description>
, the tooltip may include additional information.
Temporary time series within your configuration are displayed in italics for easy identification.
Icons
In the clickable tree-structure different icons are used. The table below explains the different icons used.
Icon | Description |
---|---|
Workflow (general) | |
Timeseries import module | |
General adapter module | |
Transformation module | |
Old Transformation module | |
Error module | |
Threshold event crossing module | |
Forecast length estimator module | |
Process (any) | |
Unit conversion (process level) | |
Id mapping (process level) | |
Module parameters (process level) | |
Input timeseries (process level) | |
Output timeseries (process level) |
Context-menu options
When you open the Workflow Navigator (WN) and select a specific node, pressing the right mouse button will display the context menu.
Depending on the hierarchy in the structure and node-type different options are available. Below mentioned table explains the different options.
Context-menu option | Shortcut | Functionality |
---|---|---|
Open config file | Ctrl+O | Opens the corresponding configuration file (in a text-editor) |
Open config file with resolved properties | Shows both the original module config file and the module config file with resolve properties ( in a comparison window) | |
Open config file with custom viewer | Ctrl+V | Opens the corresponding configuration file (in a custom viewer) - Module parameters only - Values are resolved if defined with tags. |
Open Properties | Shows the values of the configured properties (variables between $-characters in a configuration file) | |
Open id map with resolved attributes and properties | Shows the completed Idmap file in which the references to attributes and/or properties have been filled in. | |
Show configuration validation messages | Ctrl+M | Shows the WARN or ERROR messages of the selected item (Workflow or ModuleInstance) |
Show timeseries (n locations, m parameters) | Ctrl+6 | Opens a Timeseries dialog (TSD) for all n locations and m parameters in one plot |
Filter and show timeseries | Ctrl+7 | Enables the user to select from a collection of timeseries based on location and module-instance(s). After selection a new plot window is opened showing the selected timeseries |
Add timeseries to plots | Ctrl+Shift+7 | Enables the user to select from a collection of timeseries based on location and module-instance(s). After selection. the selected timeseries are added to the selected plot in the Timeseries display. |
Show rating curves | Ctrl+8 | Shows the rating curve in a plot (if selected timeseries contains a rating curve) |
Show grids | Ctrl+9 | Opens the spatial display to visualize the selected grid timeseries (only if selected timeseries is a grid) |
Show longitudinal profile | Shows the longitudinal profile in a plot (if selected timeseries is a longitudinal profile) | |
Show scalar maps | ||
Find Usages | F3 | Based on the selected node, it finds identical references throughout the complete workflow list. The result is displayed in a separated panel. Pressing <ESC> cancels the selection. |
Highlight Usages | Ctrl+F3 | Based on the selected node, the WN tree structure highlights similar references: bold means exact match, black means location match and greyed-out means no match. Pressing <ESC> cancels the selection. |
Validate | F4 | Validates the selected node (which refers to a configuration file) against the corresponding schema. The log panel displays the result of this validation. |
Options | F11 | Option to select to show "both visible and invisible workflows" or "only visible workflows". This setting is set in / read from the workflow descriptors configuration file. |