Preferences
This page provides generated reference documentation for the Preferences data model.
Preferences, die pro Projekt verwaltet werden
Overview
| Property | Summary |
|---|---|
| binariesAlias | Here you can define the database alias which shall be used for the binaries. |
| blobHandlingMethod | Specifies if BLOB data is stored in the database or otherwise handled by a special process. |
| blobPreviewSize | Specifies the size of the previews generated für binary files. |
| blobStorageAlias | The alias that points to an S3 compatible storage system. Here we can only have an alias of the type S3-storage. |
| calendarCategories | Here you can create, edit and delete calendar categories for tasks. |
| calendarCategoriesEvent | Here you can create, edit or delete calendar categories for appointments. |
| calendarReminderInterval | Specifies the interval at which to check for overdue reminders about calendar entries. |
| calendarReminderPeriod | Specifies the amount of time to retroactively check for reminders. |
| calendarUserSorting | The user collation allows you to configure the collection of users in the calendar. |
| ckeditorAIAlias | Specifies an alias for the CKEditor AI features. The alias provides information about the endpoint URL, token and extra request parameters to be used for the… |
| ckeditorAIAssistantEnabled | Specifies if the AI Assistant feature should be enabled within the CKEditor. The AI Assistant allows custom requests to the AI enpoint with a freeform… |
| ckeditorDefaultAICommandsProcess | Specifies a process that returns the default AI commands that should be visible in the CKEditor. The default commands can be overwritten by the property… |
| ckeditorDefaultAISystemPromptProcess | Specifies a process that returns the default AI system prompt that should be used for AI requests from the CKEditor. The default prompt can be overwritten by… |
| clientDefaultLoginLimit | This setting determines which value to use for a client's login limit if nothing is specified by the client itself. |
| clientSearchExcludeForIgnorecase | Enables case-sensitive in client search. |
| clientStorePreferecensAtLogout | Specifies whether the preferences should be saved only when the client is stopped or when a search is performed in the user data model of the user who is… |
| clientTempPath | Specifies the default value for the client's temporary path. If a temporary path is not set on the client, it is used. The value is freely selectable as a… |
| clusterMessagingAlias | Alias for the ClusterMessaging |
| comment | Property to store a developer comment in form of |
| compressBinaries | Indicates whether the binary data in the ASYS_BINARIES system table is compressed. |
| compressMailrepository | Specifies whether the data is compressed in the mail repository (for mail repository DB only), in the ASYS_MAILREPOSIT table. |
| contentAnalysisAlias | Alias for the Content Analysis |
| customConfigProperties | Here an administrator / developer can define custom configurations, which can be read via JDito |
| customized | — |
| customProperties | Here an administrator / developer can define custom configurations, which can be read via JDito |
| dashletstoreAlias | The alias in which the database table for the dashlets and dashlet configurations exists. |
| databaseAuditAlias | The database alias in which the changes in the database are to be logged in the audit table ASYS_AUDIT. |
| databaseAuditDoDifferencesOnlyOnUpdate | If set, only the changed elements are written to the audit layer |
| databaseAuditFilterDBSyncItems | Enables the database filter for synchronization items. This suppresses the writing of the data records that come from the other system during… |
| databaseAuditGetOldValueLobs | Sets whether the old LOB values (CLOB, BLOB) are given to the audit. |
| databaseAuditInternalCaseHandling | Sets whether the internal case handling should be used. |
| databaseAuditIsUseOldValuesOnDelete | If set, only the deleted elements are provided within the audit layer |
| databaseAuditMaximumTimestampJitter | The maximum deviation from the last value. Used to account for changes to the system time |
| databaseAuditProcessLoggerUser | The user that is used for the audit logging process. |
| databaseAuditTimestampResolution | Audit timestamps have to be unique. Here you can configure, which distance between the timestamps is used. |
| defaultDataAlias | The default alias for all data tables. As of now, only the following tables are potentially affected by this property: |
| defaultSystemAlias | The default alias for all system tables. Exceptions are all tables that are affected by defaultDataAlias. |
| description | Description |
| documentation | Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different… |
| hashtagsEnabled | Specifies whether the tags should be enabled or not |
| icon | Image. |
| iconProcess | Specifies the icon dynamically. If the icon has no effect, neither will the result of the process. |
| indexsearchAllowLeadingWildcards | Allows leading wildcards (*criterion). |
| indexsearchAutoCommitEnabled | Specifies if pending updates of the indexer will be automatically pushed to the index. |
| indexsearchAutoCommitMaxDocs | The number of updates that have occurred since the last commit of the indexer. |
| indexsearchAutoCommitMaxTimeMS | The number of milliseconds since the oldest uncommitted update of the indexer. |
| indexsearchBoostLatestDocuments | If enabled newer documents get a boost to score higher than older documents. |
| indexsearchCachePatternExtensions | Specifies whether the filter patterns of the PatternExtensions should be cached by the index for later reuse of the results. |
| indexsearchCachePermissionFilters | Specifies whether the filter patterns for the permissions should be cached by the index for later reuse of the results. |
| indexsearchCJKApplyLeadingWildcards | Specifies whether leading wildcards should be added to CJK terms. |
| indexsearchCJKApplyTrailingWildcards | Specifies whether trailing wildcards should be added to CJK terms. |
| indexsearchCJKCreatePhraseTerms | Specifies whether additional phrases should be generated for CJK terms for the individual terms. |
| indexsearchCJKCreateShingles | Specifies whether shingles are to be generated for CJK terms. |
| indexsearchCJKMaxShingleSize | The maximum length for the generated shingles for CJK terms. Default is 4. |
| indexsearchCJKMinShingleSize | The minimum length for the generated shingles for CJK terms. Default is 3. |
| indexsearchCJKMinTermSizeForShingles | The minimum length for CJK terms from which shingles are generated. Default is 4. |
| indexsearchCJKOnlyUsePhraseTerms | Specifies whether all terms are to be evaluated as phrases for CJK terms. |
| indexsearchCJKOptimizationEnabled | Controls the advanced optimization for CJK inputs of the index search. |
| indexsearchCJKOverrideUserWildcards | Specifies whether other wildcard settings should be used for CJK terms. |
| indexsearchDefaultResultCount | Sets the default amount of hits, if in JDito a specific count is not given. Has to be lower or equal to indexsearchMaximumHits. |
| indexsearchFullIndexerEnabled | Enables the full-text index. |
| indexsearchFullIndexerInterval | The interval at which the full-text index is updated. |
| indexsearchGlobalDefaultOperator | Sets the default operator of the index search for the global search. |
| indexsearchGlobalEnabled | Sets whether index lookup is available in clients. |
| indexsearchGlobalFilterExtensionHandlingMethod | Specifies how unknown filter extensions are handled in the overall index search. Default is FAIL. |
| indexsearchGlobalFuzzySearchFactor | Returns the factor used by the fuzzy search. |
| indexsearchGlobalMinTermSizeForWildcards | Defines the minimum length that an input value of the global search must have, so that the extension with wildcards is applied for the value. |
| indexsearchGlobalOnlyCountSelectedGroups | Specifies whether the counters for index groups should only be displayed for selected groups in the global search. Default is false. |
| indexsearchGlobalUseLanguageFallback | Specifies whether the global search, for a multilingual index, should search the system's default language in addition to the client language. |
| indexsearchGlobalUseRankedSearch | Specifies whether the client's global lookup component performs the weighting of each document, based on the boost settings of each index group. |
| indexsearchIncrementingIndexerBunchSize | The number of data packets that the incremental index enters in a turn. |
| indexsearchIncrementingIndexerEnabled | Enables the incremental index. |
| indexsearchIncrementingIndexerInterval | The interval at which the incremental index is updated. |
| indexsearchIndexerBufferSizeLimit | The memory limit in bytes of the indexers internal document buffer. Default is 512 MB. |
| indexsearchIndexerDBRowsForDocumentWarningLimit | Returns the limit for the indexer, above which a warning is logged that too many db columns are read for a single record. |
| indexsearchIndexerMaxBufferedDocs | The maximum amount of index documents the indexer can buffer before sending them to the index. Default is 256. |
| indexsearchIndexerWarnOnSkippedDBRows | Specifies whether the indexer should log a warning if records of the database were skipped during indexing. |
| indexsearchInitWaitTimeout | Sets the maximum amount of time a running index component, e.g. the full indexer, is waiting for the index search to reinitialize, before canceling the planed… |
| indexsearchJDitoResultFieldArraysAsString | Defines whether results, for fields with multiple values, should be returned as a string instead of an array. Affected are all IndexRecordFields where the… |
| indexsearchMaximumHits | Number of maximum search results displayed in the index search. Since the index search should only give an overview, you should not enter too large values here. |
| indexsearchSoftAutoCommitEnabled | Specifies if the indexer performs a 'soft commit', meaning that Solr will commit your changes to the Lucene data structures quickly but not guarantee that the… |
| indexsearchUseRemoteParameterSets | Specifies if the index should use parameter sets that are managed by the remote service. |
| indexsearchUseSearchableDescriptionField | Specifies if the system field #DESCRIPTION (_description_) of the index search can be searched. The default is false. This option affects all index groups… |
| indexsearchUseSearchableTitleField | Specifies if the system field #TITLE (_title_) of the index search can be searched. The default is false. This option affects all index groups and… |
| jditoCalculationDepth | The count of JDito calculation round after which the execution is aborted. Mainly affects recursive function and their recursion depth. |
| jditoCalculationVersion | This specifies which version of the calculation logic should be used for JDito variables. |
| jditoMaxContentSize | Sets the maximum size of loaded objects within JDito (for example, loaded via fileIO.getData()). |
| jditoScriptCacheTimeout | Sets the amount of time to precompile JDito code. |
| jditoScriptManagerNext | Enables the ScriptManagerNext, which pre compiles libraries for better performance. |
| jditoUserServerContext | Specifies the user who is used in the servercontext. |
| localCacheMaxMemorySize | The max size of the local cache in bytes. Affects in memory as well as near caches for remote caches. |
| mailBridgeMailserver | Specifies a mail server that the bridge should query. The parameter specifies the name of a server alias of the type mailserver IMAP or mail server POP3. At… |
| mailBridgeMaximumAbsoluteDelay | Maximum, absolute delay in milliseconds, if the delay is 0 no delay is applied |
| mailBridgeMaximumRelativeDelay | Maximum, relative delay to the interval in percent, if the delay is 0 no delay is applied |
| mailCheckerEnabled | Specifies whether to automatically check for new messages for each user. |
| mailCheckerUserDefault | Specifies whether to set the default (default user) setting for automatic email checking. Specifies the default mail server that is queried if the user account… |
| mailDefaultMailserver | Specifies the default mail server that is queried if the user account does not have a mail server specified. |
| mailEnableUserDefault | Specifies whether to specify and use default settings for user mail. These settings are then used as default values for each user account and can be overridden… |
| mailGlobalMaxSizeReceive | Specifies the maximum size, in bytes, of a received email message. The value is freely selectable as an integer. |
| mailGlobalMaxSizeSend | Specifies the maximum size, in bytes, of a mail to send. The value is freely selectable as an integer. |
| mailGlobalPrefetchEnabled | Optimization parameters, immediately fetch all necessary properties for a mail from the IMAP. |
| mailGlobalUserServerEnabled | Specifies whether user mail (querying a mailbox per user) is turned on. |
| mailGlobalUserServerMinIntervall | Specifies the interval at which to check for new messages for each user. A corresponding setting in the user account (mail server checker interval [MS])… |
| mailProcessAssignments | Specifies the link to the process to be executed. |
| mailProcessBridgeModes | Specifies what should happen when you pick up new user mails: |
| mailProcessUseOutbox | Specifies whether to copy outgoing messages from user-mail to the outbox folder of each mailbox. |
| mailRepositoryAlias | Specifies the alias of the database that serves as the repository. |
| mailRepositoryPreventDuplicates | Determines whether to check whether an email object already exists in the repository or not. |
| managerBackendAlias | Alias for the Manager Backend |
| maxEntryLifetimeInCache | The amount of time that an element remains in the cache. Affects in memory as well as near caches for remote caches. The input is alphanumeric: |
| messageQueueAlias | Alias for the MessageQueue |
| multilingualismIndexSearchLocales | Specifies which languages are used for multilingual fields of the index search. |
| multilingualismLocale | Specifies which language to use if the internal language of the client operating system cannot be found. |
| multilingualismLocaleMappings | Specifies which locales to mapped to each other. |
| neonCallLinkSchema | Set a custom call link schema for phone numbers (default: tel) |
| neonClientPermissionsEnabled | Specifies whether the permissions subsystem should be enabled |
| neonRequestHeaderSize | Sets the maximum size for the request headers |
| notificationcenterAlias | The alias in which the database table for the notification center exists. Configuration and notifications are stored in those tables. |
| pdfPreviewAlias | Alias for the PDFPreviewService |
| permissionsAlias | The alias in which the database table for permissions exists. Permissions are stored in that table. |
| processHistoryLimit | Defines the maximum number of entries in the process history. |
| projectName | The name of the project |
| recordContainerCachingAlias | Alias for the Recordcontainercache |
| relativePathToRessources | Path to the images. Per default points to the binaryUrlRessourceHandler. |
| reportJasperVirtualizer | Specifies where the data is stored when a report is generated before it is transferred to the client. Possible settings are MEMORY or FILE. |
| ressourceDomain | Domain which will be used to create the image paths of the sites userhelp. Doesn't need any trailing slashes (/). Has to be accessible from the machine which… |
| securityApplyPasswordPoliciesForTechnicalUsers | Provides the ability to disable password policies for users with the TECHNICAL role. |
| securityPasswordHistory | Specifies the number of passwords stored in the password history. |
| securityPasswordMinimumLength | Specifies the minimum length of a password. Valid value is a positive integer. |
| securityPasswordRequireRecentAlgorithm | The user is forced to assign a new password if the old password is not hashed with the latest security hash algorithm. |
| securityPasswordRequiresLetter | Specifies whether the password must contain letters. |
| securityPasswordRequiresNumber | Specifies whether the password must contain numbers. |
| securityPasswordRequiresSpace | Specifies whether the password must contain spaces. |
| securityPasswordRequiresSpecial | Specifies whether the password must contain special characters. |
| securityPasswordValidityTime | Specifies the number of days after which the password expires. The number of days is expressed as a positive integer. If -1 is specified, the password does… |
| tagAlias | The alias in which the database table for the tags exists. Favorites and hashtags are stored in those tables. |
| textAnalysisAlias | Alias for the text analysis service. |
| timerPreferencesAlias | The alias where timers should be saved. |
| title | Title (speaking name. may contain spaces and special characters.) This has different effects depending on the entity: |
| useModernImplementation | If set to "true" enables the new database layer backed by MyBatis |
| userdirectoryAlias | The alias in which the database table for the user directory/user data exists. |
| webservicesServerStyle | Specifies the style of the webservice (RPC/literal or document/literal wrapped). |
binariesAlias
Type: String
Here you can define the database alias which shall be used for the binaries.
blobHandlingMethod
Type: EBlobHandlingMethod
Specifies if BLOB data is stored in the database or otherwise handled by a special process.
For example this enables you to store BLOBs in files on a volume instead of the database. This can improve the performance of the database in the long run.
DATABASE: BLOBs are handled by the core and subsequently stored in the database in the table where the BLOBs metadata is also stored (ASYS_BINARIES).PROCESS: BLOBs are handled by a process (blobHandler).
blobPreviewSize
Type: EBlobPreviewSize
Default: MEDIUM
Specifies the size of the previews generated für binary files.
NONE: No previewLOW: 100x100pxMEDIUM: 300x300pxHIGH: 1000x1000px
This configuration only affects previews generated after changing this setting. Already generated previews will not be converted.
blobStorageAlias
Type: String
Default: ``
Requires: blobHandlingMethod property group
The alias that points to an S3 compatible storage system. Here we can only have an alias of the type S3-storage.
This is only considered if the blobHandlingMethod was set to S3-storage.
calendarCategories
Type: Map
Here you can create, edit and delete calendar categories for tasks.
The categories defined here are offered in the task frame as a list for selection. The task is displayed in myADITO in the color specified
for calendarCategories.
<!--VSCODE_ONLY-->
calendarCategoriesEvent
Type: Map
Here you can create, edit or delete calendar categories for appointments.
The categories defined here are offered in the appointment frame as a list for selection. The appointment is displayed in the calendar in the color specified for calendarCategoriesEvent.
<!--VSCODE_ONLY-->
calendarReminderInterval
Type: Long
Default: 0 ms
Specifies the interval at which to check for overdue reminders about calendar entries.
This value is expressed as a positive long value in milliseconds. If this value is set to 0, the reminders are disabled.
calendarReminderPeriod
Type: Long
Default: 147 d
Specifies the amount of time to retroactively check for reminders.
calendarUserSorting
Type: EUserSorting
The user collation allows you to configure the collection of users in the calendar.
The following settings are possible: FIRSTNAME_FIRST, LASTNAME_FIRST and TITLE.
ckeditorAIAlias
Type: String
Specifies an alias for the CKEditor AI features. The alias provides information about the endpoint URL, token and extra request parameters to be used for the prompts.
ckeditorAIAssistantEnabled
Type: Boolean
Default: false
Specifies if the AI Assistant feature should be enabled within the CKEditor. The AI Assistant allows custom requests to the AI enpoint with a freeform textfield.
ckeditorDefaultAICommandsProcess
Type: String
Specifies a process that returns the default AI commands that should be visible in the CKEditor. The default commands can be overwritten by the property ckeditorAICommandsProcess in the entityField of the CKEditor. The process should return an array with JSON objects that contain the following properties: e.g. [{ groupId: customGroupId, groupLabel: My group of commands, commands: [ { id: translateSpanish, label: Translate to Spanish, prompt: Translate this text to Spanish. }, { id: explainFive, label: Explain like I'm five, prompt: Explain this like I'm five years old. } ] }] Consult the CKEditor Documentation for more information.
ckeditorDefaultAISystemPromptProcess
Type: String
Specifies a process that returns the default AI system prompt that should be used for AI requests from the CKEditor. The default prompt can be overwritten by the property ckeditorAISystemPromptProcess in the entityField of the CKEditor. The process should return a string that describes how the AI should behave. The default CKEditor prompt is the following: "Your task is to generate HTML content accordingly to the given instruction. Never include img tag in your response even if asked for. Your answer must be a well-structured and properly formatted HTML code. Answer only with the generated HTML content. Do not add any additional remarks or notes. Do not act like a chatbot or a real person."
clientDefaultLoginLimit
Type: Integer
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE
This setting determines which value to use for a client's login limit if nothing is specified by the client itself.
The login limit limits the number of possible logins for a user to the specified number.
clientSearchExcludeForIgnorecase
Type: Boolean
Default: false
Enables case-sensitive in client search.
If the checkbox is checked, the client search will be case-sensitive for components of type char.
clientStorePreferecensAtLogout
Type: Boolean
Default: false
Specifies whether the preferences should be saved only when the client is stopped or when a search is performed in the user data model of the user who is currently logged on.
clientTempPath
Type: String
Specifies the default value for the client's temporary path. If a temporary path is not set on the client, it is used. The value is freely selectable as a string (path specification). You must enter a directory path that the client user has read and write access to. If this is not granted, there may be problems with document folders.
Differences between ADITO4 and ADITO 5:
In ADITO 5, there is no difference between $TEMP and an empty entry.
In ADITO4:
If the default temp path is left empty $USERHOME/.adito4/temp.
$TEMP reads java.io.TempDir. This is % temp% (Windows) or /tmp (Linux).
clusterMessagingAlias
Type: String
Alias for the ClusterMessaging
comment
Type: String
Property to store a developer comment in form of
/**
*
*/
In the past this was used in customizing for frame controls additional settings, such as the activation of rights, histories, or attributes.
This should not be done anymore in the comment property, because therefor a metadata property exists.
compressBinaries
Type: Boolean
Default: false
Indicates whether the binary data in the ASYS_BINARIES system table is compressed.
If this property is enabled, documents can no longer be found by using the index search.
compressMailrepository
Type: Boolean
Default: false
Specifies whether the data is compressed in the mail repository (for mail repository DB only), in the ASYS_MAILREPOSIT table.
contentAnalysisAlias
Type: String
Alias for the Content Analysis
customConfigProperties
Type: CustomProperties
Here an administrator / developer can define custom configurations, which can be read via JDito
customized
Type: String[]
customProperties
Type: CustomProperties
Here an administrator / developer can define custom configurations, which can be read via JDito
dashletstoreAlias
Type: String
The alias in which the database table for the dashlets and dashlet configurations exists.
databaseAuditAlias
Type: String
The database alias in which the changes in the database are to be logged in the audit table ASYS_AUDIT.
databaseAuditDoDifferencesOnlyOnUpdate
Type: Boolean
Default: true
If set, only the changed elements are written to the audit layer
databaseAuditFilterDBSyncItems
Type: Boolean
Enables the database filter for synchronization items. This suppresses the writing of the data records that come from the other system during synchronization. This setting is useful on the slave, so that the changes that come from the master are not also entered into the audit layer.
Attention: This makes it impossible to track the changes on the slave.
databaseAuditGetOldValueLobs
Type: Boolean
Default: false
Sets whether the old LOB values (CLOB, BLOB) are given to the audit.
As a result, the audit is slower and consumes more memory.
databaseAuditInternalCaseHandling
Type: Boolean
Default: true
Sets whether the internal case handling should be used.
If this value is No, the query is ASYS_AUDIT to the system database with an upper() command.
Yes refers to internal case handling, which is why indexes can be used in the system database, which increases performance.
databaseAuditIsUseOldValuesOnDelete
Type: Boolean
Default: true
If set, only the deleted elements are provided within the audit layer
databaseAuditMaximumTimestampJitter
Type: Long
Default: 3 s
The maximum deviation from the last value. Used to account for changes to the system time
databaseAuditProcessLoggerUser
Type: String
The user that is used for the audit logging process.
databaseAuditTimestampResolution
Type: Long
Default: 5 ms
Audit timestamps have to be unique. Here you can configure, which distance between the timestamps is used.
defaultDataAlias
Type: String
The default alias for all data tables. As of now, only the following tables are potentially affected by this property:
ASYS_BINARIESASYS_CALENDARBACKENDASYS_CALENDARSYNC
The following tables are mandatory in the system alias and can't be influenced by this property:
ASYS_ALIASCONFIGASYS_ICONSASYS_MONITOR_DASHLETCONFIGASYS_SEQUENCESASYS_SYSTEM
The following tables are also not influenced by this property because their alias is determined by special configurations that can't be overridden in a sensible way:
ASYS_AUDITASYS_CALENDARLINKASYS_FARMASYS_FARM_CLIENTASYS_MAILREPOSITASYS_MAILREPOSIT_HASHASYS_SYNCSLAVESASYS_TIMERSASYS_TIMERS_SERVERRUNSASYS_UIDRESOLVER
defaultSystemAlias
Type: String
The default alias for all system tables. Exceptions are all tables that are affected by defaultDataAlias.
Currently, these tables are potentially affected by this property:
ASYS_DASHLETCONFIGURATIONSASYS_DASHLETSASYS_NOTIFICATIONCONTENTSASYS_NOTIFICATIONSASYS_PERMISSIONASYS_PERMISSIONACTIONASYS_PERMISSIONSETASYS_RECORDASYS_RECORDGROUPASYS_ROLESASYS_ROLES_CHILDRENASYS_USERSASYS_USERTOKEN
The following tables are mandatory in the system alias and can't be influenced by this property:
ASYS_ALIASCONFIGASYS_ICONSASYS_MONITOR_DASHLETCONFIGASYS_SEQUENCESASYS_SYSTEM
The following tables are also not influenced by this property because their alias is determined by special configurations that can't be overridden in a sensible way:
ASYS_AUDITASYS_CALENDARLINKASYS_FARMASYS_FARM_CLIENTASYS_MAILREPOSITASYS_MAILREPOSIT_HASHASYS_SYNCSLAVESASYS_TIMERSASYS_TIMERS_SERVERRUNSASYS_UIDRESOLVER
description
Type: String
Description
documentation
Type: String
Contains the documentation of the data model in the popular AsciiDoc format (.adoc).
The documentation should be set by the developer to explain different aspects (like purpose, concept, etc.) of the data model that they designed.
You may want to add the extension "AsciiDoc" to your ADITO Designer in order to modify AsciiDoc files.
<!--VSCODE_ONLY-->
hashtagsEnabled
Type: Boolean
Default: true
Specifies whether the tags should be enabled or not
icon
Type: String
Image.
Depending on the datamodel, this has different effects:
- Entity: used as symbol in the designer. Do not confuse this property with the
iconIdproperty - Context: used as symbol in the designer. If the contexts entity has an icon set, the entities icon is used
- System, Language, Role, Application: icon that appears only in the designer.
- Template: Same effect as on the respective component
- Alias, User: no effect
- Frame, Process, Report, NeonFrame: icon that appears in the designer and in the client for the frame.
<!--EOF-->
You can add a custom icon by placing an icon.png file in the folder of your data model.
iconProcess
Type: String
Specifies the icon dynamically. If the icon has no effect, neither will the result of the process.
Depending on the datamodel, the result of the process has to be different:
-
When you can specify an icon-avatar-text (e.g.
VAADIN:USERS): You've to return theicon-avatar.textwithresult.string(...) -
When you can specify an image in the icon: This is returned as a string with the ID of the image in the
ASYS_BINARIESviaresult.string().
Error messages from this process do not arrive at the client, they are only visible in the server log.
indexsearchAllowLeadingWildcards
Type: Boolean
Default: true
Allows leading wildcards (*criterion).
If this is not allowed, only the following wildcards (criterion*) are accepted.
indexsearchAutoCommitEnabled
Type: Boolean
Specifies if pending updates of the indexer will be automatically pushed to the index.
The default is true.
If the auto commit flag is set to false, then only explicit commits will update the index.
This setting should only be set to false if the whole index contains less then 30000 documents
indexsearchAutoCommitMaxDocs
Type: Long
Constraints: Minimum: Long.MIN_VALUE, Maximum: Long.MAX_VALUE
The number of updates that have occurred since the last commit of the indexer.
indexsearchAutoCommitMaxTimeMS
Type: Long
The number of milliseconds since the oldest uncommitted update of the indexer.
indexsearchBoostLatestDocuments
Type: Boolean
Default: true
If enabled newer documents get a boost to score higher than older documents.
indexsearchCachePatternExtensions
Type: Boolean
Specifies whether the filter patterns of the PatternExtensions should be cached by the index for later reuse of the results.
Default is true.
indexsearchCachePermissionFilters
Type: Boolean
Specifies whether the filter patterns for the permissions should be cached by the index for later reuse of the results.
Default is true.
indexsearchCJKApplyLeadingWildcards
Type: Boolean
Specifies whether leading wildcards should be added to CJK terms.
Default is true.
indexsearchCJKApplyTrailingWildcards
Type: Boolean
Specifies whether trailing wildcards should be added to CJK terms.
Default is true.
indexsearchCJKCreatePhraseTerms
Type: Boolean
Specifies whether additional phrases should be generated for CJK terms for the individual terms.
Default is true.
indexsearchCJKCreateShingles
Type: Boolean
Specifies whether shingles are to be generated for CJK terms.
Default is true.
The length of the generated shingles is set via the corresponding parameters indexsearchCJKMinShingleSize and indexsearchCJKMaxShingleSize.
The shingles are generated only for terms, greater or equal, of the set minimum length.
The minimum term length can be set via the parameter indexsearchCJKMinTermSizeForShingles.
indexsearchCJKMaxShingleSize
Type: Integer
The maximum length for the generated shingles for CJK terms. Default is 4.
indexsearchCJKMinShingleSize
Type: Integer
The minimum length for the generated shingles for CJK terms. Default is 3.
indexsearchCJKMinTermSizeForShingles
Type: Integer
The minimum length for CJK terms from which shingles are generated. Default is 4.
indexsearchCJKOnlyUsePhraseTerms
Type: Boolean
Specifies whether all terms are to be evaluated as phrases for CJK terms.
Default is false.
indexsearchCJKOptimizationEnabled
Type: Boolean
Controls the advanced optimization for CJK inputs of the index search.
Default is true.
If the flag is active, additional search options, such as word shingles, additional phrases and separate wildcard settings are used for CJK entries. The individual options can be configured in more detail via the corresponding expert parameters.
indexsearchCJKOverrideUserWildcards
Type: Boolean
Specifies whether other wildcard settings should be used for CJK terms.
Default is false.
If active, the wildcards for CJK terms are determined by the two settings indexsearchCJKApplyLeadingWildcards and indexsearchCJKApplyTrailingWildcards, instead of the default user setting.
indexsearchDefaultResultCount
Type: Integer
Default: 25
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE
Sets the default amount of hits, if in JDito a specific count is not given. Has to be lower or equal to indexsearchMaximumHits.
indexsearchFullIndexerEnabled
Type: Boolean
Default: false
Enables the full-text index.
This should only be used for the initial structure of the index, because otherwise performance problems can occur.
All data stored in the index configuration is read from the database and stored on the hard disk.
indexsearchFullIndexerInterval
Type: Long
Default: 0 ms
Requires: indexsearchFullIndexerEnabled = true
The interval at which the full-text index is updated.
In almost all cases, the interval should be 0 and indexearchFullIndexerEnabled should be checked, since the indexer can be triggered via indexsearch.runIndexer().
indexsearchGlobalDefaultOperator
Type: EBooleanOperator
Sets the default operator of the index search for the global search.
The default is OR for the optimized user search with ranking.
If the old search without ranking is used, AND is used as the default operator.
If the one value is set, the specified operator is always used as default operator for global search. The operator is used for user input only and has no effect on internal filter or boost patterns of the search.
indexsearchGlobalEnabled
Type: Boolean
Default: true
Sets whether index lookup is available in clients.
If this setting is disabled, the index search field disappears from the clients for the users. However, you can still run evaluations with indexsearch.search().
indexsearchGlobalFilterExtensionHandlingMethod
Type: EIndexUnknownFilterExtensionHandlingMethod
Specifies how unknown filter extensions are handled in the overall index search. Default is FAIL.
This setting applies to the clients index lookup and the search via JDito indexsearch.search.
IMPORTANT: This does not affect entities or any consumer using an index record container. They will always fail on unknown pattern extensions, since they evaluate all extensions specified in the record container.
WARNING: If filter extensions are used in the permissions, the setting will most likely bypass the application of the filters
for the index search if not set to FAIL.
Corresponding patternExtensions must be defined in the index groups, which apply the missing permissions to the index search.
Options:
FAIL: The index search will not return any results and throws an exception while searching via JDito.SKIP: The index search skips all unknown filter extensions. The search is performed, but the skipped filters are not applied, returning more results than intended.AS_FIELD: The index search will treat any unknown filter extension as an index field. The search will throw an exception if no such field is defined for the affected index groups.
NOTE: This option will probably no longer be available when the entire index search can evaluate filter extensions.
indexsearchGlobalFuzzySearchFactor
Type: Integer
Constraints: Maximum: Integer.MAX_VALUE
Returns the factor used by the fuzzy search.
The factor determines whether and how many character permutations the fuzzy search may perform for individual terms.
The default is 1.
NOTE: The setting is only applied if the ranked search is used.
indexsearchGlobalUseRankedSearch
Valid values are:
0: The fuzzy search is deactivated.1: The fuzzy search performs one permutation.2: The fuzzy search performs two permutations.
indexsearchGlobalMinTermSizeForWildcards
Type: Integer
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE
Defines the minimum length that an input value of the global search must have, so that the extension with wildcards is applied for the value.
Default is 0 for no limit.
indexsearchGlobalOnlyCountSelectedGroups
Type: Boolean
Specifies whether the counters for index groups should only be displayed for selected groups in the global search.
Default is false.
The display then does not show any counters for the unselected groups. The search is then only carried out once without having to evaluate the permissions for all global index groups.
This improves performance for large indexes and systems with complex permissions.
indexsearchGlobalUseLanguageFallback
Type: Boolean
Specifies whether the global search, for a multilingual index, should search the system's default language in addition to the client language.
Default is true.
indexsearchGlobalUseRankedSearch
Type: Boolean
Default: true
Specifies whether the client's global lookup component performs the weighting of each document, based on the boost settings of each index group.
The default is true.
indexsearchIncrementingIndexerBunchSize
Type: Integer
Default: 250
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE
Requires: indexsearchIncrementingIndexerEnabled = true
The number of data packets that the incremental index enters in a turn.
indexsearchIncrementingIndexerEnabled
Type: Boolean
Default: false
Enables the incremental index.
This updates the index with the changes that have been made at a specific interval (indexsearchIncrementingIndexerInterval). Only small areas are updated here, not the entire index.
indexsearchIncrementingIndexerInterval
Type: Long
Default: 10 s
Requires: indexsearchIncrementingIndexerEnabled = true
The interval at which the incremental index is updated.
The minimum value that can be set is one second (1S), the recommended minimum value is 15S. If 0 is entered here, the indexer is not active.
indexsearchIndexerBufferSizeLimit
Type: Long
Constraints: Minimum: Long.MIN_VALUE, Maximum: Long.MAX_VALUE
The memory limit in bytes of the indexers internal document buffer. Default is 512 MB.
If the specified limit ist reached or exceeded during indexing the indexer will send all currently buffered documents to the index, ignoring the specified document limit (default 256).
The setting applies to all indexers.
The smallest possible limit supported by the indexer is 5 MB (5242880), all specified positiv values below this limit will result an effective limit of 5 MB.
Setting this option to 0 or less deactivates the limit.
WARNING: When specifying a limit that is too large or deactivating the option, can lead to high memory consumption when indexing large indexes with binary data and can end up in an OOM error.
The lower the limit, the slower the indexer will be when indexing larger content, e.g. if the index group contains binary data.
NOTE: This properties editor is a simple long editor, allowing to specify memory values greater then 2 GB.
The value must specify the actual amount of bytes.
e.g. 512 MB = 512 * 1024 * 1024 = 536870912 bytes
IMPORTANT: This option does not limit the actual amount of memory used by the indexer in any way. It only forces the indexer to flush and commit all index documents, that are currently buffered, when the specified limit is exceeded. This will only free the memory used by the buffer.
This option has no effect on the memory usage of the database requests a processes used to create the resulting index documents.
indexsearchIndexerDBRowsForDocumentWarningLimit
Type: Integer
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE
Returns the limit for the indexer, above which a warning is logged that too many db columns are read for a single record.
The default is 200 db columns per record.
The limit refers to the read db columns for a single UID of an index document and used only when the records for an index document are read out via a SQL query.
When the limit is reached, a warning is logged that the given SQL query may have an error for the affected index group, causing too many columns to be read out for a single UID.
This waning can help to detect problems in the SQL of the indexer at an early stage. The limit applies to all indexers (Full and Incremental).
If the value is set to less 0 or less, no warnings are logged.
indexsearchIndexerMaxBufferedDocs
Type: Integer
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE
The maximum amount of index documents the indexer can buffer before sending them to the index.
Default is 256.
The setting applies to all indexers
Setting this option to 0 or less, will cause the indexer to use the default.
WARNING: Specifying a too large amount, can lead to high memory consumption when indexing large indexes and can end up in an OOM error.
Specifying a too small amount, will result in a longer indexing time.
indexsearchIndexerWarnOnSkippedDBRows
Type: Boolean
Specifies whether the indexer should log a warning if records of the database were skipped during indexing.
Default is true.
This occurs if the SQL of the indexer returns records for a different UID than specified in the indexer. For example, this applies to the affectedIds of the incremental indexer.
The warning is logged to indicate a possibly incorrect SQL for the indexer of an index group.
The FullIndexer ignores this limit because there are no restrictions for the UIDs.
indexsearchInitWaitTimeout
Type: Long
Sets the maximum amount of time a running index component, e.g. the full indexer, is waiting for the index search to reinitialize, before canceling the planed execution.
The default is 10 seconds. The maximum is 5 minutes and all values greater than this will result in a timeout of 5 minutes being used. If the specified timeout is equal or smaller than 0 not timeout will be used.
indexsearchJDitoResultFieldArraysAsString
Type: Boolean
Defines whether results, for fields with multiple values, should be returned as a string instead of an array.
Affected are all IndexRecordFields where the property isMultiValued is set.
This only affects the result of the search via JDito, using indexsearch.search() or indexsearch.searchIndex().
Default is false.
If set to true, all arrays will be returned as strings, with the form [value1, value2, ..., valueN].
If false, the values are returned as native arrays.
indexsearchMaximumHits
Type: Integer
Default: 250
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE
Number of maximum search results displayed in the index search. Since the index search should only give an overview, you should not enter too large values here.
Because the index always sets the result set to the size of the maximum hits and then takes the search results, it can also lead to performance degradation in this field.
This setting is overridden by indexsearchDefaultHits, should indexsearchMaximumHits be the greater value.
indexsearchMaximumHits is only relevant for indexsearch.search() and causes you to be able to filter only up to the specified number.
indexsearchSoftAutoCommitEnabled
Type: Boolean
Specifies if the indexer performs a 'soft commit', meaning that Solr will commit your changes to the Lucene data structures quickly but not guarantee that the Lucene index files are written to stable storage.
The default ist false.
This is an implementation of Near Real Time storage, a feature that boosts document visibility, since the Searcher does not have to wait for background merges and storage to finish.
Note when using 'soft commits' and the index server crashes, all not fully committed documents are lost, even if there were visible for the searcher.
indexsearchUseRemoteParameterSets
Type: Boolean
Specifies if the index should use parameter sets that are managed by the remote service.
Default is true.
If enabled, the default, all field aliases used during a search will be stored on the remote service and are only referenced in the query. This reduces the length of the used URL of the search request.
If disabled, all needed field aliases for the search are send in as a URL parameter of the search request. This can case an exception caused by exceeding the max length of a URL, if to many field or languages are used for the index.
indexsearchUseSearchableDescriptionField
Type: Boolean
Specifies if the system field #DESCRIPTION (_description_) of the index search can be searched. The default is false.
This option affects all index groups and enables the isIndexed flag of the system field.
When changing this setting, the index must be rebuilt for it to take effect.
indexsearchUseSearchableTitleField
Type: Boolean
Specifies if the system field #TITLE (_title_) of the index search can be searched. The default is false.
This option affects all index groups and enables the isIndexed flag of the system field.
When changing this setting, the index must be rebuilt for it to take effect.
jditoCalculationDepth
Type: Integer
Default: 10
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE
The count of JDito calculation round after which the execution is aborted. Mainly affects recursive function and their recursion depth.
jditoCalculationVersion
Type: ECalculationMode
This specifies which version of the calculation logic should be used for JDito variables.
V1 is the classic calculation logic where variables are identified via static code analysis and from this the dependencies between the JDito
scripts are calculated. In versions prior to 2023.1.0, this was the default value.
In V2, the dependencies are determined at runtime via the function calls. This way cases can be identified which are not found by static code analysis. Additionally thereby also dependencies of imported libraries are found and used. V2 has beyond that a deadlock recognition, which can break deadlocks with an exception. This prevents these errors from permanently blocking the client or server. This is the new default value as of version 2023.1.0.
V2_FOR_CANARY means that V1 is used by default, but if a user has the canary role, V2 is used for that user.
jditoMaxContentSize
Type: Integer
Default: 100 MB
Sets the maximum size of loaded objects within JDito (for example, loaded via fileIO.getData()).
It is specified in bytes and should be incremented if the corresponding errors appear in the log. The default value is 10 MB (10485760 bytes).
jditoScriptCacheTimeout
Type: Long
Default: 1 d
Sets the amount of time to precompile JDito code.
By default, this value is set to one day. Higher values ensure that code is kept in memory and does not always need to be recompiled-this can relieve the CPU of the ADITO server and reduce latency, significantly increasing memory consumption.
jditoScriptManagerNext
Type: Boolean
Default: true
Enables the ScriptManagerNext, which pre compiles libraries for better performance.
jditoUserServerContext
Type: String
Specifies the user who is used in the servercontext.
localCacheMaxMemorySize
Type: Integer
The max size of the local cache in bytes. Affects in memory as well as near caches for remote caches.
mailBridgeMailserver
Type: PreferencesDataModel.Mailbridges
Specifies a mail server that the bridge should query. The parameter specifies the name of a server alias of the type mailserver IMAP or mail server POP3. At this point, a wizard can be used to specify how the Mailbridges should behave.
<!--VSCODE_ONLY-->
mailBridgeMaximumAbsoluteDelay
Type: Long
Default: 2 s
Maximum, absolute delay in milliseconds, if the delay is 0 no delay is applied
mailBridgeMaximumRelativeDelay
Type: Integer
Default: 10
Constraints: Minimum: 0, Maximum: 100
Maximum, relative delay to the interval in percent, if the delay is 0 no delay is applied
mailCheckerEnabled
Type: Boolean
Default: false
Requires: mailGlobalUserServerEnabled = true
Specifies whether to automatically check for new messages for each user.
mailCheckerUserDefault
Type: Boolean
Default: true
Requires: mailGlobalUserServerEnabled = true
Specifies whether to set the default (default user) setting for automatic email checking. Specifies the default mail server that is queried if the user account does not have a mail server specified.
A corresponding setting on the user account overrides this setting. Possible value: MailserverPOP3.
mailDefaultMailserver
Type: String
Requires: mailGlobalUserServerEnabled = true
Specifies the default mail server that is queried if the user account does not have a mail server specified.
A corresponding setting on the user account overrides this setting. Possible value: MailserverPOP3.
mailEnableUserDefault
Type: Boolean
Default: false
Requires: mailGlobalUserServerEnabled = true
Specifies whether to specify and use default settings for user mail. These settings are then used as default values for each user account and can be overridden there.
mailGlobalMaxSizeReceive
Type: Integer
Default: 32 MB
Specifies the maximum size, in bytes, of a received email message. The value is freely selectable as an integer.
mailGlobalMaxSizeSend
Type: Integer
Default: 10 MB
Specifies the maximum size, in bytes, of a mail to send. The value is freely selectable as an integer.
mailGlobalPrefetchEnabled
Type: Boolean
Default: true
Optimization parameters, immediately fetch all necessary properties for a mail from the IMAP.
mailGlobalUserServerEnabled
Type: Boolean
Default: false
Specifies whether user mail (querying a mailbox per user) is turned on.
mailGlobalUserServerMinIntervall
Type: Long
Default: 10 s
Requires: mailGlobalUserServerEnabled = true
Specifies the interval at which to check for new messages for each user. A corresponding setting in the user account (mail server checker interval [MS]) overrides this global variable.
mailProcessAssignments
Type: Map
Specifies the link to the process to be executed.
mailProcessBridgeModes
Type: Integer
Default: 0
Specifies what should happen when you pick up new user mails:
None: no action is taken.Process: only the process is executed, i.e. the mail is only processed and the original mail is forfeited.Copy: The mail is only copied to the mailrepository, but not processed.Both: The process is executed and the mail is copied to the repository.
This setting corresponds to the Bridgemode setting in the mail bridge.
mailProcessUseOutbox
Type: Boolean
Default: false
Specifies whether to copy outgoing messages from user-mail to the outbox folder of each mailbox.
mailRepositoryAlias
Type: String
Specifies the alias of the database that serves as the repository.
The database must be prepared as a mail repository (see appendix system tables in the designer help). A valid database alias from the designer must be specified as a parameter.
mailRepositoryPreventDuplicates
Type: Integer
Default: 0
Determines whether to check whether an email object already exists in the repository or not.
If this property is Yes, no duplicate entries are stored in the repository. A hash value is calculated for the check.
managerBackendAlias
Type: String
Alias for the Manager Backend
maxEntryLifetimeInCache
Type: Long
Default: 4 h
The amount of time that an element remains in the cache. Affects in memory as well as near caches for remote caches. The input is alphanumeric:
1W= one week in ms1D= one day in ms1H= one hour in ms1M= one minute in ms1S= one second in ms
Example input: 1D 42M
Default value = 4H
messageQueueAlias
Type: String
Alias for the MessageQueue
multilingualismIndexSearchLocales
Type: String[]
Constraints: Verification: EVerifier.LOCALE_LIST
Specifies which languages are used for multilingual fields of the index search.
If language packs are used for translation, the appropriate locales must be added to this property so that they are used by the indexer.
If a user uses a locale during the search that is not defined in this list (e.g. de_CH), the index search uses the corresponding locale of the language (e.g. de).
If no entry is defined for the language, the default locale (multilingualismLocale) is used.
multilingualismLocale
Type: String
Constraints: Verification: LOCALE
Specifies which language to use if the internal language of the client operating system cannot be found.
The ADITO default language is English (en). A different language can be used here.
multilingualismLocaleMappings
Type: Map
Constraints: Verification: EVerifier.LOCALE_MAPPING
Specifies which locales to mapped to each other.
For example, if you want all clients in Switzerland to be in English instead of in German, you can specify a new key for the Swiss locales under Locales (All) for the key/value pairs, and then for Locales the value en - "English".
neonCallLinkSchema
Type: String
Set a custom call link schema for phone numbers (default: tel)
neonClientPermissionsEnabled
Type: Boolean
Default: true
Specifies whether the permissions subsystem should be enabled
neonRequestHeaderSize
Type: ERequestHeaderSize
Sets the maximum size for the request headers
notificationcenterAlias
Type: String
The alias in which the database table for the notification center exists. Configuration and notifications are stored in those tables.
pdfPreviewAlias
Type: String
Alias for the PDFPreviewService
permissionsAlias
Type: String
The alias in which the database table for permissions exists. Permissions are stored in that table.
processHistoryLimit
Type: Integer
Default: 25
Constraints: Minimum: 0, Maximum: Integer.MAX_VALUE
Defines the maximum number of entries in the process history.
projectName
Type: String
Constraints: Verification: EVerifier.PROJECT_NAME
The name of the project
recordContainerCachingAlias
Type: String
Alias for the Recordcontainercache
relativePathToRessources
Type: String
Path to the images. Per default points to the binaryUrlRessourceHandler.
reportJasperVirtualizer
Type: EJasperVirtualizerType
Specifies where the data is stored when a report is generated before it is transferred to the client. Possible settings are MEMORY or FILE.
ressourceDomain
Type: String
Domain which will be used to create the image paths of the sites userhelp. Doesn't need any trailing slashes (/).
Has to be accessible from the machine which runs the designer.
securityApplyPasswordPoliciesForTechnicalUsers
Type: Boolean
Default: false
Provides the ability to disable password policies for users with the TECHNICAL role.
securityPasswordHistory
Type: Integer
Default: 0
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE
Specifies the number of passwords stored in the password history.
securityPasswordMinimumLength
Type: Integer
Default: 0
Constraints: Verification: EVerifier.NOT_NEGATIVE, Minimum: 0, Maximum: Integer.MAX_VALUE
Specifies the minimum length of a password. Valid value is a positive integer.
securityPasswordRequireRecentAlgorithm
Type: Boolean
Default: false
The user is forced to assign a new password if the old password is not hashed with the latest security hash algorithm.
securityPasswordRequiresLetter
Type: Boolean
Default: false
Specifies whether the password must contain letters.
securityPasswordRequiresNumber
Type: Boolean
Default: false
Specifies whether the password must contain numbers.
securityPasswordRequiresSpace
Type: Boolean
Default: false
Specifies whether the password must contain spaces.
securityPasswordRequiresSpecial
Type: Boolean
Default: false
Specifies whether the password must contain special characters.
securityPasswordValidityTime
Type: Integer
Default: -1
Constraints: Minimum: Integer.MIN_VALUE, Maximum: Integer.MAX_VALUE
Specifies the number of days after which the password expires. The number of days is expressed as a positive integer. If -1 is specified, the password does not expire and is valid forever.
tagAlias
Type: String
The alias in which the database table for the tags exists. Favorites and hashtags are stored in those tables.
textAnalysisAlias
Type: String
Alias for the text analysis service.
If no alias is configured the internal implementation is used.
The service is used to analyze and search contents of text, e.g. by the script function text.analyze(...).
timerPreferencesAlias
Type: String
The alias where timers should be saved.
title
Type: String
Constraints: Verification: TITLE_LENGTH
Title (speaking name. may contain spaces and special characters.) This has different effects depending on the entity:
- System, Application, Template, Language and Alias: no effect
- Frame, NeonFrame: Caption of the frame in the client
- Process: Name of the process in system administration
- Report: Labeling of the report in the client
- Role: Name of the role as it appears in the client
useModernImplementation
Type: Boolean
Default: false
If set to "true" enables the new database layer backed by MyBatis
userdirectoryAlias
Type: String
The alias in which the database table for the user directory/user data exists.
webservicesServerStyle
Type: String
Specifies the style of the webservice (RPC/literal or document/literal wrapped).