Main AppServer Commands

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.  

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:

1. Go to Windows Start –> Control Panel –> Administrative Tools –> Services.
2. Find WebSpellChecker Application Server Service on the list of all services.
3. 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:

1. Go to Windows Start –> Control Panel –> Administrative Tools –> Services.
2. Find WebSpellChecker Application Server Service on the list of all services.
3. Click Stop.

1.1. 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 verify if WebSpellChecker Server works properly, you need to start AppServer Service and check its version.

Option A. Direct connection to AppServer Service

To verify the WebSpellChecker server version, use the following command: 

If you specified a custom port number, use the next following link: 

Here is an example of a correct version response for WebSpellChecker Server x.x.x.x on a Linux server:

{"COPYRIGHT":"(c) 2000-2019 WebSpellChecker LLC","PRODUCT WEBSITE":"webspellchecker.com","PROGRAM VERSION":"x.x.x x64 master:xxxxxxx (xxxx) #xx"}

Option B. Connection to the Service via FastCGI, SSRV.cgi component, and Web or Java Application Server

Use the following link: 

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 for WebSpellChecker Server x.x.x on a Windows server where x.x.x is a current WebSpellChecker version number:

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 very AppServer status, use the following link to check the status of connection to the service to verify engines status (SpellCheck, Grammar Check, and Thesaurus):

Here is a correct status response for Spell Check, Grammar, and Thesaurus engines of WebSpellChecker Server:

{
   "Spell Check Engine": {
       "active": true
   },
   "Grammar Check Engine": {
       "active": true
   },
   "Thesaurus Engine": {
       "active": true
   }
}

Option B. Connection to the Service via FastCGI, SSRV.cgi component and Web or Java Application Server

To very AppServer status, use the following link to check the status of connection to the service to verify engines status (SpellCheck, Grammar Check, and Thesaurus) for FastCGI, SSRV.cgi component, and web server:

Here is a correct status response for Spell Check, Grammar, and Thesaurus engines of WebSpellChecker Server for FastCGI:

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