StreamBase Registry Keys on Windows

Registry Keys and Locations

The StreamBase installer adds registry keys to the following locations.

On 64-bit Windows:

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\StreamBase Systems\StreamBase.n.m

On 32-bit Windows:

HKEY_LOCAL_MACHINE\SOFTWARE\StreamBase Systems\StreamBase.n.m

If you have more than one StreamBase version installed, you will find more than one set of keys at this registry location, one for each StreamBase installation, as shown in the following example:

These keys are primarily used for configuring StreamBase Server to run as a Windows service, as described on Running StreamBase Server as a Windows Service. Use regedit or your favorite registry editor to modify the key values.

Registry Key Values Used for Different Cases

This section explains when the StreamBase keys in the Windows registry are used. Details about these keys are provided in subsequent sections.

The following registry keys are used only by StreamBase Server when running as a Windows service:

    sbd.n.mStartup
    sbd64.n.mStartup
    yourservicenameStartup

The following registry keys are used in all cases: StreamBase Server as a Windows service, or started as command-line background processes, or as command-line foreground processes.

InstallDir
DataDir

Note that not all the registry keys can be specified on a command line, or in a configuration file. The DataDir parameter specifies the directory where disk-based Query Tables (available only in StreamBase Enterprise Edition) store their persistent data. The DataDir parameter is the only key subject to a multi-stage precedence resolution, which is:

If present on the sbd command line (--datadir value).
The STREAMBASE_DATA environment variable's value.
The value in the server section of the sbd.sbconf configuration file.
The HKEY_LOCAL_MACHINE\SOFTWARE\StreamBase Systems\StreamBase.n.m\DataDir value in the Registry.
Finally, if not specified anywhere (which assumes the default-installed registry key value has been deleted), or the special value "+TEMP+" is used, a temporary directory is created on server startup and deleted on shutdown.

Place the following registry keys in the sbd.n.m or sbd64.n.m sub-keys, or in a sub-key that matches your alternate service name, if any. (Alternate service names are described in Setting Up Multiple StreamBase Services.)These keys are used only when configuring StreamBase Server to use StreamBase authentication for a server running as a Windows service.

sbWindowsServiceUserName
sbWindowsServicePassword

See Placeholder Sub-keys below and Configuring Windows Service with Authentication for instructions on configuring these features.

Registry Keys for StreamBase Server

The StreamBase Server registry keys are found at the following locations:

On 64-bit Windows:

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\StreamBase Systems\StreamBase.n.m

On 32-bit Windows:

HKEY_LOCAL_MACHINE\SOFTWARE\StreamBase Systems\StreamBase.n.m

The keys and their default values are as follows:

Key Name	Default Value	Description
DataDir	For 64-bit Windows — `C:\Program Files (x86)\StreamBase Systems\StreamBase.n.m\DataDir` For 32-bit Windows — `C:\Program Files\StreamBase Systems\StreamBase.n.m\DataDir`	Specifies a directory to contain disk-based Query Tables. Change this value to specify a different `DataDir` location for your StreamBase applications. You can also specify this setting in other ways, as described above on this page.
InstallDir	(The directory where you installed StreamBase.)	Do not change this value.
sbd64.`n.m`Startup	–b	On 64-bit Windows only, with the 64-bit StreamBase kit installed, this key specifies the command line arguments for the 64-bit version of StreamBase Server. On 64-bit Windows, you can specify independent settings for the 32-bit and 64-bit servers, and run them independently of each other. The default argument is `–b`, which starts up the server on the default port, 10000, in background mode with no containers or applications started. If you start a service with only `–b`, you can add containers and applications to the running service with the sbadmin addContainer command. See Server Background Mode and Logging. When running StreamBase applications as a Windows service, the recommended practice is to specify both `–b` and `–f` with the path to a server configuration file, like this example: `-b -f C:\Users\sbuser\marketwatch.sbconf` Use the server configuration file to designate the TCP port, the applications and containers to start, location of resources, and other details about the StreamBase application you want to run automatically as a Windows service. You can specify any valid sbd command line. For more information on the available sbd command line parameters, see its reference topic. Note If a command-line argument contains spaces, such as in a Windows path, you must enclose it in quotes.
sbd.`n.m`Startup	-b	Specifies the command line arguments for the 32-bit sbd process to be run as a service, following the instructions for the 64-bit server immediately above.
`yourservicename`Startup	–b	Registry keys of this type are only present after you add an alternate Windows service name with the sbd --install-service command, as described on Running StreamBase Server as a Windows Service. The `yourservicename` portion of the key name is the service name you specify when installing the alternate service. Use these keys to specify the command line arguments for the sbd instance to be started with the specified alternate service name. On 64-bit Windows, the sbd version referenced by these keys depends on the version you used for the sbd --install-service command. To install a 64-bit sbd with an alternate service name, be sure to run sbd --install-service from the StreamBase 64-bit Command Prompt.
VERSION_*	StreamBase release numbers.	Your release might have one or more version number registry strings whose names begin with `VERSION_`. These are used for reference by the StreamBase installer. Do not change these values.

Placeholder Sub-Keys

The following sub-keys are installed as empty placeholder keys. If one of these sub-keys does not exist for your StreamBase installation, create it as needed.

If you are using an alternate StreamBase service name, create a sub-key to match your alternate service name, as described in Setting Up Multiple StreamBase Services. For example, for the service name sbd64-alt, create a sub-key with that name.

On 64-bit Windows:

HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\StreamBase Systems\StreamBase.n.m\sbd.n.m
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\StreamBase Systems\StreamBase.n.m\sbd64.n.m

On 32-bit Windows:

HKEY_LOCAL_MACHINE\SOFTWARE\StreamBase Systems\StreamBase.n.m\sbd.n.m

When configuring StreamBase authentication, use these sub-keys to contain the keys shown in the following table. On 64-bit Windows, use the sbd64.n.m sub-key to add authentication to the 64-bit StreamBase Server, and use sbdn.m to add authentication for the 32-bit server.

Key Name	Default Value	Description
sbWindowsServiceUserName	None	These values are only required when using StreamBase Server as a Windows service in conjunction with StreamBase authentication. See Configuring Windows Service with Authentication for instructions.
sbWindowsServicePassword	None

Example Registry Keys

The following image shows an example of a yourservicenameStartup key. Notice the sbd-altStartup key, which we added with an sbd --install-service command, as described in Setting Up Multiple StreamBase Services.

Notice that we modified the sbd-altStartup key's value from the default of -b, to specify a server configuration file. That configuration file specifies the application to load, TCP port to listen on, and so on.

Back to top