Notifications
E-mail notifications can be sent when there is a need to notify a user about changes in a table record.
When a notification is created, the notification metadata is converted into a record change trigger and an email alert action. This means that the trigger with the email alert action is added to a database automatically, and vice versa, the trigger with a sole email alert action that is not reused elsewhere is viewed and edited as the notification, all on a single screen. However, these trigger and action are also listed under workflow triggers and actions to allow fine-tuning.
To create a new notification or modify an existing one:
-
Click the
Setup
link in the top right corner of the window. -
Select the table you need.
-
From the setup menu, select
E-mail Notifications
>Configure e-mail notifications
. The system will display theRecord Change Notifications
form:
If you want to edit an existing notification, click the Edit
button next to the necessary notification entry. You can also copy existing notifications or delete them by clicking the corresponding buttons on the form.
Moreover, you can enable or disable sending emails in the common list of the notifications: select the checkbox next to a necessary record and click the
Enable
orDisable
button. Use theAction
checkbox for multiple selections.
To create a new notification, click the New
button at the top of the form. As a result, the New Notification
form will be displayed.
General Properties
In the General
section of the form, enter the e-mail notification general data:
- Name
- Enter the name of the e-mail notification that you are creating.
- From
- Specify from whom the notification should be sent.
- notify@teamdesk.net: The notification will be sent from the notify@teamdesk.net email address.
- Database Owner: A database owner’s name and e-mail will be indicated in the From field of the notification.
- Me: Your user name and e-mail will be indicated in the From field of the notification.
- The User: You can specify a user whose e-mail and name will be indicated in the From field. Furthermore, if there are more than 50 users in the database user list, you should enter some letters or words to find the user you need. By default, the first 50 names of users are listed in the dropdown.
- The address listed in the column: If there are columns of the E-mail type or User type in a table, you can specify the column name. As a result, the column value will be displayed in the From field of the notification.
- Specific e-mail address: You can type-in a specific e-mail address, and this e-mail address will be displayed in the From field.
- To/Cc/Bcc
- Select options defining to whom the notification should be sent. You can specify one or many options described below.
- All users with access: The notification will be sent to all users who have the access to the database.
- Me: The notification will be sent to your user e-mail. You entered this e-mail, when registered as a database user.
- The User: You can specify a user to whom the notification will be sent. Furthermore, if there are more than 50 users in the database user list, you should enter some letters or words to find the user you need. By default, the first 50 names of users are listed in the dropdown.
- All members of the role: You can choose a role and the notification will be sent to the users whom this role is assigned.
- The address listed in the column: If there are columns of the E-mail type or User type in a table, you can specify the column name. As a result, the notification will be sent to the e-mail value kept in this column.
- Specific e-mail address: You can type-in a specific e-mail address and the notification will be sent to it.
Recipients specified in the Cc and Bcc fields will receive copies of the messages sent to every recipient specified in the To field regardless of their access rights.
- Do not notify modifier
- Check the
Do not notify modifier
option if you do not want to send the e-mail notification to a person who added, modified, or deleted the record.
Email Contents
In the E-mail Contents
section of the form, enter the data concerning e-mail contents:
- Subject
- In the
Subject
field, enter a subject of the new e-mail notification. Furthermore, in this field, you can use any column placeholder. Just write a column name in square brackets [ ], for example [Column Name]. To simplify placeholder writing, you may type the first letters of the column name after the left square bracket sign [ in the notificationBody
, and the columns starting with these letters will be displayed in the dropdown. Then you can cut/paste this placeholder from theBody
into theSubject
field. - Body
- In the
Body
field, enter the basic information of the notification. The data is entered as plain text with support for markdown formatting.
If you need to include HTML content in your email body, wrap it with
<div markup="off">...</div>
tags.
Note that the body of the e-mail notification may contain placeholders (for example, the name of the action: modifying/adding/deleting table records). To configure the body of the message, use the %
sign to choose and insert the placeholders you need. Also, you can click [
to list all columns of a table and insert column variables you need. Moreover, you can type the first letters of the column name after the [
sign, and the columns starting with these letters will be displayed in the dropdown.
You are able to select the following placeholders:
- %AppName%: The name of this database
- %AppOwner%: The owner of this database
- %AppLink%: The link to the database
- %RecData%: The copy of a record form with data.
If column values are changed, column names are highlighted in red.
Moreover, the %RecData% placeholder comprises only accessible columns (fields), which are displayed on a View Record Form.
If a notification is sent to a database user, only columns (fields) accessible and visible on form to this user will be displayed in the %RecData% placeholder of a notification sent to this user.
In case a notification is sent to a person who is not a database user, columns(fields) accessible and visible on form to a database owner will be listed in the %RecData% placeholder. - %RecChanges%: The list of the record changes. When a record is modified, the old and the new column values will be listed in the notification body.
- %RecLink%: The link to the record
- %RecId%: The record built-in Id
- %RecKey%: The record key column
- %Action%: The record action
- %Modifier%: The record modifier
- %Recipient%: If a user (or a list of users) is chosen in the To field, a corresponding user name will be displayed in this placeholder. In case a specific email or a column of an E-mail Address type is chosen in the To field, the name of the database owner will be shown in this placeholder.
When the [
symbol is entered, the columns comprised in the Table are listed in the dropdown.
If the current column value should be inserted into the notification body, just select the column name from the dropdown.
In case the column value has been changed and you want to display the previous/old column value in the email body, you can click on the <old value>
option in the dropdown and select the column from the newly opened list.
Access rights for the placeholders/columns in the message body are determined by access rights of the user specified in the To field. In case of arbitrary e-mail columns or an arbitrary e-mail address, the access rights of the database owner will be used.
- Format
- Select the desired output format for the email notification:
- HTML - The system will convert the body markup into HTML and send the message as HTML.
- Plain Text - The system will convert the body markup into plain text and send the message as Plain Text.
- Attach Document
- Select a generated document that should be automatically sent by email.
- Attach File
- In the dropdown, you can select a File Attachment column name. As a result, the file kept in this column will be attached to the E-mail notification.
Notification
In the Notification
section of the form, enter data specifying when the notification should be sent:
- Notify when record is
- Define the actions when the e-mail notification should be sent. Notification can be sent when the record is:
- Added;
- Modified;
- Deleted.
- and when the value changes in
- Select the option to specify what columns should influence the notification sending. The following options are available:
- Any column - any change in the record will trigger the notification;
- Specific column(s) - the notification will trigger only when changes are made in the selected columns.
- Filter
- Specify conditions that should be met to send the notification:
- All records if changes should concern all records in the table;
- Only records that meet certain criteria if changes should concern only specific records in the table. Specify necessary conditions using the drop-down lists at the bottom of the Filter subsection;
- Custom formula if you want to specify a formula by which the table records will be filtered. More details about the formulas are described in Formula Language Reference.
- Notification enabled
- Select the checkbox to enable notifying.
Click the Save
button to save the information entered in the form.
To quickly check the filter conditions specified in the notification and review records that could be affected, go to the notification list, click directly on the notification name, and use the View Records
button displayed on the notification form.