BuildForge Help

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 purge templates, describes the type of deletion performed.

BID

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

CMD

For source adaptors, identifies link command specific error strings.

CONSOLEHOST

The host name of the Management Console machine.

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 number of seconds the step ran.

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 source adaptors, 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

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.

SERVER

Contains the logical server name for a step.

SID

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

SRVRHOST

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 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 Works like FULLNORMALLOG, but only displays the end of the log. The number of lines displayed is controlled by the Tail Log Amount for Mail Template system setting. This variable must be used in a step notification template.

UID

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

USEREMAIL

Contains the e-mail address for the owner of a job/event.

USERNAME

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