Platform Settings

Toni Tolvanen
2024-02-22T19:29:55Z

This appendix explains in brief the general syntax of the platform settings which are located in the default_properties.xml file, and lists the platform settings which are omitted from the default set. Platform settings (which were called “framework properties” in older ESM versions) are now stored in database, and editing them is done in the Maintenance menu (General tab > Platform settings > Edit settings). The default_properties.xml file should be left untouched, because it is overwritten when ESM is upgraded.

Note:

If there is a need to change the platform settings when ESM is not running, it can be done by adding settings (as name = value pairs) in the framework.properties file. When ESM is (re)started the next time, settings in this file are read, stored in database (overriding any existing values), and finally cleared from the framework.properties file.

The platform settings are divided into several groups containing related settings. In the setting descriptions, the name of the setting is written at the beginning of each setting, and the default value (if one exists) is displayed on its right side. Values can be edited by clicking on them. If the possible values of the setting are Boolean values (0, 1, true, false), integer or decimal values, attribute codes, or a limited number of string values, listing of the possible values is the next part of the description of the setting.

In case of complex string values or otherwise complex syntax of the value, the description of the setting contains an explanation of the syntax of the possible values and/or examples of the possible values of the setting. If an integer has a minimum value, that is also declared in the description. Finally, changes to some platform settings do not take effect until the ESM server is restarted; if that is the case, this information is also included in the description.

Asynchronous Pool Settings

These properties can be used for defining how many threads timed tasks can have, i.e., how many tasks can be run simultaneously.

Note:

These settings might be missing from the Platform Settings editor in GUI, because changing them may result in a serious malfunction. Do not make changes to these settings, unless you are absolutely certain of what the effects will be.

async.pool.max.size
value: positive integer (also, async.pool.max.size must be greater than or equal to async.pool.min.size)

default: 6

Defines the maximum number of threads that handle asynchronous task execution. This has to be set to 1 if serialized handling is desired.

Graphical view settings

graphical.results.automatic.search
When changing graphical search conditions the view is automatically updated by default. This setting can be used to display a separate button for updating the view.

values: true, false

If the value is set to true, all changes to graphical search conditions that require new search will trigger it instantly. If false, there will be separate button that can be used to trigger search after all needed changes are made.

graphical.results.animation.enabled

When user selects a graphical view it is displayed by default with an introductory animation. In addition user can change the animation setting for each graphical view. This setting can be used to disable all introductory animations and hiding the animation setting on individual level.

values: true, false

If the value is set to false, all introductory animations in all graphical searches will be disabled, and the setting for enabling/disabling them on individual level will be hidden.

graph.custompalette.custompalette#

This property can be used to provide customized color palettes to graphical views.

values: Six-digit hexadecimal numbers delimited with a comma

Examples of customized color palette properties: