AppServer parameters
All the available parameters for the WebSpellChecker Server management are listed in a special .xml file called AppServerX.xml file. Below you will find the description of each parameter as well as its default and possible values.
The parameters listed below are valid for WebSpellChecker Server starting 5.20.0.0.
By default, AppServerX.xml file is located in: <WebSpellChecker_Installation_Path>/WebSpellChecker/AppServer/AppServerX.xml
ServiceName
Description:
ServiceName parameter sets the WebSpellChecker service name in the Service Control Manager database (only for Windows).
Parameter type:
String
Default value:
WSCAppServer
Possible values:
Any string value.
Before changing the name of the service, it is required to uninstall the service. Rename and install the service again with a new name.
<ServiceName>WSCAppServer</ServiceName>PathToServiceFilesDirectory
Description:
PathToServiceFilesDirectory parameter sets the directory for downloaded dictionaries and license. In selected directory WebSpellChecker directory is always created.
Parameter type:
String
Default value:
Windows: C\Program Data\
Linux: /var/lib/
Possible values:
Valid filesystem path.
To ensure the service works properly, move the files from the old directory to the new directory after changing the parameter. If the license hasn't been activated, activate it after changing the parameter so it's created in the new path.
Threads
MaxConnectionThreads
UPD | 5.0.0
Description:
MaxConnectionThreads parameter defines a maximum number of AppServer connection threads. This is the upper limit on concurrent connections to the server.
Parameter type:
Number
Default value:
1000
Possible values:
Must be greater than or equal to 0.
If 0 is specified, the TCPServerDispatcher will set this parameter to the number of available threads in its thread pool.
ConnectionThreadPriority
UPD | 5.0.0
Description:
ConnectionThreadPriority parameter sets the priority of the AppServer connection threads.
Parameter type:
String
Default value:
normal
Possible values:
lowest
low
normal
high
highest
WorkerThreads
UPD | 5.0.0
Description:
WorkerThreads parameter sets the number of worker threads which perform spell and grammar checks, etc.
Parameter type:
Number
Default value:
16
Possible values:
Non-zero value
Memory
PercentLowMemory
Description:
PercentLowMemory parameter defines a percent of the free physical memory remaining before the system will turn into low memory conditions state.
Parameter type:
Number
Default value:
5
Possible values:
1..100
AggressiveConserve
Description:
AggressiveConserve parameter turns on/off a special mode with aggressive memory conservation. In the turned-on mode, the memory will be freed as soon as possible. This parameter is bundled with the PercentLowMemory parameter. In the enabled mode, PercentLowMemory is ignored and the system is always considered to be in a low memory state.
Parameter type:
Boolean
Default value:
OFF
Possible values:
ON, OFF
Connection
Port
Description:
Port parameter sets a default port number which will be used by AppServer for serving requests.
Parameter type:
Number
Default value:
2880
Possible values:
Any available port number.
QueueSize
UPD | 5.0.0
Description:
QueueSize parameter defines the maximum size of the server socket backlog queue.
Parameter type:
Number
Default value:
3000
Possible values:
1...Nm, where Nm is the maximum allowed value of socket backlog queue. This maximum value is specific for each type of operating system.
ClientTimeout
UPD | 5.0.0
Description:
ClientTimeout parameter sets a timeout value in seconds for spell, grammar requests made by clients to AppServer.
Parameter type:
Number
Default value:
60
Possible values:
60...900
It is not recommended to set a ClientTimeout value to more than 900 seconds (15 minutes).
ServerTimeout
UPD | 5.0.0
Description:
ServerTimeout parameter sets a timeout value in seconds for requests made by AppServer to remote servers like license server.
Parameter type:
Number
Default value:
60
Possible values:
10...900
It is not recommended to set ServerTimeout value to more than 900 seconds (15 minutes).
KeepAlive
EnableKeepAlive
UPD | 5.0.0
Description:
EnableKeepAlive parameter enables a keep alive connection.
Parameter type:
Boolean
Default value:
true
Possible values:
true
false
KeepAliveTimeout
UPD | 5.0.0
Description:
KeepAliveTimeout parameter sets a timeout interval for a keep alive connection.
Parameter type:
Number
Default value:
10
Possible values:
1..Nm
MaxKeepAliveRequests
UPD | 5.0.0
Description:
MaxKeepAliveRequests parameter sets a maximum number of keep-alive requests.
Parameter type:
Number
Default value:
0
Possible values:
0 – unlimited number of requests.
1..Nm
SSL
EnableSSL
UPD | 5.0.0
Description:
EnableSSL parameter defines whether a secure connection should be enabled.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
TLSVersion
UPD | 5.0.0
Description:
TLSVersion parameter sets a specific version of Transport Layer Security (TSL).
Parameter type:
String
Default value:
TLSV1_2
Possible values:
TLSV1
TLSV1_1
TLSV1_2
VerificationMode
NEW | 5.6.4
Description:
VerificationMode parameter defines the depth of a client's SSL certificate verification.
Parameter type:
String
Default value:
RELAXED
Possible values:
NONE
RELAXED
STRICT
Detailed description of each mode is available in the VerificationMove section of Class Poco::Net::Contect.
SSLCertificateFileSettings
SSLCertificateFile
Description:
SSLCertificateFile parameter specifies a path to a private key file in a *.pfx format that containing the certificate and corresponding private key.
Parameter type:
String
Default value:
None
Possible values:
“C:/Program Files/WebSpellChecker/AppServer/certificate.pfx”
SSLCertificatePassword
NEW | 5.3.1
Description:
SSLCertificatePassword parameter specifies a pass of SSL certificate. Some of SSL certificates are exported with passwords.
Parameter type:
String
Default value:
None
Possible values:
Any
Proxy
EnableProxy
NEW | 5.10.0.3
Description:
EnableProxy parameter enables support of HTTP proxy server configuration. If enabled, proxy is used for outbound requests, like license server.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
Detailed description is available in the Poco/Net/HTTPClientSession.h
ProxyHost
NEW | 5.10.0.3
Description:
ProxyHost parameter sets a proxy server host name or IP address.
Parameter type:
String
Default value:
None
Possible values:
Host name or IP address
ProxyPort
NEW | 5.10.0.3
Description:
ProxyPort parameter sets a proxy server TCP port number.
Parameter type:
String
Default value:
None
Possible values:
TCP port number
ProxyUserName
NEW | 5.10.0.3
Description:
ProxyUserName parameter sets a proxy server user name.
Parameter type:
String
Default value:
None
Possible values:
user name
ProxyPassword
NEW | 5.10.0.3
Description:
ProxyPassword parameter sets a proxy server password.
Parameter type:
String
Default value:
None
Possible values:
password
Compression
EnableCompression
NEW | 5.4.X
Description:
EnableCompression parameter lets you enable or disable compression of outbound traffic (responses) from WebSpellChecker.
Parameter type:
Boolean
Default value:
true
Possible values:
true for enabling compression
false for disabling compression
MinSizeThreshold
NEW | 5.4.X
Description:
MinSizeThreshold specifies a minimum number of bytes of request’s body to be compressed. Any requests that are lower than this particular number (i.e. 150 bytes) are not compressed.
Parameter type:
Number
Default value:
150
Possible values:
0 to any meaningful number. Possible value of this parameter depends on desired RAM usage.
CompressionLevel
NEW | 5.4.X
Description:
CompressionLevel parameter specifies how strong the compression level should be.
For example, compression level 6 takes much less time than, say, compression level 9 and usually gives virtually the same result, thus, it is usually more effective than 9.
Parameter type:
Number
Default value:
6
Possible values:
0, 1..9 where 9 is best but slowest compression level type.
Licensing
LicenseTicket
NEW | 5.4.X
Description:
LicenseTicket is a license used for the activation of WebSpellChecker Server package.
Parameter type:
String
Default value:
None
Possible values:
A string of 15 characters
LicenseServerLink
NEW | 5.4.X
Description:
LicenseServerLink is an address link of WebSpellChecker licensing service. This address is built into the AppServer and is used to request a license from the server.
Leave the tag empty if only you are not provided alternative link to licensing service.
Parameter type:
String
Default value:
None
Possible values:
Provided with installation instructions and should not be modified.
AutoLicenseReactivation
NEW | 5.5.9
Description:
AutoLicenseReactivation enables the automatic license reactivation attempts before its expiration date.
Parameter type:
Boolean
Default value:
true
Possible values:
true - enable an automatic license reactivation
false - disable the license reactivation
FailSafety
SuppressCrashes
Description:
SuppressCrashes parameter defines whether any errors like segmentation fault, access violation, illegal instruction, division by zero, etc. will be logged and suppressed. Their presence won't cause the application to crash but might result in unstable or undefined behavior. If disabled, any such situation will be logged and cause the affected process of application to crash and possibly be substituted by other worker processes.
Parameter type:
Boolean
Default value:
true
Possible values:
true
false
MinRestartInterval
Description:
MinRestartInterval parameters sets a minimal interval value in seconds between restarts of the second cascade process. Before starting a new process, a process thread will check the time when the replaceable process has started and failed. If the time from start to failure doesn't exceed the minimal interval value, a new process thread will wait until it is reached and then start a new process. Such an approach helps to avoid an endless loop of starting processes that might cause nearly 100% CPU consumption.
Parameter type:
Number
Default value:
10
Possible values:
1..60
CascadeSize
Description:
CascadeSize parameter defines a number of processes in the second cascade that will be running simultaneously. The monitoring process will try to keep the number of processes in the second cascade constant regardless any failures in the processes.
Parameter type:
Number
Default value:
2
Possible values:
0..3
It is suggested not to have more than 3 processes in the second cascade.
WaitShutdownInterval
Description:
WaitShutdownInterval parameter sets a time interval value in seconds for the second child process to wait before it will be shut down gracefully. If the process is not shutting down during this period of time, it is allowed to terminate it.
Parameter type:
Number
Default value:
60
Possible values:
0..120
It is suggested to keep the default value provided.
CheckTimeout
Description:
CheckTimeout parameter sets a timeout interval value in seconds between sequential check calls to the active process in the second cascade.
Parameter type:
Number
Default value:
5
Possible values:
1..5
WaitResponseTimeout
Description:
WaitResponseTimeout parameter sets a timeout interval value in seconds for the controlling process to wait for a response from a child process. If no response within the specified time, the controlling process will decide that a child process hang up and start termination of all child processes one-by-one.
Parameter type:
Number
Default value:
60
Possible values:
10..600
InitialPause
Description:
InitialPause parameter sets a pause value in seconds when to begin monitoring processes which are starting.
Parameter type:
Number
Default value:
20
Possible values:
1..60
Log
The description of all the available parameters for log(s) files.
Size
Description:
Size parameter defines the maximum size of the AppServerX.log file in kilobytes. If the maximum size is reached, a new log file will be created and the previous one will be saved with an appropriate time stamp (log rotation).
Parameter type:
Number
Default value:
10000
Possible values:
0 to never rotate log files
non-zero value in kilobytes
PrioritizationLevel
UPD | 5.0.0
Description:
PrioritizationLevel parameter sets a log level for notifications that will be recorded in the log file.
Parameter type:
String
Default value:
information
Possible values:
none – no logs' information will be recorded to the log file;
fatal
critical – very severe error events that will presumably lead the application to abort;
error – error events that might still allow the application to continue running;
warning
notice
information – important information that should be logged under normal conditions such as successful initialization, services starting and stopping etc.;
debug – fine-grained informational events that are most useful to debug an application;
trace – more detailed code debugging information.
The log levels are ordered by their priority from the highest to the lowest accordingly. For example, if the default value for PrioritizationLevel is set to “information” then not only information notifications will be recorded in the log file but also notifications from its all the preceding log levels such as notice, warning, error, critical and fatal.
PathToLogsDirectory
NEW | 5.6.4
Description:
PathToLogsDirectory parameter defines the path to the Logs directory.
Parameter type:
String
Default value:
Logs
Possible values:
Any valid path (relative or absolute)
Subsystems
UPD | 5.0.0
Description:
Subsystems parameter defines for which subsystems of AppServer the logging will be performed.
Parameter type:
Array
Default value:
all
Possible values:
all – all log messages from all subsystems;
general – log messages about the state of AppServer, spellcheck, grammar, languages, dictionaries, etc.
threadpool – log messages related to managing of threads;
licensing – log messages related to licensing;
failsafe – log messages about fail safety subsystem;
selector – log messages from a listening thread;
responder – log messages from a sender thread.
SpellCheckCache
EnableSpellCheckCache
Description:
EnableSpellCheckCache parameter defines whether misspellings (and their suggestions) will be cached in the memory (RAM)
Parameter type:
Boolean
Default value:
true
Possible values:
true
false
CacheSize
NEW | 5.4.X
Description:
CacheSize parameter defines a number of misspellings and their suggestions to be cached in RAM.
Parameter type:
Number
Default value:
500000
Possible values:
Between 0 and any desired number.
The number depends on desired RAM usage. Consider the following requirement: 10 MB for cache must be enabled on Server (for 10 000 suggestions). The rough calculation here is 1 misspelling and its suggestions equals 100 bytes. The more misspellings and their suggestions are added to cache, the more RAM will be required.
CacheSavePath
NEW | 5.4.X
Description:
CacheSavePath parameter specifies either a full or relative path to a file which will be used for periodic dumping of the cache content. This file will be created if it doesn't exist, or overwritten if it does.
To enable this option, make sure that AppServerX processes have write permissions to that file.
Parameter type:
String
Default value:
None
Possible values:
Full or relative path to a file on a server.
CacheLoadPath
NEW | 5.4.X
Description:
CacheLoadPath specifies either a full or relative path to a cache dump file which will be loaded into cache at the first spellcheck request to the server.
Parameter type:
String
Default value:
None
Possible values:
Full or relative path to a file on a server.
CacheSaveInterval
NEW | 5.4.X
Description:
Each time the server encounters the number of misspellings specified in CacheSaveInterval parameter setting, the cache is dumped onto disk to the file you have specified in CacheSavePath parameter.
Parameter type:
Number
Default value:
0
Possible values:
0 – the cache dumping is turned off. In this case, the cache will be reset each time your restart AppServer.
Any number of misspellings
SpellCheckEngine
MaxErrorsPercentToSuggest
Description:
MaxErrorsPercentToSuggest parameter defines a percent (%) of misspelled words that will be processed by the engine and suggestions will be provided for.
Parameter type:
Number
Default value:
90
Possible values:
1..100
MinQueryLengthToSkipSuggest
Description:
MinQueryLengthToSkipSuggest parameter sets the minimum number of words in a request which will be processed. This parameter is related to MaxErrorsPercentToSuggest.
Parameter type:
Number
Default value:
9
Possible values:
2..Nm
MaxSuggestions
UPD | 5.0.0
Description:
MaxSuggestions parameter sets a maximum number of suggestions for each misspelled word that will be determined by the engine.
Parameter type:
Number
Default value:
3
Possible values:
0-8
SpellCheckOptions
IgnoreAllCaps
Description:
IgnoreAllCaps controls ignoring all-caps misspellings.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
IgnoreWordsWithNumbers
Description:
IgnoreWordsWithNumbers controls ignoring misspellings with numbers.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
IgnoreMixedCase
Description:
IgnoreMixedCase controls ignoring mixed-case misspellings.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
IgnoreDomainNames
Description:
IgnoreDomainNames controls ignoring domain names during spell check.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
IgnoreWordsWithUpperCase
Description:
IgnoreWordsWithUpperCase controls ignoring misspellings with any upper-cased letter.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
IgnoreWordsWithUnderscores
Description:
IgnoreWordsWithUnderscores controls ignoring misspellings with underscores (_).
Parameter type:
Boolean
Default value:
true
Possible values:
true
false
HunspellOptions
OnlyMaxDiff
Description:
OnlyMaxDiff defines whether spelling suggestions not similar to misspelling are not included into suggestion list.
Parameter type:
Boolean
Default value:
true
Possible values:
true
false
MaxDiff
Description:
MaxDiff defines the similarity factor for the n-gram based suggestions. Bigger value provides more spelling suggestions.
Parameter type:
Number
Default value:
4
Possible values:
0..10, 0 - fewer n-gram suggestions, but min. 1; 10 - MAXNGRAMSUGS n-gram suggestions
CompoundHyphenSuggest
Description:
CompoundHyphenSuggest defines whether to enable additional suggestion logic for words with hyphen. Can produce unknown suggestions.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
GrammarCheckEngine
PathToJavaVirtualMachine
NEW | 5.0.0
Description:
PathToJavaVirtualMachine parameter sets a path to Java Virtual Machine (JVM).
Parameter type:
String
Default value:
None
AppServer will try to autodetect the path to JVM.
Possible values:
Path to JVM on Linux-based environments:
/usr/lib/jvm/java-17-openjdk-amd64/lib/server/libjvm.soPath to JVM on Windows-based environments:
C:/Program Files/Java/jdk-17/bin/server/jvm.dllEmpty value
JVMMaxMemorySizeMb
NEW | 5.0.0
Description:
JVMMaxMemorySizeMb parameter sets a maximum heap size in megabytes for LanguageTool in Java Virtual Machine (JVM).
Parameter type:
Number
Default value:
2048
Possible values:
1000...Nm
1000 MB is the minimum possible size that can be used by LanguageTool in JVM but for a single language (e.g. English grammar checking).
For more details refer to Configure JVM maximum heap size
JVMObjectIdleTimeout
Description:
JVMObjectIdleTimeout parameter defines time in seconds after which an unused JVM object will be removed.
Parameter type:
Number
Default value:
300
Possible values:
Any duration in seconds. It's not recommended to set this value less than 300 seconds to avoid frequent resources reloading.
PathToPythonLib
Description:
PathToPythonLib sets path to Python. It's required if TensorFlow is used from pip package. By default TensorFlow is included with the package and works without Python.
Parameter type:
String
Default value:
None
Possible values:
Absolute or relative path to libpythonX.X.so or pythonXX.dll
PathToTensorFlowLib
Description:
PathToTensorFlowLib sets custom path to TensorFlow library. By default library included in the package is used.
Parameter type:
String
Default value:
None
Possible values:
Absolute or relative path to tensorflow.so or tensorflow.dll.
Dictionaries
ResourcesDir
UPD | 5.29.2
Description:
ResourcesDir parameter defines a path to the directory with available default language dictionaries.
Parameter type:
String
Default value:
Resources
Possible values:
Absolute or relative path to a custom directory with language dictionaries.
UserDictionaries
UserDictDir
UPD | 5.0.0
Description:
UserDictDir parameter defines a path to the directory where all created personal user dictionaries will be stored.
Parameter type:
String
Default value:
UserDictionaries
Possible values:
Absolute or relative path to a custom directory with user dictionaries files.
CustomDictionaries
CustDictConfig
UPD | 5.0.0
Description:
CustDictConfig parameter defines a path to a configuration *.xml file which will be used for storing records about created custom dictionaries.
Parameter type:
String
Default value:
CustDictConfig.xml
Possible values:
Path to a custom directory with *.xml file.
CustDictDir
UPD | 5.0.0
Description:
CustDictDir parameter defines a path to the directory where all created custom dictionaries will be stored.
Parameter type:
String
Default value:
CustomDictionaries
Possible values:
Absolute or relative path to a custom directory with custom dictionaries files.
CustDictReloadOnFly
UPD | 5.0.0
Description:
CustDictReloadOnFly parameter defines whether custom dictionaries should be reloaded automatically “on the fly” upon any changes.
Parameter type:
Boolean
Default value:
ON
Possible values:
ON – custom dictionaries are reloaded.
OFF – custom dictionaries are not reloaded automatically.
Authentication
AccessKey
Description:
AccessKey parameter defines access key which is used for custom_dictionary and style_guide commands.
Parameter type:
String
Default value:
Empty
Possible values:
Any string, at least 20 characters long, only letters (case-sensitive) and digits.
UseAccessKeyForAllCommands
Enabling this option breaks the front-end integration.
Use it only for API.
Description:
UseAccessKeyForAllCommands parameter defines whether to require access_key for every request to the server. By default the access key is required only for custom_dictionary and style_guide commands.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
Request
EnableRequestStatistic
NEW | 5.4.X
Description:
EnableRequestStatistic parameter enables or disables saving of request statistics.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
RequestStatisticDataType
NEW | 5.4.X
Description:
RequestStatisticDataType determines what kind of storage will be used to store request statistics data.
Parameter type:
String
Default value:
File
Possible values:
File - for saving the statistical information to a file. When choosing this option, you need to specify the path to a file using the RequestStatisticFilePath parameter.
Database - for saving the statistical information to a database. When choosing this option, you need to perform database setup and its configuration.
Contact [email protected] for more details on setting the database.
RequestStatisticFilePath
NEW | 5.4.X
Description:
RequestStatisticFilePath parameter sets a path to a *.log file with requests statistics.
Parameter type:
String
Default value:
Logs/RequestStatistic.log
Possible values:
Path to a log file with requests statistics.
RequestStatisticPeriodToSave
NEW | 5.4.X
Description:
RequestStatisticPeriodToSave can be used only for database as RequestStatisticOutput. Statistical data is stored into the database each RequestStatisticPeriodToSave seconds.
This parameter is applicable only if RequestStatisticDataType is set as a Database.
Parameter type:
Number
Default value:
600
Possible values:
1...86400
For example, 600 means the statistical data is saved once in 600 seconds.
MaxApiRequestSize
NEW | 5.5.8
Description:
MaxApiRequestSize parameter sets the maximum size of the API request body in bytes.
Parameter type:
Number
Default value:
50000
Possible values:
A number value in bytes more than 0. If you set too small value the common service requests from the products will fail. Too big value will result in the drastic performance issues.
EnableUserActionStatistic
Description:
EnableUserActionStatistic parameter enables statistics collection about user actions on front-end.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
RecordUserContextData
Description:
RecordUserContextData parameter enables saving user contexts (sentences) in files.
Parameter type:
Boolean
Default value:
false
Possible values:
true
false
Languages
Language
Description:
Language parameter defines a language ID, alias, and its options.
Parameter type:
String
Default value:
en_US
Possible values:
Alias
Description:
Alias parameter sets an alias, a language short name, which can be used when calling a language.
Parameter type:
String
Default value:
N/A
Possible values:
Any string associated with a particular language, e.g. alias name for American English is “am”.
SupportedCheckKits
Description:
SupportedCheckKits lists the available check kits for tha language.
Parameter type:
List
Default value:
N/A
Possible values:
For more details see Check kits
DisabledRules
Description:
DisabledRules defines disabled rules file for a language. Each language can contain several disabled rules files.
Attributes:
Path
Attribute type:
String
Possible values:
Path relative to ResourcesDir
Autocomplete
Description:
Autocomplete defines autocomplete settings for a language.
Attributes:
Enabled
Attribute type:
Boolean
Possible values:
true
false
Locale
Description:
Locale sets locale of the autocomplete model to use
Parameter type:
String
Default value:
N/A
Possible values:
Locale of autocomplete model from <AIModels>
SuggestionPrioritization
Description:
SuggestionPrioritization defines suggestion prioritization settings for a language. For more details see Suggestion prioritization mechanism
Attributes:
Enabled
Attribute type:
Boolean
Possible values:
true
false
Autocorrect
Description:
Autocorrect defines autocorrect settings for a language.
Attributes:
Enabled
Attribute type:
Boolean
Possible values:
true
false
Dictionary
Description:
Dictionary sets autocorrect pairs file.
Attributes:
Path
Attribute type:
String
Possible values:
Path relative to ResourcesDir
Last updated
Was this helpful?