This document describes how to download and install the IoT RTView DataCollector for use with the IoT RTView DataServer (and with RTView Cloud) and how to configure the data server. This document also provides an example of how to connect data sources to your DataCollector and how to connect to the IoT RTView DataServer.

The IoT RTView DataCollector collects data via connections that you define in the RTView Configuration Application and sends the collected data to the IoT RTView DataServer, which collects this data and any additional data that the IoT RTView DataServer is collecting. This collected data is then pulled into RTView Cloud via an RTView Data Server connection created in RTView Cloud. Note that the RTView Data Collector does not generate alerts or store history data.

This document describes how to download and install the IoT RTView DataCollector for use with IoT RTView DataServer and RTView Cloud, how to configure the data collector including defining the connection information, how to connect to the IoT RTView DataServer, and how to verify that your setup is working properly in the IoT RTView DataServer. This document assumes that you have already downloaded and installed the IoT RTView DataServer. See IoT DataServer Quick Start Guide for RTView Cloud for more information.

Before You Get Started

You should have Node.js version 6 or higher and Java version 1.7 or higher installed on your local machine.
You should perform the following steps in your private organization in RTView Cloud.

Downloading the RTView DataCollector

Log in to your RTView Cloud account at http(s)://rtviewcloud.sl.com. If you do not have an RTView Cloud account, go to http(s)://rtviewcloud.sl.com/register and follow the instructions to create your account.

Note: If you log in using https, you must use https for your data server links as well. If you log in using http, you can use http or https for your data server links.

Once you have logged in, RTView Cloud displays.

Click the ? icon in the upper right corner.

The RTView Cloud Support Home page displays.

Click the Downloads tile/option.

The RTView Cloud Downloads page displays.

Scroll down to the RTView DataServer region and click the Terms and Conditions link to view the SL Corporation - End User License Agreement, click the I agree to the Terms and Conditions check box, and then click the Download RTView DataServer button.

The compressed file is saved to your machine.

Registration

When you install the DataCollector, a temporary license key is included. SL Corporation will send you a permanent key that you will need to add to your RTView license key file so that you can extend the operation of your monitoring system.

This is a universal key that will enable you to run RTView on different machines and platforms. It is your responsibility to ensure you use RTView within the terms of your End User License Agreement (EULA).

To update your RTView system with your new license key, open a command window and:

Navigate to RTViewDataCollector/rtvapm/rtview/lib.
Edit the KEYS file using a text editor.
Copy/paste the new replacement key to the file.
Save the KEYS file.

Installing and Starting the RTView DataServer

Note: If using UNIX, do not include spaces in your installation directory path. The start_server.sh and stop_server.sh scripts will not function properly if spaces are included in the installation directory path.

Extract All (Windows)/unzip (UNIX/Linux) the file to the directory of your choice. For UNIX/Linux, use unzip -a to unzip the file.

Open a command window and set the JAVA_HOME environment variable to point to your Java Installation. For example:

export JAVA_HOME=/opt/Java/jdk1.7.0 (UNIX/Linux)

set JAVA_HOME=C:\Program Files (x86)\Java\jre1.8.0_201 (Windows)

Or, in Windows, you can set JAVA_HOME as an environment variable (in Control Panel > System >Advanced system settings), where it will then be used by all command windows and when you double-click on a .bat file.

In the command window, navigate to the RTViewDataCollector directory and type:

start_collector.bat (Windows)

. ./start_collector.sh (UNIX/Linux)

Or, in Windows, you can double-click on the start_server.bat file.

The RTView DataCollector is now ready to receive data at the following URL: http(s)://localhost:3270/rtvpost

Note: This script starts the DataCollector on port 3278 with HTML Server (Eclipse Jetty, by default) on port 3270. If these ports conflict with other processes running on your system, you can change the first two digits of the ports by using -portprefix: and specifying the first two digits you want to use for the ports in the command line. For example: start_collector.bat -portprefix:44 (which would change the ports to 4478 for the DataCollector and 4470 for HTML Server). If you want to save your port prefix, you can change the port prefix in the RTView Configuration Application (see the next section), or you can use -saveportprefix: command line argument (for example: start_server.bat -portprefix:44 -saveportprefix).

Configuring the DataCollector

Next, you can optionally modify your port or configure your Historian database using the RTView Configuration Application.

Open a browser and type:

http://localhost:3270/rtvadmin

The Authentication required dialog displays.

Log in using rtvadmin/rtvadmin as the username/password.

The RTView Configuration Application displays.

Click RTView DataCollector.

The RTView Configuration Application displays with the General tab open.

As previously mentioned, if you modified the port at startup, you should modify the port prefix so that you do not need to specify the port on the command line every time you run the startup script. To do so, navigate to Server Configuration > General > General Tab > Ports > Port Prefix and define a new port prefix. If you change the Port Prefix to 44 then, after saving your changes and restarting your data server, you would access the RTView Configuration Application for the RTView DataCollector using the following URL: http(s)://localhost:4470/rtvadmin (instead of the default http(s)://localhost:3270/rtvadmin URL)

Populating RTView DataCollector Caches with Data

Next, you need to populate an RTView DataCollector cache with data, which you can do by creating a script to pull the desired data from your data source into the RTView DataCollector. The example in this section provides instructions and examples showing how to push real-time monitoring data from a JavaScript application into an instance of an RTView DataCollector. Once data is pushed into the RTView DataCollector, you can connect the DataCollector to your IoT DataServer. You can use the downloaded JavaScript example to give you a better idea of how to create your own scripts.

To access the example:

Open a browser and navigate to: https://github.com/slcorp/RTView-JavaScript (see the README file on this site for additional information)

Click the Clone or download button, click Download ZIP, and save it to your machine.
Extract/Unzip the file.
Install the connector program by opening a command window, navigating to the install directory, and typing:
- cd RTView-javascript\RTView-JavaScript-master\RTView-JavaScript-master
- npm install (you must have Node.js version 6 or higher installed to run this program)
In the same directory, start the program by typing:
- node simple-example

This program can be modified to bring in custom data specific to your application.

Connecting to the IoT RTView DataServer

Next, you need to connect the IoT RTView DataCollector to the IoT RTView DataServer. NOTE: The example in the previous section created caches in your DataCollector and, to pass that data along to your DataServer, you will need to manually add those caches to the DataServer. The collected data will then be passed along to the DataServer once you complete the steps in this section.

To connect the two servers:

Navigate to Server Configuration > Data Server > Collector tab.

The Collector tab displays with a default target1 already created. This target is configured to send all solution package data to localhost:3272, which only works if your data collector and data server are on the same machine. If your data server is on a different machine, you will need to edit this target.

To edit the existing target, click the "pencil" icon associated with the target.

The Edit Target window displays.

Define the target server information and click SAVE where:

ID: The name you want to give to the target server.

URL: The complete URL for the target server connection.

Targets: Select one of the options:

All solution packages: (default) Sends all solution package data to the target (receiver) data server.

Select solution packages: Opens the Solution Packages dialog that allows you to select the solution packages for which you want data sent to the target (receiver) data server.

Enabled: Enables/disables the target connection.

Saving Your Changes and Restarting the Data Collector

Once you have completed your setup, click the SAVE button in the RTView Configuration Application.

For your changes to go into effect, you must stop and restart the data server by either:
- clicking the button (in the upper right-hand corner of the window)...

- or by typing the following in your installation directory in the command window:

stop_collector.bat (Windows)

./stop_collector.sh (UNIX/Linux)

start_collector.bat (Windows)

./start_collector.sh (UNIX/Linux)

Verifying Your Setup

To verify your setup:

First, you should verify that your collector is collecting data in your caches by opening a browser and accessing the following URL:

http(s)://<IP address>:<port>/common

For our example, we changed the port to have a prefix using 44 and we have a local installation, so our URL is:

http://localhost:4470/common

The RTView Cache Viewer application displays, which allows you to view the details for the caches that are collecting data.

Next, after you have started and configured your IoT RTView DataServer, open a browser and access the following URL: