Notification template variables

Notification templates

Template variables are resolved with the Velocity Template Language (VTL). IBM® UrbanCode™ Release supports VTL 1.7 or above. The variables that are available depend on the event and the context. The following sections describe the most commonly used variables and their properties. The contexts in which the variables are referenced are provided along with examples of use.

VTL variables

$task

$task.name

To display the status for a deployment, you can use a statement similar to the following code fragment:

$scheduledDeployment.deployment.status

The currrent status is $scheduledDeployment.deployment.status

VTL operations

#set($myVariable = "Release1")

#if ($some_variable) 
 ... do stuff here if the variable is not null
#end

For more information about VTL, see the VLT documentation.

Dates

Most date variables are time stamps. You can format the time stamps with the templateUtil.formatter, which has this syntax:

$templateUtil.format($[dateToFormat], '[Format Pattern]') 

$templateUtil.format($scheduledDeployment.scheduledDate, 'MM/dd/yy hh:mm a')

A notification message with this statement displays a value similar to this example: 03/30/16 12:00 AM.

See the Java SimpleDateFormat documentation for the available patterns.

Images

To use images in templates, the images must be uploaded to the server, and then referenced in the template Body. Images are stored in the directory specified by the notification.images.folder.path property in the installed.properties file. By default, the location is the server_directory/var/emailNotificationImages folder.

To insert the image in the message body, use the following syntax:

<img src=../notificationTemplates/image/[Name of image]width=[Size in pixels]’/>

The supported image format is PNG.

Environment variable available to all notifications

The $serverURL variable is available to all notification messages. The $serverURL variable returns the public URL of the IBM UrbanCode Release server, and can be used in hyperlinks.

Event variables

Release variable

Releases are referenced with the $release variable. The release variable returns the release that triggered the notification.

JPetStore
Pet Accounting

#foreach ($application in $release.applications)
    $application.name
#end

Application variable

Applications are referenced with the $application variable. When an application is added to a release or removed from one, the application is available to the release context.

Scheduled deployment variable

Scheduled deployments are referenced with the $scheduledDeployment variable. This variable returns the deployment that triggered the notification.

The context for the $scheduledDeployment is the release for which the deployment is scheduled.

Pre-Deployment Tasks
Deployment Task
Post-Deployment Tasks

#foreach ($approval in $scheduledDeployment.approval.taskList)
    $approval.name -  $approval.result - $approval.status 
#end

#foreach ($version in $scheduledDeployment.versions)
    $version.application.name -  $version.name
#end

#foreach ($segment in $scheduledDeployment.deployment.segments)
    $segment.name 
#end

Task variable

Tasks are referenced with the $task variable. This variable returns the task that triggered the notification.

The contexts for the $task variable are described in the following table.

#foreach ($comment in $task.comments)
    $comment.comment - $templateUtil.format($comment.dateCreated, 'MM/dd/yy hh:mm a')
#end

$templateUtil.format($task.startTimeActual, 'MM/dd/yy hh:mm a')
    

Segment variable

Segments are referenced with the $segment variable. This variable returns the segment that triggered the notification.

The contexts for the $segment variable are described in the following table.

Backup DB 
Deploy WAR

#foreach ($task in $segment.tasks)
    $task.name 
#end

Approval variable

Approvals are referenced with the $approval variable. This variable returns the approval that triggered the notification.

The contexts for the $approval variable are described in the following table.