You may often need to change AppServer properties, settings, and parameters to do the following:
- configure personal user dictionaries,
- exclude the words from the dictionaries,
- apply changes made to your AppServer,
- upgrade or reinstall WebSpellChecker.
To verify if WebSpellChecker AppServer works properly, you may need to run one or several of four AppServer commands described in this section:
1. Start AppServer
1.1. Start AppServer on Windows
There are three possible options how you can start AppServer on Windows-based environments.
Option A: Go to Windows Start –> All Programs –> WebSpellChecker –> AppServer –> Start WebSpellChecker Application Server.
Option B: Open Command Prompt –> Switch to [WebSpellChecker_Installation_Path]/AppServer –> Run AppServerX -start
Option C:
- Go to Windows Start –> Control Panel –> Administrative Tools –> Services.
- Find WebSpellChecker Application Server Service on the list of all services.
- Click Start.
1.2. Start AppServer on Linux
To start AppServer on Linux, run the start.sh script using the following command below:
sudo sh <WebSpellChecker_Installation_Path>/WSC/AppServer/start.sh
Or your can also run the start.sh script from the AppServer directory:
/<WebSpellChecker_Installation_Dir>/WSC/AppServer/# sh start.sh
2. Stop AppServer
1.1. Stop AppServer on Windows
There are three possible options how you can stop AppServer on Windows-based environments.
Option A: Go to Windows Start –> All Programs –> WebSpellChecker –> AppServer –> Stop WebSpellChecker Application Server
Option B: Open Command Prompt –> Switch to [WebSpellChecker_Installation_Path]/AppServer –> Run AppServerX -stop
Option C:
- Go to Windows Start –> Control Panel –> Administrative Tools –> Services.
- Find WebSpellChecker Application Server Service on the list of all services.
- Click Stop.
1.2. Stop AppServer on Linux
To stop AppServer on a Linux-based environment, run the stop.sh script from the AppServer directory:
sudo sh <WebSpellChecker_Installation_Path>/WSC/AppServer/stop.sh
Or your can also run the stop.sh script from the AppServer directory:
/<WebSpellChecker_Installation_Dir>/WSC/AppServer/# sh stop.sh
3. Check AppServer Version
To check the current version of WebSpellChecker Server package, start AppServer Service and check its version as shown below.
Option A. Direct connection to AppServer Service
To verify the version, use ?cmd=ver сommand:
http(s)://your_host_name:2880/?cmd=ver
The port 2880 is the default port used by AppServer Service.
If you specified a custom port number, use the next following link:
Here is an example of a correct version response for WebSpellChecker Server:
{ "Copyright": "(c) 2000-2019 WebSpellChecker LLC", "ProductWebsite": "webspellchecker.com", "ProgramVersion": "5.5.4.2 x64 master:4fb43001 (1893) #41", "PackageVersion": "5.5.4.2 master:58e1bc7 (639) #47" }
Option B. Connection to the Service via FastCGI, SSRV.cgi component, and Web or Java Application Server
To verify the version, use ?cmd=ver сommand:
http(s)://your_host_name/wscservice/script/ssrv.cgi?cmd=ver
If you specified a custom port number for a web server or a Java application server, use the following link:
Here is a correct version response:
(c) 2000-2019 WebSpellChecker LLC All rights reserved. | |
Program name: | ssrv |
Program version: | x.x.x.x x64 master:xxxxxxx (xxx) #xx for Windows or Linux |
4. Check AppServer Status
To verify if WebSpellChecker Server works properly, you need to start AppServer Service and check its status.
Option A. Direct connection to the AppServer Service
To verify status of AppServer engines (SpellCheck, Grammar Check, and Thesaurus), use ?cmd=status сommand:
http(s)://your_host_name:2880/?cmd=status
The port 2880 is the default port used by AppServer Service.
Here is a correct status response:
{ "SpellCheckEngine": { "active": true }, "GrammarCheckEngine": { "active": true }, "ThesaurusEngine": { "active": true } }
Option B. Connection to the Service via FastCGI, SSRV.cgi component and Web or Java Application Server
To verify the status of the AppServer engines (SpellCheck, Grammar Check, and Thesaurus) via FastCGI, SSRV.cgi component, and web server, use the following command:
http(s)://your_host_name/wscservice/script/ssrv.cgi?cmd=status
Here is a correct status response:
Spell Check Engine is ACTIVE Grammar Engine is ACTIVE Thesaurus Engine is ACTIVE Please find below the description of the statuses that are received from SSRV component: 'ACTIVE' status means that an Engine works properly. 'NOT ACTIVE' status means that an Engine is not enabled or does not work properly. For more details and assistance, please contact the technical support team at [email protected].