Overview

As a provider, you have the option to create or add data resources in Paradigm, e.g. email templates should the need arise. These templates can be added with dynamic data or merge fields that we made available for you to use in creating the content. This knowledge article will provide a workflow on how to search, add, and edit templates, and some template examples as well.

Complexity MEDIUM

Navigation

Workflow

Video Tutorial Link: https://www.youtube.com/watch?v=qsZ2CbvLZWw

Assumptions

You have the minimum required permission level to access the Provider tab
You understand that making changes within this section has system wide implications.
You have an understanding of the Australian Tertiary Education System / VET Sector.

Key Terms and Concepts

BE ADVISED

We have no plans for any new additional email merge fields at this time. More complex use cases should be handled using the Paradigm reporting engine by generating and attaching a file to the email communication event.

MERGE FIELDS Within Communication Templates with Descriptions

Merge Fields Within Communication Templates	Brief Overview
{email_from}	This is the email address of the sender
{email_from_first_name}	This is the first name of sender (blank if the sender is a provider)
{email_from_last_name}	This is the last name of sender (blank if the sender is a provider)
{url_read_tracker}	This is a 1 pixel image that, when added to an email, will upon opening of the email by the receiver will mark the email as open within the system
{email_first_name}	Student / Receiver's first name
{email_last_name}	Student / Receiver's last name
{student_number}	Student’s number issued by provider
{email_subject}	The communication event/email subject

FORM FIELDS EDIT DATA RESOURCE with Descriptions

Field Name	Brief Overview
Category	Template Student Academic General
Data Resource Name	The template name as determined by the institution or the staff member who created it
Data Resource number	System allocated reference number allocated to each template
Purpose	Email Template Transition Template Commitment Template Assessments
Status	Deactivate Deleted Final Draft Initial Draft In Progress Published Revised Draft

Implications

BE ADVISED

We have no plans for any new additional email merge fields at this time. More complex use cases should be handled using the Paradigm reporting engine by generating and attaching a file to the email communication event.

Workflow

1. How to Search for Communication Module Template

1. How to SEARCH for a Communication Module Template

1, 2 Choose Providers > Search Content menus on the side.

3 Enter either of these search criteria (Data Resource Name or Number, Purpose, Category, or Status).

4 Click the SEARCH DATA RESOURCE button. This will return a list of data resources / templates that meet your searched criteria.

5 You have the option to filter the returned options more by typing a keyword of the template name that you want to search. This will reduce the number of results to that keyword that you’ve entered.

6 Click the blue hyperlink on the left side of the template that you want to view.

INFO: In the sample screenshot above, since the keyword “can” has been entered, the results list has been limited to the templates which has the keyword “can” on them.

7 After clicking the template that you want to view or search, it will open the EDIT DATA RESOURCE Form section of that template (sample template screenshot shown below).

back to top

2. How to Add / Create an Email Template

2. How to ADD or CREATE an Email Template

1, 2 Choose Providers > Add Content menus on the side.

3 In the EDIT DATA RESOURCE Form section, fill out the required fields accordingly. Refer to the guide below.

A Purpose – Select the most relevant purpose of the template from the drop-down list.

B Category – Select the most relevant category from the drop-down list.

C Data Resource Name – Enter the template name here.

D Data – Enter the body of the message or the template here. Refer to the “MERGE FIELDS Within Communication Templates with Descriptions” table above under the Key Terms and Concepts section for a list of dynamic data you can use in your template.

E Status – Select the status of your template here.

F Permission Level – Select the minimum permission level required to use this template.

G Template Name – You can copy the same name here as the data resource name field above.

4 After filling out the required fields, click the SAVE DATA RESOURCE button.

back to top

3. How to Edit an Email Template

3. How to EDIT an Email Template

NOTE: You may make ad-hoc changes to an email template via the Communication Module prior to sending the email without changing the original email template (e.g. updating a semester number or year).

1, 2 Choose Providers > Search Content menus on the side.

3 Enter either of these search criteria (Data Resource Name or Number, Purpose, Category, or Status).

4 Click the SEARCH DATA RESOURCE button. This will return a list of data resources / templates that meet your searched criteria.

5 You have the option to filter the returned options more by typing a keyword of the template name that you want to edit. This will reduce the number of results to that keyword that you’ve entered.

6 Click the blue hyperlink on the left side of the template that you want to edit.

INFO: In the sample screenshot above, since the keyword “can” has been entered, the results list has been limited to the templates which has the keyword “can” on them.

7 After clicking the template that you want to edit, it will open the EDIT DATA RESOURCE Form section of that template (sample template screenshot shown below).

8 Edit or update the required information or fields. Refer to all possible editable fields below:

A Purpose – You can edit the purpose of the template to (possible values): Email Template, Transition Template, Commitment Agreement, Student Review Template.

B Category – You can edit the category of the template to (possible values): Student, Template, Academic, General.

C Data Resource Name – You can edit the name here.

D Data – You can edit the body of the template here. Refer to the “MERGE FIELDS Within Communication Templates with Descriptions” table above under the Key Terms and Concepts section for a list of dynamic data you can add in your template.

E Status – You can edit the status into: Deleted, Revised Draft, etc.

F Permission Level – You can change the permission level, to whoever has the minimum required level access to access or view this template.

G Template Name – You can rename your template here.

9 After editing and updating the required fields, click the SAVE DATA RESOURCE button or the SAVE DATA RESOURCE AS NEW REVISION as required.

back to top

Email Template Examples

Example 1. Commonwealth Assessment Notice (with attachment)

Below is an example of an email body for a Commonwealth Assessment Notice (CAN) sent via the communication module. The template includes a date field for the semester in question that an admin user would need to update each semester in advance of sending out the emails.

Paradigm email configuration

Attn: {email_first_name} {email_last_name}

Please find attached your Commonwealth Assessment Notice (CAN) for the Semester 1, 2019. It is your responsibility to check your FEE-HELP balance.


You have the right, under section 169-10 of the Higher Education Support Act 2003, to request correction of information
contained in this Notice. This request must occur in writing or via email within 14 days of the date of issue of this Notice. 

Kind regards
Star fleet Academy
Student Services

NOTICE: This message contains privileged and confidential information intended for the use only of the addressee named above. If you are not the intended recipient of this message you are hereby notified that you must not disseminate, copy or take any action in relation to it. If you have received this message in error, please immediately notify the sender at the above address.

Example of email received via Google Gmail with an attachment

Example 2. Enrolment Period (without attachment)

Below is an example of an email body template for notifying students when online unit enrolment will open for an upcoming time period.

Paradigm email configuration

Attn: {email_first_name} {email_last_name}


Enrolment for Semester 2, 2019 will open on Monday the 2nd of June 2019 and will close on Friday the 14th of July 2019.
Please ensure that you have your username and password to login to the system and that you have discussed your subject selection with your adviser prior to this time. 


Evening classes during semester 2 will be conducted in the Roddenberry building while the Picard building is being refurbished.


If you have an issues please contact Student Services.

Star Fleet Academy
Student Services



NOTICE: This message contains privileged and confidential information intended for the use only of the addressee named above. If you are not the intended recipient of this message you are hereby notified that you must not disseminate, copy or take any action in relation to it. If you have received this message in error, please immediately notify the sender at the above address.

Example of email received via Google Gmail