Skip to content

Topology file

This page is the generated field list for Topology.xml — the tree a forecaster actually clicks through in the Explorer / Interactive Forecast Display / Web OC. Every other piece of region config (workflows, filters, display groups, locations, thresholds) gets wired together here into something a person can select and run.

Purpose : Defines the node tree shown in the FEWS client: which workflow a node runs, what time window it runs over, which filter/display group/locations light up when it’s selected, and which UI buttons and permissions apply.

Folder : Config/RegionConfigFiles/

Root element : <topology> (no version attribute)

References : Workflow (workflowId), Filters (filterId), Display groups (displayGroupId), Locations (locationId), Module instance descriptors (moduleInstanceId), Threshold value sets (thresholdValueSetId).

Config/RegionConfigFiles/Topology.xml
<?xml version="1.0" encoding="UTF-8"?>
<topology xmlns="http://www.wldelft.nl/fews">
<nodes id="RiverBasin" name="River Basin">
<node id="Gauge01" name="Gauge 01">
<workflowId>ForecastRiver</workflowId>
<filterId>PublicObserved</filterId>
<mainPanel>time series dialog</mainPanel>
</node>
</nodes>
</topology>

Auto-generated from topology.xsd. Descriptions are the schema's own annotations.

Element <topology>

ElementTypeCardinalityDescription
forecasterHelperDirectories (inline) optional When present, this element specifies the directories where the forecaster helper should look for files instead of the INFORMATION_PANEL_FOLDER property in oc_global.properties.
enableOriginalButtons boolean optional Since 2014.01. By default the toolbar with 2 buttons is used: buttons 'Run' and 'Run approved forecast'. If a group node is selected, 'Run' runs the workflows of all childnodes. If a single node is selected, 'Run' runs the workflow of that node. 'Run approved forecast' has the similar functionality. When the option enableOriginalButtons is set to true, the original toolbar with 4 or 5 buttons will be used. This original buttons are: 'Switch to edit/forecast mode' (optional), 'Go to next segment','Re-run segment', 'Re-run forecast group', 'Run approved forecast', 'Update current system time...' (OC only)
hideThresholdsButton boolean optional Since 2021.02. If set to true, show threshold buttons in the Topology tree will be invisible.
hideNextSegmentButton boolean optional Since 2023.02 If set to false, next segment button will be shown in the Topology tree
hidePreviousSegmentButton boolean optional Since 2023.02 If set to false, prev segment button will be shown in the Topology tree
enableAutoRun boolean optional When this option is set to true (default) a workflow which is supposed to run locally will run automaticly when the node is selected. NOTE: this option is only applicable if 'enableOriginalButtons' is true.'
enableRunUpstreamServerNodes boolean optional When this option is set to true upstream server nodes with a workflow are run at the server prior to running the selected server node
enableRunAllPreviousNodes boolean optional if this option is enabled and a node is run all previous nodes in the topology tree are run previously to running the selected node, even if the nodes are not connected by the defined topoly. If this option is not enabled (which is the default) then only the upstream nodes will be run
enableSelectNodesFromMap boolean optional If this option is enabled it will be possible to select nodes by clicking on the location in the map. In addition you also need to configure at least one locationId and a filterId at each node which you would like to be selectable from a map.
enableAutoSaveOnRun boolean optional When this option is set to true (default = false) all edits will be automatically saved to the database without having to press apply or confirm when a node is run.
enableCrossGroupNodeReferencing boolean optional Since 2015.01. When enabled, it is allowed to list a node in another group when referencing to a "previousNodeId".
enableSelectLastNodeOnStartUp boolean optional Since 2022.02. When enabled, it allows the last selected node in the segment selection dialog on shutdown to be automatically reselected when FEWS is reopened.
selectFirstPlotOnSelectionChange boolean optional Since 2016.02 when selecting an other topology node the (thumbnail) plot is selected that shows the same parameter or location as currently displayed. To revert to the behaviour of 2016.01 specify true
enableAutoSelectParameters boolean optional When this option is set to true the parameters in the filters are automatically selected.
enableAutoClearParameters boolean optional When this option is set to true, the parameter selection is cleared whenever a node with a configured filter is selected.
groupId string required It is possible to split the configuration of the topology in different files. The topology.xml is always the main configuration file. Parts of the topology (topology groups) can be configured in separate files. These topology groups are identified by a group id. This element can be used to configure which topology group should be injected.
nodes NodesComplexType required
modifiersIconVisible boolean optional Since 2022.02. If set to true and there are modifiers associated with a node, the modifier icon will be continuously visible at the left side of that node
hideModifiersButton boolean optional Since 2021.02. If set to true, show modifiers buttons in the Topology tree will be invisible.

forecasterHelperDirectories_inline

ElementTypeCardinalityDescription
directory directoryStringType optional · repeats
allNodesDirectory directoryStringType optional · repeats
multipleNodesDirectory (inline) optional · repeats
ignoredDirectoriesNameFilter string optional

NodesComplexType

Attributes

AttributeUseNotes
id required
name optional

Elements

ElementTypeCardinalityDescription
showModifiers boolean optional Since 2014.01. This element will enable that modifiers are shown and editable at groupNodes
showRunApprovedForecastButton boolean optional if this option is enabled the run approved forecast button is also show for a local node
backgroundSelectionColor colorEnumStringType optional Since 2019.02 It is possible to configure the background color for selected individual and group nodes on the Forecast panel.
One of: alice blue, white, antique white, antique white1, antique white2, antique white3, antique white4, aquamarine, black, blanched almond, blue, blue violet, brown, cadet blue, cadet blue1, cadet blue2, cadet blue3, cadet blue4, coral, cornflower blue, cyan, dark goldenrod, dark goldenrod1, dark goldenrod2, dark goldenrod3, dark goldenrod4, dark green, dark khaki, dark olive green, dark olive green1, dark olive green2, dark olive green3, dark olive green4, dark orange, dark orange1, dark orange2, dark orange3, dark orange4, dark orchid, dark orchid1, dark orchid2, dark orchid3, dark orchid4, dark salmon, dark sea green, dark sea green1, dark sea green2, dark sea green3, dark sea green4, dark slate blue, dark slate gray, dark slate gray1, dark slate gray2, dark slate gray3, dark slate gray4, dark turquoise, dark violet, deep pink, deep pink2, deep pink3, deep pink4, deep sky blue, deep sky blue2, deep sky blue3, deep sky blue4, dim gray, dodger blue, dodger blue2, dodger blue3, dodger blue4, firebrick, floral white, forest green, ghost white, gold, goldenrod, gray, gray0, gray100, gray18, gray21, gray23, gray24, gray25, gray26, gray27, gray28, gray29, gray30, gray31, gray32, gray34, gray35, gray36, gray37, gray38, gray39, gray40, gray41, gray42, gray43, gray44, gray45, gray46, gray47, gray48, gray49, gray50, gray51, gray52, gray53, gray54, gray55, gray56, gray57, gray58, gray59, gray60, gray61, gray62, gray63, gray64, gray65, gray66, gray67, gray68, gray69, gray70, gray71, gray72, gray73, gray74, gray75, gray76, gray77, gray78, gray79, gray80, gray81, gray82, gray83, gray84, gray85, gray86, gray87, gray88, gray89, gray90, gray91, gray92, gray93, gray94, gray95, gray96, gray97, gray98, gray99, green, green yellow, hot pink, hot pink1, hot pink2, hot pink3, hot pink4, indian red, indian red1, indian red2, indian red3, indian red4, khaki, lavender blush, lavender blush2, lavender blush3, lavender blush4, lawn green, lemon chiffon, lemon chiffon2, lemon chiffon3, lemon chiffon4, light blue, light blue1, light blue2, light blue3, light blue4, light coral, light cyan, light cyan2, light cyan3, light cyan4, light goldenrod, light goldenrod1, light goldenrod2, light goldenrod3, light goldenrod4, light goldenrod yellow, light pink, light pink1, light pink2, light pink3, light pink4, light salmon, light salmon2, light salmon3, light salmon4, light sea green, light sky blue, light sky blue2, light sky blue3, light sky blue4, light slate blue, light slate gray, light steel blue, light steel blue1, light steel blue2, light steel blue3, light steel blue4, light yellow, light yellow2, light yellow3, light yellow4, lime green, magenta, maroon, medium aquamarine, medium blue, medium forest green, medium goldenrod, medium orchid, medium orchid1, medium orchid2, medium orchid3, medium orchid4, medium purple, medium purple1, medium purple2, medium purple3, medium purple4, medium sea green, medium slate blue, medium spring green, medium turquoise, medium violet red, midnight blue, mint cream, misty rose, misty rose2, misty rose3, misty rose4, navajo white, navajo white2, navajo white3, navajo white4, navy, old lace, olive drab, olive drab1, olive drab2, olive drab3, olive drab4, orange, orange red, orange red2, orange red3, orange red4, orchid, pale goldenrod, pale green, pale green1, pale green2, pale green3, pale green4, pale turquoise, pale turquoise1, pale turquoise2, pale turquoise3, pale turquoise4, pale violet red, pale violet red1, pale violet red2, pale violet red3, pale violet red4, papaya whip, peach puff, peach puff2, peach puff3, peach puff4, pink, plum, powder blue, red, rosy brown, rosy brown1, rosy brown2, rosy brown3, rosy brown4, royal blue, royal blue1, royal blue2, royal blue3, royal blue4, sandy brown, sea green, sea green1, sea green2, sea green3, sea green4, sienna, sky blue, sky blue1, sky blue2, sky blue3, sky blue4, slate blue, slate blue1, slate blue2, slate blue3, slate blue4, slate gray, slate gray1, slate gray2, slate gray3, slate gray4, spring green, spring green1, spring green2, spring green3, spring green4, steel blue, steel blue1, steel blue2, steel blue3, steel blue4, tan, thistle, turquoise, violet, violet red, violet red1, violet red2, violet red3, violet red4, wheat, yellow, yellow green, aquamarine1, aquamarine2, aquamarine3, aquamarine4, azure, azure2, azure3, azure4, beige, bisque, bisque2, bisque3, bisque4, blue1, blue2, blue3, blue4, brown1, brown2, brown3, burlywood1, burlywood2, burlywood3, burlywood4, chartreuse, chartreuse2, chartreuse3, chartreuse4, chocolate, coral2, coral3, coral4, cornsilk, cornsilk2, cornsilk3, cornsilk4, cyan1, cyan2, cyan3, cyan4, firebrick1, firebrick2, firebrick3, gainsboro, gold1, gold2, gold3, gold4, goldenrod1, goldenrod2, goldenrod3, goldenrod4, green1, green2, green3, green4, honeydew, honeydew2, honeydew3, honeydew4, ivory, ivory2, ivory3, ivory4, khaki1, khaki2, khaki3, khaki4, lavender, linen, magenta1, magenta2, magenta3, maroon1, maroon2, maroon3, maroon4, moccasin, orange1, orange2, orange3, orange4, orchid1, orchid2, orchid3, orchid4, peru, pink2, pink3, pink4, plum1, plum2, plum3, plum4, purple, purple1, purple2, purple3, purple4, red1, red2, salmon1, salmon2, salmon3, salmon4, seashell, seashell2, seashell3, seashell4, sienna1, sienna2, sienna3, sienna4, snow, snow2, snow3, snow4, tan1, tan2, thistle1, thistle2, thistle3, thistle4, tomato, tomato2, tomato3, turquoise1, turquoise2, turquoise3, turquoise4, wheat1, wheat2, wheat3, wheat4, yellow1
backgroundNonSelectionColor colorEnumStringType optional Since 2019.02 It is possible to configure the background color for non-selected individual and group nodes on the Forecast panel.
One of: alice blue, white, antique white, antique white1, antique white2, antique white3, antique white4, aquamarine, black, blanched almond, blue, blue violet, brown, cadet blue, cadet blue1, cadet blue2, cadet blue3, cadet blue4, coral, cornflower blue, cyan, dark goldenrod, dark goldenrod1, dark goldenrod2, dark goldenrod3, dark goldenrod4, dark green, dark khaki, dark olive green, dark olive green1, dark olive green2, dark olive green3, dark olive green4, dark orange, dark orange1, dark orange2, dark orange3, dark orange4, dark orchid, dark orchid1, dark orchid2, dark orchid3, dark orchid4, dark salmon, dark sea green, dark sea green1, dark sea green2, dark sea green3, dark sea green4, dark slate blue, dark slate gray, dark slate gray1, dark slate gray2, dark slate gray3, dark slate gray4, dark turquoise, dark violet, deep pink, deep pink2, deep pink3, deep pink4, deep sky blue, deep sky blue2, deep sky blue3, deep sky blue4, dim gray, dodger blue, dodger blue2, dodger blue3, dodger blue4, firebrick, floral white, forest green, ghost white, gold, goldenrod, gray, gray0, gray100, gray18, gray21, gray23, gray24, gray25, gray26, gray27, gray28, gray29, gray30, gray31, gray32, gray34, gray35, gray36, gray37, gray38, gray39, gray40, gray41, gray42, gray43, gray44, gray45, gray46, gray47, gray48, gray49, gray50, gray51, gray52, gray53, gray54, gray55, gray56, gray57, gray58, gray59, gray60, gray61, gray62, gray63, gray64, gray65, gray66, gray67, gray68, gray69, gray70, gray71, gray72, gray73, gray74, gray75, gray76, gray77, gray78, gray79, gray80, gray81, gray82, gray83, gray84, gray85, gray86, gray87, gray88, gray89, gray90, gray91, gray92, gray93, gray94, gray95, gray96, gray97, gray98, gray99, green, green yellow, hot pink, hot pink1, hot pink2, hot pink3, hot pink4, indian red, indian red1, indian red2, indian red3, indian red4, khaki, lavender blush, lavender blush2, lavender blush3, lavender blush4, lawn green, lemon chiffon, lemon chiffon2, lemon chiffon3, lemon chiffon4, light blue, light blue1, light blue2, light blue3, light blue4, light coral, light cyan, light cyan2, light cyan3, light cyan4, light goldenrod, light goldenrod1, light goldenrod2, light goldenrod3, light goldenrod4, light goldenrod yellow, light pink, light pink1, light pink2, light pink3, light pink4, light salmon, light salmon2, light salmon3, light salmon4, light sea green, light sky blue, light sky blue2, light sky blue3, light sky blue4, light slate blue, light slate gray, light steel blue, light steel blue1, light steel blue2, light steel blue3, light steel blue4, light yellow, light yellow2, light yellow3, light yellow4, lime green, magenta, maroon, medium aquamarine, medium blue, medium forest green, medium goldenrod, medium orchid, medium orchid1, medium orchid2, medium orchid3, medium orchid4, medium purple, medium purple1, medium purple2, medium purple3, medium purple4, medium sea green, medium slate blue, medium spring green, medium turquoise, medium violet red, midnight blue, mint cream, misty rose, misty rose2, misty rose3, misty rose4, navajo white, navajo white2, navajo white3, navajo white4, navy, old lace, olive drab, olive drab1, olive drab2, olive drab3, olive drab4, orange, orange red, orange red2, orange red3, orange red4, orchid, pale goldenrod, pale green, pale green1, pale green2, pale green3, pale green4, pale turquoise, pale turquoise1, pale turquoise2, pale turquoise3, pale turquoise4, pale violet red, pale violet red1, pale violet red2, pale violet red3, pale violet red4, papaya whip, peach puff, peach puff2, peach puff3, peach puff4, pink, plum, powder blue, red, rosy brown, rosy brown1, rosy brown2, rosy brown3, rosy brown4, royal blue, royal blue1, royal blue2, royal blue3, royal blue4, sandy brown, sea green, sea green1, sea green2, sea green3, sea green4, sienna, sky blue, sky blue1, sky blue2, sky blue3, sky blue4, slate blue, slate blue1, slate blue2, slate blue3, slate blue4, slate gray, slate gray1, slate gray2, slate gray3, slate gray4, spring green, spring green1, spring green2, spring green3, spring green4, steel blue, steel blue1, steel blue2, steel blue3, steel blue4, tan, thistle, turquoise, violet, violet red, violet red1, violet red2, violet red3, violet red4, wheat, yellow, yellow green, aquamarine1, aquamarine2, aquamarine3, aquamarine4, azure, azure2, azure3, azure4, beige, bisque, bisque2, bisque3, bisque4, blue1, blue2, blue3, blue4, brown1, brown2, brown3, burlywood1, burlywood2, burlywood3, burlywood4, chartreuse, chartreuse2, chartreuse3, chartreuse4, chocolate, coral2, coral3, coral4, cornsilk, cornsilk2, cornsilk3, cornsilk4, cyan1, cyan2, cyan3, cyan4, firebrick1, firebrick2, firebrick3, gainsboro, gold1, gold2, gold3, gold4, goldenrod1, goldenrod2, goldenrod3, goldenrod4, green1, green2, green3, green4, honeydew, honeydew2, honeydew3, honeydew4, ivory, ivory2, ivory3, ivory4, khaki1, khaki2, khaki3, khaki4, lavender, linen, magenta1, magenta2, magenta3, maroon1, maroon2, maroon3, maroon4, moccasin, orange1, orange2, orange3, orange4, orchid1, orchid2, orchid3, orchid4, peru, pink2, pink3, pink4, plum1, plum2, plum3, plum4, purple, purple1, purple2, purple3, purple4, red1, red2, salmon1, salmon2, salmon3, salmon4, seashell, seashell2, seashell3, seashell4, sienna1, sienna2, sienna3, sienna4, snow, snow2, snow3, snow4, tan1, tan2, thistle1, thistle2, thistle3, thistle4, tomato, tomato2, tomato3, turquoise1, turquoise2, turquoise3, turquoise4, wheat1, wheat2, wheat3, wheat4, yellow1
textSelectionColor colorEnumStringType optional Since 2019.02 It is possible to configure the text color for selected individual and group nodes on the Forecast panel.
One of: alice blue, white, antique white, antique white1, antique white2, antique white3, antique white4, aquamarine, black, blanched almond, blue, blue violet, brown, cadet blue, cadet blue1, cadet blue2, cadet blue3, cadet blue4, coral, cornflower blue, cyan, dark goldenrod, dark goldenrod1, dark goldenrod2, dark goldenrod3, dark goldenrod4, dark green, dark khaki, dark olive green, dark olive green1, dark olive green2, dark olive green3, dark olive green4, dark orange, dark orange1, dark orange2, dark orange3, dark orange4, dark orchid, dark orchid1, dark orchid2, dark orchid3, dark orchid4, dark salmon, dark sea green, dark sea green1, dark sea green2, dark sea green3, dark sea green4, dark slate blue, dark slate gray, dark slate gray1, dark slate gray2, dark slate gray3, dark slate gray4, dark turquoise, dark violet, deep pink, deep pink2, deep pink3, deep pink4, deep sky blue, deep sky blue2, deep sky blue3, deep sky blue4, dim gray, dodger blue, dodger blue2, dodger blue3, dodger blue4, firebrick, floral white, forest green, ghost white, gold, goldenrod, gray, gray0, gray100, gray18, gray21, gray23, gray24, gray25, gray26, gray27, gray28, gray29, gray30, gray31, gray32, gray34, gray35, gray36, gray37, gray38, gray39, gray40, gray41, gray42, gray43, gray44, gray45, gray46, gray47, gray48, gray49, gray50, gray51, gray52, gray53, gray54, gray55, gray56, gray57, gray58, gray59, gray60, gray61, gray62, gray63, gray64, gray65, gray66, gray67, gray68, gray69, gray70, gray71, gray72, gray73, gray74, gray75, gray76, gray77, gray78, gray79, gray80, gray81, gray82, gray83, gray84, gray85, gray86, gray87, gray88, gray89, gray90, gray91, gray92, gray93, gray94, gray95, gray96, gray97, gray98, gray99, green, green yellow, hot pink, hot pink1, hot pink2, hot pink3, hot pink4, indian red, indian red1, indian red2, indian red3, indian red4, khaki, lavender blush, lavender blush2, lavender blush3, lavender blush4, lawn green, lemon chiffon, lemon chiffon2, lemon chiffon3, lemon chiffon4, light blue, light blue1, light blue2, light blue3, light blue4, light coral, light cyan, light cyan2, light cyan3, light cyan4, light goldenrod, light goldenrod1, light goldenrod2, light goldenrod3, light goldenrod4, light goldenrod yellow, light pink, light pink1, light pink2, light pink3, light pink4, light salmon, light salmon2, light salmon3, light salmon4, light sea green, light sky blue, light sky blue2, light sky blue3, light sky blue4, light slate blue, light slate gray, light steel blue, light steel blue1, light steel blue2, light steel blue3, light steel blue4, light yellow, light yellow2, light yellow3, light yellow4, lime green, magenta, maroon, medium aquamarine, medium blue, medium forest green, medium goldenrod, medium orchid, medium orchid1, medium orchid2, medium orchid3, medium orchid4, medium purple, medium purple1, medium purple2, medium purple3, medium purple4, medium sea green, medium slate blue, medium spring green, medium turquoise, medium violet red, midnight blue, mint cream, misty rose, misty rose2, misty rose3, misty rose4, navajo white, navajo white2, navajo white3, navajo white4, navy, old lace, olive drab, olive drab1, olive drab2, olive drab3, olive drab4, orange, orange red, orange red2, orange red3, orange red4, orchid, pale goldenrod, pale green, pale green1, pale green2, pale green3, pale green4, pale turquoise, pale turquoise1, pale turquoise2, pale turquoise3, pale turquoise4, pale violet red, pale violet red1, pale violet red2, pale violet red3, pale violet red4, papaya whip, peach puff, peach puff2, peach puff3, peach puff4, pink, plum, powder blue, red, rosy brown, rosy brown1, rosy brown2, rosy brown3, rosy brown4, royal blue, royal blue1, royal blue2, royal blue3, royal blue4, sandy brown, sea green, sea green1, sea green2, sea green3, sea green4, sienna, sky blue, sky blue1, sky blue2, sky blue3, sky blue4, slate blue, slate blue1, slate blue2, slate blue3, slate blue4, slate gray, slate gray1, slate gray2, slate gray3, slate gray4, spring green, spring green1, spring green2, spring green3, spring green4, steel blue, steel blue1, steel blue2, steel blue3, steel blue4, tan, thistle, turquoise, violet, violet red, violet red1, violet red2, violet red3, violet red4, wheat, yellow, yellow green, aquamarine1, aquamarine2, aquamarine3, aquamarine4, azure, azure2, azure3, azure4, beige, bisque, bisque2, bisque3, bisque4, blue1, blue2, blue3, blue4, brown1, brown2, brown3, burlywood1, burlywood2, burlywood3, burlywood4, chartreuse, chartreuse2, chartreuse3, chartreuse4, chocolate, coral2, coral3, coral4, cornsilk, cornsilk2, cornsilk3, cornsilk4, cyan1, cyan2, cyan3, cyan4, firebrick1, firebrick2, firebrick3, gainsboro, gold1, gold2, gold3, gold4, goldenrod1, goldenrod2, goldenrod3, goldenrod4, green1, green2, green3, green4, honeydew, honeydew2, honeydew3, honeydew4, ivory, ivory2, ivory3, ivory4, khaki1, khaki2, khaki3, khaki4, lavender, linen, magenta1, magenta2, magenta3, maroon1, maroon2, maroon3, maroon4, moccasin, orange1, orange2, orange3, orange4, orchid1, orchid2, orchid3, orchid4, peru, pink2, pink3, pink4, plum1, plum2, plum3, plum4, purple, purple1, purple2, purple3, purple4, red1, red2, salmon1, salmon2, salmon3, salmon4, seashell, seashell2, seashell3, seashell4, sienna1, sienna2, sienna3, sienna4, snow, snow2, snow3, snow4, tan1, tan2, thistle1, thistle2, thistle3, thistle4, tomato, tomato2, tomato3, turquoise1, turquoise2, turquoise3, turquoise4, wheat1, wheat2, wheat3, wheat4, yellow1
textNonSelectionColor colorEnumStringType optional Since 2019.02 It is possible to configure the text color for non-selected individual and group nodes on the Forecast panel.
One of: alice blue, white, antique white, antique white1, antique white2, antique white3, antique white4, aquamarine, black, blanched almond, blue, blue violet, brown, cadet blue, cadet blue1, cadet blue2, cadet blue3, cadet blue4, coral, cornflower blue, cyan, dark goldenrod, dark goldenrod1, dark goldenrod2, dark goldenrod3, dark goldenrod4, dark green, dark khaki, dark olive green, dark olive green1, dark olive green2, dark olive green3, dark olive green4, dark orange, dark orange1, dark orange2, dark orange3, dark orange4, dark orchid, dark orchid1, dark orchid2, dark orchid3, dark orchid4, dark salmon, dark sea green, dark sea green1, dark sea green2, dark sea green3, dark sea green4, dark slate blue, dark slate gray, dark slate gray1, dark slate gray2, dark slate gray3, dark slate gray4, dark turquoise, dark violet, deep pink, deep pink2, deep pink3, deep pink4, deep sky blue, deep sky blue2, deep sky blue3, deep sky blue4, dim gray, dodger blue, dodger blue2, dodger blue3, dodger blue4, firebrick, floral white, forest green, ghost white, gold, goldenrod, gray, gray0, gray100, gray18, gray21, gray23, gray24, gray25, gray26, gray27, gray28, gray29, gray30, gray31, gray32, gray34, gray35, gray36, gray37, gray38, gray39, gray40, gray41, gray42, gray43, gray44, gray45, gray46, gray47, gray48, gray49, gray50, gray51, gray52, gray53, gray54, gray55, gray56, gray57, gray58, gray59, gray60, gray61, gray62, gray63, gray64, gray65, gray66, gray67, gray68, gray69, gray70, gray71, gray72, gray73, gray74, gray75, gray76, gray77, gray78, gray79, gray80, gray81, gray82, gray83, gray84, gray85, gray86, gray87, gray88, gray89, gray90, gray91, gray92, gray93, gray94, gray95, gray96, gray97, gray98, gray99, green, green yellow, hot pink, hot pink1, hot pink2, hot pink3, hot pink4, indian red, indian red1, indian red2, indian red3, indian red4, khaki, lavender blush, lavender blush2, lavender blush3, lavender blush4, lawn green, lemon chiffon, lemon chiffon2, lemon chiffon3, lemon chiffon4, light blue, light blue1, light blue2, light blue3, light blue4, light coral, light cyan, light cyan2, light cyan3, light cyan4, light goldenrod, light goldenrod1, light goldenrod2, light goldenrod3, light goldenrod4, light goldenrod yellow, light pink, light pink1, light pink2, light pink3, light pink4, light salmon, light salmon2, light salmon3, light salmon4, light sea green, light sky blue, light sky blue2, light sky blue3, light sky blue4, light slate blue, light slate gray, light steel blue, light steel blue1, light steel blue2, light steel blue3, light steel blue4, light yellow, light yellow2, light yellow3, light yellow4, lime green, magenta, maroon, medium aquamarine, medium blue, medium forest green, medium goldenrod, medium orchid, medium orchid1, medium orchid2, medium orchid3, medium orchid4, medium purple, medium purple1, medium purple2, medium purple3, medium purple4, medium sea green, medium slate blue, medium spring green, medium turquoise, medium violet red, midnight blue, mint cream, misty rose, misty rose2, misty rose3, misty rose4, navajo white, navajo white2, navajo white3, navajo white4, navy, old lace, olive drab, olive drab1, olive drab2, olive drab3, olive drab4, orange, orange red, orange red2, orange red3, orange red4, orchid, pale goldenrod, pale green, pale green1, pale green2, pale green3, pale green4, pale turquoise, pale turquoise1, pale turquoise2, pale turquoise3, pale turquoise4, pale violet red, pale violet red1, pale violet red2, pale violet red3, pale violet red4, papaya whip, peach puff, peach puff2, peach puff3, peach puff4, pink, plum, powder blue, red, rosy brown, rosy brown1, rosy brown2, rosy brown3, rosy brown4, royal blue, royal blue1, royal blue2, royal blue3, royal blue4, sandy brown, sea green, sea green1, sea green2, sea green3, sea green4, sienna, sky blue, sky blue1, sky blue2, sky blue3, sky blue4, slate blue, slate blue1, slate blue2, slate blue3, slate blue4, slate gray, slate gray1, slate gray2, slate gray3, slate gray4, spring green, spring green1, spring green2, spring green3, spring green4, steel blue, steel blue1, steel blue2, steel blue3, steel blue4, tan, thistle, turquoise, violet, violet red, violet red1, violet red2, violet red3, violet red4, wheat, yellow, yellow green, aquamarine1, aquamarine2, aquamarine3, aquamarine4, azure, azure2, azure3, azure4, beige, bisque, bisque2, bisque3, bisque4, blue1, blue2, blue3, blue4, brown1, brown2, brown3, burlywood1, burlywood2, burlywood3, burlywood4, chartreuse, chartreuse2, chartreuse3, chartreuse4, chocolate, coral2, coral3, coral4, cornsilk, cornsilk2, cornsilk3, cornsilk4, cyan1, cyan2, cyan3, cyan4, firebrick1, firebrick2, firebrick3, gainsboro, gold1, gold2, gold3, gold4, goldenrod1, goldenrod2, goldenrod3, goldenrod4, green1, green2, green3, green4, honeydew, honeydew2, honeydew3, honeydew4, ivory, ivory2, ivory3, ivory4, khaki1, khaki2, khaki3, khaki4, lavender, linen, magenta1, magenta2, magenta3, maroon1, maroon2, maroon3, maroon4, moccasin, orange1, orange2, orange3, orange4, orchid1, orchid2, orchid3, orchid4, peru, pink2, pink3, pink4, plum1, plum2, plum3, plum4, purple, purple1, purple2, purple3, purple4, red1, red2, salmon1, salmon2, salmon3, salmon4, seashell, seashell2, seashell3, seashell4, sienna1, sienna2, sienna3, sienna4, snow, snow2, snow3, snow4, tan1, tan2, thistle1, thistle2, thistle3, thistle4, tomato, tomato2, tomato3, turquoise1, turquoise2, turquoise3, turquoise4, wheat1, wheat2, wheat3, wheat4, yellow1
node NodeComplexType required Child element in the topology structure. Workflows of child nodes are run locally
nodes NodesComplexType required one or more parent nodes in the topology structure
groupId string required It is possible to split the configuration of the topology in different files. The topology.xml is always the main configuration file. Parts of the topology (topology groups) can be configured in separate files. These topology groups are identified by a group id. This element can be used to configure which topology group should be injected.
properties PropertiesComplexType optional These properties can be referenced in workflow files and module config file with $key$, similar to global properties. These properties are overruling the global properties and module properties.
workflowId string required The id of the workflow which is connected to this node. When configured in a parent node, this workflow will only be executed when running on the server. When running the parent node locally, the workflows of the child nodes will be executed.
refreshConfigAfterCompletion boolean optional If true, for the client type Computational Framework, the configuration is automatically reloaded after a successful run of the workflow.
moduleInstanceId string optional · repeats When no module instance ids are specified all module instances in the workflow are executed. Specifiying the module instances that should be executed only works for local runs
enableAutoApprove boolean optional Since 2019.02. If this option is set to true, an Approve checkbox will appear on the run options panel. With this checkbox the forecaster can determine if the forecast should be approved automatically after the run. The initial value of the check box is determined by the autoApprove setting of the workflowDescriptor. Note: the Approve check box will never appear if the approving of the forecast is not allowed ( allowApprove=false in workflowDescriptor). In this case also a Config.Error is logged.
secondaryWorkflowId idStringType required · repeats Since 201801. The id of a secondary workflow which can be started from the IFD. Only the first configured workflow id will be used in the OC or SA. Additional worfklows will only be available in the WebOC.
runSecondaryWorkflowAtServer boolean optional Since 201801. By default the secondary workflow will be a server run if the primary workflow also runs at the server
runSecondaryWorkflowWithTaskRunPropertiesFromIFD boolean optional Since 2019.02 (And the EA branch). By default the secondary workflow will ignore the taskrun properties in the IFD and run with configured properties in the workflow. When this option is set to true the taskrun properties of the IFD will be used.
enableSecondaryWorkflow enableSecondaryWorkflowType optional Since 2021.02 Defines when the secondary workflow button is enabled
One of: onlyWhenMainWorkflowIsPersistedOnServer
startDateTime DateTimeComplexType required Available since 2025.01 It can be used to configure a fixed starting time for an IFD run. Cannot be combined with coldStartTime, forecastLength or timeZero.
enableEarlierStartTime boolean optional Since 2025.01. If this option is set to true, the forecaster can set the start time of the run to a date before the fixed start time.
enableLaterStartTime boolean optional Since 2025.01. If this option is set to true, the forecaster can set the start time of the run to a date after the fixed start time.
endDateTime DateTimeComplexType required Available since 2025.01 It can be used to configure a fixed end time for an IFD run. Cannot be combined with coldStartTime, forecastLength or timeZero.
enableEarlierEndTime boolean optional Since 2025.01. If this option is set to true, the forecaster can set the end time of the run to a date before the fixed end time.
enableLaterEndTime boolean optional Since 2025.01. If this option is set to true, the forecaster can set the end time of the run to a date after the fixed end time.
useForecastLengthFromInteractiveForecastDisplay boolean required If this option is set to false the forecast length will be determined by the workflow
forecastLength TimeSpanComplexType optional Define the forecast length for a node. The forecast length is configured as a time span relative to T0. The user will be able to edit the forecast in the user interface (topology)
cardinalTimeStepForecastLength TimeStepComplexType optional This option can be used to define a cardinal time step for the end time or forecast length of a node.
initialForecastLengthCardinalTimeStep TimeStepComplexType optional This option will determine the initial time of the end time by fitting the time to the cardinal time step
fixedColdState FixedColdStateComplexType optional
coldState TimeSpanComplexType optional With this option can be configured which initial state selection should be used by default.
coldStateFromCurrentRun ColdStateFromCurrentRunComplexType optional With this option can be configured that the run will start with a cold state equal to the start of the previous run of the configured workflow
coldStateStartTime DateTimeComplexType optional With this option a cold state can be configured with a fixed start date/time
warmStateSelectionPeriod RelativePeriodComplexType optional Time window used to search for a warm state.
warmState TimeSpanComplexType optional With this option can be configured which initial state selection should be used by default.
noInitialState emptyElement optional With this option can be configured which initial state selection should be used by default.
cardinalTimeStepStartTime TimeStepComplexType optional This option can be used to define a cardinal time step for the start time or state selection of a node.
initialStartTimeCardinalTimeStep TimeStepComplexType optional This option will determine the initial time of the start time by fitting the time to the cardinal time step
cardinalTimeStepEndTime TimeStepComplexType optional This option can be used to define a cardinal time step for the end time or forecast length of a node.
initialEndTimeCardinalTimeStep TimeStepComplexType optional This option will determine the initial time of the end time by fitting the time to the cardinal time step
relativePeriod RelativePeriodComplexType required Define a relative period for this node. The workflow will run with a cold state equal to the start time of the node. The forecast length will be determined by calculating the difference between the end time and T0. The GUI will show a start time and an end time. This option can, for example, be used when the workflow only contains transformations.
relativeStartTime RelativeTimeComplexType required Since 2017.02. The user can only determine the start time (cold state selection of the run). The forecast length will be determined by the workflow.
timeZero DateTimeComplexType optional This option can be used to set a prefixed time zero for a group or a single node. If this option is not configured the system time will be used as time zero.
timeZeroShift TimeShiftComplexType optional By default the time zero of the shown in the IFD is non-editable. If this option is chosen the t0 is editable and is shifted with the configured timeZeroShift.
localRun boolean optional by default workflows of child nodes will run locally and parent node are run at the server. By setting this option to true the workflow will run locally
saveLocalRunEnabled boolean optional Since 2015.01. Allow the user to make a temporary local run permanent and upload it to the server, commit the modifiers, approves the forecast and makes it current. When the local run was executed on the server the run is approved and marked public
privateRunAtServer boolean required by default ifd runs run locally, but with this option the ifd run is executed at the server but are only visible for the current user. This run can be made visible for other users by pressing the save button. Uncommitted modifiers from the current users are visible at the server for this run
publishPrivateRunEnabled boolean optional Since 2015.01. Allow the user to make the private run public commit the modifiers, approve the forecast and make it current.
alwaysVisibleInForecasterNotes boolean optional Specifies that the forecaster notes, created for this node, should be always visible in the ForecasterNotesDisplay. By default, the ForecasteNotesDisplay shows the notes for the the node (and its parent) that is selected by the user in the Topology GUI. This list of forecast notes can be extended with the notes that are created for the node with option alwaysVisibleInForecasterNotes=true
mapExtentId string optional optional element to define a zoomExtent. When a node with this element defined is selected the map will automatically zoom to this extent
filterId idStringType optional · repeats The configured filter will automatically be selected when the node is selected in the topology.
disableMap boolean optional Since 2024.02. Only used in the WebOC! This element can be used to disable the map in the WebOC.
dataDownloadDisplayId idStringType optional Since 2023.02. Only used in the WebOC! The id of the data download display which is coupled to this node.
logDisplayId idStringType optional Since 2023.02. Only used in the WebOC! The id of the data log display that is configured in de DisplayConfigFiles/LogDisplays.xml file.
dynamicReportDisplayId idStringType optional Since 2024.02. Only used in the WebOC! The id of the dynamic report display that is configured in de DisplayConfigFiles/DynamicReportDisplays.xml file.
webOCDashboardId idStringType optional · repeats Since 2023.02. Only used in the WebOC! The id of the dashboard panel. It is possible to define multiple dashboard ids.
webOCMicroFrontEndId idStringType optional · repeats Since 2025.02. Only used in the WebOC! The id of the micro front end that is configured in the WebOCMicroFrontEnds DisplayConfigFiles.
documentDisplayId idStringType optional Since 2024.02. Only used in the WebOC! The reference by id to a document defined in the documentDisplays.xml.
timeSeriesButtonsPanelId idStringType optional Since 2014.01. Reference to time series button panel that becomes visible when this topology node is activated. For this functionality you need to configure the time series button panel in explorer.xml and to add timeSeriesButtonsPanels.xml in the display config files..
reportModuleInstanceId idStringType optional Since 2024.01. Only used in the WebOC! The moduleInstance id for which to show reports for this node.
dataAnalysisDisplayId idStringType optional Since 2024.01. Only used in the WebOC! The id of the data analysis display which is coupled to this node.
documentFile string optional Since 2022.02. Refer to a document file that is available in the WebResourcesFiles.
displayGroupId idStringType optional · repeats displayGroupId references the id of a configured displayGroup element in the DisplayGroups.xml
displayId idStringType optional Since 2019.01 The display id references the id of a configured display element in the DisplayGroups.xml
plotId idStringType optional Since 2019.01 define the plot from which the display should be generated. The plot id and the location id define the display which should be displayed
customInfoLabel CustomInfoLabelComplexType optional Since 2018.02 if a node has a custom info label defined then the defined text will be shown below the time zero in the IFD run options section. It is allowed to use attributes in the custom info label.
showWorkflowDescriptionBox boolean optional Since 2016.02 show a textbox in which the user can enter a description for the workflow
disableAdvancedButton boolean optional Since 2016.01 Disable the run edit options button when this node or one of its children is selected
hideModifiersOverviewPanel boolean optional Since 2015.02 hide the overview panel when this node or one its children is selected.
areaId idStringType optional This element can be used to group this node and it children to the area
modifiersReadOnly boolean optional With this option a node can be set to readonly. Which means that modifiers can be viewed, but not created, editted or deleted.
viewPermission string optional set a permission to control who can view this node
runWorkflowLocallyPermission string optional Permission to run the workflow for a node locally
runWorkflowAtServerPermission string optional Permission to run the workflow for a node at the server
runSecondaryWorkflowPermission string optional Since 201801. Permission to run the secondary workflow
defaultModifierId idStringType optional Optional element to define a default modifier for a node. When a node is selected and a default modifier is defined the section in the modifiers display in which a modifier can be created will automaticly initialize to the defined default modifier.
onlyAllowEditDefaultModifier boolean optional Since 2014.02. This element will enable that if a default modifier is configured that only the default modifier an be editted
visibleModifierGroup idStringType optional · repeats If this option is not configured, than all applicable modifiers can be used. With this option it is possible to restrict which modifier groups can be used
attributeModifierLocationConstraint ConstraintsComplexType optional Since 2018.02 Restriction for the locations whose attributes should be modified. If ommitted attributes of all locations associated with this node can be modified
graceTime TimeSpanComplexType optional If ths element is not defined only the runs from which the T0 is equal to the system time are used to define show the icons in the topology panel. However with a grace time configured also runs which fall within the period T0 - grace time are used
checkStatusPreviousServerRun boolean optional If this option is set to true a server run can only be started if the status of the previous run is fully successful
showMacroButton boolean optional this option can be used to show a macro button which can be used to start a server task with a predefined taskproperties-xml
gridDisplaySelection gridDisplaySelection optional Since 2023.01, selection in grid display can be specified with group and plot ids.
toolWindow toolWindowStringType optional · repeats this option can be used to configure which toolwindow should be activated or de-activated after selecting this node
One of: forecaster notes, log panel, plot overview, filters, document selection panel
url anyURI optional Since 2016.01. Configure a URL related to the node. Can be used by the Web Browser Display to open the URL. For file based URLs the file:/// convention should be used.
embedUrl anyURI optional Since 2023.02. Will open a URL embedded in the Web OC.
useStatusParentNode boolean optional Since 2017.01 If the node has a server run and the parent node has a more recent server run the status of the parent node will be used. If this is set to false, then the server run of the parent node will be ignored.
thresholdValueSetId idStringType optional · repeats Since 2018.02 The forecast tree shows by default icons which show the run status of the workflow associated with the node. The forecast tree however also has the possibility to show threshold related icons. This option can be used to configure for which threshold value sets icons should be showed.
scadaDisplayId idStringType optional Configure the ID of a scada display to open. Can be used by the Scada (SSD) Display to open a specific display when mainPanel is set to "schematic status display". The ID of a scada/SSD display if the same as the name of its config file (without the xml extension).
scadaPanelId idStringType optional Configure the ID of a scada panel to open. Can be used by the Scada (SSD) Display to open a specific scada panel when mainPanel is set to "schematic status display". If no scada panel Id is configured, the first scada panel configured will be opened.
popupMessageServerRun string optional Since 2022.01. The message which will be shown when a server run is started from this node.
popupMessageUncommittedModifiers string optional Since 2022.01. The message which will be shown when the leaves a node with uncommitted modifiers.
thresholdIconRelativeViewPeriod RelativePeriodComplexType optional Since 2024.01. The relative view period which will be used for the threshold icon of the topology (IFD and WebOC). If this option is not configured then no threshold icons will be shown.
icon nameStringType optional Since 202302. Define a custom icon to be used in the topology tree (WebOC and OC)
iconId nameStringType optional Since 202302. Only used in the WebOC! Define the id of the icon to be used in the topology tree of the Web OC.
mainPanel mainPanelStringType required Display can be specified using a key from the enumeration
One of: time series dialog, map display, modifiers panel, grid display, system monitor, correlation display, document panel, web browser display, kflows, topology panel, schematic status display, log display, webOC dashboard, what-if display, data analysis display
explorerTaskName nonEmptyStringType required Since 2021.02, display can be specified using the name specified for an explorer task.
displayConfigFileName nonEmptyStringType required Display config file name of the display that should be activated
panelId idStringType required Id of a specific SSD panel to open. If no Id is configured, the first SSD will be opened
tabId SystemMonitorTabEnumStringType required Id of a specific SystemMonitor tab to open. If no Id is configured, the logBrowser tab will be opened
One of: logBrowser, bulletinBoard, bulletinBoardPlus, batchTasks, importStatus, exportStatus, liveStatus, scheduledTasks, runningTasks, synchStatus, synchLog

NodeComplexType

Attributes

AttributeUseNotes
id required The id of the node. The id should always be unique!
name optional The name of the node. When this option is not used the id of the node will be used as the name. The configured name will be shown in the topology tree.

Elements

ElementTypeCardinalityDescription
previousNodeId string optional · repeats Optional element to define upstream connectivity between individual nodes.
nextNodeId string optional Optional element to define downstream connectivity between individual nodes. The same connectivity can be achieved by having the downstream node defining a previous node.
tabularLocationId idStringType optional · repeats Optional element to associate one or more locations to the node for use with the Tabular ConfigFiles Display.
componentSettingsId idStringType optional Since 2023.02. Only used in the WebOC! The id of the component settings.
showRunApprovedForecastButton boolean optional if this option is enabled the run approved forecast button is also show for a local node
backgroundSelectionColor colorEnumStringType optional
One of: alice blue, white, antique white, antique white1, antique white2, antique white3, antique white4, aquamarine, black, blanched almond, blue, blue violet, brown, cadet blue, cadet blue1, cadet blue2, cadet blue3, cadet blue4, coral, cornflower blue, cyan, dark goldenrod, dark goldenrod1, dark goldenrod2, dark goldenrod3, dark goldenrod4, dark green, dark khaki, dark olive green, dark olive green1, dark olive green2, dark olive green3, dark olive green4, dark orange, dark orange1, dark orange2, dark orange3, dark orange4, dark orchid, dark orchid1, dark orchid2, dark orchid3, dark orchid4, dark salmon, dark sea green, dark sea green1, dark sea green2, dark sea green3, dark sea green4, dark slate blue, dark slate gray, dark slate gray1, dark slate gray2, dark slate gray3, dark slate gray4, dark turquoise, dark violet, deep pink, deep pink2, deep pink3, deep pink4, deep sky blue, deep sky blue2, deep sky blue3, deep sky blue4, dim gray, dodger blue, dodger blue2, dodger blue3, dodger blue4, firebrick, floral white, forest green, ghost white, gold, goldenrod, gray, gray0, gray100, gray18, gray21, gray23, gray24, gray25, gray26, gray27, gray28, gray29, gray30, gray31, gray32, gray34, gray35, gray36, gray37, gray38, gray39, gray40, gray41, gray42, gray43, gray44, gray45, gray46, gray47, gray48, gray49, gray50, gray51, gray52, gray53, gray54, gray55, gray56, gray57, gray58, gray59, gray60, gray61, gray62, gray63, gray64, gray65, gray66, gray67, gray68, gray69, gray70, gray71, gray72, gray73, gray74, gray75, gray76, gray77, gray78, gray79, gray80, gray81, gray82, gray83, gray84, gray85, gray86, gray87, gray88, gray89, gray90, gray91, gray92, gray93, gray94, gray95, gray96, gray97, gray98, gray99, green, green yellow, hot pink, hot pink1, hot pink2, hot pink3, hot pink4, indian red, indian red1, indian red2, indian red3, indian red4, khaki, lavender blush, lavender blush2, lavender blush3, lavender blush4, lawn green, lemon chiffon, lemon chiffon2, lemon chiffon3, lemon chiffon4, light blue, light blue1, light blue2, light blue3, light blue4, light coral, light cyan, light cyan2, light cyan3, light cyan4, light goldenrod, light goldenrod1, light goldenrod2, light goldenrod3, light goldenrod4, light goldenrod yellow, light pink, light pink1, light pink2, light pink3, light pink4, light salmon, light salmon2, light salmon3, light salmon4, light sea green, light sky blue, light sky blue2, light sky blue3, light sky blue4, light slate blue, light slate gray, light steel blue, light steel blue1, light steel blue2, light steel blue3, light steel blue4, light yellow, light yellow2, light yellow3, light yellow4, lime green, magenta, maroon, medium aquamarine, medium blue, medium forest green, medium goldenrod, medium orchid, medium orchid1, medium orchid2, medium orchid3, medium orchid4, medium purple, medium purple1, medium purple2, medium purple3, medium purple4, medium sea green, medium slate blue, medium spring green, medium turquoise, medium violet red, midnight blue, mint cream, misty rose, misty rose2, misty rose3, misty rose4, navajo white, navajo white2, navajo white3, navajo white4, navy, old lace, olive drab, olive drab1, olive drab2, olive drab3, olive drab4, orange, orange red, orange red2, orange red3, orange red4, orchid, pale goldenrod, pale green, pale green1, pale green2, pale green3, pale green4, pale turquoise, pale turquoise1, pale turquoise2, pale turquoise3, pale turquoise4, pale violet red, pale violet red1, pale violet red2, pale violet red3, pale violet red4, papaya whip, peach puff, peach puff2, peach puff3, peach puff4, pink, plum, powder blue, red, rosy brown, rosy brown1, rosy brown2, rosy brown3, rosy brown4, royal blue, royal blue1, royal blue2, royal blue3, royal blue4, sandy brown, sea green, sea green1, sea green2, sea green3, sea green4, sienna, sky blue, sky blue1, sky blue2, sky blue3, sky blue4, slate blue, slate blue1, slate blue2, slate blue3, slate blue4, slate gray, slate gray1, slate gray2, slate gray3, slate gray4, spring green, spring green1, spring green2, spring green3, spring green4, steel blue, steel blue1, steel blue2, steel blue3, steel blue4, tan, thistle, turquoise, violet, violet red, violet red1, violet red2, violet red3, violet red4, wheat, yellow, yellow green, aquamarine1, aquamarine2, aquamarine3, aquamarine4, azure, azure2, azure3, azure4, beige, bisque, bisque2, bisque3, bisque4, blue1, blue2, blue3, blue4, brown1, brown2, brown3, burlywood1, burlywood2, burlywood3, burlywood4, chartreuse, chartreuse2, chartreuse3, chartreuse4, chocolate, coral2, coral3, coral4, cornsilk, cornsilk2, cornsilk3, cornsilk4, cyan1, cyan2, cyan3, cyan4, firebrick1, firebrick2, firebrick3, gainsboro, gold1, gold2, gold3, gold4, goldenrod1, goldenrod2, goldenrod3, goldenrod4, green1, green2, green3, green4, honeydew, honeydew2, honeydew3, honeydew4, ivory, ivory2, ivory3, ivory4, khaki1, khaki2, khaki3, khaki4, lavender, linen, magenta1, magenta2, magenta3, maroon1, maroon2, maroon3, maroon4, moccasin, orange1, orange2, orange3, orange4, orchid1, orchid2, orchid3, orchid4, peru, pink2, pink3, pink4, plum1, plum2, plum3, plum4, purple, purple1, purple2, purple3, purple4, red1, red2, salmon1, salmon2, salmon3, salmon4, seashell, seashell2, seashell3, seashell4, sienna1, sienna2, sienna3, sienna4, snow, snow2, snow3, snow4, tan1, tan2, thistle1, thistle2, thistle3, thistle4, tomato, tomato2, tomato3, turquoise1, turquoise2, turquoise3, turquoise4, wheat1, wheat2, wheat3, wheat4, yellow1
backgroundNonSelectionColor colorEnumStringType optional
One of: alice blue, white, antique white, antique white1, antique white2, antique white3, antique white4, aquamarine, black, blanched almond, blue, blue violet, brown, cadet blue, cadet blue1, cadet blue2, cadet blue3, cadet blue4, coral, cornflower blue, cyan, dark goldenrod, dark goldenrod1, dark goldenrod2, dark goldenrod3, dark goldenrod4, dark green, dark khaki, dark olive green, dark olive green1, dark olive green2, dark olive green3, dark olive green4, dark orange, dark orange1, dark orange2, dark orange3, dark orange4, dark orchid, dark orchid1, dark orchid2, dark orchid3, dark orchid4, dark salmon, dark sea green, dark sea green1, dark sea green2, dark sea green3, dark sea green4, dark slate blue, dark slate gray, dark slate gray1, dark slate gray2, dark slate gray3, dark slate gray4, dark turquoise, dark violet, deep pink, deep pink2, deep pink3, deep pink4, deep sky blue, deep sky blue2, deep sky blue3, deep sky blue4, dim gray, dodger blue, dodger blue2, dodger blue3, dodger blue4, firebrick, floral white, forest green, ghost white, gold, goldenrod, gray, gray0, gray100, gray18, gray21, gray23, gray24, gray25, gray26, gray27, gray28, gray29, gray30, gray31, gray32, gray34, gray35, gray36, gray37, gray38, gray39, gray40, gray41, gray42, gray43, gray44, gray45, gray46, gray47, gray48, gray49, gray50, gray51, gray52, gray53, gray54, gray55, gray56, gray57, gray58, gray59, gray60, gray61, gray62, gray63, gray64, gray65, gray66, gray67, gray68, gray69, gray70, gray71, gray72, gray73, gray74, gray75, gray76, gray77, gray78, gray79, gray80, gray81, gray82, gray83, gray84, gray85, gray86, gray87, gray88, gray89, gray90, gray91, gray92, gray93, gray94, gray95, gray96, gray97, gray98, gray99, green, green yellow, hot pink, hot pink1, hot pink2, hot pink3, hot pink4, indian red, indian red1, indian red2, indian red3, indian red4, khaki, lavender blush, lavender blush2, lavender blush3, lavender blush4, lawn green, lemon chiffon, lemon chiffon2, lemon chiffon3, lemon chiffon4, light blue, light blue1, light blue2, light blue3, light blue4, light coral, light cyan, light cyan2, light cyan3, light cyan4, light goldenrod, light goldenrod1, light goldenrod2, light goldenrod3, light goldenrod4, light goldenrod yellow, light pink, light pink1, light pink2, light pink3, light pink4, light salmon, light salmon2, light salmon3, light salmon4, light sea green, light sky blue, light sky blue2, light sky blue3, light sky blue4, light slate blue, light slate gray, light steel blue, light steel blue1, light steel blue2, light steel blue3, light steel blue4, light yellow, light yellow2, light yellow3, light yellow4, lime green, magenta, maroon, medium aquamarine, medium blue, medium forest green, medium goldenrod, medium orchid, medium orchid1, medium orchid2, medium orchid3, medium orchid4, medium purple, medium purple1, medium purple2, medium purple3, medium purple4, medium sea green, medium slate blue, medium spring green, medium turquoise, medium violet red, midnight blue, mint cream, misty rose, misty rose2, misty rose3, misty rose4, navajo white, navajo white2, navajo white3, navajo white4, navy, old lace, olive drab, olive drab1, olive drab2, olive drab3, olive drab4, orange, orange red, orange red2, orange red3, orange red4, orchid, pale goldenrod, pale green, pale green1, pale green2, pale green3, pale green4, pale turquoise, pale turquoise1, pale turquoise2, pale turquoise3, pale turquoise4, pale violet red, pale violet red1, pale violet red2, pale violet red3, pale violet red4, papaya whip, peach puff, peach puff2, peach puff3, peach puff4, pink, plum, powder blue, red, rosy brown, rosy brown1, rosy brown2, rosy brown3, rosy brown4, royal blue, royal blue1, royal blue2, royal blue3, royal blue4, sandy brown, sea green, sea green1, sea green2, sea green3, sea green4, sienna, sky blue, sky blue1, sky blue2, sky blue3, sky blue4, slate blue, slate blue1, slate blue2, slate blue3, slate blue4, slate gray, slate gray1, slate gray2, slate gray3, slate gray4, spring green, spring green1, spring green2, spring green3, spring green4, steel blue, steel blue1, steel blue2, steel blue3, steel blue4, tan, thistle, turquoise, violet, violet red, violet red1, violet red2, violet red3, violet red4, wheat, yellow, yellow green, aquamarine1, aquamarine2, aquamarine3, aquamarine4, azure, azure2, azure3, azure4, beige, bisque, bisque2, bisque3, bisque4, blue1, blue2, blue3, blue4, brown1, brown2, brown3, burlywood1, burlywood2, burlywood3, burlywood4, chartreuse, chartreuse2, chartreuse3, chartreuse4, chocolate, coral2, coral3, coral4, cornsilk, cornsilk2, cornsilk3, cornsilk4, cyan1, cyan2, cyan3, cyan4, firebrick1, firebrick2, firebrick3, gainsboro, gold1, gold2, gold3, gold4, goldenrod1, goldenrod2, goldenrod3, goldenrod4, green1, green2, green3, green4, honeydew, honeydew2, honeydew3, honeydew4, ivory, ivory2, ivory3, ivory4, khaki1, khaki2, khaki3, khaki4, lavender, linen, magenta1, magenta2, magenta3, maroon1, maroon2, maroon3, maroon4, moccasin, orange1, orange2, orange3, orange4, orchid1, orchid2, orchid3, orchid4, peru, pink2, pink3, pink4, plum1, plum2, plum3, plum4, purple, purple1, purple2, purple3, purple4, red1, red2, salmon1, salmon2, salmon3, salmon4, seashell, seashell2, seashell3, seashell4, sienna1, sienna2, sienna3, sienna4, snow, snow2, snow3, snow4, tan1, tan2, thistle1, thistle2, thistle3, thistle4, tomato, tomato2, tomato3, turquoise1, turquoise2, turquoise3, turquoise4, wheat1, wheat2, wheat3, wheat4, yellow1
textSelectionColor colorEnumStringType optional
One of: alice blue, white, antique white, antique white1, antique white2, antique white3, antique white4, aquamarine, black, blanched almond, blue, blue violet, brown, cadet blue, cadet blue1, cadet blue2, cadet blue3, cadet blue4, coral, cornflower blue, cyan, dark goldenrod, dark goldenrod1, dark goldenrod2, dark goldenrod3, dark goldenrod4, dark green, dark khaki, dark olive green, dark olive green1, dark olive green2, dark olive green3, dark olive green4, dark orange, dark orange1, dark orange2, dark orange3, dark orange4, dark orchid, dark orchid1, dark orchid2, dark orchid3, dark orchid4, dark salmon, dark sea green, dark sea green1, dark sea green2, dark sea green3, dark sea green4, dark slate blue, dark slate gray, dark slate gray1, dark slate gray2, dark slate gray3, dark slate gray4, dark turquoise, dark violet, deep pink, deep pink2, deep pink3, deep pink4, deep sky blue, deep sky blue2, deep sky blue3, deep sky blue4, dim gray, dodger blue, dodger blue2, dodger blue3, dodger blue4, firebrick, floral white, forest green, ghost white, gold, goldenrod, gray, gray0, gray100, gray18, gray21, gray23, gray24, gray25, gray26, gray27, gray28, gray29, gray30, gray31, gray32, gray34, gray35, gray36, gray37, gray38, gray39, gray40, gray41, gray42, gray43, gray44, gray45, gray46, gray47, gray48, gray49, gray50, gray51, gray52, gray53, gray54, gray55, gray56, gray57, gray58, gray59, gray60, gray61, gray62, gray63, gray64, gray65, gray66, gray67, gray68, gray69, gray70, gray71, gray72, gray73, gray74, gray75, gray76, gray77, gray78, gray79, gray80, gray81, gray82, gray83, gray84, gray85, gray86, gray87, gray88, gray89, gray90, gray91, gray92, gray93, gray94, gray95, gray96, gray97, gray98, gray99, green, green yellow, hot pink, hot pink1, hot pink2, hot pink3, hot pink4, indian red, indian red1, indian red2, indian red3, indian red4, khaki, lavender blush, lavender blush2, lavender blush3, lavender blush4, lawn green, lemon chiffon, lemon chiffon2, lemon chiffon3, lemon chiffon4, light blue, light blue1, light blue2, light blue3, light blue4, light coral, light cyan, light cyan2, light cyan3, light cyan4, light goldenrod, light goldenrod1, light goldenrod2, light goldenrod3, light goldenrod4, light goldenrod yellow, light pink, light pink1, light pink2, light pink3, light pink4, light salmon, light salmon2, light salmon3, light salmon4, light sea green, light sky blue, light sky blue2, light sky blue3, light sky blue4, light slate blue, light slate gray, light steel blue, light steel blue1, light steel blue2, light steel blue3, light steel blue4, light yellow, light yellow2, light yellow3, light yellow4, lime green, magenta, maroon, medium aquamarine, medium blue, medium forest green, medium goldenrod, medium orchid, medium orchid1, medium orchid2, medium orchid3, medium orchid4, medium purple, medium purple1, medium purple2, medium purple3, medium purple4, medium sea green, medium slate blue, medium spring green, medium turquoise, medium violet red, midnight blue, mint cream, misty rose, misty rose2, misty rose3, misty rose4, navajo white, navajo white2, navajo white3, navajo white4, navy, old lace, olive drab, olive drab1, olive drab2, olive drab3, olive drab4, orange, orange red, orange red2, orange red3, orange red4, orchid, pale goldenrod, pale green, pale green1, pale green2, pale green3, pale green4, pale turquoise, pale turquoise1, pale turquoise2, pale turquoise3, pale turquoise4, pale violet red, pale violet red1, pale violet red2, pale violet red3, pale violet red4, papaya whip, peach puff, peach puff2, peach puff3, peach puff4, pink, plum, powder blue, red, rosy brown, rosy brown1, rosy brown2, rosy brown3, rosy brown4, royal blue, royal blue1, royal blue2, royal blue3, royal blue4, sandy brown, sea green, sea green1, sea green2, sea green3, sea green4, sienna, sky blue, sky blue1, sky blue2, sky blue3, sky blue4, slate blue, slate blue1, slate blue2, slate blue3, slate blue4, slate gray, slate gray1, slate gray2, slate gray3, slate gray4, spring green, spring green1, spring green2, spring green3, spring green4, steel blue, steel blue1, steel blue2, steel blue3, steel blue4, tan, thistle, turquoise, violet, violet red, violet red1, violet red2, violet red3, violet red4, wheat, yellow, yellow green, aquamarine1, aquamarine2, aquamarine3, aquamarine4, azure, azure2, azure3, azure4, beige, bisque, bisque2, bisque3, bisque4, blue1, blue2, blue3, blue4, brown1, brown2, brown3, burlywood1, burlywood2, burlywood3, burlywood4, chartreuse, chartreuse2, chartreuse3, chartreuse4, chocolate, coral2, coral3, coral4, cornsilk, cornsilk2, cornsilk3, cornsilk4, cyan1, cyan2, cyan3, cyan4, firebrick1, firebrick2, firebrick3, gainsboro, gold1, gold2, gold3, gold4, goldenrod1, goldenrod2, goldenrod3, goldenrod4, green1, green2, green3, green4, honeydew, honeydew2, honeydew3, honeydew4, ivory, ivory2, ivory3, ivory4, khaki1, khaki2, khaki3, khaki4, lavender, linen, magenta1, magenta2, magenta3, maroon1, maroon2, maroon3, maroon4, moccasin, orange1, orange2, orange3, orange4, orchid1, orchid2, orchid3, orchid4, peru, pink2, pink3, pink4, plum1, plum2, plum3, plum4, purple, purple1, purple2, purple3, purple4, red1, red2, salmon1, salmon2, salmon3, salmon4, seashell, seashell2, seashell3, seashell4, sienna1, sienna2, sienna3, sienna4, snow, snow2, snow3, snow4, tan1, tan2, thistle1, thistle2, thistle3, thistle4, tomato, tomato2, tomato3, turquoise1, turquoise2, turquoise3, turquoise4, wheat1, wheat2, wheat3, wheat4, yellow1
textNonSelectionColor colorEnumStringType optional
One of: alice blue, white, antique white, antique white1, antique white2, antique white3, antique white4, aquamarine, black, blanched almond, blue, blue violet, brown, cadet blue, cadet blue1, cadet blue2, cadet blue3, cadet blue4, coral, cornflower blue, cyan, dark goldenrod, dark goldenrod1, dark goldenrod2, dark goldenrod3, dark goldenrod4, dark green, dark khaki, dark olive green, dark olive green1, dark olive green2, dark olive green3, dark olive green4, dark orange, dark orange1, dark orange2, dark orange3, dark orange4, dark orchid, dark orchid1, dark orchid2, dark orchid3, dark orchid4, dark salmon, dark sea green, dark sea green1, dark sea green2, dark sea green3, dark sea green4, dark slate blue, dark slate gray, dark slate gray1, dark slate gray2, dark slate gray3, dark slate gray4, dark turquoise, dark violet, deep pink, deep pink2, deep pink3, deep pink4, deep sky blue, deep sky blue2, deep sky blue3, deep sky blue4, dim gray, dodger blue, dodger blue2, dodger blue3, dodger blue4, firebrick, floral white, forest green, ghost white, gold, goldenrod, gray, gray0, gray100, gray18, gray21, gray23, gray24, gray25, gray26, gray27, gray28, gray29, gray30, gray31, gray32, gray34, gray35, gray36, gray37, gray38, gray39, gray40, gray41, gray42, gray43, gray44, gray45, gray46, gray47, gray48, gray49, gray50, gray51, gray52, gray53, gray54, gray55, gray56, gray57, gray58, gray59, gray60, gray61, gray62, gray63, gray64, gray65, gray66, gray67, gray68, gray69, gray70, gray71, gray72, gray73, gray74, gray75, gray76, gray77, gray78, gray79, gray80, gray81, gray82, gray83, gray84, gray85, gray86, gray87, gray88, gray89, gray90, gray91, gray92, gray93, gray94, gray95, gray96, gray97, gray98, gray99, green, green yellow, hot pink, hot pink1, hot pink2, hot pink3, hot pink4, indian red, indian red1, indian red2, indian red3, indian red4, khaki, lavender blush, lavender blush2, lavender blush3, lavender blush4, lawn green, lemon chiffon, lemon chiffon2, lemon chiffon3, lemon chiffon4, light blue, light blue1, light blue2, light blue3, light blue4, light coral, light cyan, light cyan2, light cyan3, light cyan4, light goldenrod, light goldenrod1, light goldenrod2, light goldenrod3, light goldenrod4, light goldenrod yellow, light pink, light pink1, light pink2, light pink3, light pink4, light salmon, light salmon2, light salmon3, light salmon4, light sea green, light sky blue, light sky blue2, light sky blue3, light sky blue4, light slate blue, light slate gray, light steel blue, light steel blue1, light steel blue2, light steel blue3, light steel blue4, light yellow, light yellow2, light yellow3, light yellow4, lime green, magenta, maroon, medium aquamarine, medium blue, medium forest green, medium goldenrod, medium orchid, medium orchid1, medium orchid2, medium orchid3, medium orchid4, medium purple, medium purple1, medium purple2, medium purple3, medium purple4, medium sea green, medium slate blue, medium spring green, medium turquoise, medium violet red, midnight blue, mint cream, misty rose, misty rose2, misty rose3, misty rose4, navajo white, navajo white2, navajo white3, navajo white4, navy, old lace, olive drab, olive drab1, olive drab2, olive drab3, olive drab4, orange, orange red, orange red2, orange red3, orange red4, orchid, pale goldenrod, pale green, pale green1, pale green2, pale green3, pale green4, pale turquoise, pale turquoise1, pale turquoise2, pale turquoise3, pale turquoise4, pale violet red, pale violet red1, pale violet red2, pale violet red3, pale violet red4, papaya whip, peach puff, peach puff2, peach puff3, peach puff4, pink, plum, powder blue, red, rosy brown, rosy brown1, rosy brown2, rosy brown3, rosy brown4, royal blue, royal blue1, royal blue2, royal blue3, royal blue4, sandy brown, sea green, sea green1, sea green2, sea green3, sea green4, sienna, sky blue, sky blue1, sky blue2, sky blue3, sky blue4, slate blue, slate blue1, slate blue2, slate blue3, slate blue4, slate gray, slate gray1, slate gray2, slate gray3, slate gray4, spring green, spring green1, spring green2, spring green3, spring green4, steel blue, steel blue1, steel blue2, steel blue3, steel blue4, tan, thistle, turquoise, violet, violet red, violet red1, violet red2, violet red3, violet red4, wheat, yellow, yellow green, aquamarine1, aquamarine2, aquamarine3, aquamarine4, azure, azure2, azure3, azure4, beige, bisque, bisque2, bisque3, bisque4, blue1, blue2, blue3, blue4, brown1, brown2, brown3, burlywood1, burlywood2, burlywood3, burlywood4, chartreuse, chartreuse2, chartreuse3, chartreuse4, chocolate, coral2, coral3, coral4, cornsilk, cornsilk2, cornsilk3, cornsilk4, cyan1, cyan2, cyan3, cyan4, firebrick1, firebrick2, firebrick3, gainsboro, gold1, gold2, gold3, gold4, goldenrod1, goldenrod2, goldenrod3, goldenrod4, green1, green2, green3, green4, honeydew, honeydew2, honeydew3, honeydew4, ivory, ivory2, ivory3, ivory4, khaki1, khaki2, khaki3, khaki4, lavender, linen, magenta1, magenta2, magenta3, maroon1, maroon2, maroon3, maroon4, moccasin, orange1, orange2, orange3, orange4, orchid1, orchid2, orchid3, orchid4, peru, pink2, pink3, pink4, plum1, plum2, plum3, plum4, purple, purple1, purple2, purple3, purple4, red1, red2, salmon1, salmon2, salmon3, salmon4, seashell, seashell2, seashell3, seashell4, sienna1, sienna2, sienna3, sienna4, snow, snow2, snow3, snow4, tan1, tan2, thistle1, thistle2, thistle3, thistle4, tomato, tomato2, tomato3, turquoise1, turquoise2, turquoise3, turquoise4, wheat1, wheat2, wheat3, wheat4, yellow1
locationId idStringType required · repeats Optional element to associate one or more locations to the node. When a filter is associated as well, these locations are highlighted on the map and in the data viewer.
locationSetId idStringType required
properties PropertiesComplexType optional These properties can be referenced in workflow files and module config file with $key$, similar to global properties. These properties are overruling the global properties and module properties.
workflowId string required The id of the workflow which is connected to this node. When configured in a parent node, this workflow will only be executed when running on the server. When running the parent node locally, the workflows of the child nodes will be executed.
refreshConfigAfterCompletion boolean optional If true, for the client type Computational Framework, the configuration is automatically reloaded after a successful run of the workflow.
moduleInstanceId string optional · repeats When no module instance ids are specified all module instances in the workflow are executed. Specifiying the module instances that should be executed only works for local runs
enableAutoApprove boolean optional Since 2019.02. If this option is set to true, an Approve checkbox will appear on the run options panel. With this checkbox the forecaster can determine if the forecast should be approved automatically after the run. The initial value of the check box is determined by the autoApprove setting of the workflowDescriptor. Note: the Approve check box will never appear if the approving of the forecast is not allowed ( allowApprove=false in workflowDescriptor). In this case also a Config.Error is logged.
secondaryWorkflowId idStringType required · repeats Since 201801. The id of a secondary workflow which can be started from the IFD. Only the first configured workflow id will be used in the OC or SA. Additional worfklows will only be available in the WebOC.
runSecondaryWorkflowAtServer boolean optional Since 201801. By default the secondary workflow will be a server run if the primary workflow also runs at the server
runSecondaryWorkflowWithTaskRunPropertiesFromIFD boolean optional Since 2019.02 (And the EA branch). By default the secondary workflow will ignore the taskrun properties in the IFD and run with configured properties in the workflow. When this option is set to true the taskrun properties of the IFD will be used.
enableSecondaryWorkflow enableSecondaryWorkflowType optional Since 2021.02 Defines when the secondary workflow button is enabled
One of: onlyWhenMainWorkflowIsPersistedOnServer
startDateTime DateTimeComplexType required Available since 2025.01 It can be used to configure a fixed starting time for an IFD run. Cannot be combined with coldStartTime, forecastLength or timeZero.
enableEarlierStartTime boolean optional Since 2025.01. If this option is set to true, the forecaster can set the start time of the run to a date before the fixed start time.
enableLaterStartTime boolean optional Since 2025.01. If this option is set to true, the forecaster can set the start time of the run to a date after the fixed start time.
endDateTime DateTimeComplexType required Available since 2025.01 It can be used to configure a fixed end time for an IFD run. Cannot be combined with coldStartTime, forecastLength or timeZero.
enableEarlierEndTime boolean optional Since 2025.01. If this option is set to true, the forecaster can set the end time of the run to a date before the fixed end time.
enableLaterEndTime boolean optional Since 2025.01. If this option is set to true, the forecaster can set the end time of the run to a date after the fixed end time.
useForecastLengthFromInteractiveForecastDisplay boolean required If this option is set to false the forecast length will be determined by the workflow
forecastLength TimeSpanComplexType optional Define the forecast length for a node. The forecast length is configured as a time span relative to T0. The user will be able to edit the forecast in the user interface (topology)
cardinalTimeStepForecastLength TimeStepComplexType optional This option can be used to define a cardinal time step for the end time or forecast length of a node.
initialForecastLengthCardinalTimeStep TimeStepComplexType optional This option will determine the initial time of the end time by fitting the time to the cardinal time step
fixedColdState FixedColdStateComplexType optional
coldState TimeSpanComplexType optional With this option can be configured which initial state selection should be used by default.
coldStateFromCurrentRun ColdStateFromCurrentRunComplexType optional With this option can be configured that the run will start with a cold state equal to the start of the previous run of the configured workflow
coldStateStartTime DateTimeComplexType optional With this option a cold state can be configured with a fixed start date/time
warmStateSelectionPeriod RelativePeriodComplexType optional Time window used to search for a warm state.
warmState TimeSpanComplexType optional With this option can be configured which initial state selection should be used by default.
noInitialState emptyElement optional With this option can be configured which initial state selection should be used by default.
cardinalTimeStepStartTime TimeStepComplexType optional This option can be used to define a cardinal time step for the start time or state selection of a node.
initialStartTimeCardinalTimeStep TimeStepComplexType optional This option will determine the initial time of the start time by fitting the time to the cardinal time step
cardinalTimeStepEndTime TimeStepComplexType optional This option can be used to define a cardinal time step for the end time or forecast length of a node.
initialEndTimeCardinalTimeStep TimeStepComplexType optional This option will determine the initial time of the end time by fitting the time to the cardinal time step
relativePeriod RelativePeriodComplexType required Define a relative period for this node. The workflow will run with a cold state equal to the start time of the node. The forecast length will be determined by calculating the difference between the end time and T0. The GUI will show a start time and an end time. This option can, for example, be used when the workflow only contains transformations.
relativeStartTime RelativeTimeComplexType required Since 2017.02. The user can only determine the start time (cold state selection of the run). The forecast length will be determined by the workflow.
timeZero DateTimeComplexType optional This option can be used to set a prefixed time zero for a group or a single node. If this option is not configured the system time will be used as time zero.
timeZeroShift TimeShiftComplexType optional By default the time zero of the shown in the IFD is non-editable. If this option is chosen the t0 is editable and is shifted with the configured timeZeroShift.
alwaysVisibleInForecasterNotes boolean optional Specifies that the forecaster notes, created for this node, should be always visible in the ForecasterNotesDisplay. By default, the ForecasteNotesDisplay shows the notes for the the node (and its parent) that is selected by the user in the Topology GUI. This list of forecast notes can be extended with the notes that are created for the node with option alwaysVisibleInForecasterNotes=true
mapExtentId string optional optional element to define a zoomExtent. When a node with this element defined is selected the map will automatically zoom to this extent
filterId idStringType optional · repeats The configured filter will automatically be selected when the node is selected in the topology.
disableMap boolean optional Since 2024.02. Only used in the WebOC! This element can be used to disable the map in the WebOC.
dataDownloadDisplayId idStringType optional Since 2023.02. Only used in the WebOC! The id of the data download display which is coupled to this node.
logDisplayId idStringType optional Since 2023.02. Only used in the WebOC! The id of the data log display that is configured in de DisplayConfigFiles/LogDisplays.xml file.
dynamicReportDisplayId idStringType optional Since 2024.02. Only used in the WebOC! The id of the dynamic report display that is configured in de DisplayConfigFiles/DynamicReportDisplays.xml file.
webOCDashboardId idStringType optional · repeats Since 2023.02. Only used in the WebOC! The id of the dashboard panel. It is possible to define multiple dashboard ids.
webOCMicroFrontEndId idStringType optional · repeats Since 2025.02. Only used in the WebOC! The id of the micro front end that is configured in the WebOCMicroFrontEnds DisplayConfigFiles.
documentDisplayId idStringType optional Since 2024.02. Only used in the WebOC! The reference by id to a document defined in the documentDisplays.xml.
timeSeriesButtonsPanelId idStringType optional Since 2014.01. Reference to time series button panel that becomes visible when this topology node is activated. For this functionality you need to configure the time series button panel in explorer.xml and to add timeSeriesButtonsPanels.xml in the display config files..
reportModuleInstanceId idStringType optional Since 2024.01. Only used in the WebOC! The moduleInstance id for which to show reports for this node.
dataAnalysisDisplayId idStringType optional Since 2024.01. Only used in the WebOC! The id of the data analysis display which is coupled to this node.
documentFile string optional Since 2022.02. Refer to a document file that is available in the WebResourcesFiles.
displayGroupId idStringType optional · repeats displayGroupId references the id of a configured displayGroup element in the DisplayGroups.xml
displayId idStringType optional Since 2019.01 The display id references the id of a configured display element in the DisplayGroups.xml
plotId idStringType optional Since 2019.01 define the plot from which the display should be generated. The plot id and the location id define the display which should be displayed
customInfoLabel CustomInfoLabelComplexType optional Since 2018.02 if a node has a custom info label defined then the defined text will be shown below the time zero in the IFD run options section. It is allowed to use attributes in the custom info label.
showWorkflowDescriptionBox boolean optional Since 2016.02 show a textbox in which the user can enter a description for the workflow
disableAdvancedButton boolean optional Since 2016.01 Disable the run edit options button when this node or one of its children is selected
hideModifiersOverviewPanel boolean optional Since 2015.02 hide the overview panel when this node or one its children is selected.
areaId idStringType optional This element can be used to group this node and it children to the area
modifiersReadOnly boolean optional With this option a node can be set to readonly. Which means that modifiers can be viewed, but not created, editted or deleted.
viewPermission string optional set a permission to control who can view this node
runWorkflowLocallyPermission string optional Permission to run the workflow for a node locally
runWorkflowAtServerPermission string optional Permission to run the workflow for a node at the server
runSecondaryWorkflowPermission string optional Since 201801. Permission to run the secondary workflow
defaultModifierId idStringType optional Optional element to define a default modifier for a node. When a node is selected and a default modifier is defined the section in the modifiers display in which a modifier can be created will automaticly initialize to the defined default modifier.
onlyAllowEditDefaultModifier boolean optional Since 2014.02. This element will enable that if a default modifier is configured that only the default modifier an be editted
visibleModifierGroup idStringType optional · repeats If this option is not configured, than all applicable modifiers can be used. With this option it is possible to restrict which modifier groups can be used
attributeModifierLocationConstraint ConstraintsComplexType optional Since 2018.02 Restriction for the locations whose attributes should be modified. If ommitted attributes of all locations associated with this node can be modified
graceTime TimeSpanComplexType optional If ths element is not defined only the runs from which the T0 is equal to the system time are used to define show the icons in the topology panel. However with a grace time configured also runs which fall within the period T0 - grace time are used
checkStatusPreviousServerRun boolean optional If this option is set to true a server run can only be started if the status of the previous run is fully successful
showMacroButton boolean optional this option can be used to show a macro button which can be used to start a server task with a predefined taskproperties-xml
gridDisplaySelection gridDisplaySelection optional Since 2023.01, selection in grid display can be specified with group and plot ids.
toolWindow toolWindowStringType optional · repeats this option can be used to configure which toolwindow should be activated or de-activated after selecting this node
One of: forecaster notes, log panel, plot overview, filters, document selection panel
url anyURI optional Since 2016.01. Configure a URL related to the node. Can be used by the Web Browser Display to open the URL. For file based URLs the file:/// convention should be used.
embedUrl anyURI optional Since 2023.02. Will open a URL embedded in the Web OC.
useStatusParentNode boolean optional Since 2017.01 If the node has a server run and the parent node has a more recent server run the status of the parent node will be used. If this is set to false, then the server run of the parent node will be ignored.
thresholdValueSetId idStringType optional · repeats Since 2018.02 The forecast tree shows by default icons which show the run status of the workflow associated with the node. The forecast tree however also has the possibility to show threshold related icons. This option can be used to configure for which threshold value sets icons should be showed.
scadaDisplayId idStringType optional Configure the ID of a scada display to open. Can be used by the Scada (SSD) Display to open a specific display when mainPanel is set to "schematic status display". The ID of a scada/SSD display if the same as the name of its config file (without the xml extension).
scadaPanelId idStringType optional Configure the ID of a scada panel to open. Can be used by the Scada (SSD) Display to open a specific scada panel when mainPanel is set to "schematic status display". If no scada panel Id is configured, the first scada panel configured will be opened.
popupMessageServerRun string optional Since 2022.01. The message which will be shown when a server run is started from this node.
popupMessageUncommittedModifiers string optional Since 2022.01. The message which will be shown when the leaves a node with uncommitted modifiers.
thresholdIconRelativeViewPeriod RelativePeriodComplexType optional Since 2024.01. The relative view period which will be used for the threshold icon of the topology (IFD and WebOC). If this option is not configured then no threshold icons will be shown.
icon nameStringType optional Since 202302. Define a custom icon to be used in the topology tree (WebOC and OC)
iconId nameStringType optional Since 202302. Only used in the WebOC! Define the id of the icon to be used in the topology tree of the Web OC.
mainPanel mainPanelStringType required Display can be specified using a key from the enumeration
One of: time series dialog, map display, modifiers panel, grid display, system monitor, correlation display, document panel, web browser display, kflows, topology panel, schematic status display, log display, webOC dashboard, what-if display, data analysis display
explorerTaskName nonEmptyStringType required Since 2021.02, display can be specified using the name specified for an explorer task.
displayConfigFileName nonEmptyStringType required Display config file name of the display that should be activated
panelId idStringType required Id of a specific SSD panel to open. If no Id is configured, the first SSD will be opened
tabId SystemMonitorTabEnumStringType required Id of a specific SystemMonitor tab to open. If no Id is configured, the logBrowser tab will be opened
One of: logBrowser, bulletinBoard, bulletinBoardPlus, batchTasks, importStatus, exportStatus, liveStatus, scheduledTasks, runningTasks, synchStatus, synchLog
localRun boolean optional by default workflows of child nodes will run locally and parent node are run at the server. By setting this option to true the workflow will run locally
saveLocalRunEnabled boolean optional Since 2015.01. Allow the user to make a temporary local run permanent and upload it to the server, commit the modifiers, approves the forecast and makes it current. When the local run was executed on the server the run is approved and marked public
privateRunAtServer boolean required by default ifd runs run locally, but with this option the ifd run is executed at the server but are only visible for the current user. This run can be made visible for other users by pressing the save button. Uncommitted modifiers from the current users are visible at the server for this run
publishPrivateRunEnabled boolean optional Since 2015.01. Allow the user to make the private run public commit the modifiers, approve the forecast and make it current.

PropertiesComplexType

ElementTypeCardinalityDescription
description string optional Optional description (this is never used in the code).
string StringPropertyComplexType required
int IntPropertyComplexType required
float FloatPropertyComplexType required
double DoublePropertyComplexType required Since 2014.01
bool BoolPropertyComplexType required
dateTime DateTimePropertyComplexType required Since 2014.01

DateTimeComplexType

Attributes

AttributeUseNotes
date required
time optional

TimeSpanComplexType

Attributes

AttributeUseNotes
unit required
divider optional
multiplier optional

TimeStepComplexType

Time step, There are 5 valid combinations of attributes. id, unit+[multiplier]+[divider]+[timeZone], times+[timeZone] + monthDays+[timeZone] ([]=optional)

Attributes

AttributeUseNotes
id optional Id of the time step. You can reference time steps defined in the regionConfig/timeSteps.xml. Only specify the id attribute when referring to a predefined time step. In the regionConfig/timeSteps.xml the time steps list both the id and the attributes that define the time step
label optional Short name for the time step which is shown to the user when he can choose one from a list.
unit optional
divider optional
multiplier optional
times optional Defines the time step by a list of times without dates, e.g. "10:00 23:00"
minutes optional Since 2017.02. Defines the time step by a list of minutes (with prefix 0 for single digits), e.g. "05 25" which results in times 0:05, 0:25, 1:05, etc.
daysOfMonth optional Defines the time step by a list of days of month, use "01 11 21" for a decade time step
monthDays optional Defines the time step by a list of dates, e.g. ""--03-01 --06-01 --09-01 --12-01" for the meteorological seasons
timeZone optional

Elements

ElementTypeCardinalityDescription
description string optional Optional description of this timeStep. This is not used and is only present for convenience.

FixedColdStateComplexType

ElementTypeCardinalityDescription
coldState TimeSpanComplexType optional With this option can be configured which initial state selection should be used by default.
locationId idStringType required Since 2023.01 The location id which provides the attributes in which the selected cold state will be stored
modifierTypeId idStringType required Since 2023.01 The modifier type id which will be used to store the pinned cold state
fixedColdStateLocationAttributeId idStringType required Since 2023.01 The location attribute (should be a date/time attribute) in which the selected cold state date/time will be stored
fixedColdStateGroupLocationAttributeId idStringType required Since 2023.01 The location attribute (should be a date/time attribute) in which the selected cold state group will be stored

ColdStateFromCurrentRunComplexType

ElementTypeCardinalityDescription
workflowId string required The id of the workflow from which the state is selected
coldState TimeSpanComplexType optional This option can be used to define which cold state to use when no default run is available

RelativePeriodComplexType

Defines a moving period in time. The start and end time are relative time to a certain time.

Attributes

AttributeUseNotes
start required
end required
startOverrulable optional default: false. When the running module (e.g. general adaptor) has exported a state the state time is used instead of the specified start time. This option is only available during a (forecast) run.
endOverrulable optional default: false. When a forecast length is specified (e.g. in the manual forecast dialog) the time 0 + forecast length is used instead of the specified end time This option is only available during a (forecast) run.
unit required

Elements

ElementTypeCardinalityDescription
description string optional

RelativeTimeComplexType

Defines a time relative to T0.

Attributes

AttributeUseNotes
value required
unit required

Elements

ElementTypeCardinalityDescription
description string optional Optional description with additional comments. This is never used in the code.

TimeShiftComplexType

Attributes

AttributeUseNotes
unit required
divider optional
multiplier optional

CustomInfoLabelComplexType

ElementTypeCardinalityDescription
labelText string required Since 2018.02 show a custom text in the IFD. It is allowed to use attributes in the text
locationId idStringType required
overrulingUnmodifiedDateTimeAttributeValue UnmodifiedDateTimeAttributeValueComplexType optional · repeats Since 2018.02 if a date time attribute is unmodified it is possible to overrule the default (unmodified value) with a calculated time

ConstraintsComplexType

ElementTypeCardinalityDescription
not ConstraintComplexType required
anyValid ConstraintsComplexType required
allValid ConstraintsComplexType required
idStartsWith IdStartsWithComplexType required Only the locations/parameters/qualifiers with an id that starts with the specified text will be included in the location set, other locations in the shape file or location sets are ignored
idEndsWith IdEndsWithComplexType required Only the locations/parameters/qualifiers with an id that ends with the specified text will be included in the location set, other locations in the shape file or location sets are ignored
idContains IdContainsComplexType required Only the locations/parameters/qualifiers with an id that contains the specified text will be included
relatedLocationExists RelatedLocationExistsComplexType required Only the locations where the related location for the specified location relation is not NULL (empty, only spaces or NaN) will be included.
attributeExists AttributeExistsComplexType required Only the locations/parameters/qualifiers where the attribute value is not NULL (empty, only spaces or NaN) will be included
attributeTextStartsWith AttributeTextStartsWithComplexType required Only the locations with attribute value start with the specified text will be included.
attributeTextEndsWith AttributeTextEndsWithComplexType required Only the locations/parameters/qualifiers with attribute value start with the specified text will be included.
attributeTextContains AttributeTextContainsComplexType required Only the locations/parameters/qualifiers with attribute value contains the specified text will be included.
attributeTextEquals AttributeTextEqualsComplexType required Only the locations/parameters/qualifiers with attribute value equals the specified text will be included in the location set, other locations in the shape file or location sets are ignored
attributeTrue AttributeTrueOrFalseComplexType required Only the locations/parameters/qualifiers with attribute value equals true will be included in the location set, other locations in the shape file or location sets are ignored.
attributeFalse AttributeTrueOrFalseComplexType required Only the locations/parameters/qualifiers with attribute value equals false will be included in the location set, other locations in the shape file or location sets are ignored.

gridDisplaySelection

ElementTypeCardinalityDescription
groupId idStringType required
plotId idStringType optional

StringPropertyComplexType

Attributes

AttributeUseNotes
key required
value required

Elements

ElementTypeCardinalityDescription
description string optional Optional description (this is never used in the code).

IntPropertyComplexType

Attributes

AttributeUseNotes
key required
value required

Elements

ElementTypeCardinalityDescription
description string optional Optional description (this is never used in the code).

FloatPropertyComplexType

Attributes

AttributeUseNotes
key required
value required

Elements

ElementTypeCardinalityDescription
description string optional Optional description (this is never used in the code).

DoublePropertyComplexType

Attributes

AttributeUseNotes
key required
value required

Elements

ElementTypeCardinalityDescription
description string optional Optional description (this is never used in the code).

BoolPropertyComplexType

Attributes

AttributeUseNotes
key required
value required

Elements

ElementTypeCardinalityDescription
description string optional Optional description (this is never used in the code).

DateTimePropertyComplexType

Attributes

AttributeUseNotes
key required
date required
time required

Elements

ElementTypeCardinalityDescription
description string optional

UnmodifiedDateTimeAttributeValueComplexType

ElementTypeCardinalityDescription
attributeId idStringType required
offset TimeSpanComplexType required
timeStep TimeStepComplexType required

ConstraintComplexType

ElementTypeCardinalityDescription
not ConstraintComplexType required
anyValid ConstraintsComplexType required
allValid ConstraintsComplexType required
idStartsWith IdStartsWithComplexType required Only the locations/parameters/qualifiers with an id that starts with the specified text will be included in the location set, other locations in the shape file or location sets are ignored
idEndsWith IdEndsWithComplexType required Only the locations/parameters/qualifiers with an id that ends with the specified text will be included in the location set, other locations in the shape file or location sets are ignored
idContains IdContainsComplexType required Only the locations/parameters/qualifiers with an id that contains the specified text will be included
relatedLocationExists RelatedLocationExistsComplexType required Only the locations where the related location for the specified location relation is not NULL (empty, only spaces or NaN) will be included.
attributeExists AttributeExistsComplexType required Only the locations/parameters/qualifiers where the attribute value is not NULL (empty, only spaces or NaN) will be included
attributeTextStartsWith AttributeTextStartsWithComplexType required Only the locations with attribute value start with the specified text will be included.
attributeTextEndsWith AttributeTextEndsWithComplexType required Only the locations/parameters/qualifiers with attribute value start with the specified text will be included.
attributeTextContains AttributeTextContainsComplexType required Only the locations/parameters/qualifiers with attribute value contains the specified text will be included.
attributeTextEquals AttributeTextEqualsComplexType required Only the locations/parameters/qualifiers with attribute value equals the specified text will be included in the location set, other locations in the shape file or location sets are ignored
attributeTrue AttributeTrueOrFalseComplexType required Only the locations/parameters/qualifiers with attribute value equals true will be included in the location set, other locations in the shape file or location sets are ignored.
attributeFalse AttributeTrueOrFalseComplexType required Only the locations/parameters/qualifiers with attribute value equals false will be included in the location set, other locations in the shape file or location sets are ignored.

RelatedLocationExistsComplexType

Attributes

AttributeUseNotes
locationRelationId required Id of the location relation (eg. UPSTREAM)

AttributeExistsComplexType

Attributes

AttributeUseNotes
id required Id of the attribute

AttributeTextStartsWithComplexType

Attributes

AttributeUseNotes
id required Id of the attribute
prefix required The text the attribute value should start with

AttributeTextEndsWithComplexType

Attributes

AttributeUseNotes
id required Id of the attribute
postfix required The text the attribute value should end with

AttributeTextContainsComplexType

Attributes

AttributeUseNotes
id required Id of the attribute
contains required The text the attribute value should contain

AttributeTextEqualsComplexType

Attributes

AttributeUseNotes
id required Id of the attribute
equals required The text the attribute value should match
modifierDependent optional When true the location set can change dynamically when a attribute is changed by a modifier. Only allowed in workflows and in the modifiers display

AttributeTrueOrFalseComplexType

Attributes

AttributeUseNotes
id required Id of the attribute
modifierDependent optional When true the location set can change dynamically when a attribute is changed by a modifier. Only allowed in workflows and in the modifiers display
  • Display selection is a choice, not a set. A node picks its main display via exactly one of mainPanel (built-in panel by name), a displayConfigFileName/panelId/tabId-style reference (config-file-driven display), or explorerTaskName (since 2021.02) — not several at once.
  • groupId only works if something defines that group. It references the id attribute on a <group> in a separate TopologyGroups *.xml file (root <topologyGroup>) — a dangling groupId with no matching group is a silent-looking config error, not a crash.
  • A parent node’s workflow only runs when the tree is run at the server; running a parent node locally instead runs its children’s workflows. See localRun and the run-button behavior in the schema docs for node.