Skip to main content

Extract and Link Information

Installing on Windows

This section contains instructions for installing and deploying Analytics Server as a RESTful server on Windows.

Additional Windows requirements

The packages are shipped as tar.gz files.  To unpack the files you will need a third-party archiving tool.  A recommended tool is:

  • 7-zip http://www.7-zip.org/

  1. Install 7-zip.

  2. Add the 7-zip installation directory to your system path.

  3. Reboot.

  4. Follow the instructions to Unpack the files from a Windows prompt.

  5. Install the license file when you have completed the installation and are ready to continue.

Unpack the files from a Windows prompt

From a Windows Command Prompt:

  1. Set the install location for the Server main package, referenced here as %ROSAPI%

    set ROSAPI=C:\rosette-<version>\server
mkdir %ROSAPI%

  2. Using 7-Zip, unpack the Server main package from the current directory into the %ROSAPI% directory

    7z x "rosette-enterprise-<version>.tar.gz" -so | 7z x -aoa -si -ttar -o"%ROSAPI%"

    Ignore any symbolic link messages from 7-Zip. 

  3. Set the install location for the component packages, referenced here as %ROSAPI_ROOTS%

    set ROSAPI_ROOTS=C:\rosette-<version>\roots
mkdir %ROSAPI_ROOTS%

  4. Unpack the component packages from the current directory into %ROSAPI_ROOTS% directory

    unpack-roots.bat "path to root tar.gz files" %ROSAPI_ROOTS%

    unpack-roots.bat is a Windows-specific batch script that requires 7-Zip  

Install the license file

Copy the license file into the subdirectory of your install directory.

copy rosette-license.xml %ROSAPI%\launcher\config\rosapi\

Set the runtime environment variables

  1. Set ROSAPI_ROOTS in the user profile.

    set ROSAPI_ROOTS=C:\rosette-<version>\roots

  2. Set JAVA_HOME in the user profile, if not already set. For example:

    set JAVA_HOME=C:\java\jdk-<version>

    Tip

    Your location of JAVA_HOME may differ based on your installation of Java.

  3. If installing the names roots (name similarity, translation, or deduplication endpoints), add the roots to the path.

    set PATH=%PATH%;%ROSAPI_ROOTS%\rni-rnt\<rni-rnt root version>\rlp\bin\amd64-w64-msvc120

Run Analytics Server

To run from the Command Prompt: 

cd %ROSAPI%\bin
App.bat

Note

If your installation includes the entity extraction component (rex-root), you may see failed to open ... warning messages for data files in languages not installed in your system. These can safely be ignored.

Note

You can check the logs in %ROSAPI%\logs\ for any errors that you may encounter at startup or when running the server.

To stop Server: 

From the /bin directory

cd %ROSAPI%\bin
launcher stop

or

cd %ROSAPI%\bin
stop-launcher

Install as a Windows service

Before completing these steps, you must have unpacked the files and installed the license file.

  1. Check for existing installations.

    cd %ROSAPI%\bin
AppCommand.bat status

  2. Remove any existing installations.

    cd %ROSAPI%\bin
AppCommand.bat remove

  3. Install Server as a Windows service.

    cd %ROSAPI%\bin
AppCommand.bat install

  4. (Optional) Add the runtime environment variables (JAVA_HOME and ROSAPI_ROOTS) to the %ROSAPI%\conf\wrapper.conf file.

    set.JAVA_HOME=C:/Java/jdk-<version>
set.ROSAPI_ROOTS=C:/rosette/roots

Tip

Any required runtime environment variables should be accessible to the "Local System Account" or configured in %ROSAPI%\conf\wrapper.conf.

It is important to understand how the service wrapper evaluates environment variables. You can read more about the details of variable expansion and definition here.

See also: