General Options

note

With v4.7.0 some of the non-administrative settings have been brought to web interface, s. Admin Panel.

All settings available on the web UI are marked with:

This page forms a comprehensive list of the available options available in the tds-server.json configuration file.

Server server

Name	Value type	Default	Behavior
name	text	TDS Data Service	Name of the TDS instance as shown on RSWA devices.
ip	text	0.0.0.0	Interface to listen on for incoming connections. Not to be mistaken with url. If you only have a single network interface, this can be left at 0.0.0.0.
url	text	https://localhost	URL that TDS will use as it's own hostname. It must be an IP or domain that TDS is reachable on as it will redirect all traffic to that domain.
port	integer	443	The port that TDS will listen on for connections. If this port is updated, it must also be appended to the url parameter unless a reverse proxy setup is used.
threads	integer	0	the amount of worker threads used to handle incoming web-requests. By default, the number is derived from the number of available system threads.
connection-threads	integer	4	Deprecated, only exists for legacy reasons.
permit-empty-logins	boolean	false	Only for troubleshooting purposes: this will allow logging into TDS without having to enter username and password.
hide-operator-names	boolean	false	When active, this will strip any user data from inspection reports and the TDS UI except for admin and supervisor users.
clamp-oversized-bond-measurements	boolean	false	Not recommended: beads which are too large will be shown as 10+.
max-http-request-size	integer	1073741824	Increase this value if you're getting errors for request headers being too large.
set-hsts-headers	boolean	false	Recommended: if active, this tells clients to access this instance only using HTTPS. This defaults to false as it can cause mysterious troubles when used together with ssl->use->false.

User Session session

Name	Value type	Default	Behavior
cookie-secure	boolean	true	whether to secure cookie usage; recommended for use with SSL - sets HttpOnly and Secure cookie flags
cookie-same-site	Strict|Lax|None	Strict	sets the SameSite policy - recommended as Strict together with SSL

Authentication auth

Name	Value type	Default	Behavior
client_hide_login_user_list	boolean	false	activating this setting will hide the user listing in Desktop Tools and RSWA during login

client_hide_login_user_list defaults to false to be consistent with the legacy behavior. It might be desired to not have the login dialog list all available users, e.g. for GDPR reasons. Setting client_hide_login_user_list to true will provide an open login dialog where the username and password must be entered manually. This setting will become active on RSWA devices once this setting is activated, TDS is restarted and a newly created revision is activated on the devices.

CSV Export csv

Name	Value type	Default	Behavior
decimal-point	text	.	will use this character for as a decimal separator for numbers in CSV exports
list-separator	text	,	will use this character as a column separator for columns in CSV exports

These settings are especially imported for non-US based companies. Loading the CSV exports into MS Excel will result in errors, when numbers like 0.05 are mis-interpreted due to localization issues. The most common setting besides the default for the US is "decimal-point":"," and "list-separator":";.

Company Branding branding

The branding section defines the header of inspection reports. The company-name attribute defines what text will be displayed at the top of each inspection report. Additionally or alternatively, the logo-file can be used to display a company logo next to that text or instead of the text, if no company-name is provided.

logo-file accepts the file name of an image in either .jpg or .png format that must be located in the TDS data folder under /img. In a default setup with logo-file as myLogo.png it would be located under %TDS_DATA_DIR%\data\img\myLogo.png.

Name	Value type	Default	Behavior
company-name	text	""	the company which will be displayed on inspection reports (and the respective print exports)
logo-file	filesystem path (file)	""	an optional path to an image file which is displayed next to the company name on inspection reports, see below for additional info

Up to

v4.8

, logo-file could contain arbitrary system paths. That was a security risk and has been changed. Now, the image must be placed inside %TDS_DATA_DIR%/data/img. The path in logo-file may be absolute or relative to that directory.

Data Reports reports

v4.6.0

Name	Value type	Default	Behavior
cscan-color-palette	standard|grayscale|blue-yellow|viridis	standard	the color palette to use for displaying C-scans; standard is the established red-green scale
weld-checks-sort-order	id|name|decision|timestamp	id	sort order for weld checks within inspection reports; id is the legacy default which sorts according to the order they were created in in Desktop Tools

Logging logging

v4.2.0

The logging section handles the storage of server logs. Usually, the log level is set to info. If problems occur, change it to debug for more details. You can also set a custom logging folder. By default, it's in the configuration folder under the log sub-folder.

Name	Value type	Default	Behavior
level	info|debug	info	changes the logging verbosity

warning

Currently, this setting is not applied when "soft-restarting" TDS using the "Restart TDS" button in the user-facing Admin Panel. Due to technical reasons, this option requires an actual restart of the application triggered from the TDS host Windows system.

User Password Requirements password_policy

v4.2.0

The password_policy section handles the complexity requirements for new passwords. Existing passwords will not be affected by these settings.

Name	Value type	Default	Behavior
min_length	integer	0	sets the minimum amount of required characters
require_special	boolean	false	requires new passwords to contain non-alphanumeric characters; note that any character outside the 26 letters and 10 digits of the English language is treated as special
require_number	boolean	false	requires new passwords to contain digits

Application Settings app

v4.8.0

Periodic Version Check | This is an opt-in feature. It can be turned on to have TDS query for version updates periodically. This should not be activated if your network administration is restricting outbound connections. |

Name	Value type	Default	Behavior
check-for-updates	boolean	false	if active, TDS will regularly check for new software releases and notify the user if updates are available
disk-space-warning-threshold-gb	integer	1	TDS will notify the user if any of the partitions that contain TDS data has less GB of free space available than given in this setting

warning

check-for-updates requires TDS to perform outbound network connections (tessonics.com) to check for updates. Such access might be restricted by company IT regulations. Please check back with your administration before activating this feature.