Since 2020.02. Contains all the Master Controller configuration and scheduling for up- and download with the AdminInterface or the API. When uploaded this file is used by both the Master Controller and the Admin Interface. The textual elements in this xml file can use variable tags between % characters which are then replaced by pre-defined Operating System environment variables. For instance, %FEWS_AI_TITLE% could be used as Admin Interface title so that the same mc config file is used for all development / testing / acceptance and production systems, except that each AI has a different FEWS_AI_TITLE system OS variable.
Enables debug logging. Defaults to false.
Defines the total amount of rolling log file sizes. Defaults to 10 Mb.
Logs slow queries as INFO message when exceeding this timespan. No effect when already in debug mode.
Default ExpiryTime for LogEntries written into the database created by the AdminInterface and the Master Controller. Defaults to 5 days.
Enables logging of errors to the windows event logger. False by default. Ignored under linux. It will be necessary to register Delft-FEWS as an event source using: %SystemRoot%\\System32\\EventCreate.exe /SO "Delft-FEWS" /t SUCCESS /ID 99 /d "Initialise WindowsNTEventLogger" /L Application
Enables logging of errors to the linux syslog using the specified facility. Ignored under Windows.
Pattern for this dateFormat. Defaults to dd/MM/yyyy HH:mm:ss.
Directory on file system, link to website or url to ftp server.
Descriptive name of the resource. Defaults to the id.
Descriptive name of the resource.
Directory on file system or url to ftp server.
Directory on file system, link to website or url to ftp server.
Descriptive name of the resource. Defaults to the id.
Descriptive name of the resource.
Directory on file system or url to ftp server.
Title of the region home in the admin interface, defaults to mcId from the LocalMcId table.
The date format that is used in the Admin Interface GUI and its date components and the Admin Interface API. The following formats are supported: 'dd/MM/yyyy HH:mm:ss' and 'MM/dd/yyyy HH:mm:ss'. If no date format is specified, the default date format is used: 'dd/MM/yyyy HH:mm:ss'.
If no time zone is defined, then uses GMT. The configured time zones can only be used when scheduling tasks.
Interval for autorefreshing the system status page of the Admin Interface. Default is 600 seconds.
Threshold for heartbeat status. Default is to two minutes.
Maximum number of entries displayed in the ViewLogs page. Default is 100.
Defines when a session is too old to be displayed in the list of active sessions. Default is one hour.
Default ExpiryTime for TaskRuns filled in the Task Form. This value is ignored for workflow descriptors with a runExpiryTime. Default is ten days.
Optional list of browsable directories, either on the file system or via ftp.
Optional list of url links.
Terminate a taskRun when it's overdue time exceeds the specified value. Defaults to 15 minutes.
Optional description of the FssGroup.
When false this FSSGroup can only process workflows explicitly mapped to it. Use false for a dedicated FssGroup, e.g. for a models with license limitations. By default true.
Defines the minimal amount of ForecastingShells that the FssLauncher will always keep awake in this FssGroup. Defaults to 1, meaning one fss is kept awake. For always using hot start set this at least to the number of available Fss. This value is also used by the SystemHealthChecker to set the mc health status when there are not enough FSS awake.
Defines the maximum amount of ForecastingShells that the FssLauncher will always keep awake in this FssGroup.
When not defined, slots are not released automatically.
Defines timespan after which spare FSSes are instructed to go to sleep mode. When not defined, fss are not instructed to sleep automatically.
Defines the priority of an FssGroup. Slow FssGroups, expensive cloud FssGroups or FssGroups with a model license get a high number so they are only used when there is no alternative.For instance an FssGroup with a license model with lower priority rank (greater integer value) will only run imports when the higher priority FssGroup normally used for imports is busy or down for maintenance.
FssGroup identifier. Typical defined as a capability, e.g. windows, linux or a specific model such as SOBEK.
Optional name of the FssGroup. When absent, defaults to the id.
Specifies the FSS Group id this configuration applies to.
Unique identifier of the Azure TenantID.
Unique identifier of the Azure Subscription. The subscription has to be in the tenant is configured by the tenant id
Azure Resource Group. Has to be part of the configured subscription
Required if used from on premise. The client id of the app registration with the appropriate permissions.
Required if used from on premise. The client secret of the app registration.
Deallocate an Azure Virtual Machine containing an IDLE forecasting shell without workflows in the queue automatically.
An fssGroup with its autoscaling options.
Default operation. Not in manual failover.
Sets the system in manual failover. By setting manual failover, the Master Controller will start operating as it were alone in the pool of Master Controllers. Synchronization of forecast data from other Master Controllers is suspended. The remote Master Controllers also suspend synchronizing forecast data from this Master Controller. See also failover policy in Task.
When the mc.xml is downloaded this setting indicates that the Master Controller has automatically been put into fail over mode. Ignored when uploaded.
jdbc url. jdbc:postgresql://host:port/database OR jdbc:oracle:thin:@//host:port/service_name OR jdbc:oracle:thin:@host:port:SID OR jdbc:oracle:thin:@TNSName OR jdbc:sqlserver://host:port/database.
Only required when not when using Kerberos or AD integration.
Only required when not using Kerberos or AD integration. Encrypted user's password. Password is encrypted with clipboard utils in F12 menu in (any) SA/OC.
When used, only status is synchronized, e.g. heart beats. No Configuration or Forecast data. Status tables are SystemActivities, ComponentLogFileSnapshots, MasterControllers, FSSGroups, ForecastingShells, FssStatus and LiveMcAvailabilities.
If set to false, no config tables are to be synchronized. Default is true.
If set to false, synchronization for the LogEntries table is disabled. Defaults to true.
If set to false synchronization for the Reports table is disabled. Defaults to true.
if set to false, synchronization for the ThresholdEvents table is disabled. Defaults to true.
If set to false, synchronization for the TimeSeries table is disabled. Defaults to true.
If set to false, no Users, UserSettings, AccessKeyHashes and UserToGroupsMappings are synchronized.
If set to false, synchronization for the WarmStates table is disabled. Defaults to true.
Controls which timeseries with what synchLevels are enabled to be synchronized. When none specified, only the default synchLevels for Timeseries are synchronized, e.g. synchLevels 0, 2, 5, 8, 30.
Define synchronization profiles.
Optional databaseIntId to validate the remote Master Controller databaseIntId.
Only required for remote Master Controllers. It is preferred to use Active Directory or Kerberos for connecting to remote Master Controller databases when possible. The actual user and encrypted password are normally put in the mcConfig file. If this is not allowed it is also possible to use variables, e.g. %FEWS_MC_MC01_DATABASE_URL%, %FEWS_MC_MC01_DATABASE_USER% and %FEWS_MC_MC01_DATABASE_ENCRYPTED_PASSWORD% can be put in the synch remote Master Controller databaseServer element. Also this allows the ICT to manage the connection details without changing the mc.xml file which is the responsibility of the Application Manager.
Refers to one of the synchProfiles.
Only applies to Master Controllers with Failover Tasks. The Master Controller with the top Priority rank (lowest number) will take over failover Tasks when the owner Master Controller fails over. Best practice is to specify the remote mcIds first in the preferred order. The current mcId is most commonly to be placed last. This prevents the Master Controller to run duplicate tasks. See the wiki for optimal guidance.
When false the MC-MC Synchronization is disabled. By default true meaning synchronization is enabled.
Identifies the remote Master Controller. Must match the contents of the mcId in the LocalMcId table.
Only applies to Master Controllers with Failover Tasks. The Master Controller with the top Priority rank (lowest number) will take over failover Tasks when the owner Master Controller fails over. Best practice is to specify the remote mcIds first in the preferred order. The current mcId is always placed last. This prevents the Master Controller to run duplicate tasks.
By setting this status, this Master Controller will start operating as it were alone in the pool of Master Controllers. This Master Controller will stop synchronizing forecast data from other Master Controllers The remote Master Controllers also stop synchronizing forecast data from this Master Controller. See also failover policy in Task. Defaults to no failover.
List of one or more remote Master Controllers to synchronize from.
Define synchronization profiles.
Maps a workflowId to a single FssGroup. Not required when the FSSGroup is allowing unmapped workflows. Always use workflow mappings for deploying dedicated FssGroups that are not allowing unmapped workflowIds.
Defines a WhatIfScenario.
Run this Task only on the Master Controller that owns it (default).
When the Duty Master Controller is in Failover mode, run this task on the top priority Failover Master Controller, but also run this task on the Duty Master Controller that owns it.
When the Duty Master Controller is in Failover mode, run this task on the top priority Failover Master Controller and do not run this task on the Duty Master Controller that owns it.
Task status: pending, suspended, finished
Task tag for events and action mappings
Task runs on remote Master Controller on failover. Defaults to "run duty".
Task properties
Only required when not present in all Master Controllers.
.
Defines a scheduled Task or a suspended one-off Task in the Master Controller.
Defines the action to be triggered by the LogEventProcessor when an eventCode is logged.
EventCode that is to trigger the specified Action Configuration. Asterisks '*' may be used for matching a eventCode wildcard pattern.
Id of the Action Configuration.
Only required when not present in all Master Controllers.
Defines a trigger for an eventAction when an eventCode is logged in the LogEntries table. The LogEventProcessor in the Master Controller will detect and execute these.
Optional mcId for identifying the Master Controller uniquely. The official Master Controller mcId is located in the LocalMcId table. When this mcId is provided it is merely used as validation before upload and when starting the Master Controller / Admin Interface. The mcId is an Alphanumeric non-empty identifier no longer than 30 characters wide. Typically (but not absolutely required) a lowercase concatenation of 2 chars for country, 2 chars for the organisation, 2 chars for the region configuration name, a single char indicating d (development), t (test), a (acceptance) or p (production), the string mc and finally two numbers for uniquely identifying this specific Delft-FEWS system (00-97), for instance ukeanwamc00 stands for United Kingdom Environment Agency North West Acceptance Master Controller 00.
Optional name of the mc. This name can be used in the config with $MC_NAME$ on OC and FSS
Optional databaseIntId (0-97) for validating the offset of the GlobalRowId. Must be unique within the pool of MasterControllers.
Defines logging options, debug mode, system logging etc.
Options to tune the Java Virtual Machine for the Master Controller. When none is specified defaults to -Xmx1024m.
Configuration options for the Admin Interface.
TaskRunDispatcher settings.
Defines synchronization from remote MasterControlllers. Absent when using a single Master Controller.
Specify the Azure Configuration for an FSS Group required for scaling FSS.
Definition of Forecasting Shell Server Groups and autoscaling options.
Maps workflowIds to FssGroups.
Deprecated and obsolete since 2021.02. No longer uploaded via the AdminInterface. Defines WhatIfScenarios so they can be also uploaded along with the Tasks that refer to them.
Defines scheduling of Tasks. Since 2021.02, Tasks with WhatIfScenarios will no longer be uploaded.
Defines EventActions. See also eventActionMappings.
Defines triggers for one or more eventActions. When an eventCode is logged in the LogEntries table, the LogEventProcessor in the Master Controller will detect them and trigger the mapped Event Actions.