Question & Answer
Question
How do you configure the debug variables within IBM Rational Build Forge?
Cause
When you have run into an error and either IBM Support or a system administrator needs to gather additional information. Build Forge has a series of debug variables that will output additional information to the logs when set properly.
Answer
This document serves as a repository of the environment variables used for debugging problems in IBM Rational Build Forge.
All these environment variables (EV's) must be set before starting Build Forge to collect verbose output that is useful in troubleshooting a specific problem.
Note: These EV's are not documented in the product manuals.
Syntax for setting the Environment Variables:
- UNIX and Linux: export <variable>=1
- Microsoft Windows: set <variable>=1
Environment Variable | Description | Related Content |
BF_AUTH_DEBUG | This environment will return the steps the engine goes through while retrieving and setting the Server authentication | |
BF_ADAPTOR_DEBUG | Returns information about the adaptor execution | |
BF_AGENT_DEBUG | Returns information on the Agent interaction with the engine | See technote 1248387 for an example of its use. |
BF_MAIL_DEBUG | Returns detailed information on the creation of notifications | |
BFDEBUG_SQL_PREPARE | Returns ALL SQL queries sent to the database | See technote 1254406 for an example of its use. |
BF_API_DEBUG | Returns a trace of the API script being run. | See technote 1266614 for an example of its use. |
BF_SERVERTEST_DEBUG | Returns detailed information about the connection of the server object on the console to the actual agent. | See technote 1267059 for an example of its use. |
BFCQDEBUG | Returns the ClearQuest database connection information when using the ClearQuest integration |
- UNIX and Linux (for 7.1.x): ./buildforge -d
- Microsoft Windows: bfengine -d
[{"Product":{"code":"SSB2MV","label":"Rational Build Forge"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Documentation","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"7.1;8.0","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]
Was this topic helpful?
Document Information
Modified date:
20 April 2020
UID
swg21267063