Customizing Email Templates

Workflow Manager 6.0

You can customize the content and design of email notification messages that are sent out by Workflow Manager.

Location of Email Templates

Outgoing emails are based on customizable email templates. The email templates are stored as text files in the following directory: AdminStudioEnterprise\wwwroot\EmailTemplate.

To change the directory storing email templates at your organization, you can update an entry in the Workflow Manager web.config file. Whenever you select an email template to use, either while defining a workflow step or configuring an issue, all of the templates in this directory will be included in the selection list. So to add a new email template to the system, simply copy the new file into this template folder.

Using Replaceable Parameters in Email Templates

Workflow Manager is installed with a set of standard email templates (text files). These email templates use parameters that are replaced with data before an email is sent.

When creating email templates, you write the text using replaceable fields, and then store the templates in a specific directory, making those templates available for use in Workflow Manager. The replaceable parameters available for use in templates are detailed below.

Replaceable Field Delimiters

Delineate replaceable fields with the characters %%# and #%%. Surround both predefined replaceable items and data items from the template with these delimiters.

Predefined Replaceable Values

The following items are predefined for use in email templates:

Email Template Predefined Values

Replaceable value

Replaced with...

AMS_Application.ApplicationLName

The name of the workflow request.

AMS_Application.DueDate

The date the workflow request is due to be completed.

AMS_Application.NewIssues

The number of issues raised for the workflow request which are not yet responded to.

AMS_Application.TotalIssues

The total number of issues raised for the workflow request.

AMS_Application.UploadBy

The account name of the person who submitted the workflow request.

AMS_Application.UploadDate

The date the workflow request was submitted.

If you are creating a notification message related, for example, to the installation of an application, and wish to show information specific to that application, follow the below example:

<html>

  <body>

    <table>

      <tr>

        <td>

        The application %%#AMS_Application.ApplicationLName#%%

        has been requested for installation by

        %%#AMS_Application.UploadBy#%%. Please note that the due

        date for this request to be completed is %%#AMS_Application.DueDate#%%.

        </td>

      </tr>

    </table>

  </body>

</html>

More predefined values can be made available by populating the AMS_CViews_Fields table. In particular, the chEmailField and chEmailQuery columns both need to be populated for a predefined value to work.

Using Data Items As Replaceable Values

All of the data items that are defined in a template are available for use in email notification messages. For these values, simply put the name of the data item between the delimiters %%# and #%%. The following example shows how to use some of these data fields:

<html>

   <body>

      <table>

         <tr>

            <td>

            Data Values for   %%#AMS_Application.ApplicationLName#%%

            <br>

            Version Number:   %%#Version (major.minor.patch)#%%

            Description:   %%#Description#%%

            Application Type:   %%#Application Type#%%

            Application Size (megabytes):   %%#Application Size

               (megabytes)#%%

            Is License Management Required?:   %%#Is License

               Management Required?#%%

            Media Type:   %%#Media Type#%%

            Number of Users:   %%#Number of Users#%%

            </td>

         </tr>

      </table>

   </body>

</html>

Legacy Standard Items

The following legacy items are defined in Workflow Manager and may be used in an email template. Enclose these item names in square brackets ( [ ] ) so that Workflow Manager will recognize them as standard data items that will be replaced with actual values prior to the email being sent.

  ApplicationName

  Changed

  Rejected

  ApplicationDataItem

  Destination

  IssueText

  Major

  Minor

  TimeSpent

  RollbackText.