Difference between revisions of "OS.app System Configuration"

From OS.bee documentation
Jump to: navigation, search
(→‎Configuration Group 'PrintServices')
(→‎OS.app System Configuration)
Line 12: Line 12:
 
Configuration entries and groups show up during operation of the application, as soon as the entry is requested by the application. The default value is used as the initial value. As soon as the configuration entry is available, it can be adjusted to the local needs.
 
Configuration entries and groups show up during operation of the application, as soon as the entry is requested by the application. The default value is used as the initial value. As soon as the configuration entry is available, it can be adjusted to the local needs.
  
−
=== Configuration Group 'Userinterface' ===
+
=== Configuration Group 'Monitoring' ===
 +
 
 +
controls the system monitoring settings
  
 
{| class="wikitable" style="margin:auto"
 
{| class="wikitable" style="margin:auto"
−
|+ Userinterface settings
+
|+ Monitoring
 
|-
 
|-
 
!Key !!Description !!Type !!Default !!Possible Values
 
!Key !!Description !!Type !!Default !!Possible Values
 
|-
 
|-
−
|action-Save ||controls the behaviour of the Save Button ||String || action-Save || action-SaveAndAsk <br />action-SaveAndNew
+
|monitorMemory ||switch on/off the monitoring  ||Boolean || false || true<br>false
 
|-
 
|-
−
|action-SaveAndAsk ||controls the behaviour of the SaveAndAsk Button ||String || action-SaveAndAsk || action-Save <br />action-SaveAndNew
+
|monitorMemory intervall (in seconds) ||repeat the measurement every x seconds  ||Integer || 60 || 60..500
 
|-
 
|-
−
|action-SaveAndNew ||controls the behaviour of the SaveAndNew Button ||String || action-SaveAndNew || action-Save <br />action-SaveAndAsk
+
|...#daysToKeep ||keep data for x days. Delete older entries to keep database small ||Integer || 7 || 1..30
 
|-
 
|-
−
|Locale ||The default locale for the application ||String || the locale received from the browser || de-DE <br />en-US <br />fr-FR <br />...
+
 
 +
|}
 +
=== Configuration Group 'Notification Templates' ===
 +
 
 +
Notification templates are use to define the content of system email, that is sent eg. when a user is unlocked.
 +
The templates can be configured for English, German and French
 +
 
 +
{| class="wikitable" style="margin:auto"
 +
|+ Notification Templates
 
|-
 
|-
−
|MenuAutoCollapseAfterSelect ||Collapse the menu after the selection of a menu entry ||Boolean || false || false <br />true
+
!Key !!Description !!Type !!Locale !!Default !!Possible Values
 
|-
 
|-
−
|MenuAutoCollapseOnExpand ||Collapse the previous selected menu tree the selection of another tree ||Boolean || false || false <br />true
+
|AccountUnlockedNotification ||used to notify user ||Templatenotification|| Deutsch || Account #USERNAME# ist jetzt entsperrt!<br />Das Benutzerkonto '#USERNAME#' ist wieder entsperrt. || any text
 
|-
 
|-
−
|DatabaseExceptionMessage ||Blocking message about exceptions during database operations<br />Either DatabaseExceptionMessage  or DatabaseExceptionNotification can be true ||Boolean || false || false <br />true
+
|AccountUnlockedNotification ||used to notify user ||Templatenotification|| English || Account #USERNAME# is unlocked now!<br />The user account #USERNAME# is unlocked again. || any text
 
|-
 
|-
−
|DatabaseExceptionNotification ||Systray notification about exceptions during database operations<br />Either DatabaseExceptionMessage  or DatabaseExceptionNotification can be true ||Boolean || false || false <br />true
+
|AccountUnlockedNotification ||used to notify user ||Templatenotification|| French || Account #USERNAME# is unlocked now!<br />The user account #USERNAME# is unlocked again. || any text
−
|-
+
−
|TableFilterDecorator-text-change-timeout ||Delay in milliseconds until the refresh of a table starts when a filter value is changed ||Integer|| 500 || 0..1000
+
 
|-
 
|-
  
Line 57: Line 65:
 
|}
 
|}
  
−
 
+
=== Configuration Group 'Userinterface' ===
−
=== Configuration Group 'Notification Templates' ===
+
−
 
+
−
Notification templates are use to define the content of system email, that is sent eg. when a user is unlocked.
+
−
The templates can be configured for English, German and French
+
  
 
{| class="wikitable" style="margin:auto"
 
{| class="wikitable" style="margin:auto"
−
|+ Notification Templates
+
|+ Userinterface settings
 
|-
 
|-
−
!Key !!Description !!Type !!Locale !!Default !!Possible Values
+
!Key !!Description !!Type !!Default !!Possible Values
 
|-
 
|-
−
|AccountUnlockedNotification ||used to notify user ||Templatenotification|| Deutsch || Account #USERNAME# ist jetzt entsperrt!<br />Das Benutzerkonto '#USERNAME#' ist wieder entsperrt. || any text
+
|action-Save ||controls the behaviour of the Save Button ||String || action-Save || action-SaveAndAsk <br />action-SaveAndNew
 
|-
 
|-
−
|AccountUnlockedNotification ||used to notify user ||Templatenotification|| English || Account #USERNAME# is unlocked now!<br />The user account #USERNAME# is unlocked again. || any text
+
|action-SaveAndAsk ||controls the behaviour of the SaveAndAsk Button ||String || action-SaveAndAsk || action-Save <br />action-SaveAndNew
 
|-
 
|-
−
|AccountUnlockedNotification ||used to notify user ||Templatenotification|| French || Account #USERNAME# is unlocked now!<br />The user account #USERNAME# is unlocked again. || any text
+
|action-SaveAndNew ||controls the behaviour of the SaveAndNew Button ||String || action-SaveAndNew || action-Save <br />action-SaveAndAsk
 +
|-
 +
|Locale ||The default locale for the application ||String || the locale received from the browser || de-DE <br />en-US <br />fr-FR <br />...
 +
|-
 +
|MenuAutoCollapseAfterSelect ||Collapse the menu after the selection of a menu entry ||Boolean || false || false <br />true
 +
|-
 +
|MenuAutoCollapseOnExpand ||Collapse the previous selected menu tree the selection of another tree ||Boolean || false || false <br />true
 +
|-
 +
|DatabaseExceptionMessage ||Blocking message about exceptions during database operations<br />Either DatabaseExceptionMessage  or DatabaseExceptionNotification can be true ||Boolean || false || false <br />true
 +
|-
 +
|DatabaseExceptionNotification ||Systray notification about exceptions during database operations<br />Either DatabaseExceptionMessage  or DatabaseExceptionNotification can be true ||Boolean || false || false <br />true
 +
|-
 +
|TableFilterDecorator-text-change-timeout ||Delay in milliseconds until the refresh of a table starts when a filter value is changed ||Integer|| 500 || 0..1000
 
|-
 
|-
  
 
|}
 
|}

Revision as of 10:09, 13 June 2022

OS.app System Configuration

Each application created with the OSbee Software Factory V4.5.5 and later contains the system configuration to manage system wide settings.

The system configuration has two parts:

  • Configuration group
  • Configuration

The configuration entries belong to a configuration group to bundle related configuration entries.

Configuration entries and groups show up during operation of the application, as soon as the entry is requested by the application. The default value is used as the initial value. As soon as the configuration entry is available, it can be adjusted to the local needs.

Configuration Group 'Monitoring'

controls the system monitoring settings

Monitoring
Key Description Type Default Possible Values
monitorMemory switch on/off the monitoring Boolean false true
false
monitorMemory intervall (in seconds) repeat the measurement every x seconds Integer 60 60..500
...#daysToKeep keep data for x days. Delete older entries to keep database small Integer 7 1..30

Configuration Group 'Notification Templates'

Notification templates are use to define the content of system email, that is sent eg. when a user is unlocked. The templates can be configured for English, German and French

Notification Templates
Key Description Type Locale Default Possible Values
AccountUnlockedNotification used to notify user Templatenotification Deutsch Account #USERNAME# ist jetzt entsperrt!
Das Benutzerkonto '#USERNAME#' ist wieder entsperrt. 		any text
AccountUnlockedNotification used to notify user Templatenotification English Account #USERNAME# is unlocked now!
The user account #USERNAME# is unlocked again. 		any text
AccountUnlockedNotification used to notify user Templatenotification French Account #USERNAME# is unlocked now!
The user account #USERNAME# is unlocked again. 		any text

Configuration Group 'PrintServices'

controls the use of the system print service in the printservice selection comboboxes The key contains the name of the print service.

Printservices
Key Description Type Default Possible Values
no printer selected used to deselect any printer Boolean true false
true
Microsoft Print to PDF Boolean true false
true

Configuration Group 'Userinterface'

Userinterface settings
Key Description Type Default Possible Values
action-Save controls the behaviour of the Save Button String action-Save action-SaveAndAsk
action-SaveAndNew
action-SaveAndAsk controls the behaviour of the SaveAndAsk Button String action-SaveAndAsk action-Save
action-SaveAndNew
action-SaveAndNew controls the behaviour of the SaveAndNew Button String action-SaveAndNew action-Save
action-SaveAndAsk
Locale The default locale for the application String the locale received from the browser de-DE
en-US
fr-FR
...
MenuAutoCollapseAfterSelect Collapse the menu after the selection of a menu entry Boolean false false
true
MenuAutoCollapseOnExpand Collapse the previous selected menu tree the selection of another tree Boolean false false
true
DatabaseExceptionMessage Blocking message about exceptions during database operations
Either DatabaseExceptionMessage or DatabaseExceptionNotification can be true 		Boolean false false
true
DatabaseExceptionNotification Systray notification about exceptions during database operations
Either DatabaseExceptionMessage or DatabaseExceptionNotification can be true 		Boolean false false
true
TableFilterDecorator-text-change-timeout Delay in milliseconds until the refresh of a table starts when a filter value is changed Integer 500 0..1000
Retrieved from "https://download.osbee.org/documentation/index.php?title=OS.app_System_Configuration&oldid=3812"