For Enterprise Video Content Management System, organizations thrive for a streamlined process of centralized communication with the wide base of their users. To enable this, organizations require an effective way of receiving alerts, prompts, notifications, and other updates regarding the application's use, as timely as possible. This is elemental in creating a responsive environment for everyone. To cater to this requirement VIDIZMO offers Email Templates functionality that enables users to manage automated emails.
Concept
In VIDIZMO, Email Templates define a standardized body of text to be sent to users to prompt them for various activities and their respective status. VIDIZMO offers limitless options to customize these Email Templates. If you are just getting started take a look at How to Configure Email Templates.
If the default template options look good to you, there is nothing more to do. But if you want to customize the content or layout of those emails, you can alter any template. In this article, we provide more details about the tools available for configuring Email Templates.
Components of an Email Template
VIDIZMO allows you to customize Email Templates by inserting variables, filters, text, links, images, and/or buttons.
Variables
Variables give users a degree of flexibility over the textual body of an email, by allowing them to add a set of values in the Email Template settings pane. In your VIDIZMO Account/Portal Email Templates, you can insert variables using a special syntax. Each variable is enclosed in curly brackets:
{{ Sender.FirstName }}
The most commonly used variables are personalization variables, which allow you to dynamically include information about your recipients, workflows, and so forth.
Filters
VIDIZMO also provides you with the functionality of template filters which are used together with template variables to provide additional functionality. This includes accessing important links (password reset, comment moderation, etc), Configuration Keys, and Configurable Terms. In the example below, the ApplicationConfiguration filter will fetch your application name stored against VIDIZMOGlobalConfig key and displays it in the email as shown in the Preview.
Variable Assignment
VIDIZMO also allows you to use Variable Assignment functionality using Tags. It helps authorized users to create and assign variables inside the email body and use them in the email body. The best part of using tags is, they help you avoid re-writing the same long piece of code more than once in an email template.
In the right part of the code below, the above filter has been used to fetch Your Application name from Configuration Keys.
In the left part of the code below a variable ApplicationUrl (it can be any name of your choice without gaps) has been created which has been used to store your Application name. Now, this variable (ApplicationUrl ) can be used at any place in the email template to display the Application URL.
{%- assign ApplicationUrl= ApplicationConfiguration | GetApplicationConfig:''ApplicationUrl'' -%}
Note: Please note that if you do not assign a variable using Tags, you may have to reuse the entire filter snippet every time you reuse it in an article. But if you assign a variable in the start of the email template, you can reuse the tag henceforth. An example of the latter is shown below.
Click here to see the list of Filters and their equivalent Tags
Conditional Tags
Conditional tags allow you to conditionally include content in your email templates. They give you powerful controls for personalizing your email to each individual recipient.
Your {{ TermMashup }} {{ Mashup.Title }} has been {% if Mashup.Status == 'Published' %} Approved. {% elsif Mashup.Status == 'Rejected' %} Rejected. {% endif %}
In the email template above, the content uploaders (email recipient) will be shown "Approved" if their uploaded content is approved. In case, content is rejected then they will be shown "Rejected", followed the content name.
Variables applicable on each Email Template
Below is the list of email templates with their default and allowed variables (variables that can be used in Email Templates in order to customize them).
Warning: Please note that certain variables that have not been assigned yet using tags as mentioned in the section above for Variable Assignment, will have to be assigned first, or will have to be used as filters. For e.g. {{TermMashup}}is not going to be applicable unless you assign the variable its value in the start of the email using {%- assign TermMashup = Tenant | GetConfigurableTerm:''Mashup'' -%}. See the list of such filters in the last section here to ensure your variables are assigned before you can use them in your templates.
Email Template: FeedbackQuestion
This email will be generated when an authorized portal user asks a question regarding any content.
Email Templates : EmailTemplateFeedbackIssue
This email will be generated when an authorized portal user reports issue(s) regarding any content.
Email Templates: FeedbackAbusive
This Email notification will be sent to the administrator when someone reports contents.
Email Templates : Downloading Allowed In Media
This email notification will be sent to the subscriber(s) when flagged content's Allow Downloading option has been changed by an authorized user.
Email Templates : Media/Collection Password Updated
This email notification will be sent to the subscriber(s) when flagged content's password has been updated by an authorized user.
Email Templates : Media/Collection Access Updated
This email notification will be sent to the subscriber(s) when flagged content's Access has been updated by an authorized user.
Email Templates : Media/Collection Updated
This email notification will be sent to the subscriber(s) when flagged content's basic information has been updated by an authorized user.
Email Templates : Media Reuploaded
This email notification will be sent to the subscriber(s) when flagged content has been reuploaded by an authorized user.
Email Templates : Media Clipped
This email notification will be sent to the subscriber(s) when flagged content has been clipped by an authorized user.
Email Templates : Media Deleted
This email notification will be sent to the subscriber(s) when flagged content has been deleted by an authorized user.
Email Templates : Media Added In Collection (Case)
This email notification will be sent to the subscriber(s) when flagged evidence has been added to a case by an authorized user.
Email Templates : Media Downloaded
This email notification will be sent to the subscriber(s) when flagged evidence has been downloaded by an authorized user.
Email Templates: Media/Collection Viewed
This email notification will be sent to the subscriber(s) when flagged evidence has been watched/viewed.
Email Templates: ChannelCreate
This Email notification will be sent to the administrator when creating a new Portal by a confirmed user.
Email Templates: Billing Error
This Email notification will be sent to the administrator when an error occurred during processing the daily bill.
Email Templates: BillingOverage
This Email notification will be sent to the administrator when an account has consumed more than allowed in the package.
Email Templates: AccountPaidConversion
This Email notification will be sent to the administrator after tenant account package updated
Email Templates: WorkflowSucceed
Email notification will be sent to the administrator when a workflow gets successful.
Email Templates: WorkflowFailed
Email notification will be sent to the administrator when a workflow gets failed in processing.
Email Templates: MashupModerated
This Email notification will be sent to the contributor after content has been moderated.
Email Templates: UserForgotPassword
This Email notification will be sent to the registered user with a temporary link to reset a password.
Email Templates: ConfirmationEmail
This Email notification will be sent to the registered user to complete the sign-up process.
Email Templates: UserRequestedRole
This Email notification will be sent to the administrator(s) when a non-admin request administrative rights.
Email Templates: ReferToFriend
This Email notification will be sent to the user when a media is refereed to someone
Email Templates: UserRequestedtoJoin
This Email notification will be sent to the administrator about pending registration/request when a new user is joining a portal.
Email Templates: UserEmailChanged
This Email notification will be sent to the newly added user for resending the confirmation link again.
Email Templates: ResetPasswordChange
This Email notification will be sent to the registered user when their password is reset.
Email Templates: UserApproved
This Email notification will be sent to the registered user when a user request to join portal is approved.
Email Templates: User Invited
This Email notification will be sent to the user informing the Portal access has been granted to the user
Email Templates: Role Updated
This Email notification will be sent to the registered user when role of a user is updated.
Email Templates: Media Shared
This Email notification will be sent to the user when content is shared with someone using limited sharing.
Available Filters
VIDIZMO filters are simple methods that can be used in Email Templates. These filters can be used to fetch allowed information securely from the database and return it at any place in the email template. Read further to learn more about these filters and their possible use.
1. GetConfigurableTerm
This filter can be used in Email Templates to fetch a list of all configurable terms from the database and return the value (Alias) of the provided Term. The code below can be used to fetch the Term Name.
{{ Tenant | GetConfigurableTerm : ''TermName'' }}
Example
In the code above TermName can be replaced with any configurable term (e.g. LearningPlan) of the portal and it will return the alias (Learning Plan).
2. GetApplicationConfig
VIDIZMO filters allow you to search and fetch configuration key values from Application Configurations using filters.
The code below can be used to fetch the Application Configuration keys.
{{ ApplicationConfiguration | GetApplicationConfig:''ApplicationName'' }}
Supported configuration key names:
- ApplicationName
- ApplicationURL
- SupportEmail
- SupportPhoneNumber
Example
The filter code above can be used in any Email Template to fetch the Application Name. Replacing ApplicationName from any supported key name will fetch the corresponding value from the database.
Note: If configuration key name does not match or key does not exist, this filter will return 'key not found'
3. GetSignInUrlEmail
Create and Return Sign-in URL using the user's Email Address.
{{ Tenant | GetSignInUrlEmail : EmailAddress }}
4. GetSignInUrlId
Create and Return Sign-in URL using the user Profile Id of the sender or receiver.
{{ Tenant | GetSignInUrlId : Sender.Id/Recipient.Id}}
5. GetConfirmationLink
Fetch Portal URL information and return email confirmation URL using email Address of the user.
{{ Tenant | GetConfirmationLink : EmailAddress }}
6. GetMediaLink
Fetch Portal URL information and return media URL.
{{ Mashup | GetMediaLink : Tenant , AccessRight.Id , true/false }}
In the code above use True to create a hyperlink or False to only generate the URL string.
7. GetGetMediaLinkForRefer
This filter can be used to fetch shareable media link
{{ Tenant | GetPresentationLinkForRefer : Mashup.Id, Mashup.Type, Mashup.Name , AccessRightId , true/false }}
In the code above use True to create a hyperlink or False to only generate the URL string.
8. GetMediaManagerReviewPageLink
This filter can be used to display moderation link for media in Email Templates. The link can take authenticated user to the drafts tab from where media can be approved or rejected.
{{ Tenant | GetMediaManagerReviewPageLink }}
9. GetCommentModerationUrl
This filter can be used to display the comment moderation URL in the Email Template. The link can take the authenticated user to the comment moderation screen.
{{ Tenant | GetCommentModerationUrl }}
10. GetLinkResetPassword
This filter can be used to fetch the registered user account's password reset link.
{{ Tenant | GetLinkResetPassword : EmailAddress }}
11. GetTenantUrl
This filter can be used to fetch SSL certificate information and subdomain Portal URL and returns the full URL in the Email Template. The filter code is given below:
{{ Tenant | GetTenantUrl }}
Filter and Their Equivalent Tags
The table below shows the filters and their equivalent tags with their usage.