Root configuration files
The following root Configuration Files are crucial for either an Operator Client (OC) and a Forecasting Shell Server (FSS)
RootConfiguration file | OC | FSS |
---|---|---|
*_clientConfig.xml | required | required |
patch.jar | required | required |
*_global.properties | required | required |
splash_screen.jpg | recommended | not needed |
A * means either "oc" or "fss"
clientConfig.xml file(s)
From Delft-FEWS 2018.02 onwards, the different clientConfig.xml files have an important place in the Delft-FEWS root configuration. Different variants (for different components) of clientConfig.xml files exist and will be explained below.
The clientConfig.xml consist of the following elements:
title
Optional element for setting the title of your application/component
clientType
Required element for defining the type. Enumeration of options includes;
- Forecasting Shell
- Operator Client
- Stand Alone
otherRootConfigFiles
One or more references to the required root configuration files which should always be downloaded when an OC or FSS starts. For an OC the following root configuration files are important to mention here: patch.jar, oc_global.properties, splash-screen reference and oc_clientConfig.xml. See below mentioned image. Important remark is that when the OC starts, it will be checked if these files are present. If not, the will be downloaded. If they are already there, it will be checked it is the correct active version as in the central database. If the files on the file systems are not the active version, they will be downloaded and overwritten.
connection
Optional element to define the connections to the Master Controller. Only required if you have more than 1 Master Controller connections (multi MC environments).
If there is only 1 Master Controller, the connection details are already within the shortcuts (TO DO: INSERT LINK TO EXPLANATION) you have created when deploying/installing the system.
databaseServer (+ url / user / password)
Required elements for setting the details of the database server if you want to specify those in the <connection>.
Example OC_clientConfig.xml
Minimum content for oc_clientConfig.xml + explanation + example
Recommended content for oc_clientConfig.xml + explanation + example
Full content/decription of oc_clientConfig.xml
FSS_clientConfig.xml
Recommendation for creating fss_clientConfig.xml per Operating System type
(fss_linux_clientConfig.xml, fss_windows_clientConfig.xml)
Minimum content for fss_clientConfig.xml + explanation + example
Recommended content for fss_clientConfig.xml + explanation + example
Full content/decription of fss_clientConfig.xml