Welcome to Build Forge Help
Getting Started
Standalone Installation
Navigating the Application
Using Filter Boxes
Creating a Hello World Project
Project Samples
Setting Up Servers
About Servers
Creating Servers
Server Authentication
Creating Server Authentications
Overriding Server Authentication
Allowing Use of Restricted Server Auth
Selectors
Creating Server Authentications
Collectors
Testing Servers
Enabling and Disabling Servers
Updating the Server Manifest Immediately
Updating the Job Count for a Server
Updating the Job Count for All Servers
Selecting the Server for a Project or Step
Dynamic Server Selection
Manifests
Set How Often a Server's Manifest is Updated
Limiting Concurrent Jobs on a Server
Built-in Properties Reference
Special Manifest Properties
Special Set Value Properties
Copying Files to and from Servers
Enabling File Copying on a Server
Getting a File from a Server
Putting a File on a Server
Using Servers at Other Sites
Subscribing to RSS Data Feed for Server Status
Working with Environments
About Environments
Variable Syntax
Variable Values
Variable Actions
Special Behavior on Projects
How the System Applies Environments to Steps
Environment Variable Inheritance in Chained Projects
Using the .set and .bset Commands to Change Variables
Storage Limits for Environment Variables
Creating Multiple Values for a Variable
Creating a Long Value List for a Variable
Use Uppercase Variables with Cygwin
System-Defined Variables (BF_ Variables)
Special Case Variables
Setting the Adaptor Log Level
Resolving Undeclared Environment Variables
Windows Mapped Drives
Selecting the Next Available Drive Letter
Agent-based Drive Mapping
Working with Projects
About Projects
Changing Project Properties
Running Projects
Copying a Project
Using the Sticky Property on Projects
Setting Pass/Fail Chains for a Project
Chaining Projects Together
Canceling Chained Projects when Wait Enabled
Launching Projects on Class Events
.run and .runwait
Using Libraries
About Libraries
Copying a Library
Deleting/Clobbering Projects
Log Filters
Creating a Log Filter
Filter Actions
Error Thresholds
Error and Warning Counts
Filter Patterns
Using Classes
About Classes
Deletion Properties of Classes
Launching Projects on Class Events
Setting Up Notification
About Notification Templates
Configuring Your SMTP Server
Setting Notification Properties of Projects and Steps
Notification Exercise
Customizing Notification Templates
Creating New Templates for Specific Projects and Steps
Editing Notification Templates
Using Environment Variables and Register Variables in Templates
Special Notification Template Variables
Notification for Inlined Projects
Working with Steps
About Steps
Step Properties
Labelling Log Output
Creating Links and Highlighting in Step Logs
Adding Notes to Steps
Launching Projects from Steps
Broadcasting a Step to Multiple Servers
Threading: Running Steps in Parallel
Log Filters
Creating a Log Filter
Assigning a Log Filter to a Step
Filter Patterns
Filter Actions
Filter Notification
Error Thresholds
Error and Warning Counts
Registers
Project Registers
Dot Commands
Dot Command Reference
.agentupdate
.bom
.bomexport
.bset
.break
.date
.defect
.drill
.edit
.export
.get
.include
.load
.lock
.mkdir
.monitor
.pack
.pop
.poptag
.purge
.push
.put
.retag
.retry
.rget
.rmdir
.rput
.run and .runwait
.scan
.semget
.semput
.set
.sleep
.source
.strsub
.test
.tset
Embedding Build Numbers in Project Files
Changing the Tag During a Job
Changing Environment Variable Values During a Job
Setting Multiple Variables
Using Command Output To Set Values
Environment Dot Commands
Running Scripts Before a Command With .source
Storing the Date or Time in a Variable with the .date Command
Using Variables from Other Groups with the .include Command
Working with Jobs
About Home
System Messages
About Jobs
Jobs, All
Jobs, Completed
Jobs, Running
Jobs, Archived
Jobs, Locked
Viewing Step Logs for a Job
Locking Jobs
Restarting Failed Jobs
Semaphores
Clearing Semaphores Manually
Deleting a Job
Deleting a Job from the Completed List
Completely Deleting a Job from the Archive List
Automatically Deleting Jobs
Working Directories for Jobs
Tagging Jobs Dynamically
Creating or Editing Tag Variables
System-defined Variables for Tags
Editing the Tag Format for a Project
Synchronizing Tags
Schedules
Schedule Parameters
Scheduling Purges
Working Directories for Jobs
Constructing the Working Directory for a Job
Constructing Directory Paths for Steps
Slashes in Paths
Bill of Materials
Displaying the Bill of Materials
Adding Baselines and Checkpoints with the .scan Command
Adding Data to a BOM with Dot Commands
Exporting the BOM as an XML File
Working with Reports
About Reports
Performance
Analyze
Queries
Quick Report
Permissions Needed for Quick Report
Running Reports
Running Existing Reports
Creating a New Report
Sample Reports
Quick Report Reference
Reports Reference
Reports Storage Reference
Setting Up Data Sources
Configuring an Existing XML File as a Data Source
Exporting and Uploading a BOM XML File
Uploading a New XML File as a Data Source
Working with Utilities
Requirement for Using System Command Line Utilities
Importing and Exporting Projects
Importing Exported Data Objects
Importing Projects via the Management Console
Importing Projects via the Command Line
Exporting Projects from the Command Line
Example
Administering the Management Console
About Administration
Security Overview
Security Example: Giving A Group the Ability to Run Jobs
Team and Project Security Plan
Managing Access Properties
Access Groups
Users
Root User
API Users
Permissions
Permissions Exercise
LDAP and Active Directory Integration
Creating LDAP Domains
Support for LDAP Traffic over SSL (LDAPS)
Turning Off LDAP/Active Directory Support
LDAP Domain Parameters
Testing LDAP Configuration for a Domain
System
Messages
Subscribing to RSS Data Feed for System Messages
Filtering the RSS Data Feed for System Messages
Managing Licenses
Entering a New License Key
Managing the Engine
Pausing the Engine
Starting and Stopping the Engine
Starting and Stopping the Engine on Windows
Starting and Stopping the Engine on Linux or Solaris Systems
Managing the Database
Deleting the Database Log File
Creating a Read-only User for Reporting
Error Messages
No active steps
License key is invalid or Build Forge license key is corrupt or missing.
A database license is required
Integrating with External Applications Using Adaptors
Adaptor Concepts
Adaptors
Adaptor Templates
Adaptors and Projects
Adaptors and Environment Variables
Adaptor Links
Adaptors and Notification
Adaptors and Job Execution
Adaptors and Job Results
Adaptor Task Overview
Core Adaptor Tasks
Selecting an Adaptor Template
Creating an Environment for the Adaptor
Creating an Environment for an Adaptor Link
Creating an Environment for Adaptor Dot Commands
Creating an Adaptor from a Template
Adding an Adaptor to a Project
Adding a Source Code Adaptor with an Adaptor Link
Adding an Adaptor with a Dot Command
Testing the Adaptor
Testing a Linked Adaptor
Testing an Adaptor Dot Command
Setting the Adaptor Log Level
Manually Starting Adaptor-Linked Projects
Quick Start for Adaptor-Linked Projects
Resetting Adaptor Templates
Updating ClearQuest Build Records
Advanced Adaptors Tasks
Modifying an Adaptor Template
Modifying a Template for a Single Adaptor
Creating a New Adaptor Template
Creating Multiple Entry Point Adaptors
Example: Enabling E-mail Notification
Example: Removing Change Details from a BOM Report
Adaptor Reference
Adaptor Requirements
General Adaptor Requirements
ClearQuest Adaptor Requirements
Dot Commands for Adaptors
.source
.defect
.test
.pack
ClearCase and ClearQuest Environment Variables
Perforce Environment Variables
Adaptor Template Structure
Adaptor XML Reference
PROJECT_INTERFACE
env
setenv
run
ontempenv
step
onproject
command
execute
integrate
resultsblock
match
bom
field
adduser
bomformat
section
Accessing Management Console from IDEs with Plug-ins
About Plug-ins for IDEs
Plug-ins for Eclipse and Rational Application Developer
Installing the Eclipse or Rational Application Developer Plug-ins
Plug-in for Microsoft Visual Studio
Installing the .NET IDE Plug-in
Special Variables for Test Projects
Working with APIs
APIs
Creating a Build Forge User for API Programs
Services Layer Clients
Java Client
Getting the Java Client
Setting Up the the Java Client
Perl Client
Getting the Perl Client Package
Setting Up the Perl Client
Perl API
Getting the Perl API Package
Installing the Perl API
Glossary
Access Group
Adaptor
Agent
Archive
Built-in Properties Reference
Class
Collectors
Database
Engine
Environments and Environment Variables
Job
Management Console
Manifests
MD5
Notification Templates
Plug-ins
Project
Run queue
Selectors
Semaphores
Servers
Steps
Timeout
Threading
User
Contacting Support
Determining the Management Console Version Number
Notices for IBM Rational Build Forge documentation
Trademarks
Using Filter Boxes