Module Name: |
global.properties |
---|---|
Description: |
Sets global properties for the application |
Why to Use? |
To override default values and to set global variables |
Where to Use? |
In the global.properties file in the root dir of the region |
Config Example |
|
Screendump: |
na |
Outcome(s): |
Updated behavior of the system |
Remark(s): |
Use with caution |
Available since: |
DelftFEWS200701 |
Overview
The global.properties file has two main uses:
- Define global variable that can be used within the (XML) configuration files (e.g. if you define NAME_OFPROGRAM=c:\Myexe.exe in the global.properties file you can use the variable $NAME_OFPROGRAM$ in the configuration files).
- To set software options.
Configuration
A list of available options is given below (all options are case sensitive):
Name |
Value |
Description |
DefaultValue |
---|---|---|---|
localDatastoreFormat |
firebird |
Use firebird for the local datastore (instead of msacces). Useful if you have large (> 2GB) datastores. Notice that in case of using firebird the localDataStore should be located at the physical hard disk and not at the network. |
msaccess |
ARCHIVE_IMPORT_PATH |
|
|
|
ARCHIVE_EXPORT_PATH |
|
|
|
REGION_HOME |
|
|
|
USE_CURRENT_SIMULATED_WITH_COLD_STATE_SELECTION |
boolean |
By default current simulated data of a module instance is visible during a run until the running forecast has started a new chain (i.e. selected a cold state) for that module instance. Setting this property to 'true' allows the use of a cold state selection in combination with timeseries of a current (approved) simulated forecast run |
false |
allowParameterMergeForNonSample |
boolean |
|
true |
timeSeriesDefaultCacheSizeMB |
50 |
Allocated memory for caching time series. More memory increases the performance of handling time series (e.g. in graphs or spatial display) |
10 Mb |
timeSeriesTaskRunCacheSizeMB |
50 |
Allocated memory for time series that are created during task runs (at a forecasting shell). |
10 Mb |
timeSeriesWriteCacheSizeMB |
50 |
Temporary time series (synchLevel 9) are written to the database when the size of the write cache is not large enough to hold them in memory. This will slow down the system. By increasing the size of the the timeseries write cache this can be avoided. In general this is only needed if you process large amounts of gridded data. |
10 Mb |
DEFAULT_EXPIRY_DAYS |
Any number of days |
Sets the default expiry time for timeseries in the database. You can override this when storing individual timeseries by specifying the expirytime in the timeseriesSet |
10 Days |
DEFAULT_EXPIRY_DAYS_LOGEVENT |
|
|
|
DEFAULT_EXPIRY_DAYS_LOGEVENT_MANUAL |
|
|
|
alwaysAllowWriteSimulatedBelongingToAlreadyRunnedModuleInstance |
|
|
|
alwaysAllowDummyModuleInstanceRuns |
|
|
|
SCHEMALOCATION |
|
|
|
PI_SCHEMALOCATION |
|
|
|
UseLenientPiTimeSeriesParser |
|
|
|
EXPLORER_SYSTEMCAPTION |
any string value |
Option to set the window title of the FEWS Explorer (i.s.o. Explorer.xml). In Explorer.xml the element <systemCaption> underneath <systemInformation> should contain a reference ($EXPLORER_SYSTEMCAPTION$) to this global property variable |
|
IDENTIFIER |
any string value |
MC identifier to be used in the EATimeSeriesWriter |
|
NIMROD_DUMP_VALUES |
|
|
|
checkFileWillExistOnCaseSensitiveFileSystem |
|
|
|
GA_shiftExternalTimesToYear2000 |
boolean |
This setting is used to export data from the General Adapter always starting in the year 2000. True means this setting is used. This overcomes the issue with running FEWS after the year 10.000 which caused problems. Internally the dates are handled normally. |
false |
REPORT_HTML2PDF_PROGRAM |
%REGION_HOME%/Modules/Reports/bin/html2pdf.cmd |
location of html2pdf program, required in case generatePDF=true in reports module |
|
REPORTS_LEFTCOLMCID |
MCID |
Reference to MCID (e.g. MC00 or MC01) to put benchmark values in left or right column of a specific system status report |
|
REPORTS_RIGHTCOLMCID |
MCID |
Reference to MCID (e.g. MC00 or MC01) to put benchmark values in left or right column of a specific system status report |
|
checkFileWillExistOnCaseSensitiveFileSystem |
boolean |
default = FALSE |
|
mapLayersCacheDir |
any local directory |
Local directory to keep an up-to-date cache of maplayers which are retrieved from a network drive. Allows central maintenance of MapLayer-files without storage in the central database. |
|
LANGUAGE |
string |
Set LANGUAGE=REGIONAL to automatically use the selected language in your Windows Regional Settings. |
EN |
COUNTRY |
|
|
|
IP |
|
|
|
PREFIXED_IP |
|
|
|
NESTED_IP |
|
|
|
JdbcServerPort |
integer |
IP port number on which the JDBC server will listen after startup |
2000 |
T0 |
string |
Date/time to set the system time to (only available for stand-alone systems). The date/time should conform to the pattern as configured for the system (in the Explorer xml) |
|
maxConfigFileSizeMB |
real |
Maximum size of configuration files that can be imported into the localDataStore using the ConfigManager |
unlimited |
runInLoopParallelProcessorCount |
integer |
Maximum nr of cores (CPU's) Delft-FEWS can use to run ensemble loops in parallel. Set to 100 to use all available cores. |
1 |
doCaseConsistencyCheckOnMc |
boolean |
Check new config files for case insensitive matches on the MC, to prevent config corruption in (case-insensitive) MsAccess localDataStores |
true if localDatastoreFormat is MsAccess, false if Firebird |
tempDir |
string |
Sets the temp dir to something other than the windows default e.g. =F:/Temp |
Windows default |
localDataStorePoolDir |
any local directory |
Sets the dir where a pool of max. 10 localdatastore directories is stored to be used by OC at Citrix like systems. Useful in case of using firebird as localdatastoreformat, which requires the localdatatstore to be at the physical disk drive (not at the network!). |
Known issues
- all options are case sensitive
- Some the of options listed here are deprecated