Creating and managing email actions
Who is this article for?
Administrators configuring Workflows.
Email Action Administration permissions are required.
Email actions allow you to create and modify notification emails that go out automatically when triggered by user actions, such as the creation of a new Document, and scheduled events, such as Document expiration.
A set of default email actions is included with your system install, but you may need to add your own. This article shows you how to do that.
1. Accessing email actions
To access email actions:
- Open Administration from the Navigation Menu.
- Select Email Actions.
You will be taken to the Email Actions list, where you can add, edit, and remove items.
2. Managing email actions
2.1. Creating actions
To create an action:
- Click Add Email Action.
- Set the Module to determine the type of action you're creating.
The list of content is specific to your environment, and the settings presented for each will vary. - Determine the Action that triggers the notification.
- Set the Time Delay.
This is the number of days between when the trigger occurs and when the email is sent. - Tick Send on Last Only as necessary.
This setting applies to Documents and Workflows and sends the email only when the last person in the assigned list or group performs the action.
- Specify which Users/Groups will receive the notification.
- Enter a Subject.
-
Compose the Body of the email notification.
This is the recommended place to insert environment variables. These are dynamic fields that update with database-specific information. These fields appear surrounded by "##" symbols, which should not be removed. - Click Save.
Dependency variables that begin with "##PARENT_" are not available in Email Actions or Reminders.
Each email action applies globally for all users.
To modify an action, click Edit to the right of its record row in the list.
2.2. Adding exceptions
These fields allow you to create routing exceptions based on custom field selections. So if a certain value is chosen, this email goes to different recipients as it's processed.
- Triggered by List field gives a list of custom fields associated with the object.
- Operator shows whether the value Equals or Does Not Equal what's selected in the List Value drop-down.
- List Value gives a list of possible values for the Triggered by List field.
If you use Exception fields here, you should create more than one Email Action for the other possible choices from the List Value field.
3. Types of email actions
3.1. Data retention
Data retention email actions are used to notify administrators or document control specialists that records in the system have been deleted.
| Actions | Purpose |
|---|---|
| Document Deleted | Sent when deleting an entire document, including all of its revisions. |
| Document Revision Deleted | Sent when only deleting a specific revision of a document. |
| Test Instance Deleted | Sent when deleting an test instance. |
| Training Instance Deleted | Sent when deleting a training instance. |
| Workflow Instance Deleted | Sent when deleting a workflow instance. |
| Recipients | Description |
|---|---|
| Add Groups/Users | By default the recipient list is empty and individuals/groups must be added. |
| Environment Variables | Description |
|---|---|
| ##DATE_DELETED## | The date the deletion event occurred. |
| ##DELETED_BY## | The user who performed the deletion. |
| ##DELETION_REASON## | Comments made during the deletion event. |
| ##DOCUMENT_REVISION_DELETED## | The document revision number deleted. |
| ##ID# | The ID number of the document, workflow, test or training instance deleted. |
| ##TITLE## | The document title, or definition title for the workflow, test or training deleted. |
3.2. Document control
Document control email actions are used to notify users about various events relating to document records.
| Actions | Purpose |
|---|---|
| Approve & Auto-Publish | Sent when a document is approved, including documents approved automatically via Publish On First Revision in the Create Document page. Only after all approvals have been completed, enable the Last Only option. |
| Approve & Schedule Publish | Sent after a document is approved and is awaiting publish. |
| Cancel Release | Sent when the current editor cancels a release for approval. |
| Cancel Release for Review | Sent whenever the editor cancels a release for review. |
| Cancel Revision | Sent when the editor cancels the current revision of a document, resetting it to the previous published revision. |
| Change Editor | Sent when the current editor assigns another user as the editor with the change editor command. If a logged in user assigns another user as the editor without using this command, they are entering an edit request (see below). |
| Create | Sent when a new document is created. |
| Edit | Sent when a document is placed in edit status. Note: this email action will not go out when an edit request is submitted. |
| Expiration Review | Sent when the Verify Up to Date command is used to re-publish a recently expired document. |
| Expire | Sent whenever a document automatically expires to edit status. |
| Manual / Scheduled Publish | Sent after a document is manually published or delay published successfully. |
| Reject | Sent when an approver rejects a document revision. |
| Release for Approval | Sent whenever the editor releases a document for approval. |
| Release for Review | Sent whenever a document is released for review. |
| Retire | Sent whenever a document is retired. |
| Review | Sent whenever a document is reviewed. For any email actions of this type, select the Last Only option to have the email sent only when all reviewers have completed. |
| Recipients | Description |
|---|---|
| Editor | The current editor of the document. |
| Document Managers | All users with the Document Manager permission. |
| Last Action By | The last user to process the document. |
| Old Editor | The last user assigned as the editor of a document, even if they did not actually edit it or publish a new revision. |
| Active Approvers | Users assigned to approve the document for the current step in the serial approval process. Note: If using this setting, it's recommended to not enable approval list as a recipient also. Enabling the Send on Last Only setting is not recommended. |
| Administrators | The administrator account (user ID# 1). |
| Approval List | All users in the approval list, even if they are not currently active approvers or the document is not released for approval. |
| Review List | All users in the review list, even if they are not currently active or the document is not released for review. |
| Notify List | All users in the notify list on the Document Properties - Documents List tab. |
| Environment Variables |
|---|
| All variables that can be inserted into automatic headers and footers for both HTML and Word documents. |
| Any custom field associated with any document on your server. Custom field variables consist of custom field title surrounded by hash signs. Spaces in the field are represented with underscores. For example, the environment variable for the Home Phone custom field would be ##HOME_PHONE##. |
3.3. Workflow
Workflow email actions must be created separately for each workflow. All workflows, even those not currently online, are listed by definition title. When you select a workflow, the Action drop-down updates to include all routes in the chosen workflow.
| Actions | Purpose |
|---|---|
| Changes Saved | Sent each time a change is made to the workflow definition. |
| Expired | Workflows can be set to expire periodically to a step determined by settings in the workflow definition. Select this action to send an email each time. |
| Launched Workflow | Used when one workflow launches another. This action may be configured for the parent workflow to send an email once a child workflow has been launched. |
| Responsible Party Changed | Sent each time a user assigns a new responsible party via a custom field while processing a workflow instance. |
| Routes | Additional actions for every route added to the workflow definition are also included. |
| Recipients | Description |
|---|---|
| Initiator | The user who started the workflow instance. |
| Responsible Parties | The responsible party for the current step. |
| Collaborators | Users permitted to fill in custom field information but not move the workflow to the next step. |
| Launched Workflow Responsible Parties | The responsible parties workflow instances initiated by the Workflow Launcher. |
| Additional Responsible Parties | Responsible parties included in the workflow definition via a custom field are also available as default recipients. |
| Environment Variables | Description |
|---|---|
| ##CUSTOM_FIELD_NAME## | Any data entered in the custom field used in the workflow is displayed where this environment variable is used. |
| ##LAUNCHED_WORKFLOW_ID## | The workflow instance ID number of the workflow launched by the workflow launcher action. |
| ##LAUNCHED_WORKFLOW_TITLE## | The title of the workflow launched by the workflow launcher action. |
Add hyperlinks to the workflow instance by using the following format: ##SERVER##/workflow/instance.aspx?id=##ID##.
3.4. User
User email actions are triggered by events related to user accounts.
| Actions | Purpose |
|---|---|
| Account Created | Sent when a new user is added. This email action can be used to inform the new user of their login credentials and the site URL. |
| Account Locked Out | Sent when an account is locked to due to the user reaching a maximum number of failed login attempts. |
| Account Reset | Sent when an administrator resets a user's locked account. This email action is useful to notify other administrators that the account has been reset so they do not need to take any action. |
| No Available Licenses | Sent when a user tries to login but gets the "All licenses are currently in use" message. This message applies only to the type of license the user is logging in under (Concurrent or Concurrent testing). Can be used to notify an administrator how often this happens, in case more licenses are required. |
| Recipients | Description |
|---|---|
| Administrators | Users with the Personnel Administration permission. |
| User | The user involved in the Action. |
| Environment Variables | Description |
|---|---|
| ##FULL_NAME## | The user's full name from their personnel profile. |
| ##LICENSE_TYPE## | The type of license a user is trying to login with. |
| ##LOGIN_NAME## | The username, as listed in the user's personnel profile. |
| ##SERVER## | The URL or IP Address of your server. |
3.5. Test
Test email actions notify users when a test is assigned, and inform managers and administrators of test results.
| Actions | Purpose |
|---|---|
| Assigned To Users | Sent when tests are sent to users/groups. |
| Failed | Sent when a user fails a test, even if they fail multiple times and eventually pass. |
| Passed | Sent when a user passes a test, even if they have to retake the test several times in order to pass. |
| Recipients | Description |
|---|---|
| Tester | All users who are assigned the test. Personnel who are in the test taker list but to whom the test is not actually sent are not included. |
| Document Managers | All users with the Document Manager permission. |
| Environment Variables | Description |
|---|---|
| ##ALL_TEST_TAKERS## | All test takers are all users the test is sent to. This is sent primarily to inform managers and test administrators. |
| ##FULL_NAME## | The user's full name from their personnel profile. |
| ##ID## | The test definition ID number. |
| ##INSTANCE_ID## | The test instance ID number. |
| ##LOGIN_NAME## | The username, as listed in the user's personnel profile. |
| ##TEST_SCORE## | The numeric test score. |
| ##TIMES_FAILED## | The number of times the user has failed a test created from the test definition. |
| ##TITLE## | The test definition title (not the title of any attached reference document). |
Add hyperlinks to the test instance by using the following format: ##SERVER##/testing/instance.aspx?id=##INSTANCE_ID##.
3.6. Training
Training email actions notify trainees and managers of various tasks and actions performed around the training process.
| Actions | Purpose |
|---|---|
| Assigned | Sent when a trainee or sign-off manager modifies a training and clicks Save Changes. |
| Cancelled | Sent when the training is cancelled by the trainee. |
| Completion Rejected | Sent when the completion or effectiveness sign-off personnel rejects the attendee's training. |
| Completion Verified | Sent when the completion sign-off personnel accepts the attendee's training. |
| Effectiveness Verified | Sent when the effectiveness sign-off personnel verifies that the attendee has demonstrated the training was effective. |
| Reschedule training | Sent when the trainee fails a test associated with the training, retries are not allowed, and the sign-off personnel resent the training. |
| Test Completed | Sent when the trainee passes a test associated with the training. |
| Training Taken | Sent when the trainee submits their training instance. |
| Recipients | Description |
|---|---|
| Trainee | Users/Groups who the training instance was assigned to. |
| Completion Sign Off Users | Users/Groups assigned as the completion sign-off personnel. |
| Effectiveness Sign Off Users | Users/Groups assigned as the effectiveness sign-off personnel. |
| Environment Variables | Description |
|---|---|
| ##ASSOCIATED_DOCUMENT_TITLE## | The name of the reference document associated with the training. |
| ##DATE_ASSIGNED## | When the training instance was assigned to the trainee. |
| ##DATE_TRAINING_COMPLETED## | When all steps were completed for the training instance. |
| ##DEFINITION_ID## | The ID number of the training definition. |
| ##INSTANCE_ID## | The ID number of the training instance sent to the Trainee. |
| ##JOB_RELATED## | Whether the training definition has the Job Related field enabled, meaning the training is related to job specific tasks company wide. |
| ##LAST_PROCESSED_BY## | The last sign-off personnel to verify or reject the training instance. |
| ##LAST_PROCESSED_COMMENTS## | Any comments the last sign-off personnel added when verifying or rejecting the training. |
| ##LAST_PROCESSED_DATE## | When the last sign-off personnel verified or rejected the training instance. |
| ##REMAINING_APPROVERS## | The name of any sign-off personnel yet to review the training instance for completion or effectiveness. |
| ##STATUS## | The current step of the training instance. |
| ##TITLE## | The name of the training, as listed in the training definition. |
| ##TRAINEE_EMAIL## | The email address of the trainee, as listed in their personnel profile. |
| ##TRAINEE_FIRST_NAME## | The trainee's first name, as listed in their personnel profile. |
| ##TRAINEE_LAST_NAME## | The trainee's last name, as listed in their personnel profile. |
| ##TRAINEE_LOGIN## | The trainee's username, as listed in their personnel profile. |
| ##TRAINEE_NAME## | The trainee's full name, as listed in their personnel profile. |
| ##TRAINING_DESCRIPTION## | Any description added to the training definition, as found on the General tab. |
Add hyperlinks to the test instance by using the following format: ##SERVER##/testing/instance.aspx?id=##INSTANCE_ID##.
3.7. Scheduled Task
Scheduled Task email actions are typically used to notify administrators that automated, scheduled events occurred successfully.
| Actions | Purpose |
|---|---|
| Scheduled Task {Name} | The Scheduled Task that you're sending a status email about. Typically to verify that it ran correctly. |
| Recipients | Description |
|---|---|
| Add Groups/Users | By default the recipient list is empty and individuals/groups must be added. Typically an administrator receives these emails. |
| Environment Variables | Description |
|---|---|
| ##DATE_EXECUTED## | When the Scheduled Task last ran. |
| ##ERROR_MESSAGE## | Failure notices, as tracked in the log files. |
| ##FREQUENCY## | The time frame the Scheduled Task is set to run to, which can be Once, Hourly, Daily, Weekly, or Monthly. |
| ##NEXT_EXECUTION## | When the Scheduled Task will next run. |
| ##PARAMETERS## | Any custom arguments affecting how the Scheduled Task is applied. |
| ##TITLE## | The name of the Scheduled Task. |