Using Variables

When constructing the subject line and message body for a template, you can use Variables. These variables are automatically expanded when the notification is issued.

Variables can be either Object Methods (such as ${application.name}) or Scalar Variables that are set by DeployHub during specific operations (such as $SERVER_STATUS during a periodic server scan).

Object Methods can be used for any object that is available to DeployHub during the operation. For example, you could use ${application.id} to get the internal application id or ${application.domain.name} to get the current domain for the application.

The table below shows which variables are set during specific operations.

Variable Name	Description	Operation
${application.name}	The name of the current application	Any DeployHub task operating on an Application (such as Deploy, Move, Approve etc)
${environment.name}	The name of the target environment	Any DeployHub task operating on an Environment (such as Deploy etc)
${user.name}	The name of the invoking user	Any DeployHub task.
$DEPLOY_ID	The Deployment ID Number	Set during a Deploy task.
$SERVER_NAME	End Point Name	The name of the end point during an automatic periodic scan (AutoPing or AutoMD5). Use this variable in a Ping or MD5 template.
$SERVER_HOSTNAME	End Point hostname	The hostname of the end point during an automatic periodic scan (AutoPing or AutoMD5). Use this variable in a Ping or MD5 template.
$SERVER_STATUS	OK or FAILED	The status of the server during an automatic periodic scan (AutoPing). Use this variable in a Ping template. Note this variable is always OK in an MD5 template since MD5 scans are only performed if the ping check succeeds.
$NAME_RESOLUTION	OK or FAILED	Set during an automatic periodic scan (AutoPing). Reflects the success or failure of resolution of hostname. Use this variable in a Ping template.
$PING	OK or FAILED	Set during an automatic periodic scan (AutoPing). Reflects the success or failure of the ping to the server. Use this variable in a Ping template.
$CONNECTION	OK or FAILED	Set during an automatic periodic scan (AutoPing). Reflects the success or failure of the connection attempt to the server using the associated credentials. Use this variable in a Ping template.
$BASEDIR	OK or FAILED	Set during an automatic periodic scan (AutoPing). Reflects the success or failure of the attempt to switch to the server's base directory. Use this variable in a Ping template.
$MD5_FILELIST	A list of files (one per line)	Set during an automatic periodic scan (AutoMD5). Lists all the files whose MD5 checksum differs from that calculated during the last deployment to the server. Use this variable in a MD5 template.
$SRCDOMAIN	The name of the Source Domain	Set during a Move or Approve task. The name of the Domain the application is being moved from (for a move) or its current domain (for an approve).
$TGTDOMAIN	The name of the Target Domain	Set during a Move or Approve task. The name of the Domain the application is being moved to or approved for.
$NOTES	Free Text	Set during a Move, Approve or Request task. The notes that were entered (if any) by the user when the task was run.
$TASKNAME	The name of the Requested Task	Set during a Request task. The name of the task being requested to be run.
$ERROR_TEXT	Last End Point Error	Set during an automatic periodic scan (AutoPing). The last error detected during the connection attempt.