Configuring E-Mail Notification Templates

Use

In this section you will find information about preparing a template that you use for e-mail notifications in the e-mail notification service of the SAP NetWeaver Development Infrastructure (NWDI). Such templates must contain HTML content in UTF-8 encoding. You can use the HTML editor of your choice to create or edit the template file.

Procedure

General rules

In your HTML template, the <title> tag of the HTML is used as the e-mail subject:

               <title>E-mail subject goes here</title>

Message attributes

In your e-mail template you can use several predefined attributes. These attributes will be automatically replaced by the current values that are expected when the notification e-mail is sent. To outline a part of the HTML template as such an attribute, you have to mark the attribute as follows:

               ${name_of_the_attribute}

Name of the attribute	Value of the attribute
action	DC_BUILD , INTERNAL_BUILD , ACTIVATION
bn	Build number.
status	success , failed
buildspace	The CBS buildspace name.
cbsbuildaddr	URL to build the log without host name and port.
cbsbuildurl	URL to build the log.
cbsreqaddr	URL to request the log without host name and port.
cbsrequrl	URL to request the log.
cbswebaddr	URL to CBS Web UI without host name and port.
cbsweburl	URL to CBS Web UI.
compartment	The CBS compartment name.
dcname	Name of the DC which was built.
dcvariant	Build variant.
dcvendor	Vendor of the DC.
finished	Build finish date and time.
jlin<prio>	Number of Jlin errors with the given priority. For example, jlin1 , jlin2 , or jlin3 .
parentid	Request ID of the parent request.
reqid	ID of the build request.
scname	Name of SC to which the DC belongs.
scvendor	Vendor of SC.
service	CBS
trackname	Name of the CMS track.
user	User who started the build or performed the integration.

Sample Code

                  To get the name of track in the template - use:
                  ${trackname}

Sample Code

                  To access the build log - use:
                  http://{hostname}:{httpport}{cbsbuildaddr}

Using pictures in the HTML e-mail template

You can use include pictures in your e-mail template. Note that the pictures must be of type JPG uploaded to the system. To reference these pictures in the e-mail template, use the following syntax:

               <img src="cid:name_of_the_image_file">

Note that you have to upload the JPG files in the template upload wizard, in the same way as you would do with the template file.

Using activations

For broken builds it might be interesting to see all activations that were performed since the last successful build. You can easily specify this in the template file. Add the following line within the HTML:

               #ACTIVATIONS attribute1 attribute2 ...

This line will be replaced by a table which contains all activations since the last successful build of the failed DC attributes.

For example, if you use the following line:

#ACTIVATIONS user dcname status finished reqid cbsweburl cbsreqlurl cbsbuildurl

The result of the template would be:

user	dcname	status	finished	reqid	cbsweburl	cbsrequrl	cbsbuildurl
user1	jmcbs2	success	2010-01-10 23:41:46	24482	cbsweburl	cbsrequrl	cbsbuildurl
user2	jmcbs1	success	2010-01-10 23:33:16	24477	cbsweburl	cbsrequrl	cbsbuildurl
user3	jmcbs1	success	2010-01-10 23:32:13	24476	cbsweburl	cbsrequrl	cbsbuildurl