- Index

< Previous |  | Next >

# StreamBase Command Prompt

## Introduction

The StreamBase Command Prompt is a feature of the Windows version of StreamBase.

The StreamBase installer places a link in the Start menu for the StreamBase `n.m` Command Prompt, where `n` and `m` are the major and minor StreamBase release numbers. This link opens a Windows Command Prompt session with its environment pre-set for running StreamBase command-line utilities.

## Environment Settings

The following table summarizes the Windows environment settings made by the script that starts the StreamBase Command Prompt.

Environment Variable | Notes
--- | ---
STREAMBASE_HOME | Set to the absolute path to the top-level StreamBase installation directory, not including a trailing backslash.
TIBCO_EP_HOME | Set to the same path as STREAMBASE_HOME. Starting with StreamBase release 10.3.0, the variable is no longer used or required, either by StreamBase Studio, or by any command-line tool. The variable was set into the `pom.xml` files for projects created by Studio releases before 10.3.0. The best approach for such projects is to import them into Studio 10.3 or later, and let Studio update the POM file. If you have projects generated with an earlier 10.x release that you must maintain as they are, then set this variable in your environment so that the mvn command and older versions of Studio can continue to use these older POM files.
PATH for StreamBase | Prepends the following directories to the PATH:
`%STREAMBASE_HOME%\bin64`
`%STREAMBASE_HOME%\bin`
`%STREAMBASE_HOME%\distrib\tibco\bin`
The following directory is prepended to these three if JAVA_HOME is not set:
`%STREAMBASE_HOME%\jdk\bin`
CLASSPATH | Prepends `%`STREAMBASE_HOME`%\lib\sbclient.jar` to the `CLASSPATH`.
PYTHONPATH | Appends `%`STREAMBASE_HOME`%\lib\python2.7` to the `PYTHONPATH`.
JAVA_HOME | If JAVA_HOME is not set, set to `%`STREAMBASE_HOME`%\jdk`.
PATH for Java | If JAVA_HOME is not set, prepends `%`STREAMBASE_HOME`%\jdk\bin` to the `PATH`.
TERR_HOME | If TERR_HOME is not set, set to `%`STREAMBASE_HOME`%\terr`.

## Opening a StreamBase Command Prompt

On Windows 7

  Use the following command sequence:

  Start → (All) Programs → TIBCO → StreamBase `n.m` → StreamBase 10.`n` Command Prompt

On Windows 10

  Click Start and begin typing `StreamBase 10` until Windows locates StreamBase 10.`n` Command Prompt.

## Open a Command Prompt Within Studio

To open a StreamBase Command Prompt from within StreamBase Studio:

1. In Studio's Project Explorer view, select a folder of interest in an EventFlow or LiveView project.

2. Right-click and select StreamBase → Open StreamBase Command Prompt Here from the context menu.

   This opens a StreamBase Command Prompt whose current directory is the workspace location you selected in step 1.

### Note

This feature is also available to StreamBase users on macOS, where the prompt reads Open StreamBase Command Terminal Here.

Linux users find StreamBase → Open StreamBase Command Shell Here.

## Running as Administrator

For running most utilities and samples on Windows, you can use the normal StreamBase Command Prompt as installed in the Start menu. However, with User Account Control (UAC) enabled, certain StreamBase commands that require elevated privileges may fail silently or return an error message.

### Running as Administrator on Windows 10

To run the StreamBase Command Prompt with elevated privileges on Windows 10 with UAC enabled, follow these steps:

1. Click the Windows Start icon in the lower left corner of the Taskbar. This opens the Start menu, but also opens a search facility.

2. Begin typing the name StreamBase 10 Command Prompt until that option is recognized. In general, you only need to type `streambase 10`.

3. Right-click the StreamBase 10 Command Prompt entry in the search results list to view its context menu.

4. Select Run as Administrator.

5. Windows prompts for permission to run the elevated privilege command.

### Running as Administrator on Windows 7

To run the StreamBase Command Prompt with elevated privileges on Windows 7 with UAC enabled, follow these steps:

1. Click the Windows orb in the lower left corner of the Taskbar.

2. Click All Programs.

3. Locate TIBCO in the list of programs and click to open the TIBCO menu.

4. Open the StreamBase n.m folder, where n.m represents your release number.

5. Right-click the StreamBase `n.m` Command Prompt entry and select Run as administrator from the context menu.

6. Click Continue in the resulting User Account Control dialog.

### Locating STREAMBASE_HOME as Administrator

In both Windows 7 and 10, a StreamBase Command Prompt opened with administrator privileges shows the word Administrator in the title bar, and opens by default in the `Windows\system32` directory instead of the StreamBase installation directory.

To navigate to the StreamBase installation directory, use the following command:

    cd %STREAMBASE_HOME%