Difference between revisions of "OS.app System Configuration"
(→Notification Templates) |
(→Textblock) |
||
| Line 49: | Line 49: | ||
==== Textblock ==== | ==== Textblock ==== | ||
| − | a simple text block value. Whatever shall be configured as a larger | + | a simple text block value. Whatever shall be configured as a larger amount of text. Can be formatted. |
==== Datainterchange ==== | ==== Datainterchange ==== | ||
Revision as of 13:45, 13 June 2022
Contents
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.
Deleting an entry will result in the recreation of the default value, as soon as the application requests the value.
Configuration Attributes
There are various attributes used for the configuration. All entries have
| Attribute | Type |
|---|---|
| configuration group | Reference to the Configuration group |
| key | String |
| description | String |
The follwing types extend this basic attribute set. It can be a simple or a complex type
Boolean
a simple yes/no value, selected means yes / true, deselected means no / false
Integer
a simple number with precision 0 eg. 5000
Float
a simple number with precision > 0 eg. 1.234
String
a simple text value. Whatever shall be configured as text
Textblock
a simple text block value. Whatever shall be configured as a larger amount of text. Can be formatted.
Datainterchange
a complex type to configure datainterchange parameters for import and export
| Attribute | Type |
|---|---|
| protocol directory | String, the directory, where the import log is stored. empty disables the logging, Default: empty |
| import blocksize | Integer, Default 5000 |
| no superindex creation | Boolean, Default yes |
| export blocksize | Integer, Default 1000 |
Notification Template
a complex type to configure user email notifications
| Attribute | Type |
|---|---|
| locale | The language, the template is valid for |
| subject | String, used as email subject |
| body | String, used as email body |
Configuration Group 'GLOBAL_PARAMETERS'
A collection of global configuration parameters
| Key | Description | Type | Default | Possible Values |
|---|---|---|---|---|
| ABSTRACTHYBRIDVAACLIPSEVIEW-NOTIFY-ABOUT-RENDERING | enable tray notification about the rendering of a ui component | Boolean | false | false true |
| ABSTRACTHYBRIDVAACLIPSEVIEW-REFRESH-TIMEOUT | Time in milliseconds, how long a refresh of a AbstractHybridVaaclipseView shall wait | Integer | 300 | 0 = off |
| BEANSERVICELAZYLOADINGCONTAINER-REFRESH-TIMEOUT | Time in milliseconds, how long a refresh of a BeanServiceLazyLoadingContainer shall wait | Integer | 0 | 0 = off |
| SINGLEINFOGRIDCOMPONENT-REFRESH-TIMEOUT | Time in milliseconds, how long a refresh of a SingleInfoGridComponent shall wait | Integer | 0 | 0 = off |
| SuperindexCronSchedule | The schedule to control the superindex rebuild. Default: every Friday at 22:00 |
String | 0 0 22 ? * FRI | Quartz Trigger Samples |
| SuperindexExclusionWords | a list of words, that will be excluded from the superindex tables | Textblock | die, der, und, in, zu, den, das, nicht, von, sie,ist, des, sich, mit, dem, dass, er, es, ein, ich,auf, so, eine, auch, als, an, nach, wie, im, für,man, aber, aus, durch, wenn, nur, war, noch, werden, bei,hat, wir, was, wird, sein, einen, welche, sind, oder, zur,um, haben, einer, mir, über, ihm, diese, einem, ihr, uns,da, zum, kann, doch, vor, dieser, mich, ihn, du, hatte,seine, mehr, am, denn, nun, unter, sehr, selbst, schon, hier,bis, habe, ihre, dann, ihnen, seiner, alle, wieder, meine,gegen, vom, ganz, einzelnen, wo, muss, ohne, eines, können, sei,ja, wurde, jetzt, immer, seinen, wohl, dieses, ihren, würde, diesen,sondern, weil, welcher, nichts, diesem, alles, waren, will, viel,mein, also, soll, worden, lassen, dies, machen, ihrer, weiter,etwas, keine, seinem, ob, dir, allen, großen, Weise, müssen,welches, wäre, erst, einmal, hätte, zwei, dich, allein, während,kein, damit, gar, euch, sollte, konnte, ersten, deren, zwischen,wollen, denen, dessen, sagen, bin, gut, darauf, wurden, gewesen,zwar, wer, ihrem, hatten, solche, eben, andern, beiden, macht,dort, kommen, werde, derselben, ganzen, lässt, vielleicht, meiner | all words, you dont want in the superindex |
Configuration Groups
DATAINTERCHANGE
Controls the datainterchange settings
For each datainterchange, the settings for the import and export can be configured
| 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 creation | Do not update the superindex during import. |
Boolean | true | true false |
| import blocksize | 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 blocksize | the number of records, that are exported in one block / file. | Integer | 1000 | 0 = no block defined |
Monitoring
Controls the system monitoring settings
| 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 |
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.
| 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 |
#USERNAME# is replaced by the name of the user, the notification is send to.
PeripheralService
Controls the behaviour of the OS.pos peripheral device communication
| 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> |
PrintServices
Controls the use of the system print service in the printservice selection comboboxes The key contains the name of the print service.
| 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 |
Userinterface
| 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 |
