Environment Variables for TIBCO Business Studio for BusinessWorks

This section lists the environment variables that can be used for application deployment inside TIBCO Business Studio for BusinessWorks for configuration management.

Environment Variable Default Values Description
APPLICATION_NAME n/a This environment variable is used to provide custom application name to fetch application properties from config management.
APP_CONFIG_PROFILE default

Name of the application profile that is to be used from a configuration management system.

BW_LOG_FORMAT n/a

  • Use value as JSON to change logging format of BWCE to JSON format.

  • Use value as 'Logstash JSON' to change logging format of BWCE to Logstash JSON format.
BW_LOGGER_OVERRIDES n/a

This environment variable contains the list of loggers and its values. The loggers are separated by whitespaces.

For example, 

BW_LOGGER_OVERRIDES="com.tibco.bw.binding.rest=DEBUG com.tibco.thor.frwk=DEBUG"
BW_PROFILE_ENCRYPTION_KEYSTORE n/a The name of the KeyStore file.
BW_PROFILE_ENCRYPTION_KEYSTORETYPEn n/a The type of the KeyStore file. The common types are; jks, jceks, pkcs12.
BW_PROFILE_ENCRYPTION_KEYSTOREPASSWORD n/a Password of the private KeyStore.
BW_PROFILE_ENCRYPTION_KEYALIASPASSWORD n/a The alias password of the KeyStore.
BW_PROFILE_ENCRYPTION_KEYALIAS n/a The alias name used for the KeyStore.
CONSUL_SERVER_URL n/a Used to set Consul server configuration.

For example,

CONSUL_SERVER_URL=http://127.0.0.1:8085

This must be set if you intend to use Consul for application configuration or for service registration and discovery.

CONSUL_CUSTOM_FOLDER n/a This must be set if you only intend to use properties from Consul Server stored in custom folders.

If properties are stored or exported to <CONSUL_SERVER_URL>/ui/dc1/kv/FOLDER1/FOLDER2 location then the value for CONSUL_CUSTOM_FOLDER = FOLDER1/FOLDER2

CONSUL_FORMAT n/a Set the value of then environment variable to YAML to use the yaml file for configuration management service using Consul.

Set the value of then environment variable to PROP to use the properties file for configuration management service using Consul.

CONSUL_DATA_KEY=<KEY_NAME> n/a The value of this property is the custom location of the yaml file or the properties files stored on Consul.
X_CONSUL_TOKEN n/a

Used to authenticate the request made to the Consul server.

This environment variable should be used when the consul server is enabled for authentication.

Note: This should be set if authentication is enabled on the consul server and you want to authenticate the requests made to the consul server.

BWCE_COMPONENT_AUTO_START_OVERRIDE n/a

  • Components configured with Auto Start enabled will be automatically executed at application startup.

  • Components configured with Auto Start disabled will not run at startup, respecting the Studio configuration..

Note: This environment variable is available only after you upgrade to TIBCO ActiveMatrix BusinessWorks™ (Container Deployment) 2.10.0 HF-004 and above.

Important: This section is applicable only after you upgrade to TIBCO ActiveMatrix BusinessWorks™ (Container Deployment) 2.10.0 HF-004 and above.

Autostart behavior

To control component auto start behavior at runtime, the following properties are introduced:

Properties Description
com.tibco.bw.includeAllStartersIf enabled, it will start all components, ignoring whatever was selected at design time.
com.tibco.bw.includeStartersUsed only if startAll is not enabled, Starts all components listed in this property. For all other components not listed, the behavior follows the design-time autostart setting.
com.tibco.bw.excludeStarters Used only if neither startAll nor include is specified, Prevents the components listed here from starting. For all other components not listed, the behavior follows the design-time autostart setting.

Note: Use bwce.component.auto.start.override=true along with these properties.