StreamBase Configuration Files

Overview of HOCON Files

Configuration files for TIBCO StreamBase use HOCON syntax. HOCON is a superset of JSON, enhanced for readability. HOCON (Human-Optimized Configuration Object Notation) is a standard with a published specification. StreamBase HOCON departs from standard HOCON in several ways described on HOCON Syntax Reference.

StreamBase HOCON files have a type, which must be specified in a header line at the top of the file. Each type specifies configuration for a particular aspect of running an EventFlow fragment. There are HOCON file types that configure DTM applications and nodes, and there are file types that configure aspects of running StreamBase EventFlow fragments.

See the HOCON Configuration Guide for the details of each HOCON configuration file type.

Placement of HOCON Files

HOCON files must use the .conf filename extension. Use any basename that reminds you of the file's contents.

When StreamBase Studio creates a new project or migrates a project from a legacy format, it creates template configuration files with names such as engine.conf and node.conf. These configuration filenames are traditional, but not required.

Place one or more HOCON configuration files in the src/main/configurations folder of your Studio project. Each file is distinguished by the combination of name, version, and type lines required in the header at the top of each file. As long as these three lines are unique in a project's src/main/configurations folder, there is no confusion between two or more files.

HOCON Editor in Studio

StreamBase Studio provides an integrated HOCON Configuration Editor that is invoked when you double-click on a file with .conf extension in your Studio project folder, or when you invoke FileNewStreamBase HOCON Configuration File.

The HOCON Editor provides syntax coloring, validation of the HOCON format, and suggestions for valid entries invoked with Ctrl+Space.

Adapter Configuration Files

There is one exception to the use of HOCON format for configuration files. Certain adapters are specified with XML files whose top-level element is <adapter-configurations>. Place these adapter configuration files in your project's src/main/resources folder.

The adapters that use XML adapter configuration files are the following:

  • ActiveSpaces

  • HBase

  • JMS and EMS

  • MQTT client

  • RabbitMQ

  • Web Reader

  • Web Server

  • Web Socket Client

  • WITSML

  • TERR