Patriot Configuration Files

Each of the Patriot component programs has its own configuration file containing application and system settings.

The files are located inside the Patriot install directory for each component, e.g. C:\Program Files (x86)\Patriot Systems Ltd\Patriot Data Service\AppSettings.json

The following headers in this document correspond to sub-sections in the corresponding config files.

The configuration system applies sensible defaults for all of these values. Only settings that you wish to change from the default values need to be included in the config file.

These settings must be put inside the root 'DataService'/'TaskService' section. For example:

{
    "DataService": {
        "SqlConnection": {
            // sql connection settings (see below)
        }
    }
}

Note: the following types 'string' and 'boolean' refer to text and true/false respectively, both of which should be wrapped in quotation marks.

Data Service Configuration

SqlConnection

Controls how Patriot connects to SQL Server.

Property	Type	Description
ServerName	string	Name of the SQL Server to connect to.
IntegratedSecurity	boolean	Indicates whether or not to use Windows Authentication to authenticate to SQL.
UserName	string	Username to authenticate to SQL. Ignored if 'IntegratedSecurity' is true.
Password	string	Password to authenticate to SQL. Ignored if 'IntegratedSecurity' is true.
MaxPoolSize	number	Maximum size of the SQL Connection pool. Must be at least 100.
Failover	Failover Options	SQL Failover options.

Failover Options

Property	Type	Description
FailoverPartner	string	Name of the secondary / failover SQL server, when using SQL Mirroring.
MultiSubnetFailover	boolean	Indicates if the failover crosses multiple network subnets. Improves recovery time during cluster failover.

Api

Settings relating to the Patriot REST / Web API. This is typically configured during ICA setup using the Utilities Program. Learn more.

Property	Type	Description
Port	number	TCP Port where Patriot will listen for API requests.
TokenSigningKey	string	The Base64-encoded token signing key used to issue API tokens.
TokenTimeout	TimeSpan	The amount of time that issued API tokens will be valid for, in HH:MM:SS (e.g. 00:01:30 ).
TokenIdleTimeout	TimeSpan	The amount of time that unused/idle API tokens will be valid for, in HH:MM:SS (e.g. 00:01:00 ).

JsonSdk

Settings relating to the legacy Patriot JSON API. Learn more.

Property	Type	Description
Enabled	boolean	Enables the legacy JSON api.
Port	number	TCP Port where Patriot will listen for API requests.
Encrypted	boolean	Enables encryption.
UserName	string	Valid username required to authenticate requests.
Password	string	Valid password required to authenticate requests.

WcfApi

Settings relating to the internal Patriot WCF API, used by the Task Service and Desktop Client to connect.

Property	Type	Description
Port	number	TCP Port where Patriot will listen for API requests.
Encrypted	boolean	Enables encryption and authentication.

StorageDirectories

Storage directory location configuration settings. Learn more.

Property	Type	Description
LocalStorageDirectory	string	Local Storage directory where the service stores local files not stored in the database.

Archiving

Settings relating to archiving of old data to reduce storage requirements. Learn more.

Property	Type	Description
Enabled	boolean	Indicates if archive database is enabled.
SignalArchivingRateLimit	number	The maximum expected average signal logging rate per client per day. In rare cases this may need to be increased via the dataservice config file.

Ulc

Settings relating to ULC compliance.

Property	Type	Description
SerialNo	string	ULC Serial Number.

Task Service Configuration

ConnectionSettings

Data service details (server, port, encryption settings).

Property	Type	Description
ServerName	string	Name of the SQL server to connect to.
ServerPort	number	Port of the SQL server to connect to.
EncryptionEnabled	boolean	Indicated whether or not encryption is enabled.
AlternateAuthentication	Alternate Authentication Options	Ignored unless 'Encryption' setting is enabled.

Alternate Authentication Options

These settings are ignored unless the 'Encryption' setting is enabled. Learn more.

Property	Type	Description
Enabled	boolean	Indicates whether alternate authentication is enabled.
Domain	string	Domain used for alternate authentication.
User	string	Valid user required to authenticate requests.
Password	string	Valid password required to authenticate requests.

BackupConnectionSettings

Alternative addresses to connect to data service. Learn more.

Property	Type	Description
AutomaticFailOver	boolean	Indicates whether automatic failover is enabled.
BackupServerName	string	Name of the backup / failover SQL server.
AutomaticFailBackTime	TimeSpan	Timespan determining when to swap to backup server, in HH:MM:SS (e.g. 00:02:00 ).
AlternatePrimary1	Endpoint Options	First alternate primary database server.
AlternatePrimary2	Endpoint Options	Second alternate primary database server.
AlternateBackup1	Endpoint Options	First alternate backup database server.
AlternateBackup1	Endpoint Options	Second alternate backup database server.

Endpoint Options

Property	Type	Description
Address	string	Hostname or IP address e.g. patriotserver or 192.168.1.100.
Port	number	IP Port number.

StorageDirectories

Local storage directory where the task service stores its files.

Property	Type	Description
LocalStorageDirectory	string	Path to the directory.

OpenTelemetry

Settings for exporting system statistics. Learn more.

Property	Type	Description
SendMetrics	boolean	Indicates whether or not metrics should be sent.
Endpoint	Uri	Destination server to which the exporter is going to send telemetry.
Protocol	OtlpExportProtocol	Supported: Grpc (default) or HttpProtobuf.
Headers	string	Optional headers to include in request (eg. api key).
TimeoutMilliseconds	number	The max waiting time (in milliseconds) for the backend to process each batch. Defaults to 10,000ms.