Architecture diagram

WebSpellChecker/WProofreader is a web-based application. Thus, it requires a properly configured web server for static files (web content) processing. Check Software requirements to find more about the supported web servers.

The diagrams below illustrate three scenarios on how the server-based version of the app communicates with the customer's web app.

Scenario A. Single entry point for service requests and static files via web server (default and recommended)

Scenario B. AppServer processes service requests directly via 2880 port and static files via web server (outdated)

Scenario C. A single entry point FastCGI proxies service requests before AppServer (outdated and deprecated)

Legend

Administrator is an administrator of both the WebSpellChecker application and a customer's web application. Administrator can perform or manage the following actions: Install and configure application on the server; Activate the application license; Customize and adjust the default settings to meet end users' and business needs; Create custom wordlists with specific terms to extend the default dictionaries (company and user-level custom dictionaries); Monitor the application performance and troubleshoot issues.
End user is a user of a customer web application. End user can perform the following actions (within the scope of the application functionality): Send input text for checking; See and correct detected errors with suggested corrections; Ignore suggestions; Add words to a dictionary called “user custom dictionary”; Change a language for text checking. Supported languages; Make changes to other settings available on UI.
Customer web application(s) where text checking functionality is required and will be used.
FastCGI is a binary protocol for interfacing interactive programs with a web server. It is aimed at reducing the overhead associated with interfacing the web server and CGI programs, allowing a server to handle more web page requests at once. For proper work of the application components, the FastCGI module must be enabled for a chosen web server.
WebSpellChecker Server
Web components is a set of various static files (web content) that are required for the application functioning. All these files are shipped with the standard package and installed automatically. These are JavaScript, CSS, HTML files.
AppServer 5.0 is an application server that is responsible for combining all the components of the system together to provide multi-language text checking functionality.
Engines include a list of integrated engines that are responsible for different types of text checking (like spelling, grammar, etc.). These engines are shipped with the default installation package.
Dictionaries combine a list of various types of dictionaries either shipped with the package or created during the application operation and use. There are three main categories of dictionaries available: default or common language dictionaries, company-level custom dictionaries, user-level custom dictionaries.
AppServerX.xml is a configuration file that contains a list of settings for the application configuration. You can find a detailed description of all available parameters in the AppServer parameters guide
Logs is a folder with log files that keeps a registry of events, processes, and messages that occur within the application.