No Results
Configuration Properties

Various properties can be specified inside the local.properties or custom.properties configuration files, which are located in the conf folder of the edgeCore installation.
The properties that you set in the configuration file will be loaded after system/command-line properties and before defaults.

 

Properties Default Value Description
expressions.info.CredentialAccess
true Used to disable the info.login.password expression when:

info.login.password=false

metrics.trackClientActivity
false Used to enable tracking of client activity
userprefs.storeOnServer
false Used to specify whether visualization state persistence settings will be stored on the server
server.session.timeout
60 minutes Used to configure the default session timeout
client.session.maxtimeout
9999 Used to configure the maximum session timeout in minutes
server.session.singlePerUser
false Used to limit one session per user when set to true; As a result, a new login will expire any other active session by that user.
instance.clusterName
Used to set the cluster name;

If the cluster name is set in local.properties, it’ll be displayed in the UI as the default value, which you can overwrite.

autoLoad.ccUrl
autoLoad.ccApikey
autoLoad.configId
Used to configure the following:
– Command Center host
– API key
– Configuration identification
Once those are specified, edgeCore will load its configuration from the Command Center on the initial server start.
autoStore.ccUrl
autoStore.ccApikey
autoStore.configId
Used to set up server configuration changes to be detected and automatically pushed to the Command Center
data.feed.type.job-status.property.poll.defaultValue 30 (seconds) Used to configure the polling period of the feed
pipeline.node.health.update
*/30 * * * * * Used to configure when the node status data that is used for the pipeline icon is cached and updated
secvars.persistUserCredentials
true Used to configure edgeCore to prevent the storage of user-scoped credentials, whether they are user-entered or configured by the administrative user.

When set to false, user-scoped credentials are not persisted in the edgeCore database, and will only be valid for the duration of user sessions.

client.showPageSearch
false Used to configure a search field, which can be used to search for pages in the system
account.emsAuthEnabled

 

true Used to enable or disable JWT token-based authentication
http.admin.address
http.admin.port

 

Used to restrict admin access to a particular HTTP endpoint;

To configure this, you also need to edit
[INSTALL_HOME]/tomcat/conf/server.xml and uncomment the additional Connector element.

edge.cli.local.user
Used to allow running the edge-cli application without having to pass in credentials as arguments;

Format: edge.cli.local.user=user@domain

Note that most edge-cli commands require the user to have admin-level permissions;

db.cache.poolmax
20 Used to configure the maximum number of connections to cache
ssl.permissive

 

false Used to configure whether edgeWeb and edgeData https connections should perform certificate validation.
ssl.trustStorePass
Used to update the Trust Store password (provided you have set this password)
ssl.mergeTomcatCertIntoTruststore

 

true Used to disable the merge of Tomcat Certificate into Truststore.

This is used to resolve an error reported during startup in cases where the merge fails.

db.cache.url
db.cache.username
db.cache.password
db.cache.driver
db.cache.dialect
Used to set up a cache database
db.auth.url
db.auth.username
db.auth.password
db.auth.driver
db.auth.dialect
Used to set up an authentication database
account.defaultSuffix
default Used to set up a default domain so that can log in without specifying the domain in the username field

Example:  account.defaultSuffix=desireddomainname

edgeWeb.socketTimeout
45000 Used to set up a socket timeout (in milliseconds); This affects only web content and data connection tests while configuring the pipeline;

The response headers must be received within this time for the connection test to succeed.

comm.websocket.receiveBufferSize
2048 Used to set up a value that specifies the size (in kilobytes) of the receive buffer of the socket
edgeWeb.connectionTestRequestTimeout
15000 Used to configure the time (in milliseconds) allowed for connection tests and feed validation
edgeWeb.connectTimeout
10000 Used to configure the maximum time (in milliseconds) to wait for an initial response from the server when attempting to establish an HTTP connection.

Affects all web content and data requests.

data.jobTimeout
120 seconds Used to configure the timeout for data jobs
account.customAuths
customAuth.js Used to register the custom Auths (provided the system is configured to have customAuth.js)

Example:

account.customAuths=customAuth.js

Note:
account.customAuths=customAuth.js
by default so you only need to add customAuth.js for it to run by default.

If you have multiple authentication flows, you may need to have:

account.customAuths=customAuthSAML.js
account.customAuths=customAuthOCSP.js
account.customAuths=customAuthToken.js

db.default.id

db.auth.id

db.config.id

db.cache.id
Used to configure a multi-tenant database
client.favoritesIcon
heart When bookmarking/setting favorite pages, this property is used to override the default heart icon with either a star or a bookmark icon:

client.favoritesIcon=star
or
client.favoritesIcon=bookmark

client.allowFavorites
true Used to disable bookmarking/favorites when set to false:

client.allowFavorites=false

client.autoCreateNewPage
true Used to disable the automatic creation of pages when set to false:

client.autoCreateNewPage=false

client.expandableAdminbar
true Used to disable the automatic expansion of the Admin menu when set to false:

client.expandableAdminbar=false

db.default.poolSize

db.auth.poolSize

db.cache.poolSize

db.config.poolSize
20 Used to configure the Auth, Cache, and Config Database connection pool size
edgeWeb.allowDoubleSlash

edgeWeb.allowEncodedSlash
false If you have some ill-formed web content to be proxied, you can accept the restricted URLs by setting these properties to true:

edgeWeb.allowDoubleSlash=true

edgeWeb.allowEncodedSlash=true

edgeweb.ws.clientTimeout
Used to configure the WebSocket proxy connection timeout in milliseconds
edgeweb.ws.binaryBufferSize
Used to configure the binary buffer size
client.breadcrumbSize
Used to configure the breadcrumb bar size; By doing so, the following will be reduced:

– the padding in the breadcrumb bar
– font size and icon sizes
– the size of the page picker on Manage Pages

The breadcrumb bar size can be: 1, 2, 3, or 4;  1 and 2 are most compact, whereas 3 and 4 are normal.

client.bannerSize
Used to configure the banner size; By doing so, the following will be reduced:

– the padding in the banner
– font size and icon sizes
– the size of the product icon
– the padding inside the menu items

The banner size can be: 1, 2, 3, or 4;  1 and 2 are most compact, whereas 3 and 4 are normal.

client.vis.headerSize
Used to configure the visualization header size; By doing so, the following will be reduced:

– the padding in the header
– font size and icon sizes
– the size of the switch visualization dropdown when enabled

The banner size can be: 1, 2, 3, or 4;  1 and 2 are most compact, whereas 3 and 4 are normal.

client.datapreview.limit
2000 rows Used to configure the server to limit the dataset previews in pipeline nodes;

If the dataset has more than 2000 (or configured limit) rows, the server will limit it and add a button to the preview table to retrieve all if wanted.

accountService.disableEmbeddedAuth
Used to disable the embedded account authentication flow when set to true. After setting this property to true, restart edgeCore.
db.auth.pageview.rollover
7 days Used to track page visit metrics for a set number of days
autoImport.restoreUsers
autoImport.archiveName
true

AUTOIMPORT.zip

Provides auto-load archive support used to initialize a clean system. The archive needs to be placed in the exports folder of the unzipped edgeCore build. The first line allows you to specify whether or not the backup you have set up to auto-load will have any users restored as part of the process.

The second line allows you to specify the naming convention for your auto-loaded archive. Prior to 4.3.6, only a single .zip file was supported.

As of 4.3.6, autoImport.archiveName supports a comma-separated list. You can use files or folders as sources. The imports are processed in order, honoring the choice of whether users should be loaded for all files.


Terms | Privacy