...
The forecaster help panel shows user provided documentation which is available for a node.
Currently the following formats are supported: textfiles, images and pdf-files.
Users can place documents in a directory within predefined directories.
These directories can be configured in the topology.xml configuration file by adding a forecasterHelperDirectories element that contains a directory element for all directories.
For instance:<forecasterHelperDirectories>
| Code Block |
|---|
<forecasterHelperDirectories> <directory>d:\Data\ForecasterHelperData\</directory> |
...
<directory>d:\Data\FHD3\</directory> |
...
</forecasterHelperDirectories> |
If this is not present the directory in the global.properties defined by the INFORMATION_PANEL_FOLDER property will be used.
Within these directories each node has its own directory. The directory should have the same name as the node id.
Within that directory the documentation for that node can be placed.
Below an example of the tool window forecaster help. In this example the forecaster has two documents available for information.
If multiple directories are configured this window will show all available files for the node from the different predefined directories together.
...