Special notification template variables

The following table lists the special variables available to notification templates. Some variables are context-sensitive and are only available when relevant (for example, the STEPNAME variable is not set for project-level notifications, only step-level notifications).

Variable

Contains

ACTION

For build purges, describes the type of deletion performed.

BID

Specifies the job ID number. Used to construct links back to the Management Console to access reports.

CONSOLEHOST

The host name of the Management Console computer.

CONSOLEPORT

The port number used by the Management Console. Allows you to construct valid URLs within a notification template.

CONTEXTLOGLINKS

Lists lines from the log that begin with "FILT:", with three lines of context per entry. The system provides links to the Management Console log entries in the message.

DURATION

For steps, specifies the run time in seconds for the step and any steps it inlined.

EID

Specifies the Environment ID number. Used to construct links back to the Management Console to access reports.

FULLNORMALLOG

Shows the log information for each step in the job, excluding the environment setup actions that appear in the detailed log.

LINK

For builds, specifies the link name.

MESSAGE

Contains the error or message text for failure or alert messages.

ONFAIL

For steps, holds the continue property for the step.

PATH

For steps, specifies paths where appropriate, for data items like servers or steps.

PID

Specifies the Project ID number. Used to construct links back to the Management Console to access reports.

PROJECTNAME

Contains the name of the project.

RUNACTION

Specifies the variable that the email template leverages.

SELECTOR

Contains the selector name for a step or project.

SERVER

Contains the selector name for a step or project.

SID

For steps, specifies the Step ID number. Used to construct links back to the Management Console to access reports.

SRVRHOST

For steps, contains the TCP/IP host name of the server for a step.

START

Contains the date/time a job started.

STEPNAME

For steps, contains the name of the step.

STEPNORMALLOG

For steps, shows the log information for the current step in the job, excluding the environment setup actions that appear in the detailed log.

TAG

Contains the tag string for a job. The same value as $BF_TAG.

TAILNORMALLOG

For steps, works like STEPNORMALLOG, but only displays the end of the log.

For builds, works like FULLNORMALLOG, but only displays the end of the log for each step.

The number of lines displayed is controlled by the Tail Log Amount for Mail Template system setting.

USEREMAIL

Contains the email address for the owner of a job/event.

USERNAME

Contains the full name for the owner of a job/event.


Feedback