Keyboard Shortcuts

This section describes all the keyboard shortcuts that are available to use in Stroom. Some shortcuts apply everywhere and some are specific to the screen that you are in or the user interface component that has focus.

Keyboard shortcuts can take two forms:

Combination - Multiple keys pressed at the same time, e.g. ctrl+enter.
Sequence - Multiple keys pressed in sequence with only one key pressed at a time, e.g. g+t, press

Warning

Currently these keyboard shortcuts will not work if a visualisation or documentation preview pane has focus. This is a known issue that will be addressed in the future.

General shortcuts

Action	Shortcut	Notes
Cancel	`esc`	Closes/cancels an open popup or dialog discarding any changes. Equivalent to clicking Cancel on a dialog.
Select / toggle	`space`	Selects a row/item in a table, list, selection box or tab bar. Toggles a focused checkbox. Selects a radio button.
Execute	`enter`	Selects a row/item in a table, list, selection box or tab bar. Opens a Document/Date picker dialog on a Document/Date field.
OK	`ctrl+enter`	Equivalent to clicking OK on a dialog, closes the dialog accepting any changes.
Context Menu	`alt+menu`	Shows the context menu for the selected item, e.g. the selected item in the explorer tree.
Select all	`ctrl+a`
Save	`ctrl+s`	Save the current tab.
Save all	`shift+ctrl+s`	Saves all open and un-saved tabs.
Close	`alt+w`	Close the current tab.
Close all	`shift+alt+w`	Closes all open tabs.

Movement

Movement within lists, selection boxes or tab bars you can use the cursor keys, hjkl or wasd to move between items.

Action	Shortcut
Up	`up` or `k` or `w`
Down	`down` or `j` or `s`
Left	`left` or `h` or `a`
Right	`right` or `l` or `d`

You can also move up or down by page using:

Action	Shortcut
Page Up	`pgup`
Page Down	`pgdn`
Home / Start	`home`
End	`end`

Finding things

Action	Shortcut	Notes
Find documents by name	`shift+alt+f` or `shift+shift`	Find documents by name, type, UUID.
Find in content	`shift+ctrl+f`	Find documents whose content contains the search term. This is the same as clicking the icon on the explorer tree.
Recent items	`ctrl+e`	Find a document in a list of the most recently opened items.
Locate document	`alt+l`	Locate the currently open document in the explorer tree. This is the same as clicking the icon on the explorer tree.
Help	`f1`	Show the help popup for the currently focused screen control, e.g. a text box. This shortcut will only work if there is a help next to the control.
Focus the Explorer Tree filter	`ctrl+/`	Changes focus to the Quick Filter in the Explorer Tree pane.
Focus the current tab Quick Filter	`/`	If the currently open tab has a Quick Filter bar it will change focus to that so a filter term can be entered.

Direct access to screens

The following shortcuts are all of the sequential type with the mnemonic Goto X. These shortcuts may not do anything if you do not have the required permissions for the screen in question.

Action	Shortcut	Notes
Goto Application Permissions	`g+a`
Goto Annotations	`g+b`
Goto Caches	`g+c`
Goto Dependencies	`g+d`
Goto Explorer Tree	`g+e`	Changes focus to the Explorer Tree so the user can use the Movement shortcuts to move around the tree to select different documents.
Goto User Groups	`g+g`
Goto Index Volumes	`g+i`
Goto Jobs	`g+j`
Goto API Keys	`g+k`
Goto Nodes	`g+n`
Goto Properties	`g+p`
Goto Data Retention	`g+r`
Goto Search Results	`g+s`
Goto Server Tasks	`g+t`
Goto User Preferences	`g+u`
Goto Data Volumes	`g+v`
Goto User Access	`g+w`
Goto User Accounts	`g+x`
Goto Signing Keys	`g+y`

Creating new documents

The following shortcuts will open the dialog to create a new document in the currently selected explorer tree folder. If a document is currently selected in the explorer tree then the new document will be created in the same folder as the selected document. If nothing is selected or multiple items are selected then these key sequences have no effect.

Action	Shortcut
Create Annotation	`c+a`
Create Elastic Index	`c+c`
Create Dashboard	`c+d`
Create Feed	`c+e`
Create Folder	`c+f`
Create Dictionary	`c+i`
Create Lucene Index	`c+l`
Create Documentation	`c+o`
Create Pipeline	`c+p`
Create Query	`c+q`
Create Analytic Rule	`c+r`
Create Text Converter	`c+t`
Create View	`c+v`
Create XSLT	`c+x`

Screen specific shortcuts

Dashboard

The following shortcuts are available when editing a Dashboard .

Action	Shortcut	Notes
Execute all queries	`ctrl+enter`	Executes all queries on the Dashboard. This is the same as clicking .

Pipeline stepping

The following shortcuts are available when stepping a pipeline.

Action	Shortcut	Notes
Step refresh	`ctrl+enter`	Refresh the current step. This is the same as clicking .

Query

The following shortcuts are available when editing a Query .

Action	Shortcut	Notes
Execute query	`ctrl+enter`	Execute the current query. This is the same as clicking .

Text editor

The following common shortcuts are available when editing text editing text in the Ace text editor that is used on many screens in Stroom, e.g. when editing a Pipeline or Query.

Action	Shortcut	Notes
Undo	`ctrl+z`	Undo last action.
Redo	`ctrl+shift+z`	Redo previously undone action.
Toggle comment	`ctrl+/`	Toggle commenting of current line/selection. Applies when editing XML, XSLT or Javascript.
Move line up	`alt+up`	Move line/selection up.
Move line down	`alt+down`	Move line/selection down.
Delete line	`ctrl+d`	Delete the current line.
Find	`ctrl+f`	Open find dialog.
Find/replace	`ctrl+h`	Open find/replace dialog.
Find next match	`ctrl+k`	Find next match.
Find previous match	`ctrl+shift+k`	Find previous match.
Indent selection	`tab`	Indent the selected text.
Outdent selection	`shift+tab`	Un-indent the selected text.
Upper-case	`ctrl+u`	Make the selected text upper-case.
Open Completion list	`ctrl+space`	Open the code completion list to show suggestions based on the current word. See Auto-Completion.
Trigger snippet	`tab`	Trigger the insertion of a snippet for the currently entered snippet trigger text. See Tab triggers.

See Ace Default keyboard shortcuts for more.

If you know Vim key bindings then the Ace editor supports a reasonable sub-set of them, see Vim Key Bindings.