...
The schematic status display shows one or more status panels, which can be selected in turn from the list on the left hand side. It is also possible to have multiple schematic status displays, each one with different panels. In that case there would be one configuration file for each different schematic status display, each one with a different filename. The filename of each schematic status display should be registered in the DisplayInstanceDescriptors.xml configuration file. When available on the file system, the name of the xml file for configuring a schematic status display is for example "StatusTwentekanalen.xml". To register a schematic status display in the DisplayInstanceDescriptors configuration file use e.g. the following xml code:
...
<displayInstanceDescriptor id="StatusTwentekanalen">
<description>Schematic Status Display Twentekanalen</description>
<displayId>ScadaDisplay</displayId>
</displayInstanceDescriptor>
Furthermore the displayId that is used in the DisplayInstanceDescriptors.xml file should be defined in the DisplayDescriptors.xml configuration file. This can be done with e.g. the following xml code:
...
<displayDescriptor id="ScadaDisplay">
<className>nl.wldelft.fews.gui.plugin.scada.ScadaDisplay</className>
</displayDescriptor>
To be able to open a schematic status display from the user interface, there should be an explorer task for it in the Explorer.xml configuration file. The xml code for a schematic status display explorer task is for example:
...
Example Configuration files:
Example of a scada display configuration file | |
Example of an svg file, which is used in the ScadaTwentekanalen.xml example configuration file |
Scada Display Configuration Options
...
displayName
Title of this display.
showTimeNavigatorToolbar
Option to show a time navigator toolbar at the top of this schematic status display. The time navigator toolbar can be used to select the display time for this schematic status display. It is only possible to select a display time that is contained within the configured relative period and is a valid time according to the configured time step. This period is always relative to the current system time. If the current system time changes, then the display time is reset to the current system time. If this option is not specified, then the time navigator toolbar is not shown.
...
Steps through the possible values of a variable, of which the parameter has to be linked to an enumeration in the parameters configuration file. Every time the display element is clicked the next value (code) of the enumeration is assigned to all time steps in the defined timeSeriesSet and overrulingRelativeViewPeriod for the specified variable.
Link Properties To Data Configuration Options
...
There are several options available:
...
Link Height To Data Configuration Options
...
The anchor point describes which part of the component should remain at the same position when the height is changed. Can be "bottom", "top" or "center".
Link Width To Data Configuration Options
...
If specified, then the tags in the text of this component are replaced using data from the specified variable. Tags should be separated by "%" signs. Text can be e.g. "Last value = %LASTVALUE(numberFormatId)%", which would be replaced by e.g. "Last value = 10.0". The following tags can be used in the text (numberFormatId/dateFormatId should be replaced by the id of a numberFormat/dateFormat that is defined at the start of this configuration file):
%CURRENTTIME(dateFormatId)% | the local time of the client. |
%STARTTIME(dateFormatId)% | the start date and time of the relative view period of the time series. Requires the relative view period to be configured. |
%ENDTIME(dateFormatId)% | the end date and time of the relative view period of the time series. Requires the relative view period to be configured. |
%LASTVALUE(numberFormatId)% | the most recent reliable or doubtful value in the time series. In case of enumeration parameter, omit the numberformatId. |
%LASTVALUETIME(dateFormatId)% | the date and time of the most recent reliable or doubtful value in the time series. |
%LASTVALUECOMMENT()% | the comment of the most recent reliable or doubtful value present in given time series array |
%FIRSTVALUE(numberFormatId)% | the first reliable or doubtful value in the time series. In case of enumeration parameter, omit the numberformatId |
%FIRSTVALUETIME(dateFormatId)% | the date and time of the first reliable or doubtful value present in given time series array |
%FIRSTVALUECOMMENT()% | the comment of the first reliable or doubtful value present in given time series array |
%MINVALUE(numberFormatId)% | the minimum reliable or doubtful value in the time series. In case of enumeration parameter, omit the numberformatId. |
%MAXVALUE(numberFormatId)% | the maximum reliable or doubtful value in the time series. In case of enumeration parameter, omit the numberformatId. |
%EXTERNALFORECASTINGSTARTTIME(dateFormatId)% | the start of the external forecast. |
%MAXTIME(dateFormatId)% | the date/time of maximum value found in the time series (occurrence closest to T0). |
%MINTIME(dateFormatId)% | the date/time of minimum value found in the time series (occurrence closest to T0). |
%TIMEZERO(dateFormatId)% | in case of forecast data the forecast time, otherwise timezero. |
%MAXWARNINGLEVEL(thresholdId)% | name of the highest warning level threshold that has been crossed (requires an available thresholdValueSet) |
%LOCATIONATTRIBUTE(textAttribute)% %LOCATIONATTRIBUTE(numberAttribute;numberFormat)% | attribute to put in text. the numberFormat is intended for number attributes. |
| %LOCATIONATTRIBUTE(numberAttribute;numberFormat;variableId)% | This option can only be used within the SSD configuration (so not the SVG file itself), and only within the title element of the openDisplay element of leftSingleClickAction and rightSingleClickAction. It is supported since 2017.02 VariableId is intended for the case that multiple variables have been configured. If no numberFormat is used the tag should be %LOCATIONATTRIBUTE(numberAttribute;;variableId)%. VariableId is optional if only one variable is configured. At least a locationId or locationSet has to be configured for the variable. |
| %PARAMETERNAME(variableId)% | Since 2017.02. Used to set title in openDisplay leftSingleClickAction and rightS ingleClickAction. Variable is optional if only one variable was configured. |
...
| Warning |
|---|
The Relative View Period specified in the variables of the Schematic Status Display is always relative to the sliderTime. While moving the slider in the timeNavigator, the sliderTime is used as TimeZero. The choice of Relative View Period is therefore essential for the best behaviour of the Schematic Status Display. For instance, for displaying the time series value at the sliderTime using the LASTVALUE tag, the configured variable should have a Relative View Period with length 0. But for instance when using the click action that opens the TimeSeriesDialog, a separate second variable should be used with a non-zero Relative View Period. |
...
- If only width and height present, then the svg document gets an absolute size, appears in the top-left corner of the display and is never resized (not even when the display window is resized). This means it can be cut-off when the display window is too small.
- If only viewBox and preserveAspectRatio are present, then the viewBox determines the rectangular region of the svg document that is drawn in the display window (the coordinates for the viewBox edges are the same as the coordinate system used within the svg file, usually the coordinates are in pixels). The preserveAspectRatio determines how the drawn region is sized and aligned within the display window. In this case the svg document is automatically resized when the display window is resized.
Examples:
Resizing attributes in the svg root element | Resizing behaviour | |||||||
|---|---|---|---|---|---|---|---|---|
| The svg document is scaled to fit the display window and the aspect ratio is preserved. | |||||||
| The svg document is scaled and stretched to fill the window (aspect ratio is not preserved). | |||||||
| Only the region with coordinates 0 <= x <= 1200 and 0 <= y <= 700 pixels is shown. The svg document is not resized when the display window is resized. |
Background information:
The width and height attributes in the root svg element of an svg file determine the size of the viewport, in other words the size of the svg document when it is viewed. The coordinates of the objects in the svg file are specified in user space, which is different from the viewport space. The viewBox attribute in the root svg element defines the rectangle in user space that should be mapped to the edges of the viewport. The preserveAspectRatio attribute in the root svg element determines how this mapping takes place. This mapping uses one of three possible methods: "meet", "slice" or "none". See http://www.w3.org/TR/SVG11/coords.html#ViewBoxAttribute and http://www.w3.org/TR/SVG11/coords.html#PreserveAspectRatioAttribute for more detailed information.
...