Apache Hop
Download
User manual 2.20.0 (pre-release)

Development Documentation

Edit this page

Hop Gui overview

Hop Gui is where you build, run, preview and debug workflows and pipelines.

Before we start building, here’s a short tour so you know what you’re looking at.

Start Hop Gui

  • Windows

  • Linux, macOS

shell
hop-gui.bat
shell
./hop-gui.sh

The main window

The Hop Gui window

 

The window has five parts.

The parts of the Hop Gui window

  1. The main toolbar, along the top, opens the Hop menu, creates new files (pipelines, workflows, metadata), opens and saves them, and opens the Marketplace.

  2. The perspectives toolbar, down the left-hand side, switches between the different things you can do in Hop Gui. The two buttons at the bottom of it show or hide the execution results and the bottom panel.

  3. The active perspective, here File Explorer, with its own toolbar. In File Explorer, the toolbar acts on the files and folders of your project, including git operations.

  4. The open file, with a tab for each pipeline or workflow you have open and the toolbar of its editor: run, stop, check, undo and redo, and zoom.

  5. The status bar, along the bottom, shows the active project and environment and, when the project is in a git repository, the current branch. You’ll use the project and environment in Projects and environments.

Perspectives

A perspective is a mode of the whole window. You’ll spend nearly all of your time in the first one, File Explorer, which is where you browse your project and edit pipelines and workflows.

Project-wide search is not a left-toolbar perspective. Open it with CTRL-F (Edit → Find). See Search.

Switch perspective by clicking its icon, or cycle through them with CTRL-SHIFT-arrow-up and CTRL-SHIFT-arrow-down.

Worth knowing early

Click anywhere

Most of Hop Gui is driven by clicking on empty canvas or on an item, which opens a context dialog with everything you can do from there. You’ll use it constantly in the next chapter.

CTRL-F searches everything

Not just the open file: it searches metadata, pipelines and workflows across the project. See Search.

There are shortcuts for most things

See Keyboard Shortcuts.

the Hop Gui section of this manual has the detailed tour, including how to hide parts of the UI for new users.

Let’s build a pipeline.