Use 'HTML Template' Property of Checklist Activity
- Last UpdatedJun 10, 2024
- 4 minute read
You can use the html email template that is present in the physical folder [AVEVA Work Tasks Installed Path]\AVEVA\Work Tasks\WorkflowElements\Default\en-US\Templates\OutlookEmailTemplate\CheckListEmail.html in the 'HTML Template' property of CheckList activity.
Complete the following steps to customize the CheckListEmail.html.
-
Right-click the Check-List activity and then select Activity Properties.
-
Under Mail Channel group, set the Use html template from property to Yes.
-
Under Mail Channel group, click HTML template edit icon.
-
Go to [AVEVA Work Tasks Installed Path]\AVEVA\Work Tasks\WorkflowElements\Default\en-US\Templates\OutlookEmailTemplate\CheckListEmail.html path and take a copy of the default html template file of Check-List activity and make the necessary changes to the copied file.
Note: While modifying the Check-List email template the following place holders should not be modified as these are necessary for the engine to process the mails that are received from the actors.
-
Email URL
<form id='Form1' action='<%#EmailURL%>' method='post'>
-
Notes
<td bgcolor="#FFFFFF" class="style2"><%#Notes%> </td>
-
Complete content
<table border='0' align='center' cellpadding='5' cellspacing='1' bgcolor='#EBEBEB' class="style2" style="width: 100%; height: 25px;">
<tr bgcolor='#EBEBEB' class="style2">
<td bgcolor='#EBEBEB' class="style2"><strong><%#locColumnName%></strong></td>
<td bgcolor='#EBEBEB' class="style2"><strong><%#locUserInputs%></strong></td>
<td bgcolor='#EBEBEB' class="style2"><strong><%#locValidInputs%></strong></td>
</tr> <%#InputPlaceHolderString%>
</table>
-
Complete content
<td width="95%" class="style2"><span class="style8"><strong><%#locEmailSecurityWarning%></strong></span><br />Workflow:{<%#ApplicationName%>:<%#EmailGUID%>:<%#WorkflowName%>}{WorkflowResourceActivityMail#3.5}{WorkflowFollowUp:<%#SkeltaFollowUpValue%>}{WorkflowReminderTime:<%#SkeltaReminderTimeValue%>}</td>
-
-
Replace only the following place holders in the copied html template as per the table below. This is because the place holders which is in ' <%# %>' format will not support in customized html format.
Note: Make sure that only the following specified place holders are replaced. Do not replace any other place holders.
Keyword
Replace with
<%#EmailURL%>
[%#EmailURL%]
<%#locSalutation%>
[%#locSalutation%]
<%#ActorName%>
[%#ActorName%]
<%#locMailDescription%>
[%#locMailDescription%]
<%#Notes%>
[%#Notes%]
<%#loctaskInfo%>
[%#loctaskInfo%]
<%#locName%>
[%#locName%]
<%#TaskName%>
[%#TaskName%]
<%#locDescription%>
[%#locDescription%]
<%#Description%>
[%#Description%]
<%#locSubmittedBy%>
[%#locSubmittedBy%]
<%#Submitedby%>
[%#Submitedby%]
<%#locSubmittedOn%>
[%#locSubmittedOn%]
<%#SubmittedDate%>
[%#SubmittedDate%]
<%#SubmittedTime%>
[%#SubmittedTime%]
<%#locRepondInTwoWays%>
[%#locRepondInTwoWays%]
<%#locRespondbyMail%>
[%#locRespondbyMail%]
<%#locReplyToMail%>
[%#locReplyToMail%]
<%#locColumnName%>
[%#locColumnName %]
<%#locUserInputs%>
[%#locUserInputs %]
<%#locValidInputs%>
[%#locValidInputs %]
<%#InputPlaceHolderString%>
[%#InputPlaceHolderString%]
<%#locRespondByWeb%>
[%#locRespondByWeb%]
<%#locWorkItemView%>
[%#locWorkItemView%]
<%#workitemView%>
[%#workitemView%]
<%#locWorkItemViewURLText%>
[%#locWorkItemViewURLText%]
<%#docview%>
[%#docview%]
<%#locDocViewURLText%>
[%#locDocViewURLText%]
<%#executionView%>
[%#executionView%]
<%#locExecutionViewURLText%>
[%#locExecutionViewURLText%]
<%#locSignature%>
[%#locSignature%]
<%#locEmailSecurityWarning%>
[%#locEmailSecurityWarning%]
<%#ApplicationName%>
[%#ApplicationName%]
<%#EmailGUID%>
[%#EmailGUID%]
<%#WorkflowName%>
[%#WorkflowName%]
<%#SkeltaFollowUpValue%>
[%#SkeltaFollowUpValue%]
<%#SkeltaReminderTimeValue%>
[%#SkeltaReminderTimeValue%]
-
After replacing place holders, the code is as shown below.
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Mailer</title>
<style type="text/css">
<!--
.style2 {
font-family: Arial, Helvetica, sans-serif;
font-size: 11px;
}
.style4 {
font-family: Arial, Helvetica, sans-serif;
font-size: 15px;
font-weight: Normal;
color: #333333;
}
.Username {
font-family: Arial, Helvetica, sans-serif;
font-size: 13px;
font-weight: Bold;
color: #333333;
}
.subject {
font-family: Arial, Helvetica, sans-serif;
font-size: 13px;
font-weight: Bold;
color: #333333;
}
.style8 {
color: #FF3300;
font-weight: bold;
}
.style9 {font-family: Arial, Helvetica, sans-serif; font-size: 11px; font-weight: bold; }
-->
</style>
</head>
<body>
<form id='Form1' action='[%#EmailURL%]' method='post' >
<table width="700" border="0" align="left" cellpadding="0" cellspacing="1" bgcolor="#CCCCCC">
<tr>
<td valign="top"><table width="100%" border="0" cellpadding="5" bgcolor="#FFFFFF">
<tr>
<td><span class="Username">[%#locSalutation%] <strong>[%#ActorName%]</strong></span>,
<p class="style2">[%#locMailDescription%]</p></td></tr>
<tr>
<td bgcolor="#FFFFFF" class="style2">[%#Notes%] </td>
</tr>
<!-- Appropriate sender details can be passed to the mail by using the sender detail contents as follows
A few are listed below
[%#Value.SendTo.UserDisplayName%]
[%#Value.SendTo.UserEmail%]
[%#Value.SendTo.UserId%]
Contents declared in Start Activity can also be used in a similar way.
XML Variables can also be used.
Variables defined in Start Activity can also be used pass the values to the mail.
Pre-defined variables can also be used.
A few are listed below.
[%#Variable.SubmittedBy.UserId%]
[%#Variable.SubmittedBy.UserName%]
[%#Variable.SubmittedBy.UserDisplayName%]
To make use of localization, Create a Key and its value in WorkflowManagementInstalledFolder/Locales/en-US/EmailTemplate.txt
and use the key in this html.
EG: Let EmailUserDefinedName be the Localization key in WorkflowManagementInstalledFolder/Locales/en-US/EmailTemplate.txt
Use the above key in html as @@EmailUserDefinedName@@ to get its localized value.
TO TRY OUT THE ABOVE POINTS, JUST UNCOMMENT THE NEXT COMMENTED PORTION OF CODE.
-->
<!--<tr>
<td bgcolor="#EBEBEB" class="style4">Resource Details</td>
</tr>
<tr>
<td>
<table width="100%" border="1" cellpadding="6" cellspacing="0" bordercolor="#CCCCCC" bgcolor="#FFFFFF" class="style2">
<tr>
<td width="21%" bgcolor="#EFEFEF">@@EmailUserDefinedDepartment@@</td>
<td width="79%" bgcolor="#EFEFEF">[%#Variable.SubmittedBy.UserDepartment%]</td>
</tr>
<tr>
<td width="21%">@@EmailUserDefinedEmail@@</td>
<td width="79%">[%#Variable.SubmittedBy.UserDisplayName%]</td>
</tr>
</table>
</td>
</tr>-->
<tr>
<td bgcolor="#EBEBEB">
<span class="style4">[%#loctaskInfo%]</span>
</td>
</tr>
<tr>
<td valign="top" bgcolor="#FFFFFF">
<table width="100%" border="0" cellspacing="0" cellpadding="1">
<tr>
<td width="50%">
<table width="100%" border="0" cellpadding="1" cellspacing="0" bgcolor="#999999">
<tr>
<td>
<table width="100%" border="1" cellpadding="6" cellspacing="0" bordercolor="#CCCCCC"
bgcolor="#FFFFFF" class="style2">
<tr>
<td width="21%" bgcolor="#EFEFEF">
<b>[%#locName%]</b></td>
<td width="79%" bgcolor="#EFEFEF">
[%#TaskName%]</td>
</tr>
<tr>
<td>
<b>[%#locDescription%]</b></td>
<td>
[%#Description%]</td>
</tr>
<tr>
<td bgcolor="#EFEFEF">
<b>[%#locSubmittedBy%]</b></td>
<td bgcolor="#EFEFEF">
[%#Submitedby%]</td>
</tr>
<tr>
<td>
<b>[%#locSubmittedOn%]</b></td>
<td>
[%#SubmittedDate%] [%#SubmittedTime%]</td>
</tr>
</table>
</td>
</tr>
</table>
</td>
</tr>
</table>
<br />
</td>
</tr>
<tr>
<td bgcolor="#EBEBEB" class="style2">[%#locRepondInTwoWays%]</td>
</tr>
<tr>
<td><table width="100%" border="0" cellpadding="4" cellspacing="0" class="style2">
<tr>
<td><strong>[%#locRespondbyMail%]</strong></td>
</tr>
<tr>
<td style="padding-left:20px"><i>[%#locReplyToMail%]</i>
<table border='0' align='center' cellpadding='5' cellspacing='1' bgcolor='#EBEBEB' class="style2" style="width: 100%; height: 25px;">
<tr bgcolor='#EBEBEB' class="style2">
<td bgcolor='#EBEBEB' class="style2"><strong>[%#locColumnName%]</strong></td>
<td bgcolor='#EBEBEB' class="style2"><strong>[%#locUserInputs%]</strong></td>
<td bgcolor='#EBEBEB' class="style2"><strong>[%#locValidInputs%]</strong></td>
</tr> [%#InputPlaceHolderString%]
</table>
</td>
</tr>
<tr>
<td><strong><br />[%#locRespondByWeb%]</strong></td>
</tr>
<tr>
<td style="padding-left:20px"><i>[%#locWorkItemView%]</i>
<br />
<a [%#workitemView%]>[%#locWorkItemViewURLText%]</a>
</td>
</tr>
</table></td>
</tr>
<tr bgcolor="#EBEBEB">
<td align="right" class="style2">
<span><a [%#docview%]>[%#locDocViewURLText%]</a></span>
|
<span><a [%#executionView%]>[%#locExecutionViewURLText%]</a></span>
</td>
</tr>
<tr>
<td bgcolor="#FFFFFF" class="style2">[%#locSignature%]</td>
</tr>
<tr>
<td bgcolor="#FFFFCC" class="style2"><table width="100%" border="0" cellspacing="0" cellpadding="3">
<tr>
<td width="95%" class="style2"><span class="style8"><strong>[%#locEmailSecurityWarning%]</strong></span><br />
Workflow:{[%#ApplicationName%]:[%#EmailGUID%]:[%#WorkflowName%]}{WorkflowResourceActivityMail#3.5}{WorkflowFollowUp:[%#SkeltaFollowUpValue%]}{WorkflowReminderTime:[%#SkeltaReminderTimeValue%]}</td>
</tr>
</table></td>
</tr>
</table></td>
</tr>
</table>
</form>
</body>
</html>
-
Copy the modified code (In this case, the above code) and paste into the HTML template window as Paste Plain Text and click Update.

-
The following code shows after pasting the code.

Variables, Contents, and XML Variables can also be inserted into the html text wherever necessary by just selecting it from the drop-down provided in the HTML template window and appending it wherever necessary.