StreamBase Studio Preferences

The following preferences can be set in the main StreamBase Studio page:

Main page preferences, descriptions, and default settings

Option	Description	Default
StreamBase Installation Location	The root directory where the current release of StreamBase is installed. This is where Studio looks for global operators and adapters at startup. If you modify this setting, restart Studio for the change to take effect. Do not change this setting, except under the direction of StreamBase Technical Support.	On Windows: `C:\Program Files\StreamBase Systems\StreamBase.n.m` On UNIX: `/opt/streambase`
Deprecated Global Operators/Adapters	When disabled (default), Studio does not load deprecated operators or adapters and does not display them in the Global Operators & Adapters Palette drawer. When enabled, deprecated operators or adapters are loaded and displayed in the Palette. An operator or adapter is marked deprecated with the Java annotation @Deprecated in its primary Java source file. You can mark your custom operators or adapters deprecated as your application evolves and new components replace older ones. StreamBase Systems occasionally marks certain components as deprecated to encourage the use of newer components. If you are working on a legacy application and need to continue using a deprecated component, enable this setting. With this setting disabled, the display of EventFlow applications that were saved with now-deprecated components is not affected. However, such applications cannot pass typechecking and cannot be run in Studio, because the code that underlies the deprecated components was not loaded. You can continue to work on such applications by enabling this option, or by upgrading the deprecated components with their replacements.	Disabled.
Automatic Perspective Switching	A perspective is a collection of Eclipse views that are opened together to perform a task. StreamBase Studio can be set to automatically switch between perspectives on certain triggering events. The Switch to SB Test/Debug perspective when running an application checkbox applies only to Studio's default launch configuration. To change the perspective-changing behavior of customized StreamBase run and debug configurations, go to the Run/Debug → Perspectives page in Window → Perspectives. The Switch to SB Authoring perspective when stopping an application checkbox applies to running all StreamBase applications, whether started with the default launch configuration or a custom one.	Both options selected.
Auto-save Options	When you attempt to run an application, StreamBase Studio checks for unsaved files and resources in the current project, which must be saved before proceeding. This preference controls how and when resources are saved before running applications. The options are: Save without prompting Automatically saves if unsaved resources are detected. The Save Resources dialog is never displayed. Prompt for save each time Displays the Save Resources dialog if unsaved resources are detected. Ask me next time This option has the following effect when you run an application: If the application has unsaved changes, the Enable Auto-save On Run dialog is displayed. This dialog lets you change your Auto-save preference to Save without prompting) without reopening the Preferences window. If there are no unsaved changes, the application runs immediately. When either of the first two options is set, the Ask me next time option is no longer shown in the Preferences page. To make it visible again, click Restore Defaults, then close and reopen StreamBase Studio.	Ask me next time
Confirmation Messages	Some StreamBase Studio confirmation dialogs include a check box labeled Do not show this again, which lets you suppress that confirmation dialog in the future. Click the Restore button to restore the original behavior for all confirmation dialogs.	Off

Authoring Preferences

Use this page to set options for the SB Authoring perspective. Note that the EventFlow Editor options do not affect the StreamSQL Editor.

Authoring page preferences, descriptions, and default settings

Option Description Default

EventFlow Editor

Automatically typecheck components

Specifies that components are automatically typechecked as you build your EventFlow application. Disable this preference to suppress automatic typechecking.

This preference has no effect on StreamSQL applications, which are always typechecked automatically. See Typechecking for more on StreamBase typechecking.

Enabled

Display additional label above components

Specifies the amount and type of information to display in blue lettering above certain components on the EventFlow canvas. Specify one of the following:

Module Reference/Class Name: Show the names only of module references, embedded operators, and adapters. (For custom operators and adapters, the name shown is the one set with the setShortDisplayName() API.)
Component Type: Show the type of each component (not including input and output streams).
Nothing: Show no labels.

Module Reference/Class Name

Show tooltips

Specifies that summary information about each component is to be shown when you hover the mouse pointer over an icon or arc on the canvas. For example:

Enabled

Show asynchronous ports

Displays a black triangle on each output port of operators that emit tuples asynchronously. For example:

The components that display the asynchronous indicator are:

Heartbeat and Metronome operators.
Any operator whose concurrency option Run in a separate thread is enabled.
All operators downstream from an operator whose concurrency option is enabled.
A module referencing an application that contains a component with asynchronous ports.

Disabled

Show indicator for components that run in a separate thread

Displays a circle around each operator whose concurrency option Run in a separate thread is enabled. For example:

Enabled

Automatically select newly inserted components Specifies that components newly placed on the EventFlow canvas are automatically selected. This automatically opens the new component's Properties view. Disabled

Save and restore view location and zoom factor When enabled, Studio preserves the current zoom level of EventFlow Editor sessions and the position of components relative to the top left corner of the EventFlow Editor canvas. These display features are saved when you save the EventFlow application, and are restored when you re-open the application. Enabled

Layout persistence option

Controls how layout and semantic elements are stored in EventFlow source files:

Keep in application file: Layout and semantic information are stored together in the EventFlow source file (the sbapp file).
Keep in layout: Layout information is removed from the EventFlow source file and is stored in a separate file with sblayout extension.
Discard: Layout information is omitted in the EventFlow file and is not preserved anywhere.

This preference setting is persistent for all projects in your workspace. You can override these settings and separate the layout of individual EventFlow files as described in Using EventFlow Layout Options.

Keep in application file

Layout options when single item is selected

The toolbar's Rearrange Components button (

) is normally used to automatically rearrange either an entire EventFlow diagram, or the selected set of components. If you have only one component icon selected when you click this button, StreamBase does not know what to do, and prompts for permission to rearrange the entire diagram instead. This preference specifies the default answer for the Single item is selected dialog.

The options are:

Do nothing. This has the effect of disabling the Rearrange Component button when a single item is selected.
Layout all items. This is equivalent to clicking the Yes button in the Single item is selected dialog.
Ask me next time has the effect of re-enabling the Single item is selected dialog if disabled by checking its Remember my decision checkbox.

Ask me next time

Select error input stream automatically when inserting new one.

Error input streams are described in Using Error Ports and Error Streams. This option determines whether newly added error input streams are automatically selected. This option allows you to automatically select all newly added components, except error input streams. That is, it can override the Automatically select newly inserted components option above, only for error input streams.

The options are:

Do nothing.
Select it.
Ask me next time.

Ask me next time

Group Background Color Specifies the default background color for newly created groups in the EventFlow canvas. See Groups for more on EventFlow groups. The default color is #8080FF, a medium purple.

New Project Options

Always create empty EventFlow Specifies the default state of the Create empty EventFlow Application file checkbox in the New StreamBase Project dialog. Enabled

Always create template server configuration file Specifies the default state of the Create default server configuration file checkbox in the New StreamBase Project dialog. Enabled

Outline View

Show empty categories (EventFlow Editor) Displays container folders in the Outline view for every component type, even if the application contains no instances of some components. By default, the view contains only Outline view categories for existing components. Disabled

For detailed information about using these options, see the EventFlow Editor topic.

Java Wizards Preferences

Specifies the location of the Java client API libraries used for developing custom Java clients, operators, and adapters. By default, StreamBase uses the clientapi.jar file installed with this StreamBase release.

Launching Preferences

Launching preferences, descriptions, and default settings

Option Description Default

Launch Options

Default Launch server

Either Local Server or Remote Server. This preference affects the Run button, and its Debug counterpart in the StreamBase Studio toolbar.

Select Remote Server to specify that clicking the Run or Debug button always runs the current StreamBase application against a remote server instance. Specify the default host name and remote user name elsewhere on this Preferences page.

The default is to run against a local server instance on the machine running StreamBase Studio.

Local Server

Open editor for running StreamBase Application when launched The application opens in the EventFlow or StreamSQL editor, as appropriate for the selected application. Enabled

Remote Options

Remote options, if set, are used as workspace defaults in the StreamBase launch configuration wizard.

Default remote server

If you select the Remote Server option above, enter the name of the host UNIX machine where the StreamBase software is installed.

The server machine can be any valid DNS name or IP address. If your administrator gave you a specific port number, enter it after the server name and a colon. (For example: machine.example.com:10001).

empty

Default remote user Enter a user name in the User Name field that will allow you to connect to the server machine. Your current local user name is entered by default. Change this, if necessary, to reflect the correct user name for the remote server.

Use SSH tunneling for all server connections

Enable SSH tunneling for the connection to the remote host UNIX machine where StreamBase is installed. When you start StreamBase Studio, StreamBase normally detects whether tunneling is required (for example, when the server host has a firewall).

Note

Before connecting from StreamBase Studio to a remote UNIX host machine, the remote system must have an SSH daemon running with TCP port forwarding enabled. You or the administrator must ensure that the /etc/ssh/sshd_config file on that host does not contain these uncommented line:

AllowTcpForwarding No

If you update the sshd_config file, remember to restart the SSH daemon before launching StreamBase Studio on client machines.

If you do not enable tunneling and StreamBase later detects that it is needed, StreamBase displays a prompt like the following example that gives you another chance to enable it.

Click Yes to enable SSH tunneling for the connection to StreamBase Server's host machine. If you are not certain, contact the administrator of the host machine.

Disabled

SSH Authentication

Either Password Authentication or Keyboard-Interactive.

Specify Password Authentication, the default, to connect to a server whose SSH configuration allows it. If the server hosting StreamBase Server has an SSH configuration that allows keyboard-interactive authentication, select Keyboard-Interactive.

Some servers, including Solaris servers, may be configured to only allow keyboard-interactive SSH authentication. In this case, you must select Keyboard-Interactive to connect to StreamBase Server running on such hosts.

If your Linux host runs OpenSSH as its SSH implementation, you specify keyboard-interactive authentication by setting ChallengeResponseAuthentication to yes in the sshd_config file and restarting the SSH daemon. Consult your site's SSH administrators for details on configuring SSH on your server machines.

Password Authenticaion

Test/Debug Preferences

The following preferences can be set for the SB Test/Debug perspective:

Test/debug preferences, descriptions, and default settings

Option	Description	Default
Tuple Buffer Size
Application Input View	When you run an application and enqueue data, the number of input tuples can become quite large. It can be helpful to limit the number of tuples in the Application Input view's display buffer. When the limit is reached, newer tuples are kept in the view while older tuples are allowed to scroll off the view. The specified display buffer size applies to the total number of tuples in the Application Input view, from the total of all input streams.	400 tuples
Application Output View	Same as above, but for output tuples in the Application Output view. The specified display buffer size applies to the display of each output stream, as well as when (All Output Streams) is selected.	400 tuples
Application Output View Highlight Color	Specifies the color applied to matching rows in the Application Output view when you have specified a filter in the Application Output Filter dialog, and have selected hightlight selected in the Results field.	#FFFF00, a solid yellow
Field Value Formatting Options
Indicate nulls using	The null token is used in Test/Debug editors and views when a field contains no value. You can substitute any string to indicate nulls.	"null"
Display blobs as	Show the first few characters of blob fields as hexadecimal values or ASCII characters.	Hex
Maximum blob characters to display	Specifies the number of bytes of blob fields to display as character data in the Application Output view.	16
Server Port
Default Port	Specifies the default TCP port number used by StreamBase Server when launched from Studio, on which to listen for client connections. If a server port number is specified in an application's server configuration file, it overrides this and the next setting on this preferences panel. See server .	10000
If default port is not available	When attempting to run an application from Studio, if the port specified in Default Port is in use: Try another random port Automatically select another port. Fail launch Block attempts to launch the server from Studio.	Try another random port

Setting Preferences

Use the buttons on the Preferences page as follows:

Click Apply to preserve your changes for the current page. If you set preferences on two pages, click Apply on the first page before moving on to the next page.
Click Restore Defaults to restore the state of a page's settings as installed.
Click OK to preserve changes for the current page and exit the Preferences dialog. Changes that require you to restart StreamBase Studio for the setting to take effect are noted in the tables above. Otherwise, changes take effect immediately when you click OK.

Back to Top ^