Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated the Stop and Start commands to include the links to Main AppServer commands.

Starting the WebSpellChecker Server release 5.1.0 and higher, the new grammar engine requires Java 8 and higher. After the installation, on start the Application Server (AppServer) will try to auto-detect a path to an existing Java existing Java Virtual Machine (JVM). Also, you have an option to set to set a path to JVM manually or  manually or change the auto-detected path to your detected path to your custom one. This manual will help you with this.

1. Install Java

First of all, you need to make sure that you have installed Java Runtime Environment (JRE) or Java Development Kit 8+, as both of them contain a Java Virtual Machine (JVM) that is required to run Java programs. The new grammar engine is written on Java.

2. Stop AppServer

Before any changes in the AppServer configuration file (AppServerX.xml), it is strongly recommended stopping AppServer. To do so, please choose one of the options below. Excerpt IncludeIN:_include_stop_appserver_windowsIN:_include_stop_appserver_windowsnopaneltrue Excerpt IncludeIN:_include_stop_appserver_linuxIN:_include_stop_appserver_linuxnopaneltrue stop AppServer.

3. Specify Path to Java Virtual Machine in AppServer Configuration File

  • Locate the AppServerX.xml configuration file in the WebSpellChecker installation folder on your server. 
Info

The default path to the AppServerX.xml file: <WebSpellChecker_Installation_Path>/AppServer/AppServerX.xml

  • Find section with parameters responsible configuration of Java Virtual Machine (JVM) that are required for the grammar engine: <PathToJavaVirtualMachine>...</PathToJavaVirtualMachine>
Code Block
languagexml
themeEmacs
titleAppServerX.xml
<!-- At least java 8 is required to use langtool grammar engine. In case of empty tag AppServer tries to detect path to jvm library automatically. -->
<!-- You can put path to jvm library here. Path example for Linux: /usr/lib/jvm/java-8-oracle/jre/lib/amd64/server/libjvm.so. -->
<!-- Path example for Windows: C:/Program Files/Java/jre1.8.0_121/bin/server/jvm.dll -->
<PathToJavaVirtualMachine></PathToJavaVirtualMachine>
<!-- Put maximum heap size restriction in megabytes for langtool in java virtual machine. -->
<JVMMaxMemorySizeMb>256</JVMMaxMemorySizeMb>
  • Use the PathToJavaVirtualMachine parameter to specify a correct path to a JVM on your server.
Code Block
languagexml
themeEmacs
titleAppServerX.xml
<PathToJavaVirtualMachine>your_path_to_JVM</PathToJavaVirtualMachine>

4. Start AppServer

As soon as a correct path to JVM is specified in AppServerX.xml, start AppServer to apply changes made using one of the options below. Excerpt IncludeIN:_include_start_appserver_windowsIN:_include_start_appserver_windowsnopaneltrue Excerpt IncludeIN:_include_start_appserver_linuxIN:_include_start_appserver_linuxnopaneltrue for the changes to take effect.

5. Verify Operability

As soon as these steps are performed, the status should change to "active":true. You can also check the grammar visiting /samples/ that are shipped with the package.

...