Notifications
Overview of how notifications are triggered and configured within myosh modules.
Introduction to Notifications
Record Notifications are used to automatically send out event information when previously defined condition(s) are met within any of the myosh modules. Creating a record notification requires a series of steps to complete the process. The email template contains all of the content that will be included in the notification. Notification conditions are used to trigger the notification being sent. The steps below will guide you through the process of creating Record Notifications, which include how to:
- Create Email Templates
- Add Variables
- Add Text
- Create the Notification
- Choose Recipients
- Edit Conditions
- Edit Notification Properties
Create a Record Notification
- Select Record Notifications from the Administration menu.
- Select the module the record notification is to be created for from the drop-down list.
- Select E-mail Templates.
- Select the module you are creating the Notification for from the drop-down list.
- Select OK.
- The Email Templates window is displayed and will show existing Record Notifications associated with the module. In the Email Templates window, existing Templates can be created, updated, and deleted.
- Select New Email Template.
- An email template defines the content in the subject that is to be sent every time the record notification is triggered, e.g., Brief Description, Risk Category, Link to the record.
- Enter the Template Name. Reference the type of notification it is going to be used for, e.g., Incident Category 4 Notification.
- Enter the Subject to be shown in the notification. Usually, the subject would contain both free text and Variables from the document.
- Type any free text that you would like to be included.
- Select Add Variable and select the field to include. Repeat the process for additional fields to include in the subject.
- Enter the Message to be shown in the notification. Usually, the message would contain both free text and Variables from the document, e.g., site reference, responsible people, and due date.
- Type any free text that you would like to be included.
- Select Add Variable and select the field to include. Repeat the process for additional fields to include in the message.
- Select Save.
Once the email template has been created, the next step is to create the Notification. Creating the notification requires conditions to be set for when the notification is to be triggered and who the notification is going to be sent to.
- Select New Notification.
- Select the module you are creating the Notification for from the drop-down list, then select OK.
- The Notification Editor window will be displayed. The Notification Editor is used to define the people who receive the notification, the conditions when the notification will be triggered, and any other notification properties.
- Enter the Name of the Notification. Reference the type of notification, e.g., Overdue Action.
- Select the Notification Type. Depending on the type selected, the notification properties will vary:
- Triggered Notification
- Timed Notification
- Record Summary Notification
- In the Send To field, select Add and enter the recipients of the Notification. Add names from the following Address source options. Multiple names can be added by selecting Add each time.
Address Source | Description |
---|---|
Input an Address | Used for external email notifications. |
Select person(s) from the system | Select a name(s) from the User list. |
Field value from the record | Select a field from the record, e.g., person named in Accountable or Supervisor field. |
Group | Select a group to send the notification, e.g., Safety Team. |
Look up value from specific record | Select the module, module form, record, look up field. |
Look up value based on key field value | Look up information found in a record using any module form. |
Look up value based on Hierarchy | Look up information found in a record matching a Hierarchy look up field. |
- In the Reply To field, select Add and enter
no-reply@myosh.com
. - Follow the above steps for names to receive a Copy To.
- Follow the above steps for names to receive a Blind Copy To.
- Select the Template to be used in the notification.
The next step is to define the conditions when the notification is to be triggered. Notification conditions can be based on a field in the record or hierarchy values.
- Select Edit Conditions.
- Select Add Field Conditions.
- Select which field condition needs to be met. The list available will change depending on the module the notification is for.
- Select from the list: contains, does not contain, is blank, is not blank.
- Select further record detail condition as appropriate.
- Add further conditions as required. In addition, you can apply Add Hierarchy Conditions. When multiple conditions are listed, there is the option to have the notification sent when any of the conditions are met or when all are met. Select Match any condition or Match all conditions as necessary.
- Select OK.
Once the Conditions have been set, the Notification Properties should be completed. The notification properties available will vary depending on the type of notification selected, e.g., Triggered, Timed, or Record Summary.
- Select Edit Notification Properties.
- Select the Notification delivery. E-Mail is the most common method selected. For Push, it will need to be first configured to make it available.
- Select the Triggering event, e.g., Record Progressed in workflow or Days of week to trigger on.
- Select the Triggering Workflow step, e.g., Open or Completed status change.
- Select OK.
- Select Save.
The record notification has now been created and will automatically trigger based on the conditions defined. The content of the notification will be sent as per the email template associated with the notification.
Removing Conditions
- Open the Record Notification that you want to remove the condition(s) for.
- Select Edit Conditions at the bottom of the form.
- Select Remove alongside the condition you want to remove from the list.
- Select OK.
Deleting Notifications
- Select the Record Notification that you want to delete.
- Double-click the record notification that is to be deleted.
- Select Delete Notification.
Version: 1
Form and Workflow Definition
This document give an overview of the Form/Workflow Definition feature in the Administration menu to edit form designs and manage workflow steps.
Site Administration Module Overview
Introduction to the Site Administration module, its purpose, and how it helps streamline configurations across other modules.