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


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>

Back to the top...


Threads

MaxConnectionThreads UPDATED IN | 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>

Back to the top...


ConnectionThreadPriority UPDATED IN | 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
<ConnectionThreadPriority>normal</ConnectionThreadPriority>

Back to the top...


WorkerThreads UPDATED IN | 5.0.0

Description:WorkerThreads parameter sets the number of worker threads which perform spell and grammar checks, thesaurus work, etc.
Parameter type:Number
Default value:

8

Possible values:
  • 0 – unlimited of worker threads.

  • Nm is a number of the processor cores * 2.

<WorkerThreads>8</WorkerThreads>

Back to the top...


Memory

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 the low memory state.

Parameter type:Boolean
Default value:OFF
Possible values:ON, OFF
<AggressiveConserve>OFF</AggressiveConserve> 

Back to the top...


PercentLowMem


Description:

PercentLowMem parameter defines a percent of the free physical memory remaining before the system will turn in low memory conditions state.

Parameter type:Number
Default value:5
Possible values:1..100
<PercentLowMem>5</PercentLowMem>

Back to the top...


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>

Back to the top...


QueueSize UPDATED IN | 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>

Back to the top...


ClientTimeout UPDATED IN | 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>

Back to the top...


ServerTimeout UPDATED IN | 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>

Back to the top...


KeepAlive

EnableKeepAlive UPDATED IN | 5.0.0

Description:EnableKeepAlive parameter enables a keep alive connection.
Parameter type:Boolean
Default value:true
Possible values:
  • true
  • false
<EnableKeepAlive>true</EnableKeepAlive>

Back to the top...


KeepAliveTimeout UPDATED IN | 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>

Back to the top...


MaxKeepAliveRequests UPDATED IN | 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
<MaxKeepAliveRequests>0</MaxKeepAliveRequests>

Back to the top...


SSL

EnableSSL UPDATED IN | 5.0.0

Description:EnableSSL parameter defines whether a secure connection should be enabled.
Parameter type:Boolean
Default value:false
Possible values:
  • true
  • false
<EnableSSL>false</EnableSSL>

Back to the top...


SSLCertificateSource NEW IN | 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:
  • FILE – SSL certificate file.
  • STORE – SSL certificate exported from Windows Certificate Store.
<SSLCertificateSource>STORE</SSLCertificateSource>

Back to the top...


SSLCertificateStoreSettings NEW IN | 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>

Back to the top...


SSLCertificateCommonName NEW IN | 5.5.3

This parameter can be specified for Windows only.

Description:

Server name protected by the SSL certificate (the fully qualified HostName).

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 server name

Example:

<SSLCertificateCommonName>Fully qualified server name example</SSLCertificateCommonName>

Back to the top...


SSLCertificateStore NEW IN | 5.5.3

This parameter can be specified for Windows only.

Description:

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:
  • MY (Personal), 
  • ROOT (Trusted Root Certification Authorities), 
  • TRUST (Enterprise Trust), 
  • CA (Intermediate Certification Authorities), 
  • USERDS (Active Directory User Object).

Example:

<SSLCertificateStore>MY</SSLCertificateStore>

Back to the top...


TLSVersion UPDATED IN | 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
<TLSVersion>TLSV1_2</TLSVersion>

Back to the top...


SSLCertificateFile NEW IN | 5.0.0

Description:SSLCertificateFile parameter specifies a path to an SSL certificate file.
Parameter type:String
Default value:None
Possible values:
  • Linux-based servers: Path to a certificate file in a *.pem format, e.g. “/opt/WSC/AppServer/cert.pem”
  • Windows-based servers: Path to a certain file in a *.pfx format (PKCS #12) containing a certificate and corresponding private key accordingly, e.g. “C:/Program Files/WebSpellChecker/AppServer/certificate.pfx”
<SSLCertificateFile></SSLCertificateFile>

Back to the top...


SSLCertificateKeyFile NEW IN | 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>

Back to the top...


SSLCertificatePassword NEW IN | 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>

Back to the top...


SSLCertificateAuthorityLocation NEW IN | 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>

Back to the top...



SSLCertificateLoadDefaultCA NEW IN | 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:
  • true
  • false
<SSLCertificateLoadDefaultCA>false</SSLCertificateLoadDefaultCA>

Back to the top...


Compression

EnableCompression NEW IN | 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
<EnableCompression>true</EnableCompression>

Back to the top...


MinSizeThreshold NEW IN | 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.
<MinSizeThreshold>150</MinSizeThreshold>

Back to the top...


CompressionLevel NEW IN | 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.
<CompressionLevel>6</CompressionLevel>

Back to the top...


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>

Back to the top...


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>

Back to the top...



LicenseTicket NEW IN | 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>

Back to the top...


LicenseServerLink NEW IN | 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.
<LicenseServerLink></LicenseServerLink>

Back to the top...


FloatingLicensing

EnableFloatingLicensing NEW IN | 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.
<LicenseServerLink></LicenseServerLink>

Back to the top...


FloatingLicenseServer NEW IN | 5.4.X


Description:

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. 

Parameter type:String
Default value:127.0.0.1:2881
Possible values:host_name:port
<FloatingLicenseServer>127.0.0.1:2881</FloatingLicenseServer>

Back to the top...


EnableLicenseSSL NEW IN | 5.4.X


Description:
EnableLicenseSSL parameter allows to enable a secure connection between WebSpellChecker Server App and a License Server.

If you have enabled SSL during the WebSpellChecker installation process, specify this option as ‘true’.

Parameter type:Boolean
Default value:false
Possible values:
  • true
  • false
<EnableLicenseSSL>false</EnableLicenseSSL>

Back to the top...


LicenseTLSVersion NEW IN | 5.4.X


Description:
LicenseTLSVersion parameter specifies the Transport Layer Security (TLS) version.
Parameter type:String
Default value:TLSV1_2
Possible values:TLSV1, TLSV1_1, TLSV1_2
<LicenseTLSVersion>TLSV1_2</LicenseTLSVersion>

Back to the top...



FailSafety

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
<MinRestartInterval>10</MinRestartInterval>

Back to the top...


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.

<CascadeSize>2</CascadeSize>

Back to the top...


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.

<WaitShutdownInterval>60</WaitShutdownInterval>

Back to the top...


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
<CheckTimeout>5</CheckTimeout>

Back to the top...


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
<WaitResponseTimeout>60</WaitResponseTimeout>

Back to the top...


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>

Back to the top...



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>

Back to the top...


PrioritizationLevel UPDATED IN | 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.

<PrioritizationLevel>information</PrioritizationLevel>

Back to the top...


Subsystems UPDATED IN | 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, thesaurus, 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.
<Subsystems>all</Subsystems>

Back to the top...


SaveRequestStatisticINACTIVE


Description:

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.

Parameter type:Boolean
Default value:OFF
Possible values:ON, OFF
<SaveRequestStatistic>OFF</SaveRequestStatistic>

Back to the top...


SpellCheckCache

CacheSize NEW IN | 5.4.X


Description:
CacheSize parameter defines a number of misspellings and their suggestions to be cached in RAM.
Parameter type:Number
Default value:150000
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.
<CacheSize>150000</CacheSize>

Back to the top...



CacheSavePath NEW IN | 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.
<CacheSavePath></CacheSavePath>

Back to the top...


CacheLoadPath NEW IN | 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.
<CacheLoadPath></CacheLoadPath>

Back to the top...


CacheSaveInterval  NEW IN | 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 CacheLoadPath parameter.
Parameter type:Number
Default value:0
Possible values:
  • 0 means the save is turned off. 
  • You can specify any number of misspellings to enable cache saving that suits your particular WebSpellChecker needs.
<CacheSaveInterval>0</CacheSaveInterval>

Back to the top...


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>

Back to the top...


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>

Back to the top...


SimpleCacheSize UPDATED IN | 5.0.0


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+.

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.

<SimpleCacheSize>10000</SimpleCacheSize>

Back to the top...


SuggestDepth

Description:

SuggestDepth parameter controls the depth and therefore the processing time of the engine to look for and generate proper suggestions.

Parameter type:Number
Default value:80
Possible values:

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. 

<SuggestDepth>80</SuggestDepth>

Back to the top...


MaxSuggestions UPDATED IN | 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:8
Possible values:0..Nm, where Nm is a maximal possible number (an integer) of suggestions. 

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.

<MaxSuggestions>8</MaxSuggestions> 

Back to the top...


SSCELock


Description:

SSCELock parameter regulates when SSCE spell checking engine should be running in a single thread instead of using multiply threads. 

Parameter type:Boolean
Default value:OFF
Possible values:

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. 


<SSCELock>OFF</SSCELock>

Back to the top...


SSCE (SpellCheck Engine Options)

AllowAccentedCaps

Description:

AllowAccentedCaps parameter determines whether capital letters words containing accents should be accepted “correct” or considered as misspelled ones.

Parameter type:Boolean
Default value:1
Possible values:
  • 0 – words containing accented capitals are considered misspelled;
  • 1 – capital letters words containing accents are considered as correct 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.

<AllowAccentedCaps>1</AllowAccentedCaps>

Back to the top...


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:
  • 0 – words which start from a capital letter are checked for spelling errors;
  • 1 – words which start from a capital letter are ignored.
<IgnoreCappedWord>0</IgnoreCappedWord> 

Back to the top...


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:1
Possible values:
  • 0 – all caps words are checked for spelling errors;
  • 1 – all caps words are ignored.
<IgnoreAllCapsWord>1</IgnoreAllCapsWord>

Back to the top...


IgnoreDomainNames

Description:

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.

Parameter type:Boolean
Default value:0
Possible values:
  • 0 – domain names and web addresses are checked for spelling errors;
  • 1 – domain names and web addresses are ignored.
<IgnoreDomainNames>0</IgnoreDomainNames>

Back to the top...


IgnoreHtmlMarkups

Description:

IgnoreHtmlMarkups parameter regulates whether the text that is a part of HTML markup should be checked for spelling errors or ignored.

Parameter type:Boolean
Default value:0
Possible values:
  • 0 – HTML tags and content surrounded by start and end tags are checked for spelling errors;
  • 1 – HTML tags are ignored and only the content surrounded by start and end tags is checked for spelling errors. Any text surrounded by angle brackets (<...>) or the text following an ampersand (&) until a semicolon (;) will be 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>.

<div class="text-container" id="scayt-div" contenteditable="true"> 
     <h3>Check your grammar and spelling mistakes as you types.</h3>
</div> 
<IgnoreHtmlMarkups>0</IgnoreHtmlMarkups>

Back to the top...


IgnoreMixedCase

Description:IgnoreMixedCase parameter regulates whether words containing mixed case letters (CamelCase) should be ignored.
Parameter type:Boolean
Default value:0
Possible values:
  • 0 – words with mixed case letters are checked for spelling errors.
  • 1 – words with mixed case letters are ignored.
<IgnoreMixedCase>0</IgnoreMixedCase>

Back to the top...


IgnoreMixedDigits

Description:IgnoreMixedDigits parameter regulates whether words containing digits should be ignored.
Parameter type:Boolean
Default value:1 (for WSC v.5.3.0 and higher)
Possible values:
  • 0 words with numbers are checked for spelling errors;
  • 1 words with numbers are ignored and determined as correct.
<IgnoreMixedDigits>1</IgnoreMixedDigits>  

Back to the top...


IgnoreNonAlphaWord

Description:IgnoreNonAlphaWord parameter regulates whether words containing no alphabetic characters should be ignored.
Parameter type:Boolean
Default value:1
Possible values:
  • 0 – words containing no alphabetic characters are checked for spelling errors.
  • 1 – words containing no alphabetic characters are ignored. For example, “991” is ignored.
<IgnoreNonAlphaWord>1</IgnoreNonAlphaWord>

Back to the top...


ReportMixedCase

Description:ReportMixedCase parameter regulates whether words with the mixed case should be reported.
Parameter type:Boolean
Default value:0
Possible values:
  • 0 – words containing mixed case letters are reported;
  • 1 – words containing mixed case letters are ignored.
<ReportMixedCase>0</ReportMixedCase>

Back to the top...


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:
  • 0 – doubled words are not reported;
  • 1 – doubled words are reported.
<ReportDoubledWord>0</ReportDoubledWord>

Back to the top...


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:
  • 0 – words containing a combination of letters and digits are not reported.
  • 1 – words containing a combination of letters and digits are reported.
<ReportMixedDigits>0</ReportMixedDigits>

Back to the top...


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:
  • 0 – words containing no alphabetic characters are checked for spelling errors.
  • 1 – uncapitalized words which are present in the dictionaries in capitalized form only are reported. For example, “ukraine” is reported.
<ReportUncapped>1</ReportUncapped>

Back to the top...


CaseSensitive

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:
  • 0 – words containing different case patterns are treated as identical. Example: “WebSpellChecker” and “webspellchecker” are identical words.
  • 1 – words containing different case patterns are treated as two separate words.

Setting the default value to 0 will degrade system performance.

<CaseSensitive>1</CaseSensitive>

Back to the top...


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:
  • 0 – hyphenated words are checked as single words.
  • 1 – hyphens are treated as word separators, and each sub-word is checked individually. This type of words splitting takes place only if the hyphenated form of the word does not exist. The word is considered to be correct if all its sub-words are correctly spelled.
<SplitHyphenatedWords>1</SplitHyphenatedWords>

Back to the top...


SplitContractedWords

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:
  • 0 – words with apostrophes are checked as single words.
  • 1 – apostrophes are treated as words separators, and each sub-word checked individually. This word splitting will take place if the contracted form of the word is not found in the dictionary. In this case, the word will be considered as a correct if all its sub-words are correctly spelled.

SplitContractedWords option is intended for use with the languages which allow ad hoc contractions (e.g. French, Italian).

<SplitContractedWords>0</SplitContractedWords>

Back to the top...


SplitWords

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:
  • 0 – words are checked entirely for spelling errors.
  • 1 – words if necessary are treated as series of concatenated sub-words, and each their sub-words are checked individually. Such words splitting takes place only if the original word is not found in the dictionary. In this case, the word will be considered as a correct if all its words containing two or more words are correctly spelled. For example, “dumptruckdriver” was not found in the dictionary, the engine makes an attempt to locate its valid sub-words (“dump”, “truck”, and “driver”). If all its sub-words are correctly spelled then the word “dumptruckdriver” will be considered as a correct one.

SplitWords option is intended for the use with languages which allow ad hoc concatenation of words (e.g. German, Finish, Danish, Swedish, Norwegian Bokmal).

<SplitWords>0</SplitWords>

Back to the top...


StripPossessives

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:
  • 0 – possessive words forms are checked for spelling.
  • 1 – possessives of the form 's and s' are removed from words before check spelling.

By default, the main language dictionaries do not contain possessive forms of words. Thus, it is highly recommended to have the StripPossessives parameter enabled.

<StripPossessives>1</StripPossessives>

Back to the top...


SuggestPhonetic


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:
  • 0 corrections are not search based on the phonetic similarity.
  • 1  corrections for misspellings are searched and suggested based on the phonetic similarity.

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.

<SuggestPhonetic>0</SuggestPhonetic>

Back to the top...


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:
  • 0 – corrections are not search based on the typographical similarity.
  • 1 – corrections for misspellings are searched and suggested based on the typographical similarity.
<SuggestTypographical>1</SuggestTypographical>

Back to the top...


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:
  • 0 – slit words are not suggested.
  • 1 – suggested words can be split into two valid sub-words. For example, “theboy”, one of its suggestions will be “the boy”.
<SuggestSplitWords>1</SuggestSplitWords>

Back to the top...



GrammarCheckEngine

GrammarCheckProvider UPDATED IN | 5.0.0


Description:

GrammarCheckProvider parameter sets a default grammar engine provider.

Parameter type:String
Default value:langtool
Possible values:langtool, atd, mixed
<GrammarCheckProvider>langtool</GrammarCheckProvider>

Back to the top...


PathToJavaVirtualMachine NEW IN | 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-8-oracle/jre/lib/amd64/server/libjvm.so'
  • Path to JVM on Windows-based environments: 'C:/Program Files/Java/jre1.8.0_121/bin/server/jvm.dll'

At least Java 8 is required for use of LanguageTool grammar engine.

<PathToJavaVirtualMachine></PathToJavaVirtualMachine>

Back to the top...


JVMMaxMemorySizeMb NEW IN | 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:

256

Possible values:

64...Nm

  • 64MB is the minimum possible size that can be used by LanguageTool in JVM but for a single language (e.g. English grammar checking).
  • Nm value will be higher as more grammar languages will be enabled. The maximum allowed value directly depends on the available RAM. In general, 512MB will be sufficient for LanguageTool in JVM for all supported grammar languages. 
<JVMMaxMemorySizeMb>256</JVMMaxMemorySizeMb>

Back to the top...


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>

Back to the top...


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>

Back to the top...


GrammarIgnoreDictFile INACTIVE


Description:

GrammarIgnoreDictFile parameters sets a path to a special file with list of grammar problems IDs comma separated that should be ignored.

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>

Back to the top...


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>

Back to the top...


Dictionaries

LangDictDir UPDATED IN | 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>

Back to the top...


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>

Back to the top...


UserDictionaries

UserDictDir UPDATED IN | 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>

Back to the top...


EnableUserDictServer NEW IN | 5.4.X


Description:

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.

Parameter type:Boolean
Default value:false
Possible values:
  • true
  • false
<EnableUserDictServer>false</EnableUserDictServer>

Back to the top...


UserDictServers UPDATED IN | 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>

Back to the top...


UserDictServerAddress UPDATED IN | 5.5.0


Description:
UserDictServerAddress specifies the address, host or domain name, and port number, where the User Dictionary Server is located. This is a shared location for all dictionary files. 

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.

Parameter type:String
Default value:127.0.0.1:2882
Possible values:host_name:port
<UserDictServerAddress>127.0.0.1:2880</UserDictServerAddress>

Back to the top...


UDSeparationByCIDEnabled INACTIVE


Description:UDSeparationByCIDEnabled parameter enables user dictionaries separation by customer ID in the UserDict directory.
Parameter type:Boolean
Default value:1
Possible values:
  • 0 – user dictionaries separation is disabled.
  • 1 – user dictionaries separation is enabled. A new sub-directory will be created for each customer ID in the UserDict directory.
<UDSeparationByCIDEnabled>1</UDSeparationByCIDEnabled>

Back to the top...


PathToMainCIDFile INACTIVE


Description:PathToMainCIDFile parameter defines a path to the main file with customer IDs.
Parameter type:String
Default value:main_cid.ini
Possible values:

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.

<PathToMainCIDFile>main_cid.ini</PathToMainCIDFile>

Back to the top...


CustomDictionaries

CustDictDir UPDATED IN | 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>

Back to the top...


CustDictConfig UPDATED IN | 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>

Back to the top...


CustDictReloadOnFly UPDATED IN | 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.

<CustDictReloadOnFly>ON</CustDictReloadOnFly>

Back to the top...


Request

EnableRequestStatistic NEW IN | 5.4.X


Description:
EnableRequestStatistic parameter enables or disables saving of request statistics.
Parameter type:String
Default value:false
Possible values:
  • true
  • false
<EnableRequestStatistic>false</EnableRequestStatistic>

Back to the top...


RequestStatisticDataType NEW IN | 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 support@webspellchecker.net for more details on setting the database.

<RequestStatisticDataType>File</RequestStatisticDataType>

Back to the top...


RequestStatisticFilePath NEW IN | 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>

Back to the top...


RequestStatisticPeriodToSave NEW IN | 5.4.X


Description:
RequestStatisticPeriodToSave can be used only for database as RequestStatisticOutput. Statistical data is stored into the database each RequestStatisticPeriodToSave seconds.
Parameter type:Number
Default value:600
Possible values:

1...86400

For example, 600 means the statistical data is saved once in 600 seconds.

<RequestStatisticPeriodToSave>600</RequestStatisticPeriodToSave>

Back to the top...


Languages

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>

Above all this, each language tag may have a list of sub-tags which allows defining additional language configuration specific to a particular language.

Back to the top...


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>

Back to the top...


GrammarCheckProvider


Description:

GrammarCheckProvider parameter sets a default grammar engine provider.

Parameter type:String
Default value:langtool
Possible values:langtool, atd, mixed
<GrammarCheckProvider>langtool</GrammarCheckProvider>

<Language Id="en_US"> <Alias>am</Alias> <GrammarProvider>langtool</GrammarProvider> </Language>

Back to the top...


GrammarProviderOptions


Description:GrammarProviderOptions 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> 
	<GrammarProvider>langtool</GrammarProvider> 
	<GrammarProviderOptions>language=en</GrammarProviderOptions> 
</Language>

Back to the top...


SpellCheckProvider NEW IN | 5.4.X


Description:
SpellCheckProvider specifies an engine used to check the spelling for the selected language.
Parameter type:String
Default value:ssce
Possible values:
  • ssce
  • enchant
  • scnc
<SpellCheckProvider>ssce</SpellCheckProvider>

Back to the top...


ThesaurusEnabled NEW IN | 5.4.X

Error rendering macro 'excerpt-include'

User 'null' does not have permission to view the page.

Back to the top...


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.

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>

Back to the top...