LiveView Connectivity Wizard

A LiveView fragment project that supports a single LiveView server instance. The server is configured to connect to your data source and immediately begin publishing data from that source.

A StreamBase Application project, which contains the LiveView fragment project as its sole dependency. This Application project is compiled into an application archive file in this project's target folder, whose file name ends in -ep-application.zip. This application archive can be deployed into a StreamBase Runtime node.

If you specified the Docker option, the application image is installed in your local Docker registry under the name artifactId-app.

Invoke the Connectivity Wizard from the Authoring perspective in StreamBase Studio with File>Connectivity Wizard.

Choose Create a new project and click Next.

Choose StreamBase Feed Simulation and click Next.

Select a Data File. In this tutorial, a CSV file was selected and the Connectivity Wizard uses it to generate a data stream.

Configure the number of rows per second, taking into consideration how long you want your feed simulation to run (for example, if your CSV contains 6000 rows of data, and you set your project to run at 10 rows per second, your feed simulation will last 10 minutes). You may want to use slow-moving data in order to inspect the data at human-visible speed.

Do you want the simulation to loop or finish? Choose whether to automatically start the simulation when it completes (see above for considerations). This applies when using a JDBC or CSV file.

The Connectivity Wizard examines the data file and attempts to determine the appropriate file encoding. If the selected encoding type is not correct, select one from the dropdown list.

Click Next.

Configure the data table. Use a field as a primary key, or let the Connectivity Wizard do it for you. The advantage of the latter: data can be replayed repeatedly, each time generating a new key. If you do not set a primary key, any replay of the data would be considered an update (as opposed to a new row). This in effect looks like the simulated stream appears to stop. This tutorial selected Get Schema from Data Source. From the returned schema definition, you can select a primary key.

Alternatively, (as in this tutorial) you can choose the data to be treated as a Time-series. This option means each row of data is read and given a time stamp. This option also provides an auto-incrementing number, which the Connectivity Wizard uses as a primary key. By default the field name for the primary key is EventID. (editable)

In the next dialog, set the data retention policy to define how much data your table will retain in memory. This is an important consideration depending on your use-case; as new data arrives, a new row is added to your data table. If left to grow indefinitely, you run the risk of exhausting your system's memory resources. When determining a retention policy, also take into account whether you chose to automatically start the simulation when it completes. In that scenario, your project may retain additional data if left unbounded.

Add basic server authentication: this dialog determines whether your generated data stream requires a login, or allows any user with a URL access to your data stream. If you choose to authenticate, the Connectivity Wizard provides one administrative user for the project. You provide the password for that user. In practice, you may want to configure additional users and passwords for this project. The generated readme from this project provides instructions for doing so (which is out of the scope of the Connectivity Wizard and this tutorial).

The Summary dialog appears. In this tutorial, the dialog explains that a feed simulation was defined and includes a schema containing 27 fields with a specified retention policy. From this dialog, you name your project and have the opportunity to change the read-in table name, which is based on the CSV file selected earlier.

Note the option to create a Docker image for your project. If you select this option, you must have Docker installed and running. See Cloud for more information.

Click Finish. The Connectivity Wizard builds the project for you, which can take some time based on system performance. Once successfully built, a dialog appears to explain the actions the Wizard performed.

Refer to the project's readme (located in the StreamBase application folder) to learn about additional configuration options for your project.

You can test your project by clicking Start Server. Several dialogs may appear as the Wizard starts LiveView server for you. From the Studio Console view, your project is ready to run in your LiveView client when the following message appears:

All tables have been loaded. LiveView is ready to accept client connections.

When finished, switch to the Test/Debug perspective and select your application in the Debug View. Clicking the red square icon to the left of the view terminates the application.