Docs
ServoyCloudSupportSamplesOpen SourceCommunity
  • Home
  • GUIDES
    • Platform Overview
    • Get Servoy
    • Get Started
      • Chapter 0
      • Chapter 1
      • Chapter 2
      • Chapter 3
      • Chapter 4
      • Chapter 5
    • Get Help
      • SuLA Instructions
      • SuLA Terms
    • Develop
      • Application Design
        • Forms
          • Layout Management
            • Simple Layout
            • Fully Responsive
              • Bootstrap 12-Grid
              • Flexbox
              • Custom Div
              • Collapsible Container
              • Simple Collapsible
              • Center Container
              • Inline Group Container
            • Abstract Form
          • Form Containers
            • Form Container
            • Tab Panel
            • Split Pane
            • Collapse
            • Accordion Panel
            • Form Component
            • List Form Component
          • Form Inheritance
          • Form Components
        • UI Components
          • Buttons and Text
            • Badge
            • Button
            • Data Label
            • Dropdown
            • Image
            • Label
          • Grids
            • Data Grid
            • Power Grid
            • Table
          • Input Controls
            • Calendar
            • Calendar Inline
            • Checkbox
            • Choice Group
            • Combobox
            • Group Buttons
            • Html Area
            • Input Group
            • Rating
            • Slider
            • Switch
            • Spinner
            • TextArea
            • Textbox
            • TextBoxGroup
            • Type Ahead
            • select2tokenizer
          • Media
            • Carousel
            • Embedded YouTube
            • File upload
            • Image label
            • Lightbox Gallery
            • MultiFile Upload
            • PDF JS Viewer
            • PDF Viewer
          • Mobile
            • Native Data List
            • Native Select
          • Navigation
            • Breadcrumbs
            • Navbar
            • sidenav
          • Visualization
            • DBTreeview
            • Progress Bar
            • Treeview
            • ChartJS
              • Data Labels Plugin
              • Funnel Chart
              • OutLabels Plugin
              • TreeMap
          • Specialized Components
            • Smart Document Editor
            • Servoy PDF Viewer
            • Fullcalendar Component
              • Fullcalendar
              • Fullcalendar Events
              • Migrating calendar from Smart and Web client to NG client
            • Fullcalendar Component 2
            • Canvas
            • Google Charts
            • Google Maps
            • svySignature
            • svywebcam
        • Styling and Themes
          • Default Theme Properties
          • CSS / LESS
          • Component Variants
          • Font Icons
        • Data Modeling
          • Databases
            • Tables
              • Columns
              • Calculations
              • Aggregations
              • Methods
              • Events / Triggers
              • Table security
            • Views
            • Procedures
          • Relations
          • Value Lists
          • Menus
          • In-Memory Databases
          • View Datasource
        • Modular Design
      • Programming Guide
        • Scripting the UI
          • Scripting Forms
          • Interacting with Components
          • Navigation
          • Windows, Dialogs and Popups
          • Events Manager
        • Working with Data
          • Concepts
          • Loading
          • Sorting
          • Iterating
          • Searching
            • Find mode
            • Query Builder
            • SQL String
          • Filtering
          • Editing
          • Validation
        • Automation and Scheduling
          • Batch Processor
          • Headless API
          • Scheduler API
        • Creating REST APIs
        • Consuming Webservices
        • Working with Files
          • File Plugin Basics
          • Images
          • Excel
          • PDF
          • JSON
        • Browser Utilities
          • Notifications
            • Web Notifications (Toastr)
            • Web Notifications (Native)
            • Block UI
          • Session Management
          • Keyboard Utilities
          • NG Utils
        • Sending and Receiving Email
        • Servoy Jasper Reports
          • Display Mode
          • Input Type
          • Jaspe Reports Viewer
          • Output format
        • Extensions
          • Modules
            • svyPhonegap
              • First Use Guide
              • Barcode Scanner
              • Browser
              • Camera
              • File
              • Fingerprint
              • Location
              • Network Interface
              • Phonegap
              • Printer
              • Push Notifications
            • svyAPI
              • Getting Started
            • svyLookup
              • Custom Templates
              • API Documentation
              • svyLookup v1
                • API Documentation v1.0.0
                • Base Form svyLookupTable v1.0.0
                • Base Form AbstractLookup v1.0.0
            • svyNavigation
              • API Documentation
                • API svyNavigation
                • API svyNavigationHistory
                • API svyNavigationUX
            • svyPopupFilter
              • Simple Filter Pickers
              • Custom Templates
              • API Documentation
                • API svyToolbarFilter
                • API svyPopupFilter
              • API Documentation v1
                • API svyToolbarFilter v1
                • API svyPopupFilter v1
            • svySearch
            • svySecurity
              • Overview
              • Token-based Auth and SSO (NEW!)
              • API Documentation
              • Getting Started
              • Tenant replication
              • Security Management Console
                • Classic Security Management Console
              • svySecurityUX
              • svyProperties
              • API Doc svyProperties
            • svyUtils
              • Log Manager
              • Log Manager Appenders
              • Smart Doc Editor Utils
              • Custom Dialogs
              • Excel Utils
                • Full API Reference
              • Crypto Utils
      • Security
        • Authentication
        • Permissions
          • UI Permissions
          • Data Permissions
          • Runtime Permissions
        • Audit Logging
        • OAuth
        • JWT
      • Multi-Language Support
      • Mobile Development
        • Getting Started
        • Mobile Design
        • Native Mobile Integrations
        • Building a Native Binary for the App Store
      • Native Desktop Development
        • NGDesktop UI plugin
        • NGDesktop Utils
        • NGDesktop File Plugin
    • Deploy
      • WAR Deployment
      • Docker Deployment
      • Server Configuration
        • Server Settings
        • Server Plugins
        • Database Servers
          • Locks
          • Transactions
          • Oracle
          • SQLServer
        • Client Sessions
        • Batch Processors
        • License Management
        • Monitoring
          • Server Log
          • Browser Console Log
          • Websocket Log
          • Query Performance
          • Client Performance
          • Client Event Tracing
          • Monitoring Servoy with JMX
      • NGClient deployment
      • Troubleshooting
      • Other Topics
        • Security: Cross-site Scripting
        • Running in an iFrame
    • Extend
    • Contribute
  • Reference
    • Servoy Core
      • Object Model
        • Database Server
          • Table
            • Aggregation
            • Calculation
            • Column
            • Method
          • View
          • Procedure
        • Solution
          • Form
          • Form Component
          • Relation
          • Relation Item
          • Table Node
          • Value List
          • Menu
          • Menu item
          • In-Memory Data Source
          • View Foundset Data Source
          • Variable
          • Column Info
          • Media
          • Layout Container
          • Method
        • i18n Message Key
      • Developer API
        • Globals
        • Forms
          • RuntimeForm
            • controller
            • containers
              • RuntimeContainer
            • elements
              • Component
              • RuntimeAccordionPanel
              • RuntimeBean
              • RuntimeButton
              • RuntimeCalendar
              • RuntimeCheck
              • RuntimeCombobox
              • RuntimeComponent
              • RuntimeDataButton
              • RuntimeDataLabel
              • RuntimeGroup
              • RuntimeHtmlArea
              • RuntimeImageMedia
              • RuntimeInsetList
              • RuntimeLabel
              • RuntimeListBox
              • RuntimePassword
              • RuntimePortal
              • RuntimeRadio
              • RuntimeChecks
              • RuntimeRadios
              • RuntimeRectangle
              • RuntimeRtfArea
              • RuntimeSpinner
              • RuntimeSplitPane
              • RuntimeTabPanel
              • RuntimeTextArea
              • RuntimeTextField
              • RuntimeWebComponent
        • JS Lib
          • Array
          • BigInt
          • Boolean
          • Date
          • Function
          • IterableValue
          • Iterator
          • JSON
          • Map
          • Math
          • Namespace
          • Number
          • Object
          • Promise
          • QName
          • RegExp
          • Set
          • Special Operators
          • Statements
          • String
          • XML
          • XMLList
        • Application
          • APPLICATION_TYPES
          • CLIENTDESIGN
          • CSSPosition
          • DRAGNDROP
          • ELEMENT_TYPES
          • JSBounds
          • JSDimension
          • JSDNDEvent
          • JSEvent
          • JSLogBuilder
          • JSLogger
          • JSPoint
          • JSUpload
          • JSWindow
          • LOGGINGLEVEL
          • NGCONSTANTS
          • Renderable
          • UICONSTANTS
          • UUID
        • SolutionModel
          • ALIGNMENT
          • ANCHOR
          • BEVELTYPE
          • CURSOR
          • DEFAULTS
          • FONTSTYLE
          • MEDIAOPTION
          • PAGEORIENTATION
          • PRINTSLIDING
          • SCROLLBAR
          • TITLEJUSTIFICATION
          • TITLEPOSITION
          • UNITS
          • JSBean
          • JSButton
          • JSCalculation
          • JSChecks
          • JSCombobox
          • JSComponent
          • JSDataSourceNode
          • JSField
          • JSForm
          • JSHeader
          • JSInsetList
          • JSLabel
          • JSLayoutContainer
          • JSList
          • JSMedia
          • JSMethod
          • JSPart
          • JSPassword
          • JSPortal
          • JSRadios
          • JSRelation
          • JSRelationItem
          • JSResponsiveLayoutContainer
          • JSStyle
          • JSTab
          • JSTabPanel
          • JSText
          • JSTextArea
          • JSTitle
          • JSValueList
          • JSVariable
          • JSWebComponent
        • Database Manager
          • JSBaseFoundset
          • JSBaseRecord
          • JSBaseSQLFoundset
          • JSBaseSqlRecord
          • JSColumn
          • JSDataSet
          • JSFoundSet
          • JSFoundSetUpdater
          • JSRecord
          • JSRecordMarker
          • JSRecordMarkers
          • JSTable
          • JSTableFilter
          • MenuFoundSet
          • MenuItemRecord
          • QBAggregate
          • QBAggregates
          • QUERY_COLUMN_TYPES
          • SQL_ACTION_TYPES
          • QBCase
          • QBCaseWhen
          • QBColumn
          • QBColumns
          • QBCondition
          • QBFunction
          • QBFunctions
          • QBGroupBy
          • QBJoin
          • QBJoins
          • QBLogicalCondition
          • QBParameter
          • QBParameters
          • QBPart
          • QBResult
          • QBSearchedCaseExpression
          • QBSelect
          • QBSort
          • QBSorts
          • QBTableClause
          • QBWhereCondition
          • ViewFoundSet
          • ViewRecord
        • Events Manager
          • EVENTS_AGGREGATION_TYPES
          • EventType
        • Menus
          • JSMenu
          • JSMenuItem
        • JSMenuDatasource
        • Utils
        • Client Utils
          • JSBlobLoaderBuilder
        • History
        • Security
        • i18n
        • ServoyException
          • DataException
        • JSUnit
        • Datasources
          • DBDataSource
          • DBDataSourceServer
          • JSConnectionDefinition
          • JSDataSource
          • MemDataSource
          • MenuDataSource
          • SPDataSource
          • SPDataSourceServer
          • ViewDataSource
        • JSViewDatasource
        • servoyDeveloper
        • enum
    • Extensions
      • UI Components
        • Buttons and Text
          • Badge
          • Button
          • Data Label
          • Drop Down
          • Image
          • Label
        • Form Containers
          • Accordion Panel
          • Collapse
          • Default Loading Indicator
          • Error Bean
          • Form Component Container
          • Form Container
          • List Form Component
          • Portal
          • Responsive Container
          • Servoy Default Navigator
          • Slider
          • Split Pane
          • TabPanel
        • Grids
          • Data Grid
          • Power Grid
          • Table
        • Input Controls
          • Calendar
          • Calendar Inline
          • Checkbox
          • Choice Group
          • Combobox
          • Floatinglabel Calendar
          • Floatinglabel Combobox
          • Floatinglabel Textarea
          • Floatinglabel Textbox
          • Floatinglabel Type Ahead
          • Group Buttons
          • Html Area
          • Input Group
          • Rating
          • Select2tokenizer
          • Slider
          • Spinner
          • Switch
          • TextArea
          • TextBox
          • TextBox Group
          • Type Ahead
        • Media
          • Carousel
          • Embedded YouTube
          • File upload
          • Image label
          • Lightbox Gallery
          • MultiFile Upload
          • PDF JS Viewer
          • PDF Viewer
        • Mobile
          • Native Data List
          • Native Select
        • Navigation
          • Breadcrumbs
          • Navbar
          • sidenav
        • SmartDocEditor
          • Smart Document Editor
        • Visualization
          • Canvas
          • Chart
          • Custom List
          • DBTreeview
          • Foundset List
          • Fullcalendar
          • Gauge
          • Google Maps
          • Kanban
          • Progress Bar
          • Treeview
      • Server Plugins
        • amortization
          • AmortizationCalculation
          • Polynomial
        • clientmanager
          • Broadcaster
          • JSClientInformation (cm)
        • DataNotifyBroadcaster
        • excelxport
        • file
          • JSFile
          • JSProgressMonitor
        • headlessclient
          • JSClient
        • http
          • Cookie
          • DeleteRequest
          • GetRequest
          • HeadRequest
          • HTTP_STATUS
          • HttpClient
          • HttpClientConfig
          • JSFileUpload
          • OptionsRequest
          • PatchRequest
          • PostRequest
          • PutRequest
          • Response
          • TraceRequest
        • images
          • JSImage
        • jwt
          • Algorithm
          • Builder
          • JWTClaims
        • mail
          • Attachment
          • MailMessage
        • maintenance
          • JSClientInformation
          • JSColumnObject
          • JSServer
          • JSTableObject
        • mobileservice
          • OfflineDataDescription
        • oauth
          • ClientAuthentication
          • CustomApiBuilder
          • OAuthProviders
          • OAuthRequest
          • OAuthResponse
          • OAuthResponseBinary
          • OAuthResponseJSON
          • OAuthResponseText
          • OAuthService
          • OAuthServiceBuilder
          • OAuthTokenExtractors
          • RequestType
        • PDFFormsPlugin
        • pdf_output
        • rawSQL
        • RestWs plugin
        • rest_ws
          • WsContents
          • WsCookie
          • WsRequest
          • WsResponse
        • scheduler
        • serialize
        • textxport
          • DataProviderExport
          • TabExporter
        • udp
          • JSPacket
        • XmlReader
          • XmlNode
      • Browser Plugins
        • Block UI
        • Block UI (ref)
        • Dialogs Plugin
        • Idle
        • Idle (ref)
        • Key Listener
        • Key Listener (ref)
        • NGDesktop File
        • NGDesktop File (ref)
        • NGDesktop UI (ref)
        • NGDesktop Utils (ref)
        • NG Utils (ref)
        • Office Javascript API for Servoy
        • Phonegap
        • Web Notifications (Native)
        • Web Notifications (Toastr)
        • Window Plugin
        • Font Awesome
      • Modules
        • Smart Doc Editor Utils
        • svyAPI
          • Getting Started
        • svyLookup
          • Custom Templates
          • API Documentation
          • svyLookup v1
            • API Documentation v1.0.0
            • Base Form svyLookupTable v1.0.0
            • Base Form AbstractLookup v1.0.0
        • svyLookupExample
        • svyNavigation
          • API Documentation
            • API svyNavigation
            • API svyNavigationHistory
            • API svyNavigationUX
        • svyNavigationUX
        • svyNavigationUXSample
        • svyPopupFilter
          • Simple Filter Pickers
          • Custom Templates
          • API Documentation
            • API svyToolbarFilter
            • API svyPopupFilter
          • API Documentation v1
            • API svyToolbarFilter v1
            • API svyPopupFilter v1
        • svyProperties
        • svySearch
        • svySecurity
          • Overview
          • Token-based Auth and SSO (NEW!)
          • API Documentation
          • Getting Started
          • Tenant replication
          • Security Management Console
            • Classic Security Management Console
          • svySecurityUX
          • svyProperties
          • API Doc svyProperties
        • svySecurityConsole
        • svySecurityUX
        • svyUtils
          • Log Manager
          • Log Manager Appenders
          • Smart Doc Editor Utils
          • Custom Dialogs
          • Excel Utils
          • Full API Reference
          • Crypto Utils
        • svyUtils$Excel
        • svyUtils$NGClient
        • svyUtils$customDialogs
        • svyUtils$logManagerAppenders
        • svyUtils$tableGrid
      • Layout
        • Boostrap 12grid layout
          • Collapsible Container
          • Simple Collapsible
          • Center Container
          • Inline Group Container
          • Flexbox Layout
      • Solutions
        • Sample Application
          • Tutorial Part 1
          • Tutorial Part 2
      • Packages
        • UI Component Packages
          • Advanced Renderers
          • Bootstrap Components
          • Bootstrap Extra Components
          • Canvas
          • Chart JS
          • Fullcalendar Component
          • googlemaps
          • kanban
          • Servoy Core
          • Servoy Extra Components
          • Servoy NG-Grids
          • Servoy PDF Viewer
          • smartDocumentEditor
        • Browser Plugin Packages
          • Block UI
          • Core NG only Services
          • Key Listener
          • NGDesktop File
          • NGDesktop UI
          • NGDesktop Utils
          • Web Notifications
          • Idle Web Service
    • Servoy Developer
      • Menu
        • File
        • Edit
        • Source
        • Refactor
        • Navigate
        • Search
        • Project
        • Actions
        • Run
        • Window
        • Help
      • Toolbar
      • Solution Explorer
        • Resources
          • Database Servers
            • Database Server
              • Procedures
              • Tables
              • Views
          • Security
          • i18n
        • All Solutions
          • Solution
          • Active Solution
            • Scopes
              • Scope
                • Variables
            • Forms
              • Working Set
              • Form
                • Controller
                • Variables
                • Elements
                • Relations
            • Form Components
              • Form Component
            • Relations
              • Relation
            • ValueLists
              • ValueList
            • Menus
              • Menu
                • MenuItem
            • Media
              • Folder
              • File
            • DataSources
              • In Memory DataSources
                • In Memory DataSource
              • View Foundsets DataSources
                • View Foundset DataSources
            • Servoy Packages
              • Package
            • Modules
              • Module
        • Solution Explorer Contextual List
      • Views
        • Command Console
        • Console
        • Problems
        • Tasks
        • Bookmarks
        • Search
        • Form Hierarchy
        • Help
        • JUnit
        • Outline
        • Profiler
        • Properties
        • Project Explorer
        • Call Hierarchy
      • Editors and Wizards
        • Property configurator for columns
        • Relation Editor
        • Text Format Editor
        • Date Format Editor
        • Number Format Editor
        • Database Synchronization Wizard
        • Security Editor
        • SQL Editor
        • i18n Editor
        • File Import Wizard
        • File Export Wizard
        • WAR Export Wizard
        • NGDesktop Export Wizard
        • Table Editor
        • Metadata Synchronization Wizard
        • Database Server Connection Editor
        • Text Property Editor
        • Valuelist Editor
        • Form Editor
          • Parts of the Form Editor
          • Designing a Form
          • Layout Tools
          • Using Containers
          • Creating and Using Forms
          • Using Servoy Beans
          • Using Shapes
          • Form Editor Subtabs
          • [Tips and Shortcuts][reference/servoy-developer/object-editors/form-editor-tips_and_shortcuts.md]
          • Editong a Responsive LayoutForm
          • CSS Positioning
        • Form Hierarchy
        • Component Properties Editor
        • Variable Editor
        • Method Selection Wizard
        • New Solution Wizard
        • Application Event Types Editor
        • New Form Wizard
        • Form Dataproviders Configurator
        • Servoy Resource Locator
        • Datasource Selection Wizard
        • Sorting Fields Wizard
        • Scripting Editor
          • Getting Started-Overview of Script Editor
          • Code Writing Features
          • Code Navigation
          • Code Rewriting Tools
          • Refactoring
          • Code Formatting
          • Script Editor Tips and Shortcuts
          • Unit Tests
        • Theme Editor
          • General Properties
          • Sidenav Properties
          • Navbar Properties
          • Tabs Properties
          • Windows Properties
          • Dialogs Properties
          • Tables Properties
          • Breadcrumb specific style Properties
          • Brand colors Properties
          • Validations Properties
          • Margins and Padding Properties
        • Editor Selection
        • Run Configurations
        • Debug Configurations
        • Externalize Strings Wizard
        • Font Chooser Wizard
        • Color Chooser Wizard
        • Project Properties Configurator
        • Move Wizard
        • External Tools Configurations
        • About Servoy Developer
        • Servoy Developer Installation Details
        • Eclipse Marketplace Wizard
        • Install Available Software Wizard
        • Cheat Sheet Selection Wizard
        • Servoy Developer Help Wizard
        • Switch to Editor Wizard
        • Find Actions Wizard
        • Customize Perspective Configurator
        • Quick Search Wizard
        • Search Wizard
        • Encoding Wizard
        • Task Wizard
        • Find - Replace Wizard
        • Properties Editor
        • New Project Wizard
        • New Method Wizard
        • New Menu Wizard
          • New MenuItem Wizard
        • Menu Editor
        • ServoyMenu Selection Wizard
        • JSMenu compatible component selector
        • Permissions Configuration Dialog
      • Project File Structure
        • Servoy Installation Directory
          • servoy.properties
        • Workspace Folder
          • Resources Directory
            • Database Information (.dbi) Files
          • Solution Folder
      • Package Manager
      • Preferences
      • Property Types for components / services
      • Debugger
        • Debug Explorer
        • Breakpoints
          • Breakpoint Properties
        • Variables
        • Expressions
        • Interactive Console
    • Application Server
    • Servoy Cloud
      • Cloud Control Center
        • Home
          • Setup Namespace
          • User profile
            • My Profile
            • Support
        • Download IDE
        • Application Overview
          • Applications
            • Pipelines
              • Jobs
                • Packages
                  • Commits
                  • Artifacts
                  • Configuration
                  • Quality reports
                  • Build markers
                • Job Configuration
                  • Build and Deploy or Build
                  • Mobile
                  • Desktop
            • Environments
              • Metrics
                • Users
                • Databases
                  • Metrics
                • System Health
                • Log Activity
                • App performance
                • Query performance
              • Cloud reporting
            • Security
              • Permissions
              • Tenants
            • Reports
            • Security Login Designer
              • Single Sign-On
                • Sign in with Google
                • Sign in with Microsoft
          • Code Repositories
        • Project Management
          • Tickets
          • Backlog
          • Active Sprints
        • User Management
          • Users
          • Roles
        • Administration
          • Security
            • ServoyCloud Roles
          • Credentials
          • Settings
        • Add-Ons
      • Database Backup
      • E2E Cypress Testing
        • Using Cypress
      • On-Premise Deployment
      • Privacy policy (ServoyAI)
      • FAQ
      • Migrate to Servoy Cloud
    • Extensions Developement
      • Component and Services
        • Component Development
        • Service Development
        • Tools and Dev Tips to use for Component/Service developement
        • Manifest (.mf file)
        • Specification (.spec file)
          • Property Types
            • Array property types
            • Custom object property types
            • Findmode property type
            • Foundset property type
            • Tags
        • Directives And Filters
          • Sablotabsequence
        • Console (serverside)
        • ServoyApi (serverside)
      • Serverside Plugins
        • Data Convertors and Validators
        • UI Convertors
  • Release notes
    • Release notes
      • 2025.06
      • 2024.03 (LTS)
      • 2023.03 (LTS)
      • 2025.03 (Servoy Cloud)
      • 2025.03
      • 2024.12
      • 2024.12 (Servoy Cloud)
      • 2024.09
      • 2024.09 (Servoy Cloud)
      • 2024.06
      • 2024.06 (Servoy Cloud)
      • 2024.03 (Servoy Cloud)
      • 2023.12
      • 2023.12 (Servoy Cloud)
      • 2023.09
      • 2023.09 (Servoy Cloud)
      • 2023.06
      • 2022.03 (LTS)
      • 2022.12 What's new
      • 2022.12
      • 2022.09 What's new
      • 2022.09
      • 2022.06 What's new
      • 2022.06
      • 2021.03.3 (LTS)
Powered by GitBook
On this page
  • Overview
  • Security
  • servoy.clientTrustDataAsHtml
  • Locale
  • locale.default
  • locale.numberformat
  • locale.integerformat
  • locale.dateformat
  • servoy.use.client.timezone
  • Internationalization (i18n)
  • defaultMessagesServer
  • defaultMessagesTable
  • NG Client
  • servoy.ngclient.testingMode
  • servoy.ngclient.enableWebResourceOptimizer
  • sablo.websocket.origin.check
  • sablo.window.timeout.secs
  • servoy.context.path
  • servoy.webclient.error.page
  • servoy.webclient.pageexpired.page
  • servoy.webclient.pageexpired.url
  • servoy.webclient.pageexpired.redirectTimeout
  • servoy.webclient.maxuploadsize
  • servoy.ng_web_client.tempfile.threshold
  • servoy.ng_web_client.temp.uploadir
  • Content Security Policy (CSP)
  • servoy.ngclient.setContentSecurityPolicyHeader`
  • servoy.ngclient.contentSecurityPolicy.frame-src
  • servoy.ngclient.contentSecurityPolicy.frame-ancestors
  • servoy.ngclient.contentSecurityPolicy.font-src
  • servoy.ngclient.contentSecurityPolicy.img-src
  • servoy.ngclient.contentSecurityPolicy.style-src
  • servoy.ngclient.contentSecurityPolicy.form-action
  • Performance
  • servoy.objectPoolSize
  • servoy.disableDataChangeNotify
  • servoy.record.lock.lockInDB
  • Branding
  • servoy.branding`
  • servoy.branding.windowtitle
  • Admin
  • servoy.application_server.allowClientRepositoryAccess
  • servoy.log.clientstats
  • servoy.admin_email_address
  • servoy.admin.clients.pageSize
  • ServerManager.databasesequence.maxlength
  • system.properties
  • user.properties
  • Log
  • servoy.client.report.max.valuelist.items
  • servoy.print.js.stacktrace
  • Solution Settings
  • servoy.allowSolutionBrowsing
  • Foundset loading and saving tuning
  • servoy.foundset.pkChunkSize
  • servoy.foundset.chunkSize
  • servoy.foundset.initialRelatedChunkSize
  • servoy.foundset.statementBatching
  • servoy.foundset.loadRelatedRecordsIfParentIsNew
  • Miscellaneous
  • servoy.client.equals.decimal.precision
  • servoy.ignore.invalid.server.on.import
  • servoy.execute.column.validators.only.on.validate_and_save
  • servoy.less.compiler
  • servoy.developer.slowproperties.workaround
  • servoy.developer.showStartPage
  • server.inMemory.collation
  • servoy.askBigMetadataTableWarning
  • servoy.max.webforms.loaded
  • servoy.client.query.convert.lenient
  • servoy.legacy.deeplinks
  • servoy.client.relatedNullSearchAddPkCondition

Was this helpful?

  1. GUIDES
  2. Deploy
  3. Server Configuration

Server Settings

PreviousServer ConfigurationNextServer Plugins

Last updated 3 months ago

Was this helpful?

Overview

The Servoy Settings section shows all the editable Servoy Settings, grouped per area. Each setting has an info button that can be clicked for info about the setting.

Restart required after editing settings After editing one of more settings, the changes need to be explicitly saved using the Save button at the bottom of the page. In order for the changes to take effect, a restart of the Servoy Application Server is required.

Security

Security setting:

servoy.clientTrustDataAsHtml

default: false It can be acceseed on the Security settings section of the admin page. This is a global setting for the Servoy Application Server to enable or disable sanitizing of data from a dataProvider when shown in elements.

When set to false (default) Servoy will protect against XSS attacks by sanitizing data before shown. When set to true, sanitizing of data displayed in elements will be disabled for this application server (makes vulnerable to XSS attacks). Setting this to true is highly discouraged, your system may be vulnerable to XSS attacks. Sanitizing of data can be turned off and on at solution or element level as well, see .

Locale

The Locale Settings are the default values for each started Servoy Client.

If specified on the Admin Page, they override the Locale Settings of the user environment. Within a Solution the developer can choose to override Locale settings programmatically.

Locale settings:

locale.default

The default locale, only used for WebClient or HeadlessClient, NGClient always gets the locale from the browser.

It should be a language code and a country code separated by a comma. Example: en,US

locale.numberformat

The default number format. This format will be applied to all number fields, that do not have the format set at the field or table level. Example: #.## Legend: # will be any valid number: 0-9 . is the decimal separator , is the grouping separator

locale.integerformat

The default integer format. This format will be applied to all integer fields, that do not have the format set at the field or table level. Example: #,###.00 Legend: # will be any valid number: 0-9 . is the decimal separator , is the grouping separator

locale.dateformat

The default date format. This format will be applied to all date fields, that do not have the format set at the field or table level. Example: dd-MM-yyyy

servoy.use.client.timezone

This property is ignored for NGClient solutions, use the format property (Use local time) per field to dictated if the timezone should be used in client or not. When true the clients timezone will be used to convert to the server/database timezone, it is recommended to use true as default to always see the correct/same dates/times in all clients (regardless of their timezone), but this means that dates are then not converted to the different timezones of clients (10:00 is always 10:00).

Internationalization (i18n)

Locale settings:

defaultMessagesServer

The server which contains i18n messages

defaultMessagesTable

The table which contains i18n messages

NG Client

The following settings are applicable to NG Client:

servoy.ngclient.testingMode

Testing support property for generating the data-svy-name attribute on forms and form elements. default: false

servoy.ngclient.enableWebResourceOptimizer

Enable grouping of resource files, like js and css, to reduce the number of page requests. default: true

sablo.websocket.origin.check

Comma separated list of allowed origins for websocket requests, <Host> for checking against host header (default) or <None> disabling the check.

sablo.window.timeout.secs

The number of seconds after which a disconnected client will be cleaned up. Within this time a client can be reconnected. Default 60.

servoy.context.path

Context path of your NGClient url. Default will be request.getContextPath(). If using a proxy you may need to configure this. For example if you map through reverse proxy on root a WAR that is deployed on tomcat on a context. Then the context path should be overwritten with / (the root). Better is to also deploy it on tomcat as the ROOT.WAR

servoy.webclient.error.page

Filename of an html template (no <html> and <body> tags) which will be shown when an error occurs. It resides in ROOT (application_server/server/webapps) for the NG Client.

NG Client error page example:

<div style='padding:40px;' ng-controller="InternalServerErrorController">
    <div class="bs-callout bs-callout-danger" >
    <h1>Internal Server error </h1>
    <p>There was an error at the server side</p>
    <pre ng-if='error.stack' ng-bind='error.stack'></pre>
    </div>
</div>

servoy.webclient.pageexpired.page

Filename of an html template (no <html> and <body> tags) which will be shown when the session times out. It resides in ROOT (application_server/server/webapps) for the NG Client.

NG Client page expired example:

<div style='padding:40px;' ng-controller="SessionExpiredController">
    <div class="bs-callout bs-callout-danger" >
    <h1>Page Expired</h1>
    <p>The page you requested has expired.</p>
    <p><a ng-href="{{redirectUrl}}">Return to home page</a></p>
    </div>
</div>

servoy.webclient.pageexpired.url

The URL which should be used or redirected to when the session expires.

servoy.webclient.pageexpired.redirectTimeout

The number of seconds a redirect should happen, -1 or null means no redirect, 0 immediate redirect, >0 x seconds wait before auto redirect.

servoy.webclient.maxuploadsize

Sets the maximum upload size, in kilobytes, that a user can do through the upload/media field. 0 or not set is no maximum, used be NG, Web and RestWS uploads.

servoy.ng_web_client.tempfile.threshold

Sets the threshold in kilobytes, when a temp file on disk should be made when a file is being uploaded for NG Client or RestWS plugin(default is 50K).

servoy.ng_web_client.temp.uploadir

Sets the upload dir that the file upload will use to store temp files when the upload size threshold is reached. It is recommended to set this to a file system where you also want to store the actual uploaded file, so that you can use JSFile.renameTo(). Rename only works within the same file system (so in windows C: to C: not C: to D:), the default value is the 'java.io.tmpdir' system property.

Content Security Policy (CSP)

For the NGClient we have on the admin page a number of properties that configures the CSP headers we set when a NGClient is launched.

You can disable it fully with the boolean property, but this should be avoided:

servoy.ngclient.setContentSecurityPolicyHeader`

Set the Content-Security-Policy header to mitigate certain types of attacks, including Cross Site Scripting (XSS) and data injection attacks. default: true

The other properties:

servoy.ngclient.contentSecurityPolicy.frame-src

frame-src Content-Security-Policy directive, default: * data:

servoy.ngclient.contentSecurityPolicy.frame-ancestors

frame-ancestors Content-Security-Policy directive, default: 'self'

servoy.ngclient.contentSecurityPolicy.font-src

font-src Content-Security-Policy directive, default: * data:

servoy.ngclient.contentSecurityPolicy.img-src

img-src Content-Security-Policy directive, default: * data: blob:

servoy.ngclient.contentSecurityPolicy.style-src

style-src Content-Security-Policy directive, default: * 'unsafe-inline'

servoy.ngclient.contentSecurityPolicy.form-action

form-action Content-Security-Policy directive, default: 'self'

Servoy has defaults (see the info buttons on the admin page) so that the basic NGClient deployment works where most of the stuff are all coming from the same host "self".

All scripts/links have a nonce which is also specified in the CSP header to allow all the scripts that Servoy generates from the web packages in the index.html (main solution index).

In NGClient1 we still allowed "eval" to happen, this is not allowed anymore for NGClient2, because of this you can't push functions as string to the client and eval it to get a function, if a component needs a property like that the property type needs to be "clientfunction" instead of "string" or "tagstring".

This way NGClient2 will generate a script from that on the server and that will be loaded as a normal js file.

Performance

The Performance Settings provides options to specify memory settings for Servoy Clients.

Performance settings:

servoy.objectPoolSize

Greater than 0 will enable object pooling on server for non mutable objects. default: 50000

servoy.disableDataChangeNotify

Disables all client data notifications (inserts, updates, deletes). Should be used for performance testing only! default: false

servoy.record.lock.lockInDB

When locks are acquired within a database transaction, also try to get an update lock for the records in the database. default: false

Branding

The Servoy Admin page exposes several Branding settings on it's main page. By enabling Branding support by setting the servoy.branding setting to true and providing custom values for the other properties, the first part of the user experience can be customized.

Branding settings:

servoy.branding`

Enable branding support default: false

servoy.branding.windowtitle

Application title shown in NG client

Admin

The Admin Settings offer options to set several groups of properties, as well as the email address of the Servoy Application Server administrator.

Admin settings:

servoy.application_server.allowClientRepositoryAccess

Allow solution code to access the repository server. When turned off, soloutions using tables in the repository_server may receive error: You do not have access to view this data. default: false

servoy.log.clientstats

Allow logging of client connection/disconnection statistics. The client stats table is situated in log server (so log server should be defined if this option is enabled). default: true

servoy.admin_email_address

The email address to use for notifies about license usage, make sure the mail (server plugin) properties are set as well to enable mail to be sent.

servoy.admin.clients.pageSize

This setting controls the maximum number of clients per solution displayed initially on the clients page. If not set or <0, it displays all clients.

ServerManager.databasesequence.maxlength

With this setting you can enlarge the maximum allowed length of the database sequence text value to a max of 200, instead of the default 50, the repository has to be created with a Servoy 8.2 install to support this. Check your database what max text length it does support for the sequences!

system.properties

user.properties

User properties to be passed to the clients. Example: user.UserProp=userPropValue

Log

Log settings:

servoy.client.report.max.valuelist.items

Do not report cases when not all records are loaded into the valuelist, i.e. when there are more than 500 records. default: true

servoy.print.js.stacktrace

Print javascript stacktrace in Servoy log. default: true

Solution Settings

The Solution Settings are global settings that affect all solutions hosted on the Servoy Application Server.

servoy.allowSolutionBrowsing

Enable/Disable solution browsing; if disabled (false), it's only possible to open solution by deep-linking URLs. default: enabled (true)

Foundset loading and saving tuning

Servoy loads a foundset by first retrieving the PKs from the database. This retrieval is done in chunks: when the foundset is initialized, the first chunk is retrieved, consecutive chunks are retrieved when needed.

The actual record data is also retrieved from the database in chunks.

The size of the different chunks are controlled by 3 properties that can be set in the servoy.properties:

servoy.foundset.pkChunkSize

Chunk size for foundset PK retrieval default: 200

servoy.foundset.chunkSize

Chunk size for record data retrieval default: 30

servoy.foundset.initialRelatedChunkSize

Chunk size for related record retrieval For the initial load of related records both the PK's and data are retrieved in one query default: 2 *servoy.foundset.chunkSize

servoy.foundset.statementBatching

(since 2020.12) This only works for inserts of records that are after each other (without another record from another datasource in between). It does now have side effects:

  • In statementBatching if you insert 10 records of the same datasource, that is now always then also in a transaction (not depending if you started a transaction) because it goes into the same (single) batch statement.

  • Because its now a transaction and a single statement to the db server, no matter if you are your self already in a transaction or we do it automatically now, if something goes wrong in 1 of the records, all records are failed, because databases don't tell us which one really failed, we would know this previously, and nothing is inserted

  • That nothing inserted was already the case in transaction mode, but this is with this property to true different in none transaction mode, which did do the inserts until the failure and now it fails the same as in transaction mode. default: false

servoy.foundset.loadRelatedRecordsIfParentIsNew

(since 2020.12) By default Servoy will not query for related records if the relation is a pk → fk relation. So if the relation has on the primary side at least all the primary keys specified. Because this scenario should already not be possible in a good designed database (if there is a fk→pk constraint specified on the child table). Child records should not already exist if there is no Parent record already. So Servoy does not ask the database for data in this scenario. Related lookups on not yet saved Parent records should only be used to make related records, not to expect to get data. By setting this property to "true" you can force Servoy to query for data even for such scenario's default: false

The values can be modified in an attempt to increase performance. The optimal values differ per application, thus no guidelines are available for alternative values. Tuning needs to be done by altering the values and monitoring the performance afterwards. The defaults are set based on averages.

Miscellaneous

servoy.client.equals.decimal.precision

Equals precision comparison for numbers. Default value is 7.

servoy.ignore.invalid.server.on.import

Import solution continues even if a server is invalid (no changes can be done to it). Default value is false.

servoy.execute.column.validators.only.on.validate_and_save

servoy.less.compiler

Less compiler to use. Can have values jlessc or lessjs. Default value is jlessc.

servoy.developer.slowproperties.workaround

Slow Properties View selection workaround for MacOS. Default value is true for Mac, false for other systems.

servoy.developer.showStartPage

Show start page in Servoy Developer. Default value is true.

server.inMemory.collation

Collation for in memory server. Default value is null.

servoy.askBigMetadataTableWarning

Show big table (lots of rows) warning in Servoy Developer. Default value is true.

servoy.max.webforms.loaded

The total maximum number of forms to be loaded in memory. Default value is 128. If this number is exceeding loaded forms will begin to be destroyed for new forms to be created.

servoy.client.query.convert.lenient

When cannot convert a column to a Servoy type let JDBC driver do the conversion (do not fail). Default value is false.

servoy.legacy.deeplinks

Whether you can use a method deeplink without @deeplink annotation (legacy behavior). Default value is false.

servoy.client.relatedNullSearchAddPkCondition

Same meaning as UICONSTANTS.RELATED_NULL_SEARCH_ADD_PK_CONDITION. Default value is true. The UI Property value has higher priority than the setting.

The Internationalization Settings provide the option to set a default Server and Table where i18n keys are stored. These default settings can be overwritten per solution. For more information on Internationalization, see .

For more information on CSP visit: .

Are there if you want to run the ngclient withing an (frame-src, frame-ancestors) or want to relax certain behaviors even more for loading if styles/fonts/images.

Servoy only enables this for when we detect a browser that can handle CSP level 3, because we need for scripts/css the "strict-dynamic" property: .

System properties for the application server (these will also be passed to the clients as properties). Example: system.property.servoy.usejaas=true For more info please refer to the

Determines whether new onValidate event should be used or old column validators. See for more information. Default value true.

Security: Cross-site Scripting (XSS)
Internationalization - I18N
Content Security Policy (CSP) - HTTP | MDN (mozilla.org)
iframe
strict-dynamic Explained (content-security-policy.com)
Apache Tomcat Documentation
Validation