TIBCO LiveView Web Getting Started Guide

Transcription

1 TIBCO LiveView Web Getting Started Guide Introduction 2 Prerequisites 2 Installation 2 Installation Overview 3 Downloading and Installing for Windows 3 Downloading and Installing for macos 4 Installing and Running the LVWeb Sample 4 Supported Browsers 5 Configure Live Datamart for SSL Connections 6 Usage Notes 6 Customization and Support 7

2 Introduction Welcome to TIBCO LiveView Web. LiveView Web is a browser-based client application that allows you to create a rich display of cards that visualize the results of querying a TIBCO Live Datamart server, set alerts to be notified of changes in results, and to create actions in response to changing data. Using only your web browser, you are able to create cards and lay them out in pages, with each card presenting the results of a continuous query against the Live Datamart server. LiveView Web displays data in a variety of visualizations and real-time charting formats, and supports customized visual extensions using JavaScript. Prerequisites TIBCO LiveView Web is a client solution that connects to a TIBCO Live Datamart server. If your site already has a Live Datamart server configured and running, you are ready to install and use LiveView Web. If you do not have a running Live Datamart server, you can download and install Live Datamart for Windows and macos. A Live Datamart installation includes the ability to run Live Datamart server locally on your Windows or OS X development computer. TIBCO Live Datamart relies on underlying technology provided by TIBCO StreamBase. Live Datamart and TIBCO StreamBase are integrated into a single installation package. When you install TIBCO StreamBase, you automatically have Live Datamart, and vice versa. Download the combined TIBCO StreamBase and TIBCO Live Datamart package from either: edelivery.tibco.com, using your TIBCO account login credentials. eval.tibco.com, to download an evaluation package of StreamBase and Live Datamart. LiveView Web requires a server from Live Datamart or later. TIBCO Live Datamart is normally configured and run during development and testing using TIBCO StreamBase Studio, which is an Eclipse-based development environment included with your TIBCO StreamBase installation. The following instructions presume basic familiarity with starting and using StreamBase Studio. Installation This section describes the steps to download LiveView Web and integrate it into an existing Live Datamart installation.

3 Installation Overview TIBCO LiveView Web is distributed as a standard web application in WAR file format; ready to load into the application server included as part of Live Datamart server. The WAR file provided is named lvweb.war; do not rename this file or the product will not load properly. Before using LiveView Web, it is strongly recommended you export your LiveView Web metadata using the lvweb-db tool. Please refer to User Authorization Guide for command details. There are two supported ways to integrate the LiveView Web WAR file into a Live Datamart server installation: 1. Project Integration. Copy lvweb.war into a subfolder of your Live Datamart project folder, which must be named lv-user-webapps. This method is simple, does not require administrative privileges, and it localizes LiveView Web integration to a single Studio project. To support LiveView Web in other Studio projects, you must repeat the copy for each project. This method is presumed and described in the installation steps that follow. 2. Server Integration. Place lvweb.war at the server installation path STREAMBASE_HOME/liveview/server/lv-user-webapps (as a sibling of the engine and lib folders). This loads support for LiveView Web applications for all projects deployed on that server. This method might require administrative privileges, depending on the location of your TIBCO StreamBase installation. Do not mix these methods. That is, avoid installing the LiveView Web WAR file in individual project folders if it is already installed with server integration. If the Live Datamart server encounters both project and server integrated lvweb.war files, it favors the project-integrated version. When upgrading to a newer LiveView Web version, simply overwrite any existing WAR file with the latest version. Downloading and Installing for Windows 1. Download the TIBCO LiveView Web Windows installer 2. Run the resulting MSI, named like the following example: TIB_ldm-web_1.3.0_win_x86.msi Make a note of the installation folder selected by the installer, which by default is a path like the following in your AppData folder, assuming a system username lvuser : C:\Users\lvuser\AppData\Local\TIBCO Software Inc\LiveView Web 1.3\ The steps below for running the LVWeb sample require you to copy a file from this installation folder to another location. On Windows, you can open the installation folder by means of a Start menu shortcut: Start > All Programs > TIBCO > LiveView Web 1.3 > Install Directory.

4 Downloading and Installing for macos 1. Download the TIBCO LiveView Web macos DMG installer 2. Double-click to open the resulting DMG file. 3. Agree to the license when prompted. 4. The DMG file contains a single folder named, for example, TIBCO LiveView Web Drag this folder to any location on your Mac. Make a note of the installation folder location so that you can copy a file from it in later steps. Installing and Running the LVWeb Sample The LiveView Web distribution includes a sample shipped as a zip file that contains a complete StreamBase Studio project folder. The sample provides an enhancement of the Hello LiveView sample with self-generated data, and includes a stored LiveView Web configuration for the Live Datamart users named admin and guest. This section describes how to import that sample zip file into Studio, run Live Datamart server with the configuration defined in the sample, then connect to the running server from a web browser. This results in a demonstration of a preconfigured LiveView Web instance. 1. Run StreamBase Studio from your StreamBase installation. 2. Import the LiveView Web sample project into Studio with the following steps: a. From Studio s top-level menus, invoke File > Import > General > Existing Projects into Workspace. b. In the resulting dialog, invoke Select Archive File, and then use its Browse button to navigate to the LiveView Web installation folder as described in either of the previous two sections. c. Select the lvweb-samples.zip file. d. Click Finish. 3. In StreamBase Studio, locate the newly imported sample project in the sample_lv-web project folder. 4. Using Windows Explorer or OS X Finder, drag and drop the lvweb.war file from the LiveView Web installation folder into the lv-user-webapps subfolder of the imported sample's project folder. Make sure the drag operation performs a copy operation, and not a move. 5. In Studio, right-click the sample_lv-web project folder and select Refresh from the context menu. 6. Start the Live Datamart server on the sample project, using one of these methods: a. If the LiveView Project Viewer is open for the project, click the green Run button in the upper right corner of the Viewer. b. Select any.lvconf file in the project, right-click, and select Run As > LiveView Project from the context menu. NOTE: If the LiveView Project Viewer is open while the server is starting, you are

5 prompted to log into the server. This prompt originates from the Project Viewer, and not from LiveView Web. The Project Viewer needs to authenticate with the server in order to complete the server startup process. This prompt occurs because the LVWeb sample project is configured to use LiveView authentication. Log in with username admin, password admin. This login is required to allow the Project Viewer to connect, and thus track the progress and occurs in any Live Datamart project configured to use LiveView authentication. This login is independent of the process of logging into the server from the LiveView Web client. 7. Watch the Console View in Studio for the words All tables have been loaded, which is the signal that the server is now up and running. 8. When you see that signal, open your web browser and go to the following URL: 9. When prompted, log in as username admin, password admin. Both terms are casesensitive as shown. 10. Observe the various pages (in tabs) and cards, each of which is displaying continuous updates of data from the Live Datamart server in different visualization styles. You can experiment with changing the configuration of any card. 11. Log out of LiveView Web as admin by selecting the icon with three horizontal bars in the upper right, then selecting Logout. 12. Log back in to LiveView Web with username guest and password guest. In this case, you are viewing the same data from the server, using the same web dashboard configured by the admin user, but with read-only access. 13. When done, click the blue and red Stop button in Studio's toolbar to stop the Live Datamart server. Supported Browsers LiveView Web is a rich HTML5 application, using various modern JavaScript frameworks in order to provide a rich and responsive environment, while handling live continuous data updates rendered in complex visualizations. As such, it greatly benefits from using the latest browsers available for your platform. Primary development and testing took place on: Google Chrome s latest stable release (at the time of writing, version 58) Apple Safari (at time of writing, version 10) Mozilla Firefox (version 53) Microsoft Edge on Windows 10 While smartphone browsers are not an intended platform target, some tablets may render LiveView Web pages and cards satisfactorily. Primary but limited testing was performed on an Apple ipad using Safari on ios 10. However, the experience on non-desktop platforms is less than ideal.

6 Configure Live Datamart for SSL Connections To configure Live Datamart servers to allow clients, including LiveView Web, to connect only over secure SSL connections, use the following steps: 1. In the TIBCO StreamBase Studio project for your server instance, locate the liveview.properties file. If the following lines exist, uncomment them; otherwise add them. liveview.ssl.port=10443 liveview.ssl.only=true liveview.ssl.hostname=localhost (or specify the DNS name or IP address of your server) 2. Add keystore and truststore certificates to the Studio project, and identify the certificate names in the project s sbd.sbconf configuration file. In the following example lines, the truststore and keystore files are the same: <sysproperty name= liveview.keystore value= server.jks /> <sysproperty name= liveview.keystore.password value= secret /> <sysproperty name= javax.net.ssl.truststore value= server.jks /> <sysproperty name= javax.net.ssl.truststorepassword value= secret /> 3. Add client-side certificates to end-user browsers. 4. Connect to your Live Datamart server using the HTTPS protocol and port Usage Notes To make better use of LiveView Web, it is useful to understand the following points. LiveView Web versions are intended to be installed on a matching major.minor Live Datamart version that is established at the time of the web application s release. For example, LiveView Web 1.3.x is intended to be used with Live Datamart or later. LiveView Web stores your pages and cards by associating them with your Live Datamart login username. This information is stored by default in the underlying project storage database; for Live Datamart 2.1, this default location is the H2 database in the Studio project path lv-systemdata/liveview.h2.db. TIBCO Support might ask you to configure an alternative for debugging purposes; in this case, configure your Live Datamart project to store LiveView Web configuration data in JSON files under the lvmetadata project folder. To enable this alternative, set the liveview.web.pstore.type Java system property to the value file. LiveView Web 1.3 is not intended to be used by the same user login concurrently. That is, do not open multiple HTTP sessions in multiple browser tabs or windows to the same LiveView Web URL while logged in as the same user. Do not log in and use LiveView Web as the same user from multiple locations at the same time. If you are running into trouble, such as pages that do not load content, try closing your browser, clearing the browser cache and any cookies relating to the LiveView Web URL,

7 and trying again. Customization and Support LiveView Web supports contributing custom card content, including loading remote resources or running end-user written JavaScript code. Any modification or customization done this way is at the end user s responsibility. For further information on writing custom card visualization, please refer to Copyright 2017 TIBCO Software Inc. All rights reserved.