This guide will help you to configure the direct connection of the WebSpellChecker Proofreader product and other products based on SpellCheckAsYouType (SCAYT) with AppServer 5.0 bypassing the old FastCGI component.

Good to know:

With WebSpellChecker Server 5.0.0 release, the service requests for spell and grammar checking using products based on SpellCheckAsYouType (SCAYT), WebSpellChecker Proofreader and Web API can be processed directly by AppServer. Previously, all such requests before reaching AppServer were processed by quite old FastCGI component and only then were sent to AppServer. Getting rid of the intermediate step with FastCGI component for newer products simplified the process of the application configuration and significantly sped up the requests processing time. 

Configuring the direct connection of WebSpellChecker Proofreader with AppServer 5.0, provides the following advantages:

  • Get rid of the FastCGI component and its additional configuration;
  • Improve performance of your application;
  • Release your Web or Application Server from processing spell and grammar check requests;
  • Simplify your configuration and improve maintainability.

1. Setup Direct Connection for WebSpellChecker Proofreader


 Click here to see how to setup direct connection for WebSpellChecker Proofreader for Editable Controls ...

Add the next parameters to the section with the WebSpellChecker Proofreader initialization in your application:

  • serviceHost: 'your_host_name'
  • serviceProtocol: 'http' or 'https'

In order to configure secure SSL connection between your application and AppServer, it is also required to perform the additional steps as described on the Setup SSL Connection with AppServer 5.0 page.

  • servicePath: '/'
  • servicePort: '2880'

The default port of AppServer is 2880. In order to setup the direct connection, it is required to pass 2880 port as a value for the servicePort parameter.

As soon as all the changes are made and saved, it is recommended to clear browser cache and reload the page.

Example 1.1: Initialization of WebSpellChecker Proofreader for HTML Editable Controls with direct connection to AppServer 5.0

<script> 
    var EditableControlsInstance; 
        WEBSPELLCHECKER.init({ 
            container: 'originalElementId', 
            autoStartup: true, 
            spellcheckLang: 'en_US', 
            localization: 'en', 
            serviceProtocol: 'https', 
            servicePort: '2880', 
            serviceHost: 'your_host_name', 
            servicePath: '/' 
        }, 
        function(instance) { EditableControlsInstance = instance; }, 
        function(error) { console.log(error); } ); 
</script>

2. Setup Direct Connection for SCAYT Plugin for CKEditor 


 Click here to see how to setup direct connection for SCAYT plugin for CKEditor...

Add the next SCAYT plugin parameters in CKEditor config.js file used your application:

  • scayt_serviceHost: 'your_host_name'
  • scayt_serviceProtocol: 'http' or 'https'

In order to configure secure SSL connection between your application and AppServer, it is also required to perform the additional steps as described on the Setup SSL Connection with AppServer 5.0 page.

  • scayt_servicePath: '/'
  • scayt_servicePort: '2880'

The default port of AppServer is 2880. In order to setup the direct connection, it is required to pass 2880 port as a value for the scayt_servicePort parameter.

As soon as all the changes are made and saved, it is recommended to clear browser cache and reload the page.

Example 2.1: Initialization of SCAYT plugin for CKEditor with direct connection to AppServer 5.0

 CKEDITOR.editorConfig = function( config ) { 
    config.scayt_srcUrl = 'https://your_host_name/spellcheck/wscbundle/wscbundle.js'; 
    config.scayt_serviceProtocol = 'https'; 
    config.scayt_servicePort = '2880'; 
    config.scayt_servicePath = '/'; 
    config.scayt_serviceHost = 'your_host_name';  };

4. Setup Direct Connection for SCAYT Plugin for Froala Editor


 Click here to see how to setup direct connection for SCAYT plugin for Froala Editor...

Add the next SCAYT plugin parameters during Froala Editor initialization in your application:

  • serviceHost: 'your_host_name'
  • serviceProtocol: 'http' or 'https'

In order to configure secure SSL connection between your application and AppServer, it is also required to perform the additional steps as described on the Setup SSL Connection with AppServer 5.0 page.

  • servicePath: '/'
  • servicePort: '2880'

The default port of AppServer is 2880. In order to setup the direct connection, it is required to pass 2880 port as a value for the servicePort parameter.

As soon as all the changes are made and saved, it is recommended to clear browser cache and reload the page.

Example 4.1: Initialization of SCAYT plugin for Froala Editor with direct connection to AppServer 5.0

<script> 
    $('#edit').froalaEditor({ 
        spellcheck: false, 
        scaytAutoload: true, 
        scaytCustomerId: 'long_customer_id', 
        scaytOptions: { extraModules: 'ui', 
        contextMenuSections: 'probleminfo|suggest|moresuggest|control|clipboard|options', 
        contextMenuCommands: 'problemdescription|ignore|ignoreall|addword|undo|redo|cut|copy|paste|settings|togglescayt|help', 
        serviceProtocol: 'https', 
        servicePort:'2880', 
        serviceHost:'your_host_name', 
        servicePath:'/', 
        enableGrayt: true, 
        contextMenuForMisspelledOnly: true, 
        spellcheckLang: 'en_US', 
        scriptPath: 'https://your_host_name/spellcheck/wscbundle/wscbundle.js', 
    } }); 
</script>


Still Have a Question?

Please feel free to contact our technical team if you are having any difficulties with configuration.



  • No labels