Difference between revisions of "OS.app System Configuration"

From OS.bee documentation
Jump to: navigation, search
(→‎OS.app System Configuration)
(→‎Configuration Group 'PeripheralService')
Line 89: Line 89:
 
|-
 
|-
 
|comminication-timeout ||Timeout in milliseconds for the communication with the OS.peripherals service ||Integer|| 2000 || 0 = no timeout, 1000..5000
 
|comminication-timeout ||Timeout in milliseconds for the communication with the OS.peripherals service ||Integer|| 2000 || 0 = no timeout, 1000..5000
 +
|-
 +
|<hostname>:<port> ||redirect the peripherals communication to another host or port for the <hostname> given in the key<br/>this allows to use mobile devices like tablets and redirect to a peripherals server, that has the configuration for the devices<br /><b>Attention! Experimental!</b> ||String|| <hostname>:<port> || <other hostname>:<other port>
 
|-
 
|-
  

Revision as of 12:34, 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 'DATAINTERCHANGE'

Controls the datainterchange settings

For each datainterchange, the settings for the import and export can be configured.


DATAINTERCHANGE settings
Attribute Description Type Default Possible Values
key the datainterchange, the setting is used for String (not editable)
description free text String
protocol directory the directory, where the camel protocol files shall be saved.
Attention: the use of protocol files has a significant impact on the performance 		String directory on the server
no superindex rebuild Do not update the superindex during import.
 Boolean true true
false
import block size the number of records, that are imported in one block.
The larger the blocksize, the more memory is needed. 		Integer 5000 0 = no block defined
export block size the number of records, that are exported in one block / file. Integer 1000 0 = no block defined


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 or any other language, the application uses.

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


Configuration Group 'PeripheralService'

Controls the behaviour of the OS.pos peripheral device communication

PeripheralService
Key Description Type Default Possible Values
comminication-timeout Timeout in milliseconds for the communication with the OS.peripherals service Integer 2000 0 = no timeout, 1000..5000
<hostname>:<port> redirect the peripherals communication to another host or port for the <hostname> given in the key
this allows to use mobile devices like tablets and redirect to a peripherals server, that has the configuration for the devices
Attention! Experimental! 		String <hostname>:<port> <other hostname>:<other port>

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=3815"