HELP!
Deployment Server Settings
This document lists all the available properties in the deployment server's 'settings.json'.
By default, the deployment server looks for the 'settings.json' file in the 'settings' folder in the server's installation folder. However the settings folder can live in an alternate location by setting the DS_SETTINGS_PATH environment variable.
Settings Properties
| Setting Name | Default | Description |
|---|---|---|
| port | 8100 | The HTTP port that the deployment server listens on |
| secure | true | Specifies whether the deployment server operates SSL. If true then the appropriate SSL certificate files (xr-cert.pem, xr-key.pem and optional ca-cert.pem) should be placed in the '/settings/keys' folder |
| alloworigin | * | This is the value returned in the HTTP "Access-Control-Allow-Origin" header property. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin for more information |
| onlyAllowSameOrigin | true | If true, the HTTP "X-Frame-Options" header property is set to "SAMEORIGIN". See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options for more information |
| contentSecurityPolicy | CSP policy | This is the value returned in the HTTP "Content-Security-Policy" header property. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP for more information. A super relaxed CSP is something like "default-src * 'unsafe-inline' 'unsafe-eval' data: blob:;" |
| tlsRejectUnauthorized | false | If set to true, all internal deployment server HTTPS calls (e.g. XSI & viabl platform calls) will be made with the request rejectUnauthorized property set to true. For more information see https://nodejs.org/api/tls.html#tlscreateserveroptions-secureconnectionlistener |
| defaultSuspendAge | 60 | Maximum age (in minutes) for a workflow (suspended) session. Additionally, this is also the effective timeout of inter-question chat responses. N.B. The xpertrule.suspend timeout takes precedence over this setting, unless the settings "alwaysDefaultSuspendAge" is true |
| alwaysDefaultSuspendAge | false | In the case of an xpertrule.suspend, should the timeout come from the xpertrule call or the "defaultSuspendAge" setting |
| allowBatchTesting | true | Does this deployment server support the "regression testing" functionality of the associated viabl.ai platform |
| logging | true | Are system log entries (and xpertrule.writeLog) stored by the deployment server. These logs are viewed from the deployment server's UI via the "knowledge base Information" dialog |
| norunlogging | false | If set to false, individual run information (start and end notifications) are not written to the output |
| windowsEventLogging | false | Is set to true, all server console output (and xpertrule.writeLog outputs) are also written to the Windows Event Viewer. N.B. This functionality requires the node-windows npm library to be installed |
| maxLogDays | 5 | The maximum age (in days) of log entries (if logging is enabled via the "logging" settings) |
| allowPeriodicSuspend | false | Are periodic KBs allowed to "workflow suspend". If set to true, there is a slight performance hit for periodic runs |
| protectConcurrent | true | Should this deployment server protect against the concurrent execution (via API call only; periodic scheduling is always protected) of individual knowledge bases |
| periodicTickMs | 500 | Specifies the interval (in milliseconds) the periodic scheduler runs at |
| runFromStart | false | For periodic scheduled knowledge bases, at the end of an execution, when should the NEXT execution be performed? If true then the next execution is based on the START time of this execution + interval. If false then the next execution is based on the END time of this execution + interval |
| maxPeriodicTimeMs | 60000 | The timeout (in milliseconds) for a periodic scheduled execution. If the execution time exceeds this timeout, the KB is re-scheduled for when the timeout occurred + KB periodic interval |
| detailedPeriodicLog | true | Add log entries for the successful periodic execution of apps (if set to false, only errors are logged) |
| periodicStartupRangeMs | 1000 | At startup, all periodic apps are evenly spread to have their first runs over this time period (in milliseconds) |
| external_url | localhost | This is the externally referenceable URL used in the creation of BOT portal task links. If a protocol is supplied (e.g. "https://localhost") then this property is used verbatim; however if no protocol is supplied (e.g. "localhost") then the "secure" and "port" properties are used to build the full URL |
| hiddenTabs | [] | An array of tab names to hide from the deployment server UI. Valid tab names are "apps", "bots", "bottest" and "bayes" |
| maximumKBcount | 0 | The maximum number of deployed knowledge bases that this deployment server can host. 0 = no limit |
| testRunDeleteMins | 1440 | The maximum age of a Test-Run deployed Knowledge Base (default = 24 hours). After this age, the deployed knowledge base is removed. If this property is 0, Test-Run knowledge bases are never automatically removed |
| enforceHardSessionExpiry | false | If a session is about to expire, even if there is a task associated with it (e.g. it's a saved session), still delete the session |
| deployAllowedFileTypes | [".png", ".json", etc..] | A whitelist of allowed file types to accept when a knowledge base is uploaded to this deployment server. You might need to extend (or truncate) this list based on additional files that may have been included in the knowledge base resources |
| uploadAllowedFileTypes | [".png", ".jpg", etc..] | A whitelist of allowed file types to accept for the dialog deployment "upload" control |
| upload_maxsz | 1000000 | The default maximum size (in bytes) of files uploaded via the dialog deployment "upload" control |
| upload_totsz | 10000000 | The default maximum size (in bytes) of ALL files uploaded in a single KB via the dialog deployment "upload" control |
| upload_age | 1440 | The default maximum age (in minutes) of files uploaded via the dialog deployment "upload" control |
| remoteDF | "http://editor" | This string specifies the uri link (back) from this deployment server to the viabl.ai platform development environment. This link back is used to authenticate UI login access to this deployment server as well as verifying any viabl.ai test-run / publish / deployments. In general this URI matches the URL used to access the viabl platform from the web browser less the page name (e.g. editor.html) |
| remoteDFuserAgent | null | Optional string value passed in the "User-Agent" header when calling the viabl platform (useful if the viabl platform has WAF rules) e.g. "XpertRule DF" |
| noUserKBfilters | false | If set to true, all (logged in) users can view all deployed applications |
| taskForwardWebhook | null | This property can hold a URL string which is POSTED to when a task is forwarded to another user (from the portal tasks page). The url can either be local (in which case the property is a local path e.g. "/XYZ123") or remote (e.g. "https://mynotify.com"). The body of the POST contains... id (task ID), info (object with full task information), comments (the comments entered into the forward) and users (the user(s) receiving the task) |
| mongoDB | {"uri": "mongodb://127.0.0.1:27017", "dbName": "jeremy_db"} | Connection information for this deployment server's Mongo DB installation and the specific database within that installation. N.B. These property values can be overridden via the DS_MONGODB_URI and DS_MONGODB_DBNAME environment variables |
| assertDBwrites | false | For certain database operations, check that a document has been inserted before trying to modify it. This is useful where there is possible latency (e.g. replicated AWS documentDB) on the database |
| disableLocalDBaccess | false | Should access to the local (system) database be allowed via the xrMongoDB object specifying the system DB {jeremyDB: true} |
| serverSideTimeoutS | 10 | The maximum duration for a server-side procedure (i.e. a Dialog mode KB with server procs) to complete |
| restartPeriodicOnStartup | true | Clear and re-apply triggers for all periodic KBs on deployment server startup (take care if running multiple deployment server's against a single MongoDB database) |
| stopwords | ["a", "about" etc.] | This is the default list of words which are ignored when performing Bayesian (unstructured) training and classification. This list (and all following Bayesian settings) can be over-ridden on a domain by domain basis from the deployment server UI "Domain Settings" |
| splitter | \b[a-z0-9_]+\b | This is the regex used to extract words from text supplied to the Bayesian (unstructured) training and classification |
| minWordLength | 4 | This is shortest word length (in characters) to process in Bayesian (unstructured) training and classification |
| removeNumbers | false | If true, extracted words which consist of purely numeric characters are ignored by the Bayesian (unstructured) training and classification |
| stemming | true | If true, words extracted from Bayesian input text are stemmed before proceeding to the training and classification algorithm. See here https://tartarus.org/martin/PorterStemmer/def.txt for more information on the stemming algorithm |
| logClassifications | true | If true, the statistics are updated for every call to the Bayesian classifier. These statistics can be viewed on a domain by domain basis via the deployment server UI |
| mail_server | null | An object defining the connection setting to an email server (for system notifications). Deployment server uses the nodemail library for sending email and this main_server object is passed verbatim as the configOptions. See https://www.npmjs.com/package/nodemailer for more details |
| notification_from_email | notification@xpertrule.com | This is the "from" address used when sending email notification from the deployment server. See the mail_server property for more details in setting up the email notifications |
| storage | null | An optional configuration object which enables the external (cloud) storage of uploaded files (via either the dialog file upload control or the chat upload question type). See the additional section below for more details |
Storage configuration object
The optional storage configuration object enables the external (cloud) storage of uploaded files (via either the dialog file upload control or the chat upload question type). At time of writing the only supported external cloud storage is Azure blob container storage referenced by using the deployment server "filestore_azure" mode (this requires the @azure/storage-blob npm library to be installed)
Example settings storage opject...
"storage": {
"name": "filestore_azure",
"connection_string": "DefaultEndpointsProtocol=https;AccountName=<storage account name>;AccountKey=<azure key>==;EndpointSuffix=core.windows.net",
"container_name": "test-container"
}