Alert Template

TIBCO MFT Command Center provides an alert template. The template is named as email-alert-notification-template.xml and is located by default in the TIBCO MFT Command Center <MFT_Install>\server\webapps\cfcc\email-template directory.

The following example is a copy of the alert template that is shipped with the TIBCO MFT Command Center software: 

<?xml version="1.0"?>
<!DOCTYPE alert-notification-email SYSTEM "alert-notification-email.dtd">

<!-- Sample file notification template  -->

<alert-notification-email>
	<sender>
		<address><token name="emailsender"/></address>
	</sender>
	<subject>Email Alert</subject>
	<message>
		A transfer matches alert definition, and triggers the alert processing.

		--- Alert Properties ---
		Alert ID: <token name="alertname"/>
		Alert Time: <token name="alerttime"/>
		Alert Description: <token name="alertdescription"/>
		Alert Severity: <token name="severity"/>

		--- Transfer Properties ---
		Audit ID: <token name="auditid"/>
		Department: <token name="department"/>
		File Description: <token name="description"/>
		Local Transaction Id: <token name="localTranId"/>
		Transfer Direction: <token name="transferdirection"/>
		Client File Name: <token name="clientfilename"/>
		To Server: <token name="node"/>
		Server File Name: <token name="serverfilename"/>
		Byte Count: <token name="bytecount"/>
		Start Time: <token name="starttime"/>
		End Time: <token name="endtime"/>
		Transfer Status Message ID: <token name="transferstatusmsg"/>
		Transfer User: <token name="userid"/>
		Transfer status: <token name="transferstatus"/>
		Client IP: <token name="clientip"/>		
		Proxy Msg: <token name="proxystatusmsg"/>
		ProcessName: <token name="processname" />
		UserData: <token name="userdata" />

		Email comment: <token name="comment"/>

	</message>
</alert-notification-email>

The following table lists the description for each line in the template:

Line Description 
<!DOCTYPE alert-notification-email SYSTEM "alert-notification-email.dtd">
 This line defines the DTD file associated with the XML file.

You should insure that this file exists in the same directory as the email template. If the DTD file is not in the same directory as the email template, email processing does not work. 

<sender>
<address><token name="emailsender"/></address>
 This line defines the name of the email sender.

The default sender name is cfcc@companyname.com.

This name can be changed to any appropriate email address. When the user receives an email, the data entered here is shown as the Sender (or From). 

<subject> Email Alert</subject>
 This line defines the information that is shown in the Subject field of the email.

In this case, it indicates that the file is successfully transferred. 

A transfer matches alert definition, and triggers the alert processing.
 This is a comment that indicates the file is transferred successfully.

You can also insert other comments or instructions here. 

Audit ID: <token name="auditid"/>
Department: <token name="department"/>
File Description: <token name="description"/>
Local Transaction Id: <token name="localTranId"/>
Transfer Direction: <token name="transferdirection"/>
Client File Name: <token name="clientfilename"/>
To Server: <token name="node"/>
Server File Name: <token name="serverfilename"/>
Byte Count: <token name="bytecount"/>
Start Time: <token name="starttime"/>
End Time: <token name="endtime"/>
Transfer Status Message ID: <token name="transferstatusmsg"/>
Transfer User: <token name="userid"/>
Transfer status: <token name="transferstatus"/>
Client IP: <token name="clientip"/>		
Proxy Msg: <token name="proxystatusmsg"/>
ProcessName: <token name="processname" />
UserData: <token name="userdata" />

Email comment: <token name="comment"/>
 These fields define information regarding the transfer that triggers the alert.

When a token is included in the field, the information from the transfer definition and audit records is substituted for the token.