- Index

< Previous |  | Next >

# EventFlow Editor Command Reference

This topic describes the commands you can use while working in the EventFlow Editor canvas. The availability of each command depends on your selection, focus, or mouse position in the canvas.

Many of these commands are available in multiple places: in a Studio menu, in the right-click context menu, in a toolbar button, or with a keyboard shortcut. The following table is in alphabetical order by command name.

Command | Description | On Context Menu? | On StreamBase Studio Menu? | Toolbar Button?
--- | --- | --- | --- | ---
Add Note | Creates a note associated with one or more selected components. See Using Notes. Keyboard shortcut: / | Yes | Insert → Note | No
Add Input Stream To Port `n` | Available only if your mouse is over the input port of a component. Creates an input stream attached to the specified port. This is a quicker alternative to dragging an input stream from the Palette. | Yes, when over an input port with no stream attached. | No | No
Add Output Stream To Port `n` | Same as above, but for output streams. | Yes, when over an output port with no stream attached. | No | No
Align | Shows a submenu with two parts: Align Left, Center, and Right align the selected components vertically along their left sides, vertical center lines, or right sides, respectively. Align Top, Middle, and Bottom align the selected components horizontally along their top sides, horizontal middle lines, or bottom sides, respectively. Keyboard shortcuts: Ctrl+J for Align Center and Ctrl+K for Align Middle. | Yes, when two or more components are selected. | EventFlow menu |
Center Selection | Available when one or more components in the Editor are selected. Centers the view in the Editor with the selected component in the center of the new view. | No | EventFlow menu | No
Compare Schemas | Only appears in the context menu when you have selected two arcs or two streams in the canvas. Opens the Compare Schemas dialog as described in Compare Schemas. | Yes, with two arcs or two streams selected. | No | No
Compare With | Initiates an EventFlow comparison operation, and opens the Studio Compare Editor on the selected files or file versions to compare two files, or the current module with an earlier version in Studio's local history, or with a version in a supported version control system. | Yes | No | No
Debug As > EventFlow Fragment | Attempts to run the current EventFlow module in debugging mode as a fragment in a node. | Yes | Debug menu |
Debug As > EventFlow Fragment Unit Test | Attempts to run the Java and EventFlow debuggers on the current Java test file, as a way to debug the test. The sbapp file specified in the test is launched into a node. You can also select the entire `src/test/java` folder to Debug all EventFlow module test files therein. | Yes | Debug menu |
Debug As > Java Fragment Unit Test | Attempts to run the Java debugger on the current Java test file, as a way to debug the test. You can also select the entire `src/test/java` folder to Debug all Java test files therein. | Yes | Debug menu |
Disable Arc | Disables the selected arc and all downstream components. Tuples arriving at the beginning of a disabled arc are not passed to its end. See Commenting Out. Keyboard shortcut: Ctrl+/ | Yes, when the current selection is a single arc. | No | No
Disable Breakpoint | Disables a breakpoint on an arc. An enabled breakpoint appears as a filled circle; in that state, this menu option disables it. Use Toggle Breakpoint to place or remove breakpoints from arcs. Keyboard shortcut: Ctrl+Shift+B | Yes, when the current selection is an arc with a breakpoint. | No | No
Disable Component | Disables the selected component, including all input and output ports, and all downstream components. See Commenting Out. Keyboard shortcut: Ctrl+/ | Yes, when the current selection is a non-arc component. | No | No
Enable Arc | Only appears in the context menu when the current selection is a disabled arc. Re-enables the disabled arc. See Commenting Out. Keyboard shortcut: Ctrl+/ | Yes, when the current selection is a disabled arc. | No | No
Enable Breakpoint | Enables a disabled breakpoint on an arc. A disabled breakpoint appears as an open circle; in that state, this menu option enables it. Use Toggle Breakpoint to place or remove breakpoints from arcs. Keyboard shortcut: Ctrl+Shift+B | Yes, when the current selection is an arc with a breakpoint. | No | No
Enable Component | Only appears in the context menu when the current selection is a disabled component. Re-enables the disabled component. See Commenting Out. Keyboard shortcut: Ctrl+/ | Yes, when the current selection is a disabled component. | No | No
Export view as PNG | Allows you to save the currently visible portion of the current EventFlow Editor, at its current zoom level, to an image file in portable network graphics format. Opens the Export Diagram as PNG dialog, in which you specify a name for the image file. You can navigate anywhere in your file system to save the image file. | Yes | No | No
Extract ... | See Refactor > Extract ...
Insert Operator | Only appears in the context menu when you have selected an arc. Allows you to replace the selected arc with a Filter, Map, Split, or Union operator, with new arcs drawn from the newly added operator to the upstream and downstream components. | Yes, when one arc is selected. | No | No
Group Selection | Creates a group containing the select components. See Using Groups. Keyboard shortcut: Ctrl+G | Yes, with two or more components selected. | No | No
Layout Application | Rearranges the EventFlow module's components and connections on the Editor canvas. Keyboard shortcut: Ctrl+L | No | EventFlow menu |
Module Call Hierarchy | Opens the Module Call Hierarchy view for the currently active application. | Yes | EventFlow menu | No
Open Declaration | When a Module Reference is selected, opens the EventFlow file that defines that module. When an Extension Point is selected, opens the associated Interface Editor. 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. (Source for StreamBase-provided operators and adapters is not in your workspace, and cannot be opened.) Keyboard shortcut: F3 | Yes | EventFlow menu | No
Quick Outline | Displays the whole application's components and details in a Quick Outline window. See Quick Outline. Keyboard shortcut: Ctrl+O | Yes | EventFlow menu | No
Rearrange Components and Arcs | Rearranges all components and arcs on this canvas for the best and clearest left-to-right layout, then runs the Reroute Arcs function. With a few adjacent components selected, rearranges only those components, then centers the EventFlow canvas on them. Keyboard shortcut: Ctrl+Alt+L on Windows, or Shift+L on Linux. | No | EventFlow menu: Layout Application |
Refactor > Extract As Module | Extracts the selected components and places them in a new module in the current project folder, then replaces the selected components with a Module Reference pointing to the new module. See Extracting a Module. | Yes, on the Refactor submenu, with two or more components selected. | EventFlow menu, Refactor submenu | No
Refactor > Extract Interface | Opens the Extract Interface dialog that allows you to create a StreamBase interface file from the selected streams and components. | Yes, on the Refactor submenu. | No | No
Refactor > Extract Named Schema | Opens the Promote to Named Schema dialog, which allows you to save the schema of the currently selected component as a named schema in the Definitions tab for the current module. See Promoting a Private Schema to a Named Schema. | Yes, on the Refactor submenu, when a stream or schema-bearing component is selected. | No | No
Refactor > Extract Table Schema | Opens the Refactor to Table Schema dialog, which allows you to save the schema and indexes of the currently selected Query Table as a table schema in the Definitions tab for the current module. See Refactoring a Query Table to a Table Schema. | Yes, on the Refactor submenu, when a Query Table is selected. | No | No
Refactor > JDBC Query Operator Schemas Wizard | Starts the JDBC Query Operator Schema Refactor wizard as described in Refactor All JDBC Query Operators. | Yes, on the Refactor submenu. | EventFlow menu, Refactor submenu | No
Refactor > Remove Unused Imports Wizard | Starts the Remove Unused Import wizard as described in Minimizing Module Imports. | No | EventFlow menu, Refactor submenu | No
Refactor > Rename | Allows you to rename the selected component and propagate the name change to all components in the module search path that reference that component. The name is changed for the selection itself and everywhere it appears. By contrast, when you press F2 (Enter on Mac) to rename, the new name is only local (for the current canvas only). Keyboard shortcut: Alt+Shift+R | Yes, on the Refactor submenu, with one component selected. | No | No
Refresh Project Typecheck Environment | If you have Java code in the current project (providing, for example, a custom operator or adapter), run this command when you have changed any Java code, to force the EventFlow module to reread the changed Java code. Keyboard shortcut: F5 | Yes | No | No
Replace With | Initiates an EventFlow comparison operation, and opens the Studio Compare Editor on the selected files or file versions to compare two files, or the current module with an earlier version in Studio's local history, or with a version in a supported version control system. | Yes | No | No
Reroute Arcs | Reroutes all arcs on this canvas, introducing curves and bends in arcs to route around components. If one or more arcs is selected, reroutes only the selected arcs. Keyboard shortcut: Ctrl+Alt+L | No | EventFlow menu |
Run As > EventFlow Fragment | Attempts to run the current EventFlow module as a fragment in a node. | Yes | Run menu |
Run As > EventFlow Fragment Unit Test | Attempts to run the current Java test file as a JUnit test using the EventFlow degugger. The sbapp file specified in the test file is launched into a node the test. You can also select the entire `src/test/java` folder to Run all EventFlow module test files therein. | Yes | Run menu |
Run As > Java Fragment Unit Test | Attempts to run the current Java test file as a JUnit test using the Java debugger. You can also select the entire `src/test/java` folder to Run all Java test files therein. | Yes | Run menu |
Typecheck | Typechecks the selected components in the EventFlow Editor, or the entire EventFlow module, if no components are selected. Keyboard shortcut: Ctrl+T | No | EventFlow menu |
Toggle Breakpoint | Places or removes a breakpoint on an arc. Once a breakpoint is in place, the Disable and Enable Breakpoint menu options are active. Keyboard shortcut: Ctrl+Shift+B | Yes, when an arc is selected. | No | No
Undo {`Edit`} | Reverse changes to the last edited component where {`Edit`} is replaced with the exact editing task. Keyboard shortcut: Ctrl+Z | Yes | Edit menu | No
View Module with Overridden Schema | Non-hygienic modules can have the schemas of their input streams overridden by the schema of the corresponding input port of the calling Module Reference. This command opens a read-only EventFlow Editor canvas that shows the referenced module with its input stream schemas overridden. This feature helps you understand and debug how a non-hygienic module is actually used at runtime. See EventFlow Editor Read-Only Canvas. | Yes, only in the context menu for a Module Reference that references a non-hygienic module. | No | No
View Source | Displays a pop-up window showing the XML source of the current EventFlow module. If a single component is currently selected, the window contains the XML source code for that component only. If you select zero or multiple components, the entire application is shown. To hide GUI-related code (which has no functional effect) in the View Source window, select the Filter non-semantic elements check box. | Yes | EventFlow menu | No
Zoom In | Increments the zoom factor of the entire EventFlow module, making details larger. If the application becomes larger than the Editor window, scroll bars are displayed. If your Windows or Linux computer has a mouse with a scroll wheel (or a touchpad that emulates a scroll wheel), and the wheel is enabled, then Ctrl + Mouse Wheel also zooms in. For this feature to work, you must click anywhere in the EventFlow Editor canvas to select it. | Yes | EventFlow menu |
Zoom Out | Decrements the zoom factor of the entire EventFlow module, making details smaller. Ctrl + Mouse Wheel also zooms out. See the note directly above. | Yes | EventFlow menu |
Zoom to Fit | Zooms the current EventFlow module in or out to fit the current Editor canvas. | No | EventFlow menu |

Back to Top ^