Configuring E-Mail Notifications - Electronic Plan Review - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

Electronic Plan Review

Platform
OnBase
Product
Electronic Plan Review
Release
Foundation 23.1
License
Standard
Essential
Premier

Plan Review uses the Hyland Distribution Service to send e-mail notifications to submitter users. In order to be able to send these e-mail notifications, you must properly install and configure your Hyland Distribution Service. See the Hyland Distribution Service documentation for more detail.

Template files control the appearance of the notifications sent to your submitter users. These files are stored in the Views | Shared folder of your Plan Review Web site directory, and can be modified using a standard text editor.

You can update the fields in the template file as needed to customize your solution. For example, in the MsgUserRegistration.template file, you can change the email address that will appear in the sender field of registration email notifications generated by Plan Review. To do so, navigate to the else if (Model.Render == RegistrationViewModel.MessagePart.Sender) section and replace the value in the <text> field with the email address you would like to use (by default, this is set to Administrator@MyPlanReviewSite.com).

Note:

When updating template files, do not alter parts of the syntax such as the braces or object names (Model.Render, etc). Only change the values noted in the table below.

File

Description

MsgAcceptProjectInvite.template

This file controls the e-mail notification sent to a user when a project invitation that the user has sent out has been accepted.

Editable values:

  • STR_EP_EMAIL_ACCEPT_SUBJECT: this value is used as the subject line of the email notification.

  • STR_EP_EMAIL_PROJECTACCEPT_MSG: this value is used as the body text of the email notification.

  • Model.EmailAddress: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the e-mail address of the notification's recipient.

  • GrantPrivilege: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the access level being granted to the recipient of the notification.

  • Model.ProjectData.ID: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the ID of the project to which the recipient is being invited.

  • Model.ProjectData.Name: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the name of the project to which the recipient is being invited.

  • Model.ProjectData.Date: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the date of the project to which the recipient is being invited.

  • Model.ProjectData.ProjectGroupID: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the ID of the project group that contains the project to which the recipient is being invited.

  • Model.ProjectData.ProjectGroupName: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the name of the project group that contains the project to which the recipient is being invited.

  • Model.ProjectData.ReviewTypeName: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the name of the review type of the project to which the recipient is being invited.

  • Model.ProjectData.ProjectIdentifier: this value can be added to this template file manually. The value entered here should be something meaningful that will help to identify the project. This value is displayed in the Identifier column on the Web Portal, and the Project ID field in Unity Client.

MsgGrantProjectPrivilege.template

This file controls the e-mail notification sent to a user when he or she is granted access to a project by that project's owner.

Editable values:

  • STR_EP_EMAIL_PRIVUPDATE_SUBJECT: this value is used as the subject line of the email notification.

  • STR_EP_EMAIL_GRANTPRIV_MSG: this value is used as the body text of the email notification.

  • Model.EmailAddress: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the e-mail address of the notification's recipient.

  • GrantPrivilege: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the access level being granted to the recipient of the notification.

  • Model.ProjectData.ID: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the ID of the project to which the recipient is being invited.

  • Model.ProjectData.Name: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the name of the project to which the recipient is being invited.

  • Model.ProjectData.Date: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the date of the project to which the recipient is being invited.

  • Model.ProjectData.ProjectGroupID: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the ID of the project group that contains the project to which the recipient is being invited.

  • Model.ProjectData.ProjectGroupName: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the name of the project group that contains the project to which the recipient is being invited.

  • Model.ProjectData.ReviewTypeName: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the name of the review type of the project to which the recipient is being invited.

  • Model.ProjectData.ProjectIdentifier: this value can be added to this template file manually. The value entered here should be something meaningful that will help to identify the project. This value is displayed in the Identifier column on the Web Portal, and the Project ID field in Unity Client.

MsgInviteUser.template

This file controls the e-mail notification sent to a user when he or she has been invited to join a project by that project's owner.

Editable values:

  • STR_EP_EMAIL_INVITE_SUBJECT: this value is used as the subject line of the email notification.

  • STR_EP_EMAIL_INVITE_MSG: this value is used as the body text of the email notification.

  • Administrator@MyPlanReviewSite.com: this value is used as the sender's email address for the email notification.

  • Model.EmailAddress: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the e-mail address of the notification's recipient.

  • Model.ProjectData.ID: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the ID of the project to which the recipient is being invited.

  • Model.ProjectData.Name: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the name of the project to which the recipient is being invited.

  • Model.ProjectData.Date: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the date of the project to which the recipient is being invited.

  • Model.ProjectData.ProjectGroupID: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the ID of the project group that contains the project to which the recipient is being invited.

  • Model.ProjectData.ProjectGroupName: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the name of the project group that contains the project to which the recipient is being invited.

  • Model.ProjectData.ReviewTypeName: this value can be added to this template file manually. When the e-mail notification is generated, this value is replaced with the name of the review type of the project to which the recipient is being invited.

  • Model.ProjectData.ProjectIdentifier: this value can be added to this template file manually. The value entered here should be something meaningful that will help to identify the project. This value is displayed in the Identifier column on the Web Portal, and the Project ID field in Unity Client.

MsgRecoverUserName.template

This file controls the e-mail notification sent to a user when he or she uses the Recover Username feature.

Editable values:

  • STR_EP_EMAIL_RECOVER_SUBJECT: this value is used as the subject line of the email notification.

  • STR_EP_EMAIL_RECOVER_MSG: this value is used as the body text of the email notification.

  • Administrator@MyPlanReviewSite.com: this value is used as the sender's email address for the email notification.

MsgResetPassword.template

This file controls the e-mail notification sent to a user when he or she uses the Reset Password feature.

Editable values:

  • STR_EP_EMAIL_PWDRESET_SUBJECT: this value is used as the subject line of the email notification.

  • STR_EP_EMAIL_PWDRESET_MSG: this value is used as the body text of the email notification.

  • Administrator@MyPlanReviewSite.com: this value is used as the sender's email address for the email notification.

MsgRevokeProjectPrivilege.template

This file controls the e-mail notification sent to a user when his or her access to a project has been revoked by the owner of the project.

Editable values:

  • STR_EP_EMAIL_PRIVUPDATE_SUBJECT: this value is used as the subject line of the email notification.

  • STR_EP_EMAIL_REVOKEPRIV_MSG: this value is used as the body text of the email notification.

  • Model.ProjectData.ProjectIdentifier: this value can be added to this template file manually. The value entered here should be something meaningful that will help to identify the project. This value is displayed in the Identifier column on the Web Portal, and the Project ID field in Unity Client.

MsgUserRegistration.template

This file controls the e-mail notification sent to a user when he or she registers an account on your Plan Review Web site.

Editable values:

  • STR_EP_EMAIL_REGISTRATION_SUBJECT: this value is used as the subject line of the email notification.

  • STR_EP_EMAIL_REGISTRATION_MSG: this value is used as the body text of the email notification.

  • Administrator@MyPlanReviewSite.com: this value is used as the sender's email address for the email notification.