core/common/ApplicationOptions.ts
Optional brandingCssVars |
Type : BrandingCssVars
|
Object with properties that will be converted to CSS custom variables. |
Optional brandingUrl |
Type : string
|
URL to *.css file which will replace default branding. |
Optional breadcrumbs |
Type : boolean
|
Enable or disable breadcrumbs in the header for groups and devices (default: false). |
Optional companyName |
Type : string
|
Name of company handling support requests from app users (displayed in notification message). |
Optional contentSecurityPolicy |
Type : string
|
CSP string to be applied to |
Optional contextHelp |
Type : boolean | string
|
Allows to enable or disable context help. By default the context help uses the base URL defined in the "docsBaseUrl" option, if this option is not defined the following will be used as the base URL: https://www.cumulocity.com/guides. The base URL can also be passed to this option to override the previously mentioned values. |
contextPath |
Type : string
|
Application context path (saved to the server). |
Optional cookieBanner |
Type : CookieBannerConfiguration
|
Cookie Banner configuration |
Optional cookiePreferences |
Type : CookiePreferencesConfiguration
|
Cookie preferences configuration. Here you can enable or disable cookie categories |
Optional copy |
Type : []
|
Additional assets to copy to the build output. See https://github.com/webpack-contrib/copy-webpack-plugin for more information about the patterns to add here. |
Optional disableOnlyRootsQuery |
Type : boolean
|
By default, cockpit and devicemanagement use the onlyRoots query to resolve root nodes. This could lead to performance issues, if a customer has a lot of root nodes. Therefore you can disable the use of this query with this flag. |
Optional docs |
Type : Docs
|
Documentation links settings. |
Optional docsBaseUrl |
Type : string
|
Base URL for documentation links. |
Optional dynamicOptionsUrl |
Type : string
|
URL to dynamically fetched options. |
Optional entryModule |
Type : string
|
Entry module for Angular compiler (only used with lazy loaded routes), e.g. |
Optional exports |
Type : PluginsExports[]
|
NgModule export for plugins. |
Optional extraCssUrls |
Type : string[]
|
Array of URLs to additional *.css files to be loaded at runtime. |
Optional faviconUrl |
Type : string
|
URL to favicon. |
Optional forceSetup |
Type : boolean
|
Allows to force showing the setup wizard. |
Optional gainsightKey |
Type : string
|
A key for the product experience software Gainsight. |
Optional globalTitle |
Type : string
|
HTML page title. |
Optional guideHrefTemplate |
Type : string
|
URL template for documentation links (default: |
Optional hideNavigator |
Type : boolean
|
Collapse navigator on initial load. |
Optional hidePowered |
Type : boolean
|
Hide "powered by" and version info at the bottom of the navigator and in the user menu. |
Optional i18nExtra |
Type : I18nExtra
|
Allows for adding custom translations. It is an optional property. Its keys are language codes (https://cumulocity.com/guides/users-guide/getting-started/#a-name-languages-a-available-languages) and its values are objects with key-value pairs, where the key is the original string in English and the value - its translation.
For example you can add the translation of your custom cookie banner configured in the branding settings:
|
Optional icon |
Type : Icon
|
Application icon to be displayed in app switcher and header bar. |
Optional indexTemplate |
Type : string
|
Path to custom index.html (otherwise default one will be used). |
Optional isSetup |
Type : boolean
|
Indicates if the application needs to show the setup wizard. |
key |
Type : string
|
Application key (saved to the server). |
Optional languages |
Type : Languages
|
Allows for adding or overriding languages available in the application. Its keys are language codes and its values are objects with the following properties:
Example:
|
Optional localePath |
Type : string
|
Path to the folder from which *.po files will be loaded. |
Optional loginExtraLink |
Type : LoginExtraLink
|
Additional link to display on login screen. |
Optional mapWidgetHideMaxDeviceOnMapHint |
Type : boolean
|
Allows to hide the hint that there are more devices with geo coordinates then displayed on the map widget and maps in general. |
Optional mapWidgetPageSize |
Type : number
|
Allows to adjust the default pagesize of 100 items of the map widget and maps in general. |
Optional mapWidgetRealtimeDisabled |
Type : boolean
|
Disables realtime updates on the map widget and maps in general. |
name |
Type : string
|
Application name (saved to the server). |
Optional newsletter |
Type : boolean
|
Show or hide a newsletter subscription checkbox in edit user modal. |
Optional noAppSwitcher |
Type : boolean
|
Hide application in app switcher (saved to the server). |
Optional noLogin |
Type : boolean
|
By default a WebSDK app requires the user to be logged in. In case you would like to develop just a static application, that does not require any kind of access to the backend, you can use this flag to disable the login screen. NOTE: not all WebSDK components support this, some might require the user to be logged in and won't work. |
Optional noPlugins |
Type : boolean
|
Allows to opt out of supporting/loading plugins for this application. |
Optional remotes |
Type : RemotePlugins
|
List of imported remote plugins. |
Optional rightDrawer |
Type : boolean
|
Enable or disable the right drawer. |
Optional rootNodeModulesPath |
Type : string
|
Path to the root node_modules dir (useful when working in monorepo setup, e.g. yarn workspaces). |
Optional sensorPhone |
Type : boolean
|
Enables cloud sensor wizard |
Optional source |
Type : string | number | IApplication
|
The package source a application origins from as IApplication or simply the id of the source |
Optional storageLimitationFeatureEnabled |
Type : boolean
|
Enable or disable storage limitation feature. |
Optional supportUrl |
Type : boolean | string
|
URL to support page (set to |
Optional supportUserString |
Type : string
|
Replacement string for |
Optional tabsHorizontal |
Type : boolean
|
Show tabs horizontally or vertically. |
Optional tsConfigPath |
Type : string
|
Path to tsccnfig.json file if TypeScript is used (default: ./tsconfig.json). |
Optional upgrade |
Type : boolean
|
Set to |