Using Live Datamart Clients

The TIBCO® Live Datamart product family includes both server and client components:

  • The server component is the LiveView server. See Getting Started with LiveView Server for an introduction.

  • You have several options for client programs, as described on this page.

TIBCO LiveView Desktop

TIBCO LiveView™ Desktop is a separately licensed client application that is based on Eclipse. LiveView Desktop is described on the following pages:

TIBCO LiveView Web

TIBCO LiveView Web™ is a browser-based application that allows you to create a rich display of cards that visualize data from queries and to create actions against a Live Datamart server. It displays data in a variety of real-time charting formats, and supports extensions such as custom visuals using JavaScript. Cards are created and laid out in pages, with each card presenting the results of a continuous query against the Live Datamart server in a variety of visualizations and data displays.

Starting with release 10.1.0, TIBCO Live Datamart includes a copy of TIBCO LiveView™ Web Standard Edition, with restricted licensing terms. Read about LiveView Web in the documentation for TIBCO LiveView™ Web Enterprise Edition on docs.tibco.com.

LiveView Web is implemented by adding a WAR file, lvweb.war, to a certain place in a Live Datamart project. You can do this at project creation time, or you can add the WAR file to an existing project.

Adding LiveView Web at Project Creation Time

When you run the FileNewStreamBase Project wizard and select the LiveView Fragment project type, a property of that project creation type specifies adding the lvweb.war file to the project.

To control this, click Next twice in the wizard to get to the Archetype Properties panel. As shown in the following example, the default setting of the lvweb property is true.

If you are certain that you do not want LiveView Web client functionality in your new Live Datamart project, you can change the value of lvweb to false.

With this setting set to true, Maven retrieves the lvweb.war file from the on-disk repository delivered with Live Datamart, and places it into the src/main/liveview/lv-user-webapps folder of the newly created project. You may have to refresh the project folder to see the file in place.

Adding LiveView Web to an Existing Project

You can add the the lvweb.war file to an existing Live Datamart project. Follow these steps:

  1. In StreamBase Studio, open the folder for your Live Datamart project in the Project Explorer view.

  2. Locate the pom.xml file for your project. Double-click to open this file.

  3. In the POM Editor, select the pom.xml bottom tab, which shows a source view of the pom.xml file.

  4. In the source view, locate the <dependencies> section.

  5. Add a new <dependency> element with the following contents:

    <dependency>
      <groupId>com.tibco.ep.lvweb</groupId>
      <artifactId>lvweb</artifactId>
      <type>war</type>
      <scope>provided</scope>
    </dependency>

    If your pom.xml file does not yet have a <dependencies> section, then add the following lines instead:

    <dependencies>
      <dependency>
        <groupId>com.tibco.ep.lvweb</groupId>
        <artifactId>lvweb</artifactId>
        <type>war</type>
        <scope>provided</scope>
      </dependency>
    </dependencies>
  6. Save the pom.xml file. This causes Studio to retrieve the WAR file from the on-disk repository delivered with Live Datamart, and place it in the src/main/liveview/lv-user-webapps folder of this Live Datamart project.

  7. Select the project's name in the Project Explorer view. Right-click and select Refresh.

  8. Confirm that lvweb.war is now in the src/main/liveview/lv-user-webapps folder.

  9. Now when you run this project in Studio as a LiveView Project, you can point your browser to a URL such as http://localhost:10080/lvweb to see the LiveView Web client view of the server. That view is likely to be initially blank until you configure a dashboard with pages and cards.

Updating LiveView Web Versions

The version of TIBCO LiveView™ Web Standard Edition bundled with the current release of TIBCO Live Datamart is shown in Supported Configurations on the Supported Configurations page of the StreamBase Installation Guide.

LiveView Web is released on a different schedule than TIBCO Live Datamart. You may wish to use the lvweb.war file from a newer or older release of LiveView Web than the one bundled with Live Datamart.

Follow these steps:

  1. Disable the Maven dependency on the bundled lvweb.war version:

    1. Edit the pom.xml file for your project.

    2. Open the Dependencies tab.

    3. Select the lvweb : war line.

    4. Click Remove.

    5. Save the pom.xml file.

  2. Remove the lvweb.war file from the src/main/liveview/lv-user-webapps folder.

  3. Manually copy the lvweb.war file from the installation of your licensed different release of LiveView Web into the lv-user-webapps folder.

  4. Right-click the project name in the Project Explorer view, and run MavenUpdate Project.

You must perform these steps for every LiveView fragment project in which you want to use a LiveView Web version different from the bundled one.

Note

If you copy a different release's lvweb.war file into lv-user-webapps without disabling the Maven dependency, then Maven will restore the file version that the dependency calls for in the next MavenUpdate Project or on reopening Studio.

As an alternative, you can add a new release of the lvweb.war file to your local repository, using one of the methods discussed on Using External JAR Files. Then add a dependency using the MavenAdd Dependency dialog, searching for the phrase lvweb. This now shows both the bundled version and the version you added to the repository for selection.

lv-client

Live Datamart includes the lv-client command line tool that provides simple access to a running LiveView server. See the lv-client reference page for details.

Custom-Written Clients

You can write your own custom clients using either the LiveView Java Client API or the LiveView JavaScript Client API as described in the LiveView Development Guide.