BuildForge Help

Documentation Updates for the Online Help

This section describes updates or changes that were made to the product documentation after the 7.0.2 documentation was shipped.

The information documented here supersedes information in the 7.0.2 online Help documentation.

Default Installation Path for Windows Management Console

In the installation guide and in the online help documentation, the default installation path for the Management Console on Windows changed to:
C:\Program Files\IBM\Build Forge
Previously, it was:
C:\Program Files\BuildForge

Default Installation Path for Windows Agent

In the installation guide and in the online Help documentation, the default installation path for the Agent on Windows changed to:
C:\Program Files\IBM\Build Forge\Agent
Previously, it was:
C:\Program Files\BuildForge\Agent
Note: The variable part of the installation directory is C:\Program Files\IBM\Build Forge. The installer always appends the Agent directory to the default path or the path you provide.

Online Help: Adaptor Name Changes

The following ClearQuest and ClearCase adaptor names changed in 7.0.2:
ClearQuestCaseByActivities ClearQuestClearCaseByActivities
ClearQuestCaseByDate ClearQuestClearCaseByDate

Online Help: Link Manual Jobs System Settings for Adaptors

The 7.0.2 version of the online Help does not correctly document the usage of the Link Manual Jobs system configuration setting. (The documentation will be corrected in a subsequent release of the online Help documentation.)

In 7.0.2, the system configuration setting for Link Manual Jobs no longer applies to running adaptor-linked jobs manually. The Run Link check box is now always displayed for adaptor-linked projects on the Start Project page.

The Link Manual Jobs system setting applies only to running an adaptor-linked project using the Quick StartFigure shows a quick start icon, a green button with a white triangle icon (Jobs > Start). You must set the Link Manual Jobs setting if you want to use the Quick Start option for adaptor-linked projects.

Online Help: System Configuration Setting (Tag: Date Format)

The examples in the description of the Tag: Date Format setting were updated to reflect the correct default format (ymd):
Tag: Date Format
Defines the format used to display the date in the BF_D tag variable. Use the characters y, m, and d as variables for the year, month, and day to show the desired format, along with any desired special characters as separators. For example, for the date September 21, 2005:
Format Output
ymd 050921
m/d/y 09/21/05

Online Help: Creating and Editing Users (Users who own jobs cannot be deleted)

The 7.0.2 version of the online Help does not document the following restriction. (This restriction will be added in a subsequent release of the online Help documentation.)

If a user account owns a scheduled job, the Delete button on the user account form is disabled to prevent the user account from being deleted.

If you want to delete a user account that has scheduled jobs, you must first delete the scheduled jobs.

Online Help: Register names must be referenced using uppercase letters

The 7.0.2 version of the online Help does not document the following restriction. (This restriction will be added in a subsequent release of the online Help documentation.)

Register names for projects and ordinary registers are stored in uppercase.

Use uppercase to create register names and to reference all register types. Even though you can create registers using lowercase letters, registers are stored and must be referenced using uppercase letters.

Online Help: Managing Access Properties

The 7.0.2 documentation for this topic incorrectly states that steps do not inherit access group properties from the project to which they belong. In fact, steps do inherit access group properties from their parent projects.

This statement will be corrected in a subsequent release of the online Help documentation.

Online Help: .agentupdate

The 7.0.2 documentation for this dot command incorrectly stated that the <directory_path> for the command is relative to the default installation directory.

In fact, the directory path can be any used to specify any non-default installation path. Build Forge looks for the agent executable file in this directory.

.agentupdate <directory_path> agent_executable_file

The incorrect statement will be corrected in a subsequent release of the online Help documentation.

Online Help: .drill command

The 7.0.2 documentation for this dot command included an incorrect example (missing the -r flag) for using project registers as the data source for the .drill command.
.drill -p ProjectRegisterA exec "cat $1" 

The -r flag is required to use the project register as a data source for the .drill command. The correct example follows:

.drill -rp ProjectRegisterA exec "cat $1"