Chapter 1. Getting Started

1.1. Introduction to Esper Notebook
1.2. Notebook Main Page
1.3. Notebook Note Page
1.4. Additional Information

Esper Notebook is a web-based notebook application for compiling EPL, executing event and time sequences, and viewing results. It enables EPL developers to be more productive by developing, organizing, executing, and sharing code and results without needing a compiler or runtime.

Esper Notebook organizes into notes. Each note contains multiple paragraphs. Each paragraph is either a snippet of EPL or a scenario with events and time.

When running a note, the notebook runs all paragraphs:

In summary, the notebook application allows you to:

The main page is similar to the below screen capture.

The left side of the page lists the existing notes. Here you have the option to create a new note, import an existing note or to open a note.

The right side of the page contains the My Account link that brings you to the login account management page. The right side also has links to documentation and further help.

When you create a new note you can decide the default interpreter. By default this is Esper.

The Notebook button on the top navigation menu is a shortcut for navigating between notes and for creating new notes.

The upper right-hand corner is a drop-down that has a Logout option for logging out of your account.

The next screen capture is a sample note page.

The note shown above has the name Sample Note. The note has two paragraphs. The first paragraph begins with %esperepl which tells the interpreter that the paragraph contains EPL. The second paragraph begins with %esperscenario which tells the interpreter that the paragraph contains a sequence of event and time.

Please find information on all interpreters below. There is another interpreter %espersetup for customizing output.

Each paragraph consists of 2 sections: A code section where you put your EPL or scenario, and a result section where you can see the result.

In the example above, for the paragraph with EPL there is no output as the sample EPL compiles without compilation errors. In the case when the EPL doesn't compile the compilation errors are directly below the EPL. For the paragraph with a scenario there is an HTML table with the output for that scenario.

You may run all paragraphs using the play icon of the top icon bar. You may also run a single paragraph by using the play icon of the paragraph.

Esper Notebook is provided by EsperTech Inc., builds on Apache Zeppelin and extends Zeppelin with Esper interpreters, EPL syntax highlighting and more. More information on Apache Zeppelin can be found at http://zeppelin.apache.org.

More information on the user interface can be found among the Apache Zeppelin user interface documentation at http://zeppelin.apache.org/docs/latest/quickstart/explore_ui.html.

Esper Notebook only provides the Esper interpreters.