Studio Button Reference

The following table describes the buttons and icons you might see in StreamBase Studio.

New StreamBase Project

In the Project Explorer or Open StreamBase Resource dialog, marks a Studio project. As a toolbar button, opens the New StreamBase Project dialog.

New EventFlow Application

In the Project Explorer or Open StreamBase Resource dialog, marks an EventFlow application file. As a toolbar button, opens the New StreamBase EventFlow Application dialog. Click the down arrow to select New StreamBase Interface.

New StreamBase Server Configuration File

In the Project Explorer or Open StreamBase Resource dialog, marks a server configuration file.

New Feed Simulation

In the Project Explorer or Open StreamBase Resource dialog, marks a feed simulation file. As a toolbar button, opens the New Feed Simulation dialog, where you can create a new feed simulation for the currently selected application.

New StreamBase Unit Test

Opens the New StreamBase Unit Test Class dialog.

New LiveView Configuration File

Opens the New StreamBase LiveView Configuration dialog.

Open StreamBase Resource

Opens the Open StreamBase Resource dialog.

Warning

Alerts you to a potential problem and, if appropriate, suggests how to avoid it.

Error

Indicates a typecheck error in a component in an EventFlow module. Messages describing typecheck errors are displayed in Properties views.

Apply and typecheck

In the main toolbar, runs a typecheck validation pass on the currently open and selected module. In the toolbar of a Properties view, applies the changes you made for this component's Properties view tabs, without having to save the module. Note that is it normally unnecessary to explicitly typecheck, because StreamBase Studio automatically typechecks your application as you work.

Revert

Displayed in the Properties view. This button reverts changes to the current operator since the last time it was saved (reverting to its previous settings).

Help

Displayed in several views and dialogs. Opens a help topic specific to the currently selected window or tab.

Add

Adds a row to the end of an editable table in the Properties view, Feed Simulation Editor, and other dialogs. If you click the arrow to the right of the button, you can specify whether the row is to be added above or below the currently selected row. When you add a row, the newly created row is highlighted. To start entering information, click in the cell you want to edit. (However, some cells are not user-editable.)

Remove

Removes the currently selected row in an editable table (Properties view). Click the arrow to the right of the button to remove all rows in the table.

Copy Schema

Displayed in the Edit Schema tab of Properties views that enable you to modify schemas, in the Feed Simulation Editor, and in several dialogs. Pre-fills the table with a schema that already exists in another component. The component can be selected from any module in your Studio workspace. See Copying Schemas.

Fill All Rows

Displayed in the Output Settings tab of Map operator Properties view, if you select the explicitly specified fields Output Type option. Pre-fills the table with all output fields from the previous component. You then specify the changes you want to make by applying the Add, Replace, or Remove action to each field. The arrow to the right of the button lets you load specific input fields instead of all fields.

Pass All

Displayed in the Output Settings tab of Map operator Properties view, if you select the all input fields Output Type option. Clicking the button fills the table with all output fields from the input stream. You can also click the triangle to the right of the button, and select specific input fields to load. You can then modify the default action on each field (which simply passes the input field through unchanged). For example, you can change the Replace expression, or add or remove fields.

Move Up and Move Down

Displayed in the Edit Schema tab of Properties views that enable you to modify schemas. Move Up selects the previous row in the schema if one exists; Move Down selects the next row.

Open Perspective

Displays a short list of perspectives (based on your recent activities) that you might choose to open. To see all available perspectives, choose the Other option to open the Open Perspective dialog.

Assign All

Displayed in Input Port and Output Port tabs of the Module Reference Properties view. Automatically assigns input streams from the referenced application to the Module Reference input or output ports. The streams are assigned to ports in sorted order. Also creates any missing ports needed for the assignment.

Disable Dequeuing

When running an application in the SB Test/Debug perspective (for example, using a feed simulation), prevents output from appearing in the Output Streams view. This can speed up the application's performance in StreamBase Studio.

Show Details or Expressions Pane

In the Input Streams and Output Streams View, displays or hides (toggles) the details pane of the Details pane shows all the fields of a row that you select in the view.

In Properties views where expressions are required, provides a range of information to help you write expressions, such as the names of fields and functions.

Scroll Lock

When running an application in StreamBase Studio, prevents the Input Streams or Output view from automatically scrolling during execution. You can use the view's scrollbar to navigate rows of input or output.

Filter

In the Output Streams view, opens the Output Streams Filter dialog, which allows you to specify a string to match against incoming field names or field contents.

Collapse All

Collapses all nodes nested list of items.

Follow Editor

Selects components in the Outline view when you select them in the EventFlow Editor.

Clear (filter)

In a filter control, deletes any text in the filter and stops filtering. For example, in the Outline view, causes all components to be included.

Stop Node

Stops the selected node.

Remove Node

Removes the selected node. If you select a node that is currently started, and containing an EventFlow or LiveView running fragment, Studio prompts for confirmation.

Force Remove Node

Forcefully removes the selected node. If you select a node that is currently started, and contains an EventFlow or LiveView running fragment, Studio prompts for confirmation.

Snapshot

Exports a snapshot of the currently selected node's logs and runtime state, based on the contents of its node directory. This might be requested by Support to aid in troubleshooting a failed node deployment.

Select the node of interest before clicking the Snapshot button. This opens a dialog that prompts for the location to write the snapshot zip file. The default location is a folder named snapshots/nodedir in the current Studio workspace, where nodedir is the name of the selected node.

If you select a cluster name or engine name before clicking Snapshot, the resulting dialog prompts for the location of the node directory of interest. Navigate into the .nodes subdirectory of your Studio workspace, then select the node directory. If you click Next in this dialog, it prompts for the target location of the snapshot zip file as above.

Display

This button determines the set of installed nodes to display in the Clusters view. The button toggles between showing only the nodes in the same Studio workspace (default) and showing all nodes in the IP subnet of the current machine. Local workspace nodes include nodes installed by Studio even if you change the default cluster name during this Studio session, and those installed from the command line with epadmin, as long as the cluster name matches.

The Cluster name setting can be managed in the StreamBase Studio>Cluster panel of the Studio Preferences dialog, and is the system login name of the current user by default.

Refresh

Forces a refresh of the displayed clusters and nodes.

Drop-down menu

The drop-down menu provides an option to locate the Properties panel on the right of the Clusters, Nodes, and Engines panel or on the bottom.