ARES Kudo Server Configuration

The approot folder you need to pass when starting the Kudo server contains wt_config.xml that configures some application settings. For most settings/properties it is recommended to keep the default settings. But some properties can be changed without any risk and you might want to tweak them for your needs. We recommend to backup original wt_config.xml if you plan to make changes, just for the case you need to restore it.

Here is a description of application settings: https://www.webtoolkit.eu/wt/doc/reference/html/overview.html#configuration_sec

We strongly recommend to not change these settings. You might break application. 

Here is a description of application properties:

Profile-storage, server-side-rendering, webgl-rendering, dbhost, generate-pan-images, show-menu 

Obsolete or not use

client-side-cursor

Specifies if cursor is drawn on client side, true by default. Do not change this. It will only slow down UI experience.

editorURL, scriptURL, styleURL, iconURL, qtresourcesURL, resourcesURL, favicon

Editor static resource locations. Be careful if you change this. Resources might not be found anymore

log-events

Some events are logged only if true. It is only used when call editor url with &debug=true

log-trackjs-events

If true, JS errors are logged to trackJS.

saveDwgVersion

Overrides the dwg version the drawing should be saved in on SAVE and autosave. Supported values: 2018/2013/2010/2007/2004/2000/R14/R13/R12

saveFormat

Overrides the format the drawing should be saved in on SAVE and autosave. Supported values: dwg/dxf/dxb

use-deltas

If true, changes are saved as deltas (only differences) instead of full drawing. Default is false. Do not change this as deltas are not fully supported at the moment.

use-3dmouse

If true, editor tries to connect to 3d mouse. If you want to use a 3d mouse, make sure it is set to true. If you don’t have a 3d mouse and it is true, it won’t harm but you will see a 3dconnexion error in console.

delta-snapshot-period

Only used if use-deltas is true. It determines after how many changes a full drawing snapshot is stored.

delta-snapshot-at-exit

Only used if use-deltas is true. It determines if full drawing snapshot is stored on exit.

dwg-snapshot-period

Only used if use-deltas is false. It determines after how many changes the drawing is automatically saved.

dwg-snapshot-min-seconds

Only used if use-deltas is false. It determines how many seconds have to be passed between two save operations.

dwg-snapshot-max-seconds

Only used if use-deltas is false. It determines after how many seconds the drawing is automatically saved also if there are less than dwg-snapshot-period changes

api-timeout

Timeout of API calls to download/upload files. Default is 120 seconds. It determines when API calls are aborted. It is not so relevant if running local API server as this should be always available and fast.

Statsd-logging

If true, timing of some API calls are logged to a statsd server that is specified by statsd-server, statsd-port and statsd-prefix. Nothing will be logged if statsd server is not valid.

origin

This is used to verify if a JS message is accepted. Only messages from this origin are handled.

disableXRefs

Used to disable UI to attach/insert files (e.g. “Attach a file…” for xrefs or “Browse…” for insert commmand) that requires showChooseDialog message event to be handled by iframe’s parent. It is true (disabled) by default. Once your frame can handle the ‘showChooseDialog’ message and provide a file picker, you can enable the UI by setting this option to false.

save-crash-dumps

If true, crash dumps are saved when a crash occurs. You might want to turn it off to save space.
Crash dump location: c:\ProgramData\Xenon\CrashRpt\ (Windows), /var/crash (Linux)

disable-IE-warning-on-load

If false, the Kudo editor will show a message about unsupported browser if you open a drawing with such browser. Unsupported browsers are IE/old Edge and Safari on Windows.

disable-help

By default help command (_HELP) is disabled. Setting this flag to false will enable it. Running the command will then call a pre-defined help url “{API server url}/help/index.htm” where API server url is the url of the API backend passed as “server” query parameter.

mem_limit

Linux server only: memory in bytes that has to be available to allow to open a drawing (MemAvailable from /proc/meminfo is used to check available memory). If the available memory is below this limit, we reject new sessions and end users will see a 503 error. The intention is to keep the server and existing sessions responsive if memory gets low.

rlimit_as

Linux server only: the maximum size in bytes of a session process's virtual memory. If a session process exceeds this limit, memory allocation and automatic stack growth will fail and the session process is killed by a SIGSEGV.

allow-system-option

If false, the kudo editor will not show the “System Option” tab in the option dialog (sessionId is required to to save the Preferences).

allow-user_preferences

If false, the kudo editor will not show the “User Preferences” tab in the option dialog (sessionId is required to to save the Preferences).

allow_drawing_compare

If the allow_drawing_compare property is set to false, it means that the Drawing Compare command will not be enabled or accessible.

enable_commenting_for_all_users

If the enable_commenting_for_all_users property is set to false, it means that according to capabilities commenting feature will be enable or disable.