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.
- Parameters listed below are valid for WebSpellChecker Server starting version 5.0.0.
- By default, AppServerX.xml file is located in: <WebSpellChecker_Installation_Path>/WSC/AppServer/AppServerX.xml
ServiceName
Before changing the name of the service, it is required to uninstall the service. Rename and install the service again with a new name.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. <ServiceName>WSCAppServer</ServiceName>
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: |
<MaxConnectionThreads>1000</MaxConnectionThreads>
ConnectionThreadPriority
UPD | 5.0.0
normalDescription: ConnectionThreadPriority parameter sets the priority of the AppServer connection threads. Parameter type: String Default value: Possible values: <ConnectionThreadPriority>normal</ConnectionThreadPriority>
WorkerThreads
UPD | 5.0.0
8 0 – unlimited of worker threads. Nm is a number of the processor cores * 2.Description: WorkerThreads parameter sets the number of worker threads which perform spell and grammar checks, thesaurus work, etc. Parameter type: Number Default value: Possible values: <WorkerThreads>8</WorkerThreads>
Memory
AggressiveConserve
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 the low memory state.Description: Parameter type: Boolean Default value: OFF Possible values: ON, OFF <AggressiveConserve>OFF</AggressiveConserve>
PercentLowMem
PercentLowMem parameter defines a percent of the free physical memory remaining before the system will turn in low memory conditions state.Description: Parameter type: Number Default value: 5 Possible values: 1..100 <PercentLowMem>5</PercentLowMem>
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.<Port>2880</Port>
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 a maximum allowed value of socket backlog queue. This maximum value is specific for each type of the operating system. |
<QueueSize>3000</QueueSize>
ClientTimeout
UPD | 5.0.0
Description: | ClientTimeout parameter sets a timeout value in seconds for spell, grammar, and thesaurus 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). |
<ClientTimeout>60</ClientTimeout>
ServerTimeout
UPD | 5.0.0
Description: | ServerTimeout parameter sets a timeout value in seconds for requests made by AppServer to remote servers like user dictionaries server or license servers. |
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). |
<ServerTimeout>60</ServerTimeout>
KeepAlive
EnableKeepAlive
UPD | 5.0.0
Description: | EnableKeepAlive parameter enables a keep alive connection. |
Parameter type: | Boolean |
Default value: | true |
Possible values: |
|
<EnableKeepAlive>true</EnableKeepAlive>
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: |
<KeepAliveTimeout>10</KeepAliveTimeout>
MaxKeepAliveRequests
UPD | 5.0.0
Description: | MaxKeepAliveRequests parameter sets a maximum number of keep-alive requests. |
Parameter type: | Number |
Default value: | 0 |
Possible values: |
|
<MaxKeepAliveRequests>0</MaxKeepAliveRequests>
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: |
|
<EnableSSL>false</EnableSSL>
SSLCertificateSource
NEW | 5.5.3
This parameter can be specified for Windows only.
Description: | SSLCertificateSource defines the source of an SSL certificate. |
Parameter type: | String |
Default value: | STORE |
Possible values: |
|
<SSLCertificateSource>STORE</SSLCertificateSource>
SSLCertificateStoreSettings
NEW | 5.5.3
This parameter can be specified for Windows only.
Description: | SSLCertificateStoreSettings tag collects the parameters for certificate store settings. |
Parameter type: | N/A |
Default value: | N/A |
Possible values: | N/A |
Example:
<SSLCertificateStoreSettings> <SSLCertificateCommonName></SSLCertificateCommonName> <SSLCertificateUseMachineStore>true</SSLCertificateUseMachineStore> <SSLCertificateStore>MY</SSLCertificateStore> </SSLCertificateStoreSettings>
SSLCertificateCommonName
NEW | 5.5.3
This parameter can be specified for Windows only.
Description: | SSLCertificateCommonName parameter defines a fully qualified HostName for which an SSL certificate is issued for. If specified, Windows machine certificate store is used. Otherwise, the user's certificate store is used. |
Parameter type: | String |
Default value: | N/A |
Possible values: | Fully qualified HostName |
Example:
<SSLCertificateCommonName>Fully qualified HostName</SSLCertificateCommonName>
SSLCertificateStore
NEW | 5.5.3
This parameter can be specified for Windows only.
Description: | SSLCertificateStore parameter defines the type of store used for an SSL certificate. According to Microsoft official website System Store Locations article, a system store is a collection that consists of one or more physical sibling stores. For each system store, there are predefined physical sibling stores. |
Parameter type: | String |
Default value: | MY |
Possible values: |
|
Example:
<SSLCertificateStore>MY</SSLCertificateStore>
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: |
|
<TLSVersion>TLSV1_2</TLSVersion>
SSLCertificateFile
UPD | 5.0.0
Description: | SSLCertificateFile parameter specifies a path to an SSL certificate file. |
Parameter type: | String |
Default value: | None |
Possible values: |
|
<SSLCertificateFile></SSLCertificateFile>
SSLCertificateKeyFile
NEW | 5.0.0
Description: | SSLCertificateKeyFile parameter specifies a path to a private key file in a *.pem format. This parameter is intended only for Linux-based environments. |
Parameter type: | String |
Default value: | None |
Possible values: | “/opt/WSC/AppServer/key.pem” |
<SSLCertificateKeyFile></SSLCertificateKeyFile>
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 |
<SSLCertificatePassword></SSLCertificatePassword>
SSLCertificateAuthorityLocation
NEW | 5.5.3
Description: | SSLCertificateAutorityLocation parameter сontains the path to the file or directory containing the CA/root certificates. |
Parameter type: | String |
Default value: | Empty |
Possible values: | Any |
<SSLCertificateAutorityLocation></SSLCertificateAutorityLocation>
SSLCertificateLoadDefaultCA
NEW | 5.5.3
Description: | SSLCertificateLoadDefaultCA parameter specifies whether the built-in CA certificates from OpenSSL are used. |
Parameter type: | Boolean |
Default value: | false |
Possible values: |
|
<SSLCertificateLoadDefaultCA>false</SSLCertificateLoadDefaultCA>
Compression
EnableCompression
NEW | 5.4.X
Description: Parameter type: Boolean Default value: true Possible values: <EnableCompression>true</EnableCompression>
MinSizeThreshold
NEW | 5.4.X
0 to any meaningful number.Description: Parameter type: Number Default value: 150 Possible values: <MinSizeThreshold>150</MinSizeThreshold>
CompressionLevel
NEW | 5.4.X
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.Description: Parameter type: Number Default value: 6 Possible values: 0, 1..9 where 9 is best but slowest compression level type. <CompressionLevel>6</CompressionLevel>
License
LicenseServer
INACTIVE
Description: LicenseServer parameter defines a license server where AppServer will call when its license expired asking for a new license. Parameter type: String Default value: 127.0.0.1 Possible values: Server host:port which is used as a license server. <LicServer>127.0.0.1</LicServer>
LicenseWarning
INACTIVE
Description: LicenseWarning parameter sets a time interval before the license expiration after which AppServer attempts to request a new license. Parameter type: Time Default value: 0.0:5:0 Possible values: days.hours:minutes:seconds <LicenseWarning>0.0:5:0</LicenseWarning>
LicenseTicket
NEW | 5.4.X
Description: LicenseTicket is a license used for the activation of WebSpellChecker Server package. Parameter type: String Default value: N/A Possible values: A string of 15 characters <LicenseTicket></LicenseTicket>
LicenseServerLink
NEW | 5.4.X
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.Description: Parameter type: String Default value: None Possible values: Provided with installation instructions and should not be modified. <LicenseServerLink></LicenseServerLink>
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: <AutoLicenseReactivation>true</AutoLicenseReactivation>
FloatingLicensing
EnableFloatingLicensing
NEW | 5.4.X
Description: Parameter type: Boolean Default value: false Possible values: <EnableFloatingLicensing>false</EnableFloatingLicensing>
FloatingLicenseServer
NEW | 5.4.X
FloatingLicenseServer parameter defines the address, host or domain name, and port number of the License Server which issues a license. It also validates the request from a WebSpellChecker Server App whether to provide a license or not. The default port number for a License Server is 2881. Description: Parameter type: String Default value: 127.0.0.1:2881 Possible values: host_name:port <FloatingLicenseServer>127.0.0.1:2881</FloatingLicenseServer>
EnableLicenseSSL
NEW | 5.4.X
If you have enabled SSL during the WebSpellChecker installation process, specify this option as ‘true’.Description: Parameter type: Boolean Default value: false Possible values: <EnableLicenseSSL>false</EnableLicenseSSL>
LicenseTLSVersion
NEW | 5.4.X
Description: Parameter type: String Default value: TLSV1_2 Possible values: TLSV1, TLSV1_1, TLSV1_2 <LicenseTLSVersion>TLSV1_2</LicenseTLSVersion>
FailSafety
MinRestartInterval
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.Description: Parameter type: Number Default value: 10 Possible values: 1..60 <MinRestartInterval>10</MinRestartInterval>
CascadeSize
0..3 It is suggested not to have more than 3 processes in the second cascade.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: <CascadeSize>2</CascadeSize>
WaitShutdownInterval
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. 0..120 It is suggested to keep the default value provided.Description: Parameter type: Number Default value: 60 Possible values: <WaitShutdownInterval>60</WaitShutdownInterval>
CheckTimeout
CheckTimeout parameter sets a timeout interval value in seconds between sequential check calls to the active process in the second cascade.Description: Parameter type: Number Default value: 5 Possible values: 1..5 <CheckTimeout>5</CheckTimeout>
WaitResponseTimeout
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.Description: Parameter type: Number Default value: 60 Possible values: 10..600 <WaitResponseTimeout>60</WaitResponseTimeout>
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 <InitialPause>20</InitialPause>
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: 1..2*106, where 2*10 is 2GB. <Size>10000</Size>
PrioritizationLevel
UPD | 5.0.0
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.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: <PrioritizationLevel>information</PrioritizationLevel>
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: <Subsystems>all</Subsystems>
SaveRequestStatistic
INACTIVE
SaveRequestStatistic parameter regulates whether the service usage statistics should be logged. The usage statistics information is the general information about date and time of a request, domain, service ID, N of a session, type of command (spellcheck, grammar_check, get_suggestions and etc), user agent, language, look&feel. This type of the information might be useful if there is a need to monitor usage statistics of the WebSpellChecker services.Description: Parameter type: Boolean Default value: OFF Possible values: ON, OFF <SaveRequestStatistic>OFF</SaveRequestStatistic>
SpellCheckCache
CacheSize
NEW | 5.4.X
Between 0 and any desired number. Description: Parameter type: Number Default value: 150000 Possible values: <CacheSize>150000</CacheSize>
CacheSavePath
NEW | 5.4.X
To enable this option, make sure that AppServerX processes have write permissions to that file.Description: Parameter type: String Default value: None Possible values: Full or relative path to a file on a server. <CacheSavePath></CacheSavePath>
CacheLoadPath
NEW | 5.4.X
Description: Parameter type: String Default value: None Possible values: Full or relative path to a file on a server. <CacheLoadPath></CacheLoadPath>
CacheSaveInterval
NEW | 5.4.X
Description: Parameter type: Number Default value: 0 Possible values: <CacheSaveInterval>0</CacheSaveInterval>
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: 100 Possible values: 1..100 <MaxErrorsPercentToSuggest>100</MaxErrorsPercentToSuggest>
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: 11 Possible values: 2..Nm <MinQueryLengthToSkipSuggest>11</MinQueryLengthToSkipSuggest>
SimpleCacheSize
INACTIVE
This parameter is disabled by default due to the сustom dictionary functionality. It can be enabled if the custom dictionary functionality is not used or the same for all users. It is available for all languages including default and additional ones. This is a recommended parameter for the Server version of the application.Description: SimpleCacheSize parameter defines a number of suggestions that will be cached in the memory (RAM). Parameter type: Number Default value: 10000 Possible values: 0..Nm, where Nm is a number of suggestions stored in the cache. Depending on the RAM size this value may vary from 1,000 to 10,000+. <SimpleCacheSize>10000</SimpleCacheSize>
SuggestDepth
SuggestDepth parameter controls the depth and therefore the processing time of the engine to look for and generate proper suggestions. 1..100 The depth ranges from 0 which stands for the fastest processing time with least relevant suggestions to 100 which stands for the slowest processing time with the most relevant suggestions. Thus, if the processing time is not a problem, you can set 100 get the best set of suggestions for a misspelled word. For languages with huge wordlists, over several million, such as Brazilian Portuguese or German, it is highly recommended to set the SuggestDepth parameter default value to 30-50. This will help to improve the overall system performance without tangible losses of suggestions quality. Description: Parameter type: Number Default value: 80 Possible values: <SuggestDepth>80</SuggestDepth>
MaxSuggestions
UPD | 5.0.0
The overall system performance might be affected if the MaxSuggestion value is much higher than a given default value. The more suggestions the system is required to provide, the more time will be needed to process the text, detect errors and provide suggestions accordingly.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 <MaxSuggestions>3</MaxSuggestions>
SSCELock
SSCELock parameter regulates when SSCE spell checking engine should be running in a single thread instead of using multiply threads. ON, OFF It is recommended to have SSCELock parameter disabled to allow the engine process requests in multiply threads. Enabling this parameter might lead to significant performance degradation. Description: Parameter type: Boolean Default value: OFF Possible values: <SSCELock>OFF</SSCELock>
SSCE (SpellCheck Engine Options)
AllowAccentedCaps
AllowAccentedCaps parameter determines whether capital letters words containing accents should be accepted “correct” or considered as misspelled ones. If the default spell checking language is French or Canadian French, AllowAccentedCaps should be set to 0. For other cases, it is recommended to keep AllowAccentedCaps set to 1. Otherwise, with 0, you might experience slight performance degradation.Description: Parameter type: Boolean Default value: 1 Possible values: <AllowAccentedCaps>1</AllowAccentedCaps>
IgnoreCappedWord
Description: IgnoreCappedWord parameter defines whether words which start from a capital letter should be ignored or checked for any spelling errors. Parameter type: Boolean Default value: 0 Possible values: <IgnoreCappedWord>0</IgnoreCappedWord>
IgnoreAllCapsWord
Description: IgnoreAllCapsWord parameters defines whether capitalized words, all letters are capital, should be ignored or checked for any spelling errors. Parameter Type: Boolean Default value: 0 Possible values: <IgnoreAllCapsWord>0</IgnoreAllCapsWord>
IgnoreDomainNames
IgnoreDomainNames parameter regulates whether to ignore domain names and web addresses or not. The words are considered to be domain names if they contain at least one “dot” (“.”) and at least two alpha-numeric characters in a row.Description: Parameter type: Boolean Default value: 0 Possible values: <IgnoreDomainNames>0</IgnoreDomainNames>
IgnoreHtmlMarkups
IgnoreHtmlMarkups parameter regulates whether the text that is a part of HTML markup should be checked for spelling errors or ignored. In the code sample below, with the default value set to 1, the text that will be checked for any spelling errors is “Check your grammar and spelling mistakes as you types.”. The text surrounded by angle brackets will be ignored:<div class="text-container" id="scayt-div" contenteditable="true"> , <h3>, </h3> and</div>.Description: Parameter type: Boolean Default value: 0 Possible values: <div class="text-container" id="scayt-div" contenteditable="true">
<h3>Check your grammar and spelling mistakes as you types.</h3>
</div>
<IgnoreHtmlMarkups>0</IgnoreHtmlMarkups>
IgnoreMixedCase
Description: IgnoreMixedCase parameter regulates whether words containing mixed case letters (CamelCase) should be ignored. Parameter type: Boolean Default value: 0 Possible values: <IgnoreMixedCase>0</IgnoreMixedCase>
IgnoreMixedDigits
Description: IgnoreMixedDigits parameter regulates whether words containing digits should be ignored. Parameter type: Boolean Default value: 0 Possible values: <IgnoreMixedDigits>0</IgnoreMixedDigits>
IgnoreNonAlphaWord
Description: IgnoreNonAlphaWord parameter regulates whether words containing no alphabetic characters should be ignored. Parameter type: Boolean Default value: 1 Possible values: <IgnoreNonAlphaWord>1</IgnoreNonAlphaWord>
ReportMixedCase
Description: ReportMixedCase parameter regulates whether words with the mixed case should be reported. Parameter type: Boolean Default value: 0 Possible values: <ReportMixedCase>0</ReportMixedCase>
ReportDoubledWord
Description: ReportDoubledWord parameter regulates whether two occurrences of the same word in a row should be reported. Parameter type: Boolean Default value: 0 Possible values: <ReportDoubledWord>0</ReportDoubledWord>
ReportMixedDigits
Description: ReportMixedDigits parameter regulates whether words containing a combination of letters and digits should be reported. Parameter type: Boolean Default value: 1 Possible values: <ReportMixedDigits>0</ReportMixedDigits>
ReportUncapped
Description: ReportUncapped parameter regulates whether uncapitalized words which are present in the dictionaries in capitalized form only should be reported. Parameter type: Boolean Default value: 1 Possible values: <ReportUncapped>1</ReportUncapped>
CaseSensitive
Setting the default value to 0 will degrade system performance.Description: CaseSensitive parameter regulates whether words with different letter-case patterns should be treated as different words. Parameter type: Boolean Default value: 1 Possible values: <CaseSensitive>1</CaseSensitive>
SplitHyphenatedWords
Description: SplitHyphenatedWords parameter regulates whether hyphens (“-”) should be treated as words separators where each sub-word is checked individually. Parameter type: Boolean Default value: 1 Possible values: <SplitHyphenatedWords>1</SplitHyphenatedWords>
SplitContractedWords
SplitContractedWords option is intended for use with the languages which allow ad hoc contractions (e.g. French, Italian).Description: SplitContractedWords parameter regulates whether apostrophes should if necessary be treated as word separators, and each sub-word is checked individually. Parameter type: Boolean Default value: 0 Possible values: <SplitContractedWords>0</SplitContractedWords>
SplitWords
SplitWords option is intended for the use with languages which allow ad hoc concatenation of words (e.g. German, Finish, Danish, Swedish, Norwegian Bokmal).Description: SplitWords parameter regulates whether words if necessary should be treated as series of concatenated sub-words, and each sub-word is checked individually. Parameter type: Boolean Default value: 0 Possible values: <SplitWords>0</SplitWords>
StripPossessives
By default, the main language dictionaries do not contain possessive forms of words. Thus, it is highly recommended to have the StripPossessives parameter enabled.Description: StripPossessives parameter regulates whether possessive words endings 's and s' should be removed from the words before check spelling. Parameter type: Boolean Default value: 1 Possible values: <StripPossessives>1</StripPossessives>
SuggestPhonetic
The SuggestPhonetic and SuggestTypographical parameters are interconnected. Only one of these parameters can be enabled at a time. The typographical suggestions are enabled by default and have higher priority over phonetic suggestions. Thus, if you prefer to have suggestions given based on the phonetic similarity, you need to turn off typographical suggestions.Description: SuggestPhonetic parameter regulates whether corrections for misspelled words should be searched and suggested based on the phonetic (sounds-like) similarity. Parameter type: Boolean Default value: 0 Possible values: <SuggestPhonetic>0</SuggestPhonetic>
SuggestTypographical
Description: SuggestTypographical parameter regulates whether corrections for misspelled words should be searched and suggested based on the typographical similarity. Parameter type: Boolean Default value: 1 Possible values: <SuggestTypographical>1</SuggestTypographical>
SuggestSplitWords
Description: SuggestSplitWords parameter regulates whether the engine should attempt to split suggested words into two valid sub-words. Parameter type: Boolean Default value: 1 Possible values: <SuggestSplitWords>1</SuggestSplitWords>
GrammarCheckEngine
GrammarCheckProvider
UPD | 5.0.0
GrammarCheckProvider parameter sets a default grammar engine provider.Description: Parameter type: String Default value: langtool Possible values: langtool, atd, mixed <GrammarCheckProvider>langtool</GrammarCheckProvider>
PathToJavaVirtualMachine
NEW | 5.0.0
PathToJavaVirtualMachine parameter sets a path to Java Virtual Machine (JVM). None AppServer will try to autodetect the path to JVM. At least Java 8 is required for use of LanguageTool grammar engine.Description: Parameter type: String Default value: Possible values: <PathToJavaVirtualMachine></PathToJavaVirtualMachine>
JVMMaxMemorySizeMb
NEW | 5.0.0
JVMMaxMemorySizeMb parameter sets a maximum heap size in megabytes for LanguageTool in Java Virtual Machine (JVM). 256 64...NmDescription: Parameter type: Number Default value: Possible values: <JVMMaxMemorySizeMb>256</JVMMaxMemorySizeMb>
PathToNgramData
NEW | 5.6.3
Full or relative path to folder on a server with unzipped n-gram data sets.Description: PathToNgramData parameter defines a path to an unzipped folder with n-gram data sets. It is used to improve grammar quality by detecting errors with words that are often confused. Parameter type: String Default value: None Possible values: <PathToNgramData></PathToNgramData>
MixedProvider
INACTIVE
Description: MixedProvider tag is used to define several grammar engine providers and determine special rules for each engine to process certain grammar problems. Parameter type: String Default value: None <MixedProvider>
<Providers>atd,langtool</Providers>
<CustomPrioritiesFile>CustomPriorities.xml</CustomPrioritiesFile>
</MixedProvider>
ATDProvider
INACTIVE
Description: ATDProvider parameter defines an address of the external After the Deadline (ATD) grammar engine that can be used for grammar checking requests processing in a bundle with WebSpellChecker. Parameter type: String Default value: localhost:1049 Possible values: ATD server's host:port <ATDProvider>localhost:1049</ATDProvider>
GrammarIgnoreDictFile
INACTIVE
GrammarIgnoreDictFile parameters sets a path to a special file with list of grammar problems IDs comma separated that should be ignored.Description: Parameter type: String Default value: grammar_ignore.txt Possible values: Path to a custom directory with a special file *.txt file with grammar rules to ignore. <GrammarIgnoreDictFile>grammar_ignore.txt</GrammarIgnoreDictFile>
ThesaurusEngine
ThesaurusProvider
Description: ThesaurusProvider parameter specifies a provider of a Thesaurus engine that will be used for the Thesaurus tool functionality. Parameter type: String Default value: ssce Possible values: N/A <ThesaurusProvider>ssce</ThesaurusProvider>
Dictionaries
LangDictDir
UPD | 5.0.0
Description: LangDictDir parameter defines a path to the directory with available default language dictionaries. Parameter type: String Default value: LanguageDictionaries Possible values: Path to a custom directory with language dictionaries. <LangDictDir>LanguageDictionaries</LangDictDir>
SCNCDictionaryFolders
INACTIVE
Description: SCNCDictionaryFolders parameter defines a name of the directory where language dictionaries of the SCNC engine will be stored. Parameter type: String Default value: dicts Possible values: Path to a custom directory with language dictionaries used by the SCNC spellcheck engine. <SCNCDictionaryFolders>
<Folder>dicts</Folder>
</SCNCDictionaryFolders>
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: Path to a custom directory with user dictionaries files. <UserDictDir>UserDictionaries</UserDictDir>
EnableUserDictServer
NEW | 5.4.X
EnableUserDictServer parameter defines if the Server for personal User Dictionaries is enabled. User Dictionary Server allows to share personal user dictionaries between several WebSpellChecker Servers. You may find it useful if you have several WebSpellChecker Servers under a Load Balancer. For details, refer to Architecture diagram description.Description: Parameter type: Boolean Default value: false Possible values: <EnableUserDictServer>false</EnableUserDictServer>
UserDictServers
UPD | 5.0.0
Description: UserDictServers parameter defines a path to a remote server where user dictionaries should be stored and where to send the user dictionary requests accordingly. Parameter type: String Default value: localhost Possible values: host:port <UserDictServers>
<host>localhost</host>
</UserDictServers>
UserDictServerAddress
UPD | 5.0.0
Leave the tag empty if only you are not provided alternative link to licensing service. The default port number for a User Dictionary Server is 2882.Description: Parameter type: String Default value: 127.0.0.1:2882 Possible values: host_name:port <UserDictServerAddress>127.0.0.1:2880</UserDictServerAddress>
UDSeparationByCIDEnabled
INACTIVE
Description: UDSeparationByCIDEnabled parameter enables user dictionaries separation by customer ID in the UserDict directory. Parameter type: Boolean Default value: 1 Possible values: <UDSeparationByCIDEnabled>1</UDSeparationByCIDEnabled>
PathToMainCIDFile
INACTIVE
None The parameter joins several customer IDs. Values: path to .ini file. Content of .ini file for a customer that has 3 customer IDs: customerid maincid short_CID_1 short_CID_3 short_CID_2 sort_CID_3.Description: PathToMainCIDFile parameter defines a path to the main file with customer IDs. Parameter type: String Default value: main_cid.ini Possible values: <PathToMainCIDFile>main_cid.ini</PathToMainCIDFile>
CustomDictionaries
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: Path to a custom directory with custom dictionaries files. <CustDictDir>CustomDictionaries</CustDictDir>
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. <CustDictConfig>CustDictConfig.xml</CustDictConfig>
CustDictReloadOnFly
UPD | 5.0.0
ON – custom dictionaries are reloaded. OFF – custom dictionaries are not reloaded automatically.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: <CustDictReloadOnFly>ON</CustDictReloadOnFly>
Request
EnableRequestStatistic
NEW | 5.4.X
Description: Parameter type: String Default value: false Possible values: <EnableRequestStatistic>false</EnableRequestStatistic>
RequestStatisticDataType
NEW | 5.4.X
Contact [email protected] for more details on setting the database.Description: Parameter type: String Default value: File Possible values: <RequestStatisticDataType>File</RequestStatisticDataType>
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. <RequestStatisticFilePath>Logs/RequestStatistic.log</RequestStatisticFilePath>
RequestStatisticPeriodToSave
NEW | 5.4.X
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. 1...86400 For example, 600 means the statistical data is saved once in 600 seconds.Description: Parameter type: Number Default value: 600 Possible values: <RequestStatisticPeriodToSave>600</RequestStatisticPeriodToSave>
MaxApiRequestSize
NEW | 5.5.8
50000Description: MaxApiRequestSize parameter sets the maximum size of the API request body in bytes. Parameter type: Number Default value: Possible values: <MaxApiRequestSize>50000</MaxApiRequestSize>
Languages
Language
Besides, each language tag can have a list of sub-tags which allows defining additional language configuration specific to a particular language.Description: Language parameter defines a language ID, alias, and its options. Parameter type: String Default value: en_US Possible values: <Language Id="en_US">
</Language>
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”. <Language Id="en_US">
<Alias>am</Alias>
</Language>
GrammarCheckProvider
GrammarCheckProvider parameter sets a default grammar engine provider.Description: Parameter type: String Default value: langtool Possible values: langtool, atd, mixed <GrammarCheckProvider>langtool</GrammarCheckProvider>
<Language Id="en_US"> <Alias>am</Alias> <GrammarCheckProvider>langtool</GrammarCheckProvider> </Language>
GrammarCheckProviderOptions
Description: GrammarCheckProviderOptions defines grammar engine options, such as a language. Parameter type: String Default value: N/A Possible values: language=en <Language Id="en_US">
<Alias>am</Alias>
<GrammarCheckProvider>langtool</GrammarProvider>
<GrammarCheckProviderOptions>language=en</GrammarProviderOptions>
</Language>
SpellCheckProvider
Description: Parameter type: String Default value: ssce Possible values: <SpellCheckProvider>ssce</SpellCheckProvider>
ThesaurusEnabled
Description: Parameter type: Boolean Default value: false Possible values: <ThesaurusEnabled>true</ThesaurusEnabled>
EnableNgramData
NEW | 5.6.3
EnableNgramData parameter allows to enable n-gram data sets for a specific language. This option is available for the English, German, French, Spanish, and Dutch languages. Should be specified after <LanguageId="xx_XX">.Description: Parameter type: Boolean Default value: None / There is no such parameter in AppServerX.xml Possible values:
SpellEngineOptions
SpellEngineOptions parameter defines spell check engine options that should be applied for a specific language. Any of the parameters “options” described in SpellCheck Engine Options can be predefined for each language. Locale – language short code; SpellCheckProvider – spellcheck engine provider; Any of the SpellCheck Engine Options.Description: SpellEngineOptions parameter defines spell check engine options that should be applied to a specific language. Possible sub-tags: <SpellEngineOptions>
<Locale>am</Locale>
<SpellCheckProvider>ssce</SpellCheckProvider>
<Dictionary FullPath="ssceam2.clx">
<ForSuggest>no</ForSuggest>
</Dictionary>
<Dictionary FullPath="ssceam2s.clx">
<ForSuggest>yes</ForSuggest>
</Dictionary>
<Dictionary FullPath="keywords.clx"/>
<Dictionary FullPath="ssceam.tlx"/>
</SpellEngineOptions>