You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

This step-by-step guide is intended to outline the main steps for the WebSpellChecker application installation on Windows Server with Apache Tomcat Application Server. In this guide we will run you through the whole installation process from downloading installation packages to embedding spell/grammar checking functionality to your web-based system.

Before you begin:

  1. Check if your environment configuration meets Installation requirements.
  2. Acknowledge with Architecture diagram.

  3. Make sure that you have a valid license:

    First of all you need to get a valid License Ticket ID to proceed with the license activation. Depending on the server license type, it may be a commercial (e.g. 1 year) or a 30-day trial license. Except the validity period, there is no difference between ticket types from the technical perspective.

    Good to know:

    • If you do not have a license yet, you can obtain it using one of the following ways:
    • Starting from v5.8.1 released on December 30, 2020, the license is no longer validated by or tied to the hardware characteristics of a machine or server. License for older versions of the packages is hardware-dependent. 
    • If you are migrating WebSpellChecker from one server to another, you will need to deactivate (detach) a license on the current server and then reactivate it on a new one. Check carefully the Migrating License to New Server guide under the Licensing section.
    • If you have problems with your license, contact us.

1. Download Installation Package

Download WebSpellChecker application package for a corresponding version of your operating system (OS). By default, it is provided on a license purchase or maintenance renewal. You can also request it contacting us at [email protected]. 

2. Install WebSpellChecker


Follow the instructions in the setup window, selecting the options that are appropriate to your environment. It is recommended that you install the Application Server as a service. To do this, select the “Install Application Server as service” checkbox.

2.1. Run the installation package (e.g. wsc_app_win_x64_release_5.4.x.x_xx.exe). 

2.2. Before proceeding with installation, read and confirm WebSpellChecker Software License Agreement.

Visit WebSpellChecker Software License Agreement page to acknowledge with the full terms and conditions of WebSpellChecker Software.



2.3. Select location. The installation process starts with the Select WebSpellChecker Location dialog. This is where WebSpellChecker will be installed.

2.4. Select components. It is recommended to select Full installation to install all the components: AppServer, WebInterface and Samples. However, you may choose not to install a Samples component. It is optional and provides sample web pages that will be helpful for further setup and integration of WebSpellChecker with your system.

2.5. Web/Application Server settings. The properly configured Web or Application Server is required for correct work of the application. 

  • Choose Java Application Server (Apache Tomcat, Oracle WebLogic Server, etc.) option to run WebSpellChecker on the Apache Tomcat Application Server.

This section outlines the details of wscservice.war deployment on Apache Tomcat (static files and all requests to engines are served) or binding only static files and the rest of the service requests such as spelling or grammar checking, directly connecting with AppServer.

Option A: Binding of Static Files and Serving Service Requests by AppServer

To bind only static files and the rest of the service requests such as spelling or grammar checking directly connecting with AppServer:

1. Stop Apache Tomcat before modifying the configuration files. 

2. Add the following paths to the server.xml file inside the <Host name=“localhost”  appBase="webapps" unpackWARs="true" autoDeploy="true"> tag:

<Context docBase="C:/Program Files/WebSpellChecker/WebComponents/WebInterface" path="/wscservice" />
<Context docBase="C:/Program Files/WebSpellChecker/WebComponents/Samples" path="/wscservice/samples" />

3. If you plan to host WebSpellChecker and your web app(s) on different domains, you might face the CORS issues. To avoid this, add the Access-Control-Allow-Headers to enable cross-origin requests to the Apache Tomcat settings. For this you can use CORS filter.

4. Start Apache Tomcat after modifying the configuration files.

Option B: Serving both Static Files and Service Requests by Java Application Server (deployment of wscservice.war)

To deploy wscervice.war on Apache Tomcat for binding static files and all service requests to engines such as spelling or grammar checking: 

1. Create the WSC_DIR environment variable. It must be pointed to the WebSpellChecker Server installation directory.

  • Go to Apache Tomcat System Properties. Open the Advanced tab. In this tab, locate the Environment Variables... button. 

  • Go to the section with System variables. In this section, click New… to create a new variable.

  • A new pop-up window New System Variable will be open. Type a variable name and variable value as follows:

2. Deploy wscservice.war on your Apache Tomcat Application Server. 

  • Copy the wscservice.war file from <WSC_DIR>/J2EEServerComponents to the Apache Tomcat /webapps directory.
  • Start Apache Tomcat, or stop and then start if it is already running.

Note that the wscservice.war file should be unpacked automatically. Otherwise, unpack it manually.

2.6. Specify WebSpellChecker Service URL. Specify a protocol, full domain name, port and virtual directory to the application. 

The default ports for Apache Tomcat Application Server are 8080 and 8443 for HTTP and HTTPS protocols respectively.

2.7. Select WebSpellChecker Start Menu Folder. Choose a program name which will be used as Start Menu item.

2.8. Click Install to start the installation process.

2.9. As soon as the installation process has been completed, click Finish to close the installation dialog. 

3. Activate License

Refer to  the License Activation on Windows guide if you are installing WebSpellChecker Server for the first time to find out how to activate a license on a Windows-based server.

4. Configure Grammar Engine

The Grammar engine requires Java 8 and higher. The installation wizard will try to auto-detect a path to an existing Java Virtual Machine (JVM). If no path is found, you will be asked to specify the path to JVM using the next window:

You have an option to set a path to JVM manually or change the auto-detected path to your custom one. Please visit Enabling Grammar Engine to find out more.

5. Verify Operability

To verify if WebSpellChecker Server works properly, you need to start AppServer Service and check its status and version.

Option A (Direct connection to the AppServer Service):

  • Check Version: http(s)://your_domain_name:2880/?cmd=ver
  • Check Status: http(s)://your_domain_name:2880/?cmd=status

The port 2880 is the default port used by AppServer Service.

If you specified a custom port number for the AppServer Service, use the next form of the link: http(s)://your_host_name:port/?cmd=ver

Option B (Connection to the Service via FastCGI, SSRV.cgi component) and Application Server):

  • Check Version: http(s)://your_domain_name/spellcheck/script/ssrv.cgi?cmd=ver
  • Check Status: http(s)://your_domain_name/spellcheck/script/ssrv.cgi?cmd=status
  • Default Samples: http(s)://your_domain_name/spellcheck/samples/

If you specified a custom port number for Apache Tomcat, use the next form of the link: http(s)://your_host_name:port/spellcheck/script/ssrv.cgi?cmd=ver

WebSpellChecker Version

Here is a correct version response for WebSpellChecker Server 5.4.x on a Windows server:

(c) 2000-2019 WebSpellChecker LLC

All rights reserved.

www.webspellchecker.net

Program name:ssrv
Program version:5.4.x.x x64 master:xxxxxxx (xxx) #xx for Windows

WebSpellChecker Server Status

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

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

WebSpellChecker Demo Samples

Here is the correct view of the WebSpellChecker demo samples:


6. Integrate WebSpellChecker

Integrate WebSpellChecker products into your web application.

Option A. Integration Guides

Visit Products and Integrations Guides to lean more how to get started with WebSpellChecker products.

WProofreader

Try our WProofreader. It is based on SpellCheckAsYouType (SCAYT) core, designed to simplify the integration and combine functionality of proofread as you type functionality and proofread in a dialog.

Here are the main benefits of using WProofreader:

  • Easy to get started. A single script for all editable fields in a web app;
  • Auto-search functionality which detects editable fields on a web page and enables proofreading functionality;
  • Proofread as you type functionality on multiply languages. Spell checking functionality is supported for 16 default languages and 152 additional languages, grammar checking functionality is available for 14 out of 16 default languages;
  • Simplified box with corrections for spelling and grammar problems;
  • A new badge button with the WebSpellChecker Proofreader settings;

  • Supported in all modern browsers such as Chrome, Firefox, Internet Explorer 11+, MS Edge, and Safari.

Refer to Get Started with WProofreader Server (autoSearch) guide for more information.

Option B. Demo Samples

Depending on the type of elements (HTML native elements, rich text editors) where the spelling/grammar check functionality is needed, you may choose and use the demo samples shipped with the WebSpellChecker Server package. 

To access the default samples, go to the following page:  https://your_host_name:port/spellcheck/samples/. The default samples contain all the necessary samples and instructions that will help with the integration of the WebSpellChecker products. Moreover, each sample contains detailed development documentation with a list of methods and parameters available.

  • No labels