Role Settings

Define system and custom app settings

Overview

The role settings are basically JSON map document defining key-value pairs. Each of the keys is recognized either by the system or by any of the system or custom applications deployed in the current application area. This allows the administrators to "control" and change the behaviour of the apps to match their needs. A setting for example may control the Date and time format for specific app or the default currency.

Settings Format

The settings are JSON map document like this:

{
"setting1": "value1",
"setting2": "value2",
"setting3": "value3"
}

System supported settings

There are number of system supported settings, where some of them must be always presented in the settings document - e.g. they are required.

{
"language": "en",
"company": ""
}
‚Äč

Setting name

Setting value

Required

Notes

language

en

yes

defines the language of the UI

company

free value

yes

defines the name of the company used during data sync sessions. Can be empty string.

syncMethod

syncPolicy or erp

no

Specify if the application area is connected to ERP

$devMode

true | false

no

activated developer mode for the role. Must be used only for trusted developer accounts as it disabled the Task security applied via Access Policy in the mobile and backend apps

Every custom application may support other settings, so consult with the supported settings with the documentation of each custom backend or mobile app.