Editing EventFlow Run Configurations

A configuration name is generated for you when you first run a fragment. You can change the name according to your site's standards. The name you enter is not reflected in the navigator pane on the left until you click Apply.

The default cluster name for Studio-initiated nodes is the system login name in effect when Studio started, and is not specified in a Run Configuration. You can change the default, global cluster name in Studio Preferences.

Alternatively, you can specify a cluster name on a per-run configuration basis in the Use name field.

This field specifies a name for the node that Studio creates to contain this fragment. For example, you can specify here the same node name you are using in your test and deployment environment with the epadmin command.

Studio's default node name is generated from a naming pattern generated from a set of variables. Use the Node Name Variables button to select a different set of project-related variables, or use the Other Variables button to specify variables available to Studio as a whole. The naming pattern you assign must include the S(SeqNum) variable, to make sure that a sequence number is assigned to make node names unique.

Use this control to specify one or more parameters for Studio to use when it installs a node to contain this fragment. The valid parameters are the same as can be used with the epadmin install node command; run epadmin help node at the command prompt to see the available parameters.

The feature is best used with parameters such as memorysize to specify a JVM heap size larger than the default 512 MB for certain EventFlow or LiveView fragments.

For debugging purposes only, you can dequeue data from intermediate streams in your application, not only from output streams. This debugging feature allows you to examine the value of a tuple at an intermediate point in the stream of tuples flowing left to right, before that tuple has been fully processed, and before it has arrived on an output stream. See Intermediate Stream Dequeuing for configuration options.

Select Use Default to specify using Studio's default global logging level, which is usually the INFO level. It is possible to specify a Logback configuration file as part of an EventFlow or LiveView fragment configuration that sets a higher or lower default logging level for the engine that is to run that fragment. It is also possible to use epadmin set commands to change an engine's current default logging level for an engine in a running StreamBase Application.

Also remember that adapters and some operators can set a logging level independent of the containing EventFlow fragment's default level.

Select Specified to override the current global logging level for the engine to be launched with the current configuration. The higher the log level you specify, the more messages and message types are sent to the Console view and/or to an output log file, if specified.

The Logback FATAL logging level is not specified in Studio Run Configurations because Studio handles and reports that condition with its own dialogs and Console messages. See Using StreamBase Logging for more information regarding current and legacy log levels.

Arguments that you specify here are used as command line arguments for the JVM engine that hosts the EventFlow fragment. Click Variables to invoke the Select Variable dialog, from which you can build a VM argument setting using Java standard system property names.

In general, set StreamBase properties with a HOCON configuration file instead of the VM arguments control. Use this feature sparingly, or under the direction of TIBCO Technical Support.

The next EventFlow fragment launch defined by this configuration has a default engine name generated by Studio. The Default setting is appropriate in the great majority of cases. You can see the engine name Studio chooses in the Clusters view at runtime. Select the Engine entry of a started node; the Name entry is near the top of the Properties list.

It is possible for a single node to contain more than one engine. For command-line launches, engines and engine name are specified in a HOCON configuration file of type c.t.e.dtm.c.node. Use the Specified option to direct this Studio Run Configuration to use the same engine name that will be used for command line launches. Valid characters for engine names are letters, digits, underline, hyphen, period, and dollar sign.

Set name-value pairs in the Deploy parameters field to pass command options to the deployment mechanism when running or debugging the EventFlow module. Deployment parameter options are shown in the following table.

cat > /etc/security/limits.d/tibco.conf <<EOF
sbuser hard rtprio 70
sbuser soft rtprio 0
EOF

ulimit -r 99

Use this field to define substitution variables, or to specify a file that contains substitution variables. See HOCON Substitution Variables for more information on using substitution variables in configuration files.

Take, for example, a security configuration file that includes the property portNumber = ${LDAP_PORT}. If you include a Name-Value pair in the Substitutions table, where the name is LDAP_PORT and the value is a non-default port such as 5389, then when the project is run and the configuration file is read, the portNumber = line in that security configuration file is read as if the file contains: portNumber = 5389.

Remember that all EventFlow fragments are launched into StreamBase Runtime nodes, and that nodes are always part of a StreamBase Runtime cluster.

Studio enables the Append environment to operating system environment setting by default. This means the shell environment for the operating system in which Studio runs is passed to and available to fragments running in nodes. Any variables specified in this tab can supplement the system settings, or can modify or override existing system environment variables.

You can select the Use specified environment only control to restrict the launched node's environment settings to those specified in this tab.

A StreamBase Runtime node has its environment set at node installation time. This has the following consequences:

The New/Edit Environment Variable dialog contains a Variables button, which is a feature inherited from Eclipse. Use this button to specify the value of an environment variable using one or more Eclipse system variables whose contents are resolved by Eclipse when this configuration is run. Use the Help button on this dialog for further information on each available variable.

The list of variables includes ${sb_home}, which is defined as the absolute file system path of the StreamBase installation directory as currently set in Studio's Preferences dialog.

See Environment Variables for a further discussion of the ways environment variables are used in StreamBase.

Fragment launches in Studio cannot set customized values for the TIBCO_EP_HOME or JAVA_HOME environment variables because those have particular meaning for Studio operations. This is true even if these variables are inherited from the system environment.

Studio detects and blocks attempts to use these two variables, whether explicitly specified in this Environment tab, or inherited from the system environment. In this case, Studio displays a warning dialog like the following.

Select the Remember my decision check box to suppress this warning dialog for future fragment launches.

This option determines where this Run Configuration is saved. The default setting, Local file, saves configurations in the workspace metadata area. As an alternative, you can select Shared file to save this Run Configuration as a file in one of your project folders. In this case, the Run Configuration is saved as Name.launch, where Name is specified in the Name field. Specify the target project folder using the Browse button.

The favorites menu is a list of Run Configuration names that appears in the second section of the drop-down menu of the Run and Debug buttons on the toolbar. The first section contains a changing list of recently Run Configurations. Add a configuration to the favorites section to keep it in the menu, even when other applications have replaced it in the recently-run section. This option performs the same function as the Organize Favorites option in the Run and Debug drop-down menus.

Use this section to specify a non-default character encoding for log messages sent to the Console View (and optionally to a standard output file).

Allocate Console is selected by default. This specifies using the Console view to display logging messages written to standard output and standard error.

Input File is not supported by EventFlow fragment launches.

Output File is unselected by default. To specify that standard output and standard error of your fragment's run are written to a log file, select the Output File check box, and enter a path to a file. If the specified file does not exist, it is created for you. If both Allocate Console and Output File options are selected, log messages are written to both places.

You must designate the path to the file using Eclipse-specific syntax. Rather than typing a path, use the Workspace or File System buttons to navigate to a workspace or file system folder, and specify a file name. These buttons let Eclipse write the syntax for you. If you are familiar with the Eclipse syntax required in this field, you can use the Variables button to build up a path from components.

Append is dimmed unless the Output File option is selected. Select the Append check box to have log messages appended to the file specified in the Output File field. If unselected (the default setting), the designated file is overwritten with each run of this configuration.

Use this option to specify that the launching process itself runs in the background. (The StreamBase server that hosts your EventFlow fragment is always run in the background.) Selecting this box returns control to Studio immediately when you launch this configuration, without displaying the usual Starting Server dialogs.