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 set in 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. This variable is required by the epadmin command.
PATH

Prepends %STREAMBASE_HOME%\bin64, %STREAMBASE_HOME%\bin, and %STREAMBASE_HOME%\distrib\tibco\bin to the PATH.

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.
JAVA_HOME 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

Open a StreamBase Command Prompt with the following command sequence for Windows 7:

Start(All) ProgramsStreamBase n.mStreamBase n.m Command Prompt

For Windows 10, click Start and start typing StreamBase 10 until Windows locates StreamBase 10.0 Command Prompt.

You can also select the top level of a project folder in the Studio Package Explorer, right-click, and select one of the following from the context menu. This opens a StreamBase Command Prompt whose current directory is the selected project's directory in the Studio workspace.

  • Select Open StreamBase Command Prompt Here (Windows).

  • Select Open StreamBase Command Terminal Here (MacOS).

  • Select Open StreamBase Command Shell Here (Linux).

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%