BuildForge Help

System-Defined Variables (BF_ Variables)

The system sets values for the following variables automatically in every step. The variables are listed here in alphabetical order.
Note: Environment variables starting with "BF_" are reserved for use by the system and cannot be defined by the user.

Variable

Contains

BF_AGENT_PLATFORM

A string identifying the platform that the agent is running on.

BF_AGENT_VERSION

The version number of the agent for the current server.

B

The default tag variable, which starts at 1 and gets incremented for every job. Can be used in tags.

BF_BID

Contains the job ID number, unique for jobs of the current project.

BF_CLASS

The class for the project

BF_D

Date. Can be used in tags. Format is determined by the Tag: Date Format system setting.

BF_HOST

The TCP/IP host name of the logical server.

BF_J

Day of the year. Can be used in tags.

BF_LASTGOODRUN

The date of the last passing job of the same project, or the last job if no passing job exists.

BF_LASTGOODTAG

Tag for the last passing job (or last job, if no passing jobs stored of the same project).

BF_LASTGOODUNIX

Same as BF_LASTGOODRUN, but expresses the date in UNIX® format.

BF_LASTRUN

The date of the previous job of the current project.

BF_LASTTAG

The tag string for the previous job of the same project.

BF_LASTUNIX

Same as BF_LASTRUN, but expresses the date in UNIX format.

BF_ONFAIL

The Halt/Continue flag for the step

BF_PID

Contains the project ID number.

BF_PROJECTNAME

The project name.

BF_PROJECTNAME_PHYS

Project name as used to create the project directory. The system changes characters specified in the Invalid Relative Dir Characters system setting into underscore characters to create the project directory. For example, if the setting includes a space, then a project named "My Project" receives a project directory named "My_Project".

that

BF_ROOT

The base working directory for the job.

BF_SERVER

The logical server name

BF_SERVER_ROOT

The base path assigned to the logical server

BF_SID

The step ID, which uniquely identifies the current step in the project.

BF_SPID

Contains the calling project ID if the current project was called by another project; otherwise, the value is the same as BF_PID.

BF_STEPNAME

The step name.

BF_SSID

The step ID of the calling step, if the current project was called by another project; otherwise, the value is the same as BF_SID.

BF_T

Time. Can be used in tags. Format is determined by the Tag: Time Format system setting.

BF_TAG

The expanded tag string generated when the job was started.

BF_TAG_PHYS

The tag string with spaces replaced by underscores, except in steps with the Absolute option selected, for which it is the same as BF_TAG.

BF_USER

The user name of the owner of the job

BF_W

Day of the week (a numeric value, from 0 to 6).