You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 73 Next »

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

global.properties

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:

  1. Define global variables 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).
  2. To set software options (see Configuration table).

Known issues

  1. all options are case sensitive
  2. Some the of options listed here are deprecated
  3. obsolete properties not to be used anymore:
    1. identifier=
    2. timeSeriesDefaultCacheSizeMB=
    3. timeSeriesTaskRunCacheSizeMB=

Configuration table

A list of special global properties manipulating the system instead of variables in xml is given below (all options are case sensitive):

Name

Default

Value

Description

alwaysAllowDummyModuleInstanceRuns

false

 

TransformationModule is allowed to edit time series created earlier in the same workflow, the TransformationModule can create simulated time series for any ModuleInstanceId and this can create unexpected behaviour when making runs current, this can mess up the branching information of other workflows

alwaysAllowWriteSimulatedBelongingToAlreadyRunnedModuleInstance

false

 

General adapter import activities time series sets should have the same ModuleInstance as the general adapter

checkFileWillExistOnCaseSensitiveFileSystem

false

boolean

if configuration runs on Linux, this needs to be true

COUNTRY / LANGUAGE / VARIANT

empty string

string

E.g. COUNTRY=AU, LANGUAGE=EN, VARIANT=BOM

COUNTRY /LANGUAGE / VARIANT selects the language files that are used in the user interface

LANGUAGE default is english

 

DEFAULT_EXPIRY_DAYS

10 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

DEFAULT_EXPIRY_DAYS_LOGEVENT

 

Any number of days

Sets the default expiry time for logevents in the database.

DEFAULT_EXPIRY_DAYS_LOGEVENT_MANUAL

 

Any number of days

Sets the default expiry time for manual logevents in the database.

doCaseConsistencyCheckOnMc

false

boolean

Check new config files for case insensitive matches on the MC, to prevent config corruption in (case-insensitive) MsAccess localDataStores, important for Linux systems

dockingfalse Determines whether displays can be docked

GA_shiftExternalTimesToYear2000

false

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.

JdbcServerPort

2000

integer

IP port number on which the JDBC server will listen after startup

localDatastoreFormat

msaccess

firebird

Use firebird for the local datastore (instead of msaccess). 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. Note that this information can also be configured in ClientConfig.xml

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 localdatastore to be at the physical disk drive (not at the network!).
For example: localDataStorePoolDir=C:/FewsLocalDataStores
>> creates C:\FewsLocalDataStores\<Region>\localDataStore0, ...1, ...2 etc

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.

maxConfigFileSizeMB

unlimited

real

Maximum size of configuration files that can be imported into the localDataStore using the ConfigManager

PI_SCHEMALOCATION

http://fews.wldelft.nl/schemas/version1.0/pi-schemas/

 

If you do not want to use the Deltares schema location server, only used when FEWS writes xml files

readCompleteBranchSimulatedHistoricalWhenReadCompleteForecast

false 

since 2012.01 read complete forecast only reads the current historical run instead of the complete branch

used for compatibility with version FEWS 2011.02

 

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

runInLoopParallelProcessorCount

1

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.

SCHEMALOCATION

http://fews.wldelft.nl/schemas/version1.0/

 

If you do not want to use the Deltares schema location server, only used when FEWS writes xml files

tempDir

Windows default

string

Sets the temp dir to something other than the windows default e.g. =F:/Temp

timeSeriesWriteCacheSizeMB

10 Mb

50 Mb

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.

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)

USE_CURRENT_SIMULATED_WITH_COLD_STATE_SELECTION

false

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

UseLenientPiTimeSeriesParser

false

 

makes the PITimeSeriesParser more tolerant to other data formats (e.g. 31-02)

Variable table

A suggested list of global variables that can be defined in the xml configuration with the use of $ or % signs around the variables (e.g. %REGION_HOME%). These are suggestions only, all variables can be defined.

VariableExampleDescription
ARCHIVE_EXPORT =//SERVER/../../ARCHIVE/EXPORTPath definition
ARCHIVE_IMPORT=//SERVER/../../ARCHIVE/IMPORTPath definition
EXPLORER_SYSTEMCAPTION=Application NameOption to set the CLIENT window title of the FEWS Explorer. In Explorer.xml the element <systemCaption> underneath <systemInformation> should contain a reference ($EXPLORER_SYSTEMCAPTION$) to this global property variable
EXPORT_FOLDER=//SERVER/../../EXPORTPath definition
EXPORT_FOLDER_SOURCE=//SERVER/../../EXPORT/MATROOSPath definition. Option to control the import/export folders in the global properties. This can be configured in the Import/Export Modules.
IMPORT_FOLDER=//SERVER/../../IMPORTPath definition
IMPORT_FOLDER_SOURCE=//SERVER/../../IMPORT/ECMWF_DETPath definition. Option to control the import/export folders in the global properties. This can be configured in the Import/Export Modules.
REGION_HOME Home directory FEWS application
  • No labels