Show 

 

StreamBase Data Source

StreamBase® Event Stream Processing is a CEP (Complex Event Processing) platform that empowers organizations to process, analyze and act on real-time streaming data within milliseconds of its arrival. CEP solutions are capable of reading, creating, transforming, correlating or abstracting complex data events. A CEP platform provides the necessary performance for solutions that demand high-speed correlation of streaming data (i.e.: financial services, fraud detection, IT quality of service [SLAs], eCommerce monitoring and location based services).

With RTView you can connect directly to StreamBase® event streams and create real-time business activity monitoring applications, such as:

§        a financial trading application to monitor real-time trade activity;

§        a fraud detection dashboard and alerting system that would monitor on-line financial services; or

§        a web-based monitoring system that would show business activity and analyze behavior on an eCommerce web site.   

In typical solutions, users define CEP using the StreamBase® tool set and then utilize RTView to:

§        visualize the resulting information via dashboards;

§        archive information for historical trend analysis; and/or

§        activate automated user behavior and create reports.

The StreamBase® data source also provides metrics from the StreamBase® platform, so the status and current operating levels of the platform can be monitored for capacity planning.

This section includes:

§        “StreamBase System Requirements and Setup” on page 685

§        “Attach to StreamBase Data” on page 686

§        “Define StreamBase Command” on page 691

§        “Application Options - Streambase” on page 694

§        “RTView Deployment - StreamBase” on page 698

§        “StreamBase Demos” on page 699

§        “StreamBase Data Source Command Line Options” on page 701

 

StreamBase System Requirements and Setup

System Requirements

In addition to basic “System Requirements”, the StreamBase data source requires StreamBase and is only available if you include your StreamBase client jar in RTV_USERPATH. See the README_sysreq.txt file in your installation’s home directory for the current version(s) supported.

If you use the Rich Client Browser with Direct Data deployment, you will need to setup applet permissions on each client to allow access to your StreamBase application. See “Rich Client Browser with Direct Data Connection - Manual Setup” for more information.

Setup

In addition to general environment variables (see “Setup”), you must include the StreamBase client jar in RTV_USERPATH:

Name

Description

Example

RTV_USERPATH

Path for the StreamBase sbclient.jar.

Note: If RTV_USERPATH already exists, append sbclient.jar to it.

C:\Program Files\StreamBase Systems\StreamBase\lib\sbclient.jar

See StreamBase provider documentation for more information on the location of this jar.

Attach to StreamBase Data

Note: The StreamBase data source may not be licensed in your RTView installation.

Right-click on the Property Name (e.g., the value property or the valueTable property) from the Object Properties window and select Attach to Data>SB to display the Attach to StreamBase Data dialog. This dialog is used to attach an object property to StreamBase monitoring metrics or stream content and display real-time results in an RTView display. Once an object property has been attached it receives continuous updates.

The Attach to StreamBase Data dialog provides several drop down menus that allow you to specify information regarding the tuples you retrieve. If the drop down menu does not contain the item you require, type your selection into the text field.

atd_dialog_sb.gif

 

Field Name

Description

Connection

The StreamBase connection name. You may specify a connection on the “StreamBase Connections Tab” of the Application Options dialog.

Note: If * is entered, data will be retrieved from all defined connections.

Stream Name

The name of the stream from which you want content. Choose either a Stream Name or “RTViewDs”. Available Stream Names are based on the Connection specified in the Application Options dialog.

Note: All returned rows of data are identified by both Connection and Stream Name. In the returned table, Connection names will appear in a column named conn added to each incoming tuple.

Streams -- Returns a table with a single row containing the latest tuple data.

History -- Returns a table with one row for each tuple received. This table continuously grows to the maximum specified for History Depth in the Application Options dialog. Example: streamname_history

History2 -- Returns a table containing one row for each tuple received up to that point in time. Does not continue updating as new tuples come in. Example: streamname_history2

Field(s)

If Stream, History, or History2 is selected in the Stream Name field, the Field(s) field dropdown menu is populated with the following options. For RTViewDs options, see the “RTViewDs” table.

Filter Rows

Check box to indicate whether or not to filter the rows.

Filter Column

Name of the column field to use as a filter.

Filter Value

Value that the filter field must equal.

Data Server

Select to read data through your configured Data Server and not directly from the StreamBase data source.

Default - Select the default Data Server you configured in Application Options>“Data Server Tab”.

None - Bypass data being redirected through the specified data server(s) for this attachment and instead attach directly to the data source.

Named Data Servers - Select a Named Data Server that you configured in Application Options>“Data Server Tab”.

Multi-Server Attachment - To configure multiple data servers, enter a semicolon (;) delimited list containing two or more Named Data Servers (e.g. ds101;ds102). Each name specified must correspond with a Named Data Server that you configured in Application Options>“Data Server Tab”. It is also possible to specify __default and __none (e.g. __default;ds101;ds102).

Note: The values __default and __none begin with two underscore characters.

Alternatively, a value of * can be entered to specify all data servers, including __default and __none.

 

When multiple data servers are specified, the data attachment will be directed to each data server in the list. For tabular data attachments, a column named DataServerName will be added as the first column of the table and contain the name of the server from which the data was received.

 

A multi-server attachment will receive data independently from each of the servers it specifies, so in most cases it will be necessary to combine the tables received into a single table. This can be accomplished in two ways:

 

1.     The multi-server attachment can be applied to a local cache that has the DataServerName column specified as an index column. The current table of that cache will contain the combination of the tables received from all servers. Note: It may also be necessary to configure cache row expiration settings to remove defunct rows.

2.     The multi-server attachment can be applied as the Table argument of the RTView function named Combine Multi-Server Tables. See “Tabular Functions”

Drop down menus populate based on connections added from the Application Options dialog or those typed directly into the Attach to StreamBase Data dialog.

When an object property has been attached to data, the Property Name and Value in the Object Properties window will be displayed in green. This indicates that editing values from the Object Properties window is no longer possible. To remove the data attachment and resume editing capabilities in the Object Properties window, right-click on the Property Name and select Detach from Data. You will recognize that an object property has been detached from the data source when the Property Name and Value are no longer green

Substitutions

The Substitutions feature allows you to build open-ended displays in which data attachments depend on values defined at the time the display is run. A generic stream name such as $stream is used instead of a specific stream name. Later when the display is running, this generic value is defined by the actual name of a specific stream, such as SalesInfo. In this way, a single display can be reused to show data from a number of different sources. For more information on creating displays using substitution values, see “Substitutions”.

RTViewDs

The following special values can be entered for the Stream Name field:

RTViewDs

Column Available

Description

RTViewDs.Connections

Connected

True / False. Indicates whether connected.

 

Status

Status information for this connection.

 

StatusFull

Status information for this connection.

 

Stream Count

Count of active streams in a connection.

 

URI

The connection name.

 

Version

StreamBase client software version currently running.

RTViewDs.Streams

Connected

True if the connection for this stream is connected.

 

Last Tuple Time

The time RTView received the latest tuple on this stream.

 

Stream

The name of the stream.

 

Time Since Last Tuple

The amount of time in seconds that has passed since RTView received a tuple on this stream.

 

Tuples Received

The total number of tuples received on this stream since RTView started. This does not include history.

 

Tuples Total

The total number of tuples received on this stream since RTView started plus the total number of tuples from history.

 

URI

The URI for the connection for this stream.

RTViewDs.OperatorInfo

Timestamp

The time that the Snapshot for this data was taken.

 

URI

The URI for the connection for this monitor information.

 

Name

The name of the operator.

 

InputPortCount

The number of input ports on this operator.

 

InputTuplesDequeuedDelta

The number of input tuples consumed by this operator since the previous Snapshot. If this number is less than the number of tuples enqueued to the input stream, then tuples are being queued up faster than the operator can consume them.

 

InputTuplesDequeuedTotal

The total number of input tuples consumed by this operator since the StreamBase Server was started. If this number is less than the number of tuples enqueued to the input stream, then tuples are being queued up faster than the operator can consume them.

 

InputTuplesEnqueuedDelta

The number of tuples enqueued on this operator's input streams since the previous Snapshot.

 

InputTuplesEnqueuedTotal

The total number of input tuples enqueued on this operator's input streams since the StreamBase Server was started.

 

OutputPortCount

The number of output ports on this operator.

 

OutputTuplesEnqueuedDelta

The number of output tuples produced by this operator since the previous Snapshot.

 

OutputTuplesEnqueuedTotal

The total number of output tuples produced by this operator since the StreamBase Server was started.

 

PercentUsage

The number of profiler hits divided by the total profiler hits.

 

ProfilerHits

The number of miniticks used by the operator, as defined by profiler samples.

 

Size

The size of the operator. The definition of "size" varies by operator.

 

Status

The status of the operator. When blank, this returns an empty string.

 

TotalProfilerHits

The number of miniticks used by all operators in the contained ProfileState. The percentage usage is then profiler hits/total profiler hits.

RTViewDs.ThreadInfo

Timestamp

The time that the Snapshot for this data was taken.

 

URI

The URI for the connection for this monitor information.

 

Name

The name of the thread.

 

PercentCPU

The percent of CPU used by this thread, in microseconds.

 

PercentSystem

The percent of system CPU time used by this thread, in microseconds.

 

PercentUser

The percent of user CPU time used by this thread, in microseconds.

 

SystemTimeDelta

The system time spent by thread since the last Snapshot, in microseconds.

 

SystemTimeTotal

The system time spent by this thread since the StreamBase Server started, in microseconds.

 

UserTimeDelta

The user time spent since the last Snapshot, in microseconds.

 

UserTimeTotal

The user time spent by thread since the StreamBase Server started, in microseconds.

RTViewDs.SystemInfo

DequeueClientCount

The current number of dequeueing clients.

 

FreeMemory

The amount of free memory in the StreamBase Server process, in bytes.

 

MaxMemory

The maximum amount of memory which the StreamBase Server process is allowed to allocate, in bytes.

 

Timestamp

The time that the Snapshot for this data was taken.

 

URI

The URI for the connection for this monitor information.

 

ProcessSize

The amount of memory used the StreamBase Server process, in Megabytes.

 

TimeRunning

The amount of time that the StreamBase Server has been running, in seconds.

 

TotalKB

The total amount of memory, in kilobytes, available for use in the StreamBase server process.

 

TotalMemory

The total amount of memory, in bytes, available for use in the StreamBase Server process.

 

FreeKB

The amount of free memory, in kilobytes, in the StreamBase server process.

 

maxKB

The maximum amount of memory, in kilobytes, which the StreamBase server process is allowed to allocate.

 

numDequeue

The current number of dequeuing clients.

 

UsedMemory

The total amount of memory currently in use in the StreamBase Server process, in bytes.

Select Columns Fields (Tables Only)

From the Attach to Data dialog you can specify which tuple fields to display as columns in a table and in what order they will appear. In order to populate the listing of available tuple fields, you must first select a valid stream name.

Click on the ellipses button ellipse_button00035.gif in the Field(s) field (or right-click in the Field(s) field and click Select Columns) to display the Select Columns dialog. The dialog contains a list of Available Columns that you can add to your table.

To add a field, select an item from the Available Columns list and click on the Add button. If the item you require is not listed, type your selection into the Enter Column Name field. Click the Remove button to delete an item previously added to the Selected Columns list. You can control the order of fields in a table by arranging the items in the Selected Columns list with the Move Up and Move Down buttons.

If no data is available for a table row within a selected column, the table cell will display one of the following values: N/A, false, 0, or 0.0.

select_columns_rv00036.gif

 

The following describes Attach to StreamBase Data dialog commands:

Field Name

Description

OK

Applies values and closes the dialog.

Apply

Applies values without closing the dialog.

Reset

Resets all fields to last values applied.

Clear

Clears all fields. Detaches object from data source (once Apply or OK is selected).

Cancel

Closes the dialog with last values applied.

 

 

Define StreamBase Command

Note: The StreamBase data source may not be licensed in your RTView installation.

You can access the Define StreamBase Command dialog from the Object Properties window. This dialog is used to assign a StreamBase stream to an object's command property, giving you the ability to send tuples from within an RTView display. If you execute a StreamBase command from a Thin Client with Direct Data Connection or any Served Data deployment, the command will execute on the server.   

To open the Define StreamBase Command dialog, right-click on the command property in the Object Properties window and select Define Command>SB. The information supplied assigns a stream to the command property. See the “Define/Execute Command” section for information on how to execute a command.

command_dialog_sb.gif

 

Field Name

Description

Command

tuple -- Sends a tuple.

Connection

Enter a connection name. You may define a connection on the “StreamBase Connections Tab” of the Application Options dialog.

Stream Name

The name of the stream you want content from. Available stream names are based on the connection specified.

Fields

Type - Select Field to define a message field.

Data Type - Select the data type for this field or property.

Name - Specify the name for this field or property.

Value - Specify the value for this field or property.

Add Field/Property

Add a field.

Delete Field/Property

Delete the selected field or property.

Data Server

Select to read data through your configured Data Server and not directly from the StreamBase data source.

 

Default - Select the default Data Server you configured in Application Options>“Data Server Tab”.

 

None - Bypass data being redirected through the specified data server(s) for this attachment and instead attach directly to the data source.

 

Named Data Servers - Select a Named Data Server that you configured in Application Options>“Data Server Tab”.

 

Multi-Server Command - When multiple data servers are specified, the command will be executed on each data server in the list.

 

To configure multiple data servers, enter a semicolon (;) delimited list containing two or more Named Data Servers (e.g. ds101;ds102). Each name specified must correspond with a Named Data Server that you configured in Application Options>“Data Server Tab”. It is also possible to specify __default and __none (e.g. __default;ds101;ds102).

Note: The values __default and __none begin with two underscore characters.

 

Alternatively, a value of * can be entered to specify all data servers, including __default and __none.

Drop down menus populate based on connections added from the Application Options dialog or those typed directly into the “Attach to StreamBase Data” dialog.

Substitutions

The Substitutions feature allows you to build open-ended displays in which data attachments depend on values defined at the time the display is run. A generic stream name such as $stream is used instead of a specific stream name. Later when the display is running, this generic value is defined by the actual name of a specific stream, such as SalesInfo. In this way, a single display can be reused to show data from a number of different sources. For more information on creating displays using substitution values, see “Substitutions”.

Special Values

$value

When an actionCommand is executed, $value is replaced with the value from the control. This value may be used in any field in the Define StreamBase Command dialog.

Note: This value may only be used for Action Commands. See “Define/Execute Command” for more information.

The following describes Define StreamBase Command dialog commands:

Command

Description

OK

Applies values and closes the dialog.

Apply

Applies values without closing the dialog.

Reset

Resets all fields to last values applied.

Clear

Clears all fields. Detaches object from assigned message subject (once Apply or OK is selected)

Cancel

Closes the dialog with last values applied.

Application Options - Streambase

Select Tools>Options in the Display Builder to access the Application Options dialog.

Options specified in StreamBase tabs can be saved in an initialization file (SBOPTIONS.ini). On startup, the initialization file is read by the Display Builder, Display Viewer, Display Server, Data Server, and Historian to set initial values. If no directory has been specified for your initialization files and SBOPTIONS.ini is not found in the directory where you started the application, then RTView will search under lib in your installation directory. See “RTV_JAVAOPTS” for more information.

Note: Options specified using command line arguments will override values set in initialization files.

There are four Options tabs: “StreamBase Connections Tab”, “StreamBase Streams Tab”, “StreamBase History Streams Tab”, and “StreamBase Administration Tab”.

StreamBase Connections Tab

This tab allows you to add or remove connections and set your default connection. When you add a StreamBase connection to the list it will be highlighted in yellow indicating that RTView has not connected to it. To attempt to connect to a StreamBase connection, click OK, Apply, or Save. If the background remains yellow, then RTView was unable make a connection. Check that your StreamBase connection was setup correctly and that the StreamBase message server is running.

Note: Regardless of which tab you are currently working from in the Application Options dialog, RTView will attempt to connect to all unconnected connections each time you click OK, Apply, or Save.

sb_opt_sbtab.gif

 

Field Name

Description

Default Connection

Name of connection used as the default for data attachments. Select from drop down menu to change default setting.

Add Connection

Click to open the Add Connection dialog. To edit, select a connection from the list and double-click. Connections that are updating objects in a current display cannot be renamed.

 

Connection Name - The name to use when referencing this StreamBase connection in your data attachments.

 

URIs - The complete URI of your StreamBase server. Multiple URIs can be entered, one per line, to connect to a StreamBase application running on multiple servers.

 

Dequeue Interceptor - Enter the name of a Java class. This class name must be added to the definition for the RTV_USERPATH environment variable. The Java class entered should include the processResult() method, which will be called by the StreamBase application in the course of dequeuing each tuple. Within the processResult() method you can make decisions about the dequeue process. For example, in an application where two servers are both dequeueing tuples but only one is designated the leader, you may choose to suppress the tuples from the non-leader server. For more information on StreamBase High-Availability features, go to http://streambase.com/developers/docs/latest/admin/highavail.html.

Remove Connection

Select a connection from the list and click Remove Connection to delete. Connections that are updating objects in a current display cannot be removed.

StreamBase Streams Tab

This tab allows you to configure streams, including any number of filtered logical streams. When RTView connects to a StreamBase server, it retrieves the list of available streams and then uses the Streams list you specify to control which subscriptions to make. Filtered logical streams will be applied on the server to each tuple before it is sent to the client and only tuples that pass through the filter will be sent on those logical streams, thus reducing the amount of data sent to the client.

sb_opt_streamstab.gif

 

Field Name

Description

Streams

Specify any number of logical streams for a given stream. When a logical stream is added there is no subscription to the physical stream, but rather to the logical stream with the filter expressions as specified. If no streams are specified, then RTView subscribes to all streams on each specified connection (URI).

Note: If it is necessary to subscribe directly to the physical stream, then there are no performance benefits gained by creating logical streams. To filter the data, create one physical stream and use row filtering in the “Attach to StreamBase Data” dialog.

 

Add Stream -- Click Add Stream and enter the name of a stream. Press Enter to add to the Streams list.

 

Add Logical Stream -- Select a stream from the Streams list and click Add Logical Stream. Enter a name for the logical stream and press Enter to add to the Streams list.

 

Remove -- Select a stream or logical stream from the list and click Remove.

Filter Expression

Select a logical stream from the list and enter filter expression. “Substitutions” may be used in filter expressions.

Note: For a complete description of filter expression syntax, refer to your StreamBase documentation.

StreamBase History Streams Tab

This tab allows you to configure history stream and simulated stream options.

sb_opt_streamstab_hist.gif

 

Field Name

Description

History Streams

Enables the reading of the CSV file for the specified stream. Select Write History (on the “StreamBase Administration Tab”) to create a CSV file.

Note: In order for historical data to be available, the DATA subdirectory (located in the directory from which you launched RTView) must contain a CSV file for the stream.

 

Add -- Enter the name of the stream for which you want to read a CSV file and click Add to include it in the History Streams list.

 

Remove -- Select a stream from the list and click Remove.

Simulated Streams

For each stream name specified, the DATA subdirectory (located in the directory from which you launched RTView) must contain a CSV file named stream_name.csv. RTView will look for stream_name.csv on each update. If found, and the timestamp on the file has changed since the last time it was read, RTView will use the data in the file to simulate data for that stream.

Note: The data in the CSV file must match the stream format defined in your .sbapps file.

 

Add -- Enter the name of the stream that you want to simulate data for and click Add to include it in the Simulated Streams list.

 

Remove -- Select a stream from the list and click Remove.

StreamBase Administration Tab

This tab allows you to setup administration options for the StreamBase data source.

sb_opt_admintab.gif

 

Field Name

Description

Enable Monitor Metrics

Select to enable event driven statistics. These statistics will be polled every ten (10) seconds. Default is enabled.

Note: Setting this parameter to true will increase traffic on your streams as the monitor information must be sent from StreamBase to RTView.

Write History

Select to enable the writing of a CSV file containing all the data for all tuples received for the streams specified in History Streams. CSV files are written to the DATA subdirectory, located in the directory from which you launched RTView. History Streams must be enabled for Write History to execute.

History Depth

The number of rows RTView keeps in the history table for each stream. Default is 20,000.

RTView Deployment - StreamBase

This section contains details about the deployment process that are specific to your data source. Please go to the Deployment section of this documentation for instructions on how to implement your RTView deployment option. Return to this section whenever you are instructed to refer to deployment information that is specific to your data source.

System Requirements and Setup

The Streambase data source has additional “System Requirements” and “Setup”.

Data Source Configuration File

RTView saves general application settings as well as data source configuration options in initialization files that are read at startup. If no directory has been specified for your initialization files and files are not found in the directory where you started the application, then RTView will search under lib in your installation directory. See “Application Options”, “Application Options - Streambase”, and “RTV_JAVAOPTS” for more information.

Include the following initialization file when you deploy RTView with this data source:

File Name

Description

SBOPTIONS.ini

Contains data source options for StreamBase.

Note: Options specified using command line and applet parameters override values set in these initialization files.

Rich Client Browser Deployment Setup for Direct Data Connection

A. Required Applet Parameters

In addition to basic applet parameters, you must specify the following in your HTML file to host the Display Viewer Applet. See “Rich Client Browser with Direct Data Connection - Manual Setup” for more information.

Include the StreamBase data source in your applet:

1.     Add the following to your ARCHIVE parameter (found under your installation directory in lib):

gmsjsbds.jar 

2.     Add the following applet parameter:

name = ds 

value = com.sl.gmsjsbds.GmsRtViewSbDs 

Note: To specify multiple data sources for the value of the ds parameter, separate them with a ;.

3.     Include the client jar from your StreamBase installation in the ARCHIVE parameter:

sbclient.jar 

B. Optional Applet Parameters

No optional applet parameters are supported for this data source, all options are read from SBOPTIONS.ini.

C. Setup Client

To access a StreamBase application from the Display Viewer Applet, modify your Java security settings to include the following permissions:

permission java.util.PropertyPermission "java.net.preferIPv4Stack", "write";

permission java.util.PropertyPermission "java.io.tmpdir", "read";

permission java.util.PropertyPermission "streambase.read-buf-size", "read";

permission java.util.PropertyPermission "streambase.write-buf-size", "read";

permission java.util.PropertyPermission "streambase.max-queue-size", "read";

permission java.util.PropertyPermission "streambase.tuple-connection-timeout", "read";

permission java.util.PropertyPermission "streambase.reconnect-sleep", "read";

permission java.util.PropertyPermission "streambase.log-level", "read";

permission java.util.PropertyPermission "streambase.max-logfile-size", "read";

permission java.util.PropertyPermission "streambase.logfile", "read";

permission java.util.PropertyPermission "com.streambase.ext.org.apache.xmlrpc.TypeFactory", "read";

permission java.util.PropertyPermission "streambase.tuple-charset", "read";

permission java.util.PropertyPermission "streambase.tmpdir", "read";

permission java.util.PropertyPermission "streambase.packing-percent", "read";

Additional permissions may be required by your StreamBase application.

StreamBase Demos

Except where noted, all demos can be run in three ways, as an application, or via rich or thin client in a browser.

Before You Begin

Start the Demo Server 

Rich Client and Thin Client Demos only. 

There are rich and thin client demos already installed on the “RTView Demo Server”.

In an initialized command window (see “Initializing a Command Prompt or Terminal Window”):

Type run_startup_demoserver 

 

Data Source Demo

The Data Source Demo is designed to illustrate each data source.

1.     Start the Sample StreamBase Application

In an initialized command window (see “Initializing a Command Prompt or Terminal Window”), navigate to the demos/dstutorial directory and type:

run_sbsimapp   

2.     Start the StreamBase Data Simulator

Start the simulators for each data source you will be using. To run the StreamBase Data Simulator:

In an initialized command window (see “Initializing a Command Prompt or Terminal Window”), navigate to the demos/dstutorial directory and type:

run_sbsimdata

3.     Run Demos - Application, Rich Client Browser, or Thin Client Browser

Application Demo 

1. In an initialized command window (see “Initializing a Command Prompt or Terminal Window”), go to the demos/dstutorial directory.

2. To view the demo, type:

run_viewer 

3. To edit the demo, type:

run_builder 

Rich Client Browser Demo

“Start the Demo Server” if it is not running.

1. In an initialized command window (see “Initializing a Command Prompt or Terminal Window”), go to the demos/dstutorial directory.

2. Start the Data Server by typing:

run_dataserver -socket 

3. In the Data Server dialog, select:

Start Serving Data

4. Open a browser and navigate to http://localhost:8068/dstutorial_applet.

Thin Client Browser Demo 

“Start the Demo Server” if it is not running.

1. In an initialized command window (see “Initializing a Command Prompt or Terminal Window”), go to the demos/dstutorial directory.

2. Start the Display Server by typing:

run_displayserver

3. Open a browser and navigate to http://localhost:8068/dstutorial.

 

StreamBase Data Source Command Line Options

In addition to general options, the following command line arguments are enabled with the StreamBase data source when you run RTView applications from a Windows Command Prompt or UNIX terminal window. See “Command Line Options: Display Builder and Display Viewer” for more information.

Note: If a command line argument contains a space or a semicolon, then the entire argument must be enclosed in quotes (e.g.: "-sub:$data:my Data").

Name

Description

-sbds:history.depth:

The number of rows RTView keeps in the history table for each stream. Default is 20,000. Use for short term storage. For longer term storage, use the Historian.

Example:

-sbds:history.depth:5000

-sbds:loadhistory:

Enables the reading of the CSV file, created if Write History is selected, for the specified stream. In order for historical data to be available, the DATA subdirectory, located in the directory from which you launched RTView, must contain a CSV file for the stream. Enter the name of the stream for which you want to read a CSV file and click Add to include it in the History Streams list. To remove history streams from the list, select a history stream on the list and click Remove. See “Application Options - Streambase” for more information.

Example:

-sbds:loadhistory streamname

-sbds:monitor:(true or false)

Select to enable event driven statistics. These statistics will be polled every ten (10) seconds. Default is enabled.

Note: Setting this parameter to true will increase traffic on your streams as the monitor information must be sent from StreamBase to RTView.

Example:

-sbds:monitor:false

-sbds:sim:

Enter the name of the stream that you want to simulate data for and click Add to include it in the Simulated Streams list. To remove streams from the list, select a stream on the list and click Remove. For each stream name specified, the DATA subdirectory, located in the directory from which you launched RTView, must contain a CSV file named stream_name.csv. RTView will look for the CSV file on each update. If found, and the timestamp on the file has changed since the last time it was read, RTView will use the data in the file to simulate data for that stream. The data in the CSV file must match the stream format defined in your .sbapps file.   

Example:

-sbds:sim:streamname

-sbds:streams:

Enter the name of a stream to subscribe to. If no streams are specified, RTView subscribes to all streams on each specified connection (URI). If this option is used, RTView will only subscribe to the streams specified.

Example:

-sbds:streams:streamname

-sbds:writehistory

Select to enable the writing of a CSV file containing all the data for all tuples received for the streams specified in History Streams. CSV files are written to the DATA subdirectory, located in the directory from which you launched RTView. History Streams must be enabled for Write History to execute.

Example:

-sbds:writehistory