SurveyVisualizer Server

Setup

Installing SurveyVisualizer Server

Installation of SurveyVisualizer Server is pretty straight forward and can usually be performed by simply running the appropriate installer and accepting the default settings. For detailed instructions, including customization notes, please follow the platform-specific instructions for Windows, macOS, Unix/Linux below.

Connecting to SurveyVisualizer Server

A web server is built into SurveyVisualizer Server. Simply launch SurveyVisualizer Server and use a web browser to connect to its interface. The default port for the web-based interface is 9092. If you are on the same machine as SurveyVisualizer Server, the following URL will usually work: http://127.0.0.1:9092. The default port number can be changed by editing the surveyvisualizer‑server.vmoptions file in your installation directory.

Setting up SurveyVisualizer Server on Windows

  1. Download the Setup Executable from http://www.surveyvisualizer.com/server/download/

  2. Run the surveyvisualizer-server_windows_2020_x_x.exe installer

  3. If desired, change the default settings:

    1. Accept or customize the destination directory (default is C:\Program Files\Macrofocus\SurveyVisualizerServer\)

    2. Customize the port number if necessary (default is 9092). Choose another port if the default is already used by another service. Port 80 is the standard HTTP port and can be used if no web server is running on the computer.

    3. Customize the datasets location if desired (default is C:\Program Files\Macrofocus\SurveyVisualizerServer\data\). You can either make this point to the installation directory of the desktop version of SurveyVisualizer (C:\Program Files\Macrofocus\SurveyVisualizer\ by default) or any other location where SurveyVisualizer data files (with the .mtm extension) are stored. The use of network drive is allowed if multiple people want to share their data files.

    4. If desired, customize the maximum memory that SurveyVisualizer Server is allowed to use. 512 MB (the default) should be adequate for small to medium datasets with a low number of concurrent users. If your computer has a lot of RAM, then increasing this value may for sure not hurt.

  4. Enter the user name and the license key as provided in your license certificate. Make sure to enter both exactly as indicated, as they should match.

  5. Once the installation is completed, SurveyVisualizer Server is operational. Click Finish and your default Internet browser will start (if you are on the same machine as SurveyVisualizer Server) and open the main landing page of SurveyVisualizer Server (by default http://localhost:9092/). From there, any dataset available at the datasets location will be listed and is also accessible by appending the file name to the URL, e.g. http://localhost:9092/Rainbow%20Air.msv. Note that potential space characters in the file name have to be replaced by %20.

    1. If there is no firewall or NAT router preventing connection to it, it can also be reached from other computer on the network (and potentially the Internet) by using the IP address of the computer instead of localhost. Finding your computer’s IP address can be done by following the instructions at http://windows.microsoft.com/en-us/windows7/find-your-computers-ip-address. If you have a firewall enabled on the computer, you may have to add an exception to allow connections to the port number SurveyVisualizer Server is running on (follow the instructions at http://windows.microsoft.com/en-gb/windows7/open-a-port-in-windows-firewall if you are using Windows Firewall).

    2. SurveyVisualizer Server will be started automatically every time the computer starts. It runs as a standard Windows service and a surveyvisualizer‑server.exe file is in the installation directory. You can use this executable to install and control the SurveyVisualizer Server service. You can also use the Services tool in the Windows Control Panel to start and stop the service, or from a console window run the following commands:
      surveyvisualizer‑server /install — installs the service.
      surveyvisualizer‑server /uninstall — uninstalls the service.
      surveyvisualizer‑server /start — starts the service.
      surveyvisualizer‑server /stop — stops the service.

    3. Advanced users may wish customize paramaters to the runtime environment of SurveyVisualizer Server. You can do this by editing the surveyvisualizer‑server.vmoptions file in the installation directory. Each parameter to the VM should be on a new line of the file. For example, to set the max VM heap size to 1024 MB, you’d use:
      -Xmx1024m

Setting up SurveyVisualizer Server on macOS

  1. Download the DMG Archive from http://www.surveyvisualizer.com/server/download/

  2. Open the archive and run the SurveyVisualizer Server Installer application

  3. If desired, change the default settings:

    1. Accept or customize the destination directory (default is /Applications/SurveyVisualizerServer)

    2. Customize the port number if necessary (default is 9092). Choose another port if the default is already used by another service. Port 80 is the standard HTTP port and can be used if no web server is running on the computer.

    3. Customize the datasets location if desired (default is /Applications/SurveyVisualizerServer/data/). You can either make this point to the installation directory of the desktop version of SurveyVisualizer (/Applications/SurveyVisualizer/ by default) or any other location where SurveyVisualizer data files (with the .mtm extension) are stored. The use of network drive is allowed if multiple people want to share their data files.

    4. If desired, customize the maximum memory that SurveyVisualizer Server is allowed to use. 512 MB (the default) should be adequate for small to medium datasets with a low number of concurrent users. If your computer has a lot of RAM, then increasing this value may for sure not hurt.

  4. Enter the user name and the license key as provided in your license certificate. Make sure to enter both exactly as indicated, as they should match.

  5. Once the installation is completed, SurveyVisualizer Server is operational. Click Finish and your default Internet browser will start (if you are on the same machine as SurveyVisualizer Server) and open the main landing page of SurveyVisualizer Server (by default http://localhost:9092/). From there, any dataset available at the datasets location will be listed and is also accessible by appending the file name to the URL, e.g. http://localhost:9092/Rainbow%20Air.msv. Note that potential space characters in the file name have to be replaced by %20.

    1. If there is no firewall or NAT router preventing connection to it, it can also be reached from other computer on the network (and potentially the Internet) by using the IP address of the computer instead of localhost. Finding your computer’s IP address can be done by following the instructions at http://support.apple.com/kb/PH10658. If you have a firewall enabled on the computer, you may have to add an exception to allow connections to the port number SurveyVisualizer Server is running on (follow the instructions at http://support.apple.com/kb/PH4358 if you are using macOS Firewall).

    2. SurveyVisualizer Server will be started automatically every time the computer starts. It runs as a standard daemon and a surveyvisualizer‑server executable file is in the installation directory. You can use this executable to control the SurveyVisualizer Server daemon from a Terminal window by running the following commands:
      surveyvisualizer‑server start — starts the daemon.
      surveyvisualizer‑server stop — stops the daemon.
      surveyvisualizer‑server status — displays status information about the daemon.
      surveyvisualizer‑server restart — restarts the daemon.

    3. Advanced users may wish customize paramaters to the runtime environment of SurveyVisualizer Server. You can do this by editing the surveyvisualizer‑server.vmoptions file in the installation directory. Each parameter to the VM should be on a new line of the file. For example, to set the max VM heap size to 1024 MB, you’d use:
      -Xmx1024m

Setting up SurveyVisualizer Server on Linux/Unix

If you are running on a Red Hat or Red Hat like system (CentOS, Fedora, etc), we recommend using the RPM as it contains some custom handling of the standard Red Hat like environment. Assuming that you have used the RPM, you can start and stop SurveyVisualizer Server using the /etc/init.d/surveyvisualizer-server script.

    # /etc/init.d/surveyvisualizer-server
    Usage /etc/init.d/surveyvisualizer-server {start|stop|restart|status|condrestart|reload}
    # /etc/init.d/surveyvisualizer-server start
    Starting surveyvisualizer-server:

If you are running on a different Linux/Unix varient, and/or you have used the .tar.gz 'installer', you can start and stop SurveyVisualizer Server using the surveyvisualizer-server script in your installation directory:

    # ./surveyvisualizer-server
    Usage: ./surveyvisualizer-server {start|stop}
    # ./surveyvisualizer-server start
    Starting surveyvisualizer-server