Deploy Applications with epadmin

Summary of Steps

To deploy an EventFlow or LiveView fragment at the command prompt with the epadmin command requires the following steps:

In StreamBase Studio:
  1. Create a new, separate project in StreamBase Studio of type StreamBase Application.

  2. Add a Maven dependency on the fragments you want to include in this StreamBase Application project.

  3. Create an application archive file for the StreamBase Application project.

At the command prompt:
  1. Install a node containing the application archive file, using epadmin install node.

  2. Start the node, thereby starting the fragment running, using epadmin start node.

The sections below explain these steps in more detail.

1. Create a StreamBase Application Project

Create a new, separate Studio project to contain the StreamBase Application that will incorporate your fragment archive.

  • In Studio, invoke File>New>StreamBase Project.

  • In the resulting dialog's first panel, enter a name for the project, and select StreamBase Application as the project type. It is a best practice to choose a name for this project that starts with "deploy" to distinguish it from EventFlow fragment projects.

  • Click Next, then Next.

  • Optional. At the second panel, click Next instead of Finish. This opens a third panel named Archetype Properties. To cut down on the number of test instances created, edit the testnodes line from its default A,B,C to just A.

  • Click Finish.

2. Add a Dependency

The newly created StreamBase Application project does not yet know about any fragments. You must add a Maven dependency for your new project on the fragment archive created in step 1.

  • Select the name of the StreamBase Application project in the Project Explorer view.

  • Right-click and from the context menu, select Maven>Add Dependency.

  • In the Add Dependency dialog, in the Enter groupid, artifactId field, enter the first few parts of the group ID of the fragment you are adding. Enter enough letters to narrow the list to the projects whose package name begins with those letters.

    For StreamBase samples, enter or com.example to narrow the list to the fragment archives you have created for samples. For your own projects, enter the first portion of your company's group ID.

  • In the Search Results field, select the EventFlow fragment project for which you built a fragment archive in step 1. The following image shows the fragment archive for the Best Bids and Asks sample.

  • Selecting a fragment archive entry fills in the Group Id, Artifact Id, and Version fields of the dialog. Click OK.

  • The Add Dependency dialog has made changes to the project's pom.xml file. Save those changes by clicking the Save or Save all button, or with Ctrl+S (Windows) or command+S (Mac).

3. Create an Application Archive

Create a runnable archive file for your StreamBase Application project as follows:

  • In the Project Explorer view, select the name of your StreamBase Application project.

  • Right-click and from the context menu, select StreamBase>Create StreamBase Application Archive.

  • This opens a wizard:

  • Click Finish. The wizard runs for a moment. Its tasks are to:

    • Create fragment archives for the dependent projects.

    • Create an application archive for the application project. The application archive contains the fragment archives.

    The process shows a number of logging lines both in the Output field of the wizard and in Studio's Console view. Look for the BUILD SUCCESS message in both places.

  • Click Cancel to close the wizard.

    The wizard creates a file in the target folder of the StreamBase Application project, whose name ends with *

    (You may have to right-click and select Refresh on the target folder.)

4. Install a Node

Install the newly created application archive zip file into a StreamBase Runtime node as follows:

  • Using a StreamBase Command Prompt on Windows or a configured shell prompt on macOS and Linux, navigate to your Studio workspace folder. For example:

    Windows: cd "\Users\sbuser\Documents\StreamBase Studio 10.5 Workspace"
    macOS:   cd /Users/sbuser/Documents/StreamBase\ Studio\ 10.5\ Workspace
  • Navigate to the target subfolder of your StreamBase Application project. For example:

    cd deploy_bestbids/target


    As a shortcut for the above steps, you can select any EventFlow fragment project in Studio's Project Explorer view, right-click, and from the context menu, select StreamBase>Open Command Prompt Here (Windows) or StreamBase>Open Command Terminal Here (Mac). Then navigate up and over to your deployment project.

    cd ../deploy_bestbids/target
  • Run a command like the following. This is a single command, shown here on multiple lines for clarity. On macOS:

    epadmin install node \ \
      --nodename=A.sbuser \

    Remember that you can use shortened parameter names, as long as they are unique within the epadmin target's command set:

    epadmin install node \ \
      --nodena=A.sbuser \

    On Windows, you can use forward slashes as shown above, or use Windows-style backslashes and a drive letter:


    These example commands are shown on four lines for clarity, but must be typed as a single command.

  • You can now run edadmin display services to make sure your node was installed.

Refer to the following pages to understand the parameters you can type on the epadmin install node and epadmin start node command lines:

5. Start the Node

Start the installed node with a command like the following. For the servicename= parameter, use the same name you declared as nodename= above.

epadamin servicename=A.sbuser start node

Your EventFlow fragment is now running inside a StreamBase Runtime node and can accept input and return output.