Studio Menu Reference

StreamBase Studio adds entries to the Eclipse menus. As with all Eclipse menus, the available menu entries change, based on the perspective or editor you are currently using.

Some menu entries also have keyboard equivalents. When a keyboard shortcut is available, it is displayed after that menu entry.

The following sections describe only the entries added by StreamBase Studio in the Eclipse menu, or clarify an Eclipse menu's behavior in StreamBase Studio. For menu entries not discussed here, consult the Eclipse Help.

File Menu

New

Allows you to create a new StreamBase resource, as well as standard Eclipse resources.

Open File

Opens a selected file in your file system, using the program associated with the file in your system. For example, a CSV file might be opened in your favorite text editor. StreamBase files generally have specialized editors.

Open Projects from the File System

Allows you to import a StreamBase Studio project from the file system into this instance of Studio from a project folder or from a zip file created by the File>Export operation in this or another instance of Studio.

Connectivity Wizard

Invokes the LiveView Connectivity Wizard, which enables you to quickly stand up a LiveView server application for the purpose of streaming live data to Spotfire from certain data sources.

Import

Opens the Eclipse Import dialog. The StreamBase section of the import source tree allows you to import projects from a file system or the StreamBase Component Exchange. See Importing into Studio.

Export

Opens the Eclipse Export dialog. The StreamBase section allows you to export the current application to a StreamBase application bundle. See Exporting from Studio.

Import Samples and Community Content

Opens a dialog that lets you import sample projects that illustrate various aspects of StreamBase and LiveView. You can load sample projects from three sources:

  • Samples included in StreamBase and supported by Spotfire, loaded from your StreamBase installation.

  • Samples supported by Spotfire, loaded from Spotfire's GitHub repository for samples.

  • Samples provided by Spotfire and customers, loaded from Spotfire's GitHub repository for Community Samples.

See Loading Samples in Studio.

StreamBase Component Exchange

Opens a dialog that allows you to download StreamBase projects, libraries, utilities, and components from the StreamBase Component Exchange.

Switch Workspace

Allows you to specify an alternate workspace. When selected, StreamBase Studio closes and reopens using the specified workspace. Use alternate workspaces to organize projects into groups that share resources.

Restart

Restarts StreamBase Studio with the currently open workspace.

Exit

For StreamBase Studio on Windows, closes Studio. On Mac, the StreamBase Studio menu in the toolbar provides the Quit menu to close Studio.

Edit Menu

Select All

This option selects all components in the currently active editor.

The following entries are added to the Edit menu when you are editing in the StreamSQL Editor, which is provided to assist customers who are migrating projects from earlier StreamBase releases that supported StreamSQL. In current StreamBase releases, you can edit StreamSQL but cannot run it in Studio. See StreamSQL Editor.

Show Tooltip Description (F2)

Shows the standard Eclipse pop-up description of the StreamSQL keyword under the cursor.

Word Completion

Completes a StreamSQL term when you have partially entered its name, if the remaining text is unambiguous. If the result is not satisfactory, try typing more text or using Content Assist. Keyboard shortcut is Ctrl+..

Content Assist

In the StreamSQL Editor, shows a drop-down list of keywords and functions that you can choose to insert in a line of StreamSQL code. It may also display syntax and brief help for the current item. To select an item from the list, you can scroll to locate the desired item, or you can begin typing its name. The type ahead feature completes the item when it can do so unambiguously. If you have begun typing a word, Content Assist may complete the word without displaying a list, as with Word Completion. Keyboard shortcut is Ctrl+space.

Parameter Hints

Displays brief help if you hover your cursor over a function name in a StreamSQL statement.

Navigate Menu

Open StreamBase Resource

Opens the Open StreamBase Resource dialog. This dialog allows you to look up and open StreamBase-specific resources anywhere in your workspace, across all current projects in the workspace. The StreamBase resources included in the list are all StreamBase-related file types in the workspace.

You must type a search string before the list of resources is populated. Enter a single asterisk to show all resources in your workspace.

Project Menu

Build Automatically

Under most circumstances, leave this item checked. If checked, when you save an EventFlow Editor editing session, that application and all StreamBase applications in your workspace are typechecked. When unchecked, automatic typechecking on save does not occur.

EventFlow Menu

This menu is only available when the EventFlow Editor has focus, and provides menu access to many of the functions provided by the StreamBase toolbar or the EventFlow context menu.

Refactor

Extract as Module (on the submenu):

Replaces the selected components in the current EventFlow module with a Module Reference, and creates a new module in the current project folder. See Extracting a Module.

JDBC Operator Schemas Wizard (on the submenu):

Starts the JDBC Query Operator Schema Refactor wizard as described in Refactor All JDBC Query Operators.

Remove Unused Imports Wizard (on the submenu):

Starts the Remove Unused Import wizard as described in Minimizing Module Imports.

Align

When two or more components are selected on the EventFlow canvas, provides a submenu with six options for aligning the selected items on the canvas: Align Left, Align Center, Align Right, Align Top, Align Middle, Align Bottom.

Snap to Geometry

A toggle that enables the blue alignment lines that appear when moving a component icon on the canvas to help you align the component with adjacent ones.

Quick Outline

Opens a pop-up summary of the components in the current EventFlow — a faster alternative to the Outline view.

Module Call Hierarchy

Opens the Module Call Hierarchy view to examine the module calling order of the currently selected EventFlow module.

View Source

Displays a pop-up window showing the XML source of the current EventFlow module. If a single component is selected, the window contains the XML source code for that component only. If you select zero or multiple components, the entire application is shown.

Typecheck

Typechecks the current EventFlow module. See Typechecking.

Automatically Typecheck

Toggles the state of automatic typechecking.

Center Selection

Centers the selected components in the current EventFlow Editor canvas.

Layout Application

Rearranges the EventFlow module's components and connections on the Editor canvas.

Zoom to Fit

Zooms the current EventFlow module in or out to fit the current Editor canvas.

Open Declaration

When a Module Reference is selected, opens the EventFlow file that defines that module. When the icon for a custom Java operator or adapter is selected, opens the Java source file for that Java operator or adapter, if the source is available in the current Studio workspace.

Insert Menu

This menu is only available when the EventFlow Editor has focus. It provides a set of menu and keyboard-based alternatives to dragging and dropping components from the Palette View to the canvas. Notice that each item in the Insert menu lists a keyboard shortcut.

Run Menu

Terminate LiveView Fragment

Stops the currently running LiveView fragment, if one is running. If more than one is running, Studio prompts you to select which LiveView fragments you want to stop.

Terminate EventFlow Fragment

Stops the currently running EventFlow fragment, if one is running. If more than one is running, Studio prompts you to select which EventFlow fragments you want to stop.

Run

By default, runs the currently selected EventFlow module, or runs the launch configuration associated with the selected application, or re-runs the last-run configuration. The behavior of the Run button can be changed using Window>Preferences, then Run/Debug>Launching.

Run History

Provides a menu of recently run launch configurations.

Run As

When an EventFlow module has the current focus, the Run As menu has one submenu, StreamBase Application that runs the currently selected EventFlow module using Studio's default launch configuration. You can modify the default launch configuration using Window>Preferences, then Run/Debug>Launching.

Run Configurations

Opens the Eclipse launch configuration dialog, where you can create, edit, and run launch configurations for Eclipse-hosted applications, including StreamBase applications.

Debug, Debug History, Debug As, Debug Configurations

These options are the same as their Run counterparts, except that they run the selected application in debug mode, and allow you to specify a saved debug configuration.

External Tools

Provides tools to configure an Ant build, or to run another external build tool. This is an Eclipse feature not expected to be useful for StreamBase applications.

Window Menu

This menu is available in standard Eclipse. For a menu description see the Eclipse documentation on www.eclipse.org

However, StreamBase Studio users often have need of the settings in the Preferences menu item. The settings provide methods to manage the various views and perspectives in Eclipse, including those contributed by StreamBase Studio. See Studio Preference Settings for more information.

Help Menu

This menu provides help on using StreamBase and StreamBase Studio.

Welcome

Opens the StreamBase Welcome page.

Help Contents

Displays Help contents in an Eclipse Help window or external browser. The help contains books, topics, and information for StreamBase, together with information about Eclipse-contributed components.

Search

Opens a Help view where you can search the Help systems of all current Eclipse plug-ins. To narrow the search to include only StreamBase Help, use the Search scope control.

Show Context Help

Opens a Help view in the Related Topics pane, where you get help text for the active view which dynamically updates as the active view changes.

Show Active Keybindings...

View key bindings available for StreamBase Studio commands. To change a binding, select its name in the Key Assist list and press Shift+Ctrl+L or Shift+Cmd+L.

Tips and Tricks...

Opens the Tips and Tricks dialog.

  • Select Eclipse Java Development Tools to see a page of Tips and Tricks (JDT). You get Platform Tips and Tricks for general Eclipse tips and What's New (JDT) for features in the current release.

  • Select Eclipse Platform to see a page for general Eclipse tips.

Cheat Sheets...

Opens the Cheat Sheet Selection dialog, from which you can open a cheat sheet for StreamBase Studio or other Eclipse plug-ins. A cheat sheet is an interactive tutorial that guides you through a demonstration or topic, step by step.

Eclipse User Storage

Allows users to store project information and data on the Eclipse Foundation server.

  • Select Eclipse User Storage>Open My Account to create an Eclipse account.

  • Select Eclipse User Storage>Open Marketplace Favorites... to create and share favorites list for transactions and URLs.

  • Select Eclipse User Storage>Sign Out to end your Eclipse session.

Check for Updates

Checks for the latest recommended updates for Eclipse plug-ins from available software sites.

Install New Software

Opens the installation dialog, from which you can access the Eclipse mechanism for installing Eclipse plug-ins and updates from an Eclipse update site.

Eclipse Marketplace...

Opens the Eclipse Marketplace wizard, from which you can browse and install Eclipse-based solutions listed on the Eclipse Marketplace portal.

Evaluate StreamBase Expression...

Use to evaluate any expression used in any Steaming project. You can experiment with the expressions until you get the results you want in the Result box. See function for more information.

Synchronize StreamBase Maven Artifacts

This menu option forces Studio to rerun its population of the local Maven repository with all Streaming-related artifacts.

StreamBase Expressions Guide

Opens the core reference document for StreamBase expression language features.

StreamBase Functions Guide

Opens the core function reference for the StreamBase expression language.

Studio Resource Center

Launches the Studio Resource Center view, which provides a hands-on walkthrough of StreamBase Studio, its different perspectives, and how to run a simple EventFlow fragment. The Resource Center also includes links to Spotfire Streaming and LiveView user documentation.

StreamBase Secrets Helper...

Opens a dialog box where you can encrypt sensitive data (such as passwords) for use in Streaming configuration files. You can also generate a substitutions file to use with a runtime node. Users can browse for the Keystore file or create a new Keystore to store encrypted values.

Press Ctrl+1 to activate the StreamBase Secrets Helper dialog box in:

  • The HOCON Forms editor when editing a sensitive field. A small lock icon next to the text field appears.

  • The HOCON text editor when the cursor is editing a sensitive field.

StreamBase Support Wizard...

This wizard can collect information about your system, StreamBase Studio, projects, launch configurations, and node snapshots and create an archive file suitable for sending it to our product support. Select Basic Information and Advanced options relevant to the issue you are experiencing. See StreamBase Support Wizard for more information.

Register JDBC Driver For Feedsim...

Opens a dialog box to create a JDBC driver fragment for use in feed simulations. See Feed Simulation with a JDBC Data Source for more information.

About StreamBase® Studio

Note

For macOS users, click StreamBase Studio>About StreamBase® Studio.

Displays feature, license, and plug-in information about the current release of StreamBase. Click on the Installation Details button to get all the details of Installed Software, Installation History, Features, Plug-ins, and Configuration of your running system.

Click on the Installation Details>Configuration to get following information:

  • System and Virtual Machine properties

  • Eclipse installation details, like installed features and plugins

  • Preferences

  • Installed OSGi bundles

  • Security configuration

  • Streaming version information

Click on View Error Log to display information about current error condition. Use this when communicating with Product Customer Support.