Overview
There are several different email and notification related options in the Kuali Research system. Some of these settings are appropriate for production and test instances, but some are only appropriate for one type of environment or the other. It is important to know how to configure these settings during an implementation, and if you have an environment that mirrors data from production on a regular basis it's important to know how to turn off notifications before doing certain types of testing.
Parameters that Impact Email Notifications
In order to find the related parameters go to All Links on the Dashboard and search for Parameter and select.
The parameters that impact email and notification behavior in the system are listed below with an explanation of what functionality they drive and what valid values can be listed in each parameter. To modify one of these parameters search for them by Parameter Name and click the edit button next to the search return you wish to modify.
| Parameter Name | EMAIL_NOTIFICATION_TEST_ENABLED |
| Parameter Description | This parameter will turn on TEST MODE. It is important to have this parameter turned on in all test environments to avoid notification emails from test documents being sent to faculty or staff who may not be involved in testing. When test mode is turned on all notifications will go to a email indicated in the parameters listed below. These notifications will also indicate who would have received the notification in a production environment. |
| Out of the Box Value | N |
| Valid Parameter Values and Behavior Explanation |
N = When this parameter is set to N all notifications will be sent to the appropriate recipients in the system. This includes faculty, staff, etc. Y = When this parameter is set to Y all notification will be sent to Test email indicated in the EMAIL_NOTIFICATION_TEST_ADDRESS parameters. |
| Parameter Name | EMAIL_NOTIFICATION_TEST_ADDRESS |
| Parameter Description | This parameter defines which email test notifications are sent to. This parameter appears in the KR-WKFLW and KC-GEN namespaces, and both versions must be set in order for all notifications to go to a test email account. |
| Out of the Box Value | kc.notification@kuali.org |
| Valid Parameter Values and Behavior Explanation |
List an email address here. All notifications generated by Kuali will go to that email address when EMAIL_NOTIFICATION_TEST_ENABLED is set to Y. |
| Parameter Name | FROM_ADDRESS |
| Parameter Description | The email address listed in this parameter is the email that all workflow notifications sent by the system will come "from". So if a user receives a research notification and attempts to send questions about the document by pressing reply this email will receive those replies. While best practice with modern systems is not to reply to automated notifications, some users will still take this action and it helps if an office email of some sort is listed here so these questions are not lost. |
| Out of the Box Value | rice.test@kuali.org |
| Valid Parameter Values and Behavior Explanation |
List an email address here, and all notifications generated by Kuali Research will come from that address. |
| Parameter Name | EMAIL_NOTIFICATION_FROM_ADDRESS |
| Parameter Description | The email address listed in this parameter is the email that all functional notifications sent by the system will come "from". This would be system notifications coming from the Notification table. Also, if a user receives a workflow notification and attempts to send questions about the document by pressing reply this email will receive those replies. While best practice with modern systems is not to reply to automated notifications, some users will still take this action and it helps if an office email of some sort is listed here so these questions are not lost. |
| Out of the Box Value | from.address@kuali.org |
| Valid Parameter Values and Behavior Explanation |
List an email address here, and all notifications generated by Kuali Notifications table will come from that address. |
| Parameter Name | EMAIL_NOTIFICATIONS_ENABLED |
| Parameter Description | This parameter allows an institution to turn functional email notifications on or off. In some cases a school may want to disable notifications altogether. |
| Out of the Box Value | Y |
| Valid Parameter Values and Behavior Explanation |
Y = When this is set to Y the system will send functional notifications from the Kuali Research Notification System. N = When this is set to N the system will not send any functional notification from the Kuali Research Notification System. |
| Parameter Name | SEND_EMAIL_NOTIFICATION_IND |
| Parameter Description | This parameter allows an institution to turn workflow email notifications on or off. In some cases a school may want to disable notifications altogether. |
| Out of the Box Value | Y |
| Valid Parameter Values and Behavior Explanation |
Y = When this is set to Y the system will send Action List Workflow notifications from the Kuali System. N = When this is set to Y the system will not send Action List Workflow notifications from the Kuali System. |
| Parameter Name | LOOKUP_CONTACT_EMAIL |
| Parameter Description | Certain lookups in the system such as Addressbook have an option to contact the System Administrator if the user does not find what they are looking for. The email listed in this parameter will receive all communication initiated from this link. |
| Out of the Box Value | test@kuali.org |
| Valid Parameter Values and Behavior Explanation |
List an email address here, emails initiated from the contact the System Administrator link will be sent to this email. |
| Parameter Name | KC_DEFAULT_EMAIL_RECIPIENT |
| Parameter Description | If an email is null or invalid for a email notification it will send instead to the configured default email address in this parameter. |
| Out of the Box Value | kcnotification@gmail.com |
| Valid Parameter Values and Behavior Explanation |
List an email address here, emails that have no where to go (due to invalid or null addresses) will be sent to this email. |
Comments
0 comments
Article is closed for comments.