Getting Started with LiveView Server

This page provides basic start and stop instructions for running Spotfire LiveView Server.

Minimal Configuration Required

When a LiveView Server instance starts, its first task is to compile a set of configuration specifications that you provide into one or more LiveView data tables. On subsequent starts, LiveView Server recompiles only the configuration specifications that have changed, if any.

A LiveView table is a data table with a particular schema that is ready to accept a stream of incoming data and queries. In the absence of the configuration specifications for at least one data table, there is nothing for the LiveView Server to do, and it cannot start.

Thus, to start the LiveView Server even for a simple test requires some configuration. The LiveView installation provides a sample that illustrates the minimal configuration for LiveView, which is just enough to start and run the server. This smallest possible LiveView configuration requires a valid LiveView table configuration file to define a data table.

LiveView configuration files are called lvconf files. All lvconf files that constitute a single LiveView project must reside in the same top-level project folder. When you run a LiveView Server instance, you are running the configuration defined in the project folder that contains your lvconf file(s).

Loading LiveView Samples into Studio Workspace

  1. Start StreamBase Studio.

  2. Select File>Import Samples and Community Content from Studio's top-level menu.

  3. In the Import Samples and Community Content dialog, open the Spotfire LiveView category.

  4. Select the sample whose description is Shows the minimum configuration to start LiveView Server and press OK.

The sample loads into Studio with the project name sample_lv-minimal.

Starting LiveView Server from StreamBase Studio

Installing LiveView adds support to StreamBase Studio for starting and stopping LiveView Server instances from within StreamBase Studio. Follow the steps below to start LiveView Server running the Minimal sample loaded as described in the previous section. These steps apply equally to the Windows and Linux editions of StreamBase Studio.

  1. In the Project Explorer view, select the project's folder, sample_lv-minimal.

  2. Click the Run button ().

  3. This opens the Run As dialog. Select LiveView Fragment and click OK.

  4. Studio opens the Console view, and begins to show messages from LiveView Server. After a few minutes, look for a Console view message at or near the end that says:

    { Server Started } - 
    *** All tables have been loaded. LiveView is ready to accept client connections. ***

Notice that LiveView Server runs in Studio independently of any StreamBase Server run or debug session you might want to run at the same time. The only constraint are the port numbers, which must be different for each running server. You can configure StreamBase Server to automatically try another port if Studio's default port, 10000, is in use by LiveView Server.

You can also run two or more instances of LiveView Server by editing one instance's launch configuration to use a different port.

Stopping LiveView Server from StreamBase Studio

If you started LiveView Server from StreamBase Studio, as described in the previous section, stop it by clicking the red and blue square Terminate button () in the Console view's toolbar.

This button is configured to send an lv-client shutdown command when the currently selected Console view launch is a LiveView Server instance. You can also run lv-client shutdown manually from a Linux terminal prompt or a StreamBase Command Prompt on Windows.

Stopping LiveView Server at the Command Prompt

If you started LiveView Server from the command prompt, you can also use the lv-client shutdown command to stop the server.

Open a separate terminal window on Linux or StreamBase Command Prompt on Windows, and enter:

lv-client shutdown

The window in which the server is running issues a series of shutdown messages, then returns to the command prompt.