Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

Complexity:

Status
colourRed
titleexpert

Communication Event Module Setup and Configuration

The communication event module uses the email delivery provider SendGrid to deliver emails on behalf of the users. To avoid being classified as SPAM, it is important that our SendGrid email server IP address (168.245.65.115) is white-listed to ensure that Paradigm is able to send emails on behalf of your existing company email server. It may also be necessary to configure a DKIM or SPF DNS record to ensure that Paradigm is permitted to send emails on behalf of a provider email domain.

For more details, please contact the Silverband Support Team.

Key Terms and Concepts

...

Overview

The Communication Event menu in Paradigm is intended to send bulk communications to students or selected recipients with information regarding their study at your business or institution. The body of your email template can be personalised using some of the merge fields that we made available, and emails can contain attachments to provide more detailed, personalised, and dynamic data to be included in the report/letter attachment. This knowledge article will guide you on how to send bulk communications to a bulk list of students/recipients with or without attachments.

Complexity:

Status
colourRed
titleexpert

...

Expand
titleCommunication Event: Initial Setup and Configuration

Communication Event Module Initial Setup and Configuration

The communication event module uses the email delivery provider SendGrid to deliver emails on behalf of the users. To avoid being classified as SPAM, it is important that our SendGrid email server IP address (168.245.65.115) is white-listed to ensure that Paradigm is able to send emails on behalf of your existing company email server. It may also be necessary to configure a DKIM or SPF DNS record to ensure that Paradigm is permitted to send emails on behalf of a provider email domain.

After your IT person/department has white-listed our IP address, you can try sending bulk communications by referring to the workflows below – if there are any further issues, raise a ticket to our Support Team.

For more details, please contact the Silverband Support Team.

Expand
titleCommunication Email Details: Adding a New Communication Sender [From: dropdown list]

Adding a New Communication Sender [From: dropdown list]

Image Added

Refer to this How-To Guide: Adding a New Communication Sender (From:) in the Communication Eventfor the workflow.

are required for such a report (i.e. Bulk student report) but additional ones can be added.

Refer to this knowledge article on how to Search, Add and Edit Content (e.g. Email Templates).

Expand
titleCommunication Event: Email Templates

Email Templates

The letter templates are designed to be a cover letter (in email format) for attaching invoices, CANs, enrolment letters, etc to be emailed to the students and stored as proof of communication. Copies of both the letter and attachments are then saved to the student's record within the communication event section. These can then be interrogated for delivery, bouncing, and opening. The letter can be formatted within the provider section for ease of use and minimal updating when used.

Contained within each email sent with the communication module is a one-pixel tracker. This is one 1x1 pixel that is hidden within the body of the email that allows the email client to track the email. It can determine if the email has bounced, been delivered, has been opened and read and if any attachments have been clicked into. This can be particularly useful when students are questioning if an important email/communication was sent to them and if they received it.

Below is a list of required fields to build a bulk student report for Communication events. This report can be built in the report builder and saved for future use. The fields below are required for such a report (i.e. Bulk student report) but additional ones can be added.

Expand
titleTable 1: Email Template Form Fields

Table 1: Email Template Form Fields

Field Name

Brief overview

Communication Request Sender

It will be sent from the email address that is recorded against the users profile.

Provider record is linked with the student’s course enrolment. Make sure you load the student’s course enrolment first, then you will see Provider option in the drop-down.

Expand
titleTable 1: Email Template Form Fields

Table 1: Email Template Form Fields

Field Name

Brief overview

From:

Communication Request Sender

It will be sent from the email address that is recorded against the user's profile.

Provider record is linked with the student’s course enrolment. Make sure you load the student’s course enrolment first, then you will see the Provider option in the drop-down.

If you want a Provider Name/Home Institution (that is not linked to a student's profile or course enrolment) or to add a specific sender/department in your business or institution to be in one of the options under the From field, you have to add a role to that Provider record as a “Communication Sender“, see Adding a New Communication Sender (From:) in the Communication Event for more details.

To:

Communication Request Recipient

Who the email is going to

Communication name / Email Subject

The subject name / line of the email

Communication Date

Date sent. This date is recorded within the communication event as the sent date.

Communication Type

For Communication Events this is normally set to Email

Communication Status

This will tell you the status of the communication event:

  • Bounced - Receiving Server could not or would not accept the message. 

  • Cancelled - Communication Event Cancelled

  • Closed -

  • Email Opened - Recipient has opened the Message

  • Entered -

  • Failure Sending -

  • In-Progress -

  • Pending -

  • Referred -

  • Resolved -

  • Sent -

  • Unknown Party -

Course Enrolment

The Course of Study the student is enrolled in

Communication Template Message

This option will allow the user to select from pre-written email templates. These can be added to or updated once loaded into the HTML writer.

Communication Description / Email Body

This is where the template will be displayed once loaded. Alternatively this is where the user can write the body of the email to be sent.

...

Expand
titleTable 2: Merge Fields in Communication

Table 2: Merge Fields in Communication

Merge Fields Within Communication Templates

Brief Overview

{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

{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

 

Workflow

...

Status
colourBlue
titlestep 1

...

Status
colourBlue
titlestep 2

...

Status
colourBlue
titlestep 3

...

mark the email as open within the system

 

Workflow

...

Follow the instructions below in order from

Status
colourBlue
titlestep 4
depending on your communication event (with or without attachment):

...

1
to
Status
colourBlue
titlestep

...

There are three ways to create the bulk list of students that you want to be the recipients of the communication event, you have the option to choose either of these three possible ways in creating your bulk list:

(
Status
colourGreen
title1
) Search Course screen (Student > Search Course)

You can search for students via this screen by Course Name, Enrolment Status, Institution, Funding Type, Start and End Date, Contact Mode and Hours, Order By, and Agent.

Refer to the instructions on this workflow How to ADD a List of Students to a Bulk List.

(
Status
colourGreen
title2
) Upload Bulk List screen (Student > Upload Bulk List)

...

2
, and choose between
Status
titleoption 1
[if with an attachment] or
Status
titleoption 2
[if without] depending on your communication event.

(

Expand
titleSTEP 1. Create the Bulk List of Students as Recipients to the Communication Event

Status
colourBlue
titlestep 1
Create the Bulk List of Students as Recipients of the Communication Event


1. There are a lot of ways to create the bulk list of students that you want to send be the recipients of the communication event to.Refer to the instructions on this workflow Student > Upload Bulk List., you have the option to choose either of the options in creating your bulk list below:

(
Status
colourGreen
title

3

1
)

Report Builder

Student Search screen (

Report students to send your communication event using your existing saved report or generate a new report with your own criteria / conditions, then this is the best way for you to create the bulk list

Student >

Report Builder)If you want to build a list of

Search)

You can search for students via this screen by Home Institution, Status, etc. which can further be filtered out.

Refer to the instructions on this workflow Report Builder > Bulk Student Select.After creating your bulk list, proceed to theHow to Add Students to a Bulk List via Student Search

(
Status
colour

Blue
Status
colourGreen
title1
)-(
Status
colourGreen
title5
) After filling out the required fields and the email body, set the (
Status
colourGreen
title3
) Communication Status field to Sent, and click the (
Status
colourGreen
title6
) SAVE NEW COMMUNICATIONS FOR LOADED STUDENTS button.

Image Removed

After saving your communication/email body from the bulk list, proceed to the

Status
colourBlue
titlestep 3
Send Bulk Communications WITH Attachments instructions below if you want your communication event to have attachments, else jump to
Status
colourBlue
titlestep 4
Send Bulk Communications WITHOUT Attachments. Expand
title3. Send Bulk Communications WITH Attachments to the Bulk List of Students/Recipients

Status
colourBlue
titlestep 3
Send Bulk Communications WITH Attachments

NOTE: The instructions below assume that you have already followed the

Status
colourBlue
titlestep 1
to
Status
colourBlue
titlestep 2
instructions above.

Status
colourBlue
titlestep 1
Create the Bulk List of Students as Recipients to the Communication Event

Status
colourBlue
titlestep 2
Save a New Communication Event to Selected Recipients

Green
title

step 2Save a New Communication Event to Selected Recipientsinstructions below to save a new communication for the currently loaded (bulk list) students. Expand
title2. Save a New Communication Event to Selected Recipients

Status
colourBlue
titlestep 2
Save a New Communication Event to Selected Recipients

After creating the bulk list of students to whichever method you choose from the options above(

Status
colourBlue
titleSTEP 1
), you are now ready to save a new communication event to your selected recipients.

NOTE:

You should have a bulk list ready [following from the

Status
colourBlue
titleSTEP 1
instructions above] before you can proceed to following the instructions below. In the sample screenshot below, the Search Course screen is being used to generate the students' bulk list – this should be the initial screen prior to sending bulk communications.

You can also remove student(s) at this stage (by clicking the REMOVE button on the right – against the student record to be removed) whom you don’t want to include in the bulk communications.

Note

BE ADVISED:

Bulk actions are much harder to undo, please ensure only the required students are added to the bulk list.

Image Removed

Status
colourGreen
title1
Choose Student > Communication menus on the side or click the (hat)🎓icon on the top left hand corner then select the Communication(✉) menu.

Tip

Refer to the tables above under the Key Terms and Concepts for a description of the required fields below and the available merge fields you can utilise for your email body.

TipTo edit your Communication Templates, refer to the Search, Add and Edit Content (e.g. Email Templates)knowledge article.

2
) Search Course screen (Student > Search Course)

You can search for students via this screen by Course Name, Enrolment Status, Institution, Funding Type, Start and End Date, Contact Mode and Hours, Order By, and Agent.

Refer to the instructions on this workflow How to ADD a List of Students to a Bulk List.

(
Status
colourGreen
title3
) Upload Bulk List screen (Student > Upload Bulk List)

Upload a list from a CSV Source File. You can use this option if you have an existing (valid with all the required fields matching to Paradigm) CSV file with a list of students that you want to send the communication event to.

Refer to the instructions on this workflow Student > Upload Bulk List.

(
Status
colourGreen
title4
) Report Builder screen (Report > Report Builder)

If you want to build a list of students to send your communication event using your existing saved report or generate a new report with your own criteria/conditions, then this is the best way for you to create the bulk list.

Refer to the instructions on this workflow Report Builder > Bulk Student Select.

2. After creating your bulk list, proceed to

Status
colourBlue
titlestep 2
Save a New Communication Event to Selected Recipientsinstructions below to save a new communication for the currently loaded (bulk list) students.

4. Send Bulk Communications WITHOUT
Expand
titleSTEP 2. Save a New Communication Event to Selected Recipients
title

Status
colourBlue
titlestep 2
Save a New Communication Event to Selected Recipients


Note

BE ADVISED:

Bulk actions are much harder to undo, please ensure only the required students are added to the bulk list.

After creating the bulk list of students to whichever method you choose from the options above (

Status
colourBlue
titleSTEP 1
), you are now ready to save a new communication event to your selected recipients.

NOTE:

You should have a bulk list ready [following from the

Status
colourBlue
titleSTEP 1
instructions above] before you can proceed to following the instructions below. In the sample screenshot below, the Search Course screen is being used to generate the students' bulk list – this should be the initial screen prior to sending bulk communications.

You can also remove student(s) at this stage (by clicking the REMOVE button on the right – against the student record to be removed) whom you don’t want to include in the bulk communications.

Image Added

1. After you have finalised your list, choose Student > Communication menus on the side or click the (hat)🎓icon on the top left-hand corner then select the Communication(✉) menu. Go to the COMMUNICATION DETAILS section to setup/edit/update your email details.

Tip

Refer to the tables above under the Key Terms and Concepts for a description of the required fields below and the available merge fields you can utilise for your email body.

(

Status
colourGreen
title1
After clicking the SAVE NEW COMMUNICATIONS FOR LOADED STUDENTS button, it will display all the students under the COMMUNICATION EVENT BULK LIST section with all details that you’ve filled out from ) Enter the Email/Communication Subject accordingly.

(

Status
colourBlueGreen
titlestep 2
. Leave this screen for now) Enter the Entry Date.

Image Removed

(

Status
colourGreen
title2
Choose Reports > Letters menus on the side. Find the letter/report that you want to attach and click the GET REPORT button.

In the sample screenshot below, the COMMONWEALTH ASSISTANCE NOTICE report it selected.

Image Removed

3
) Set the Communication Status to Sent.

(

Status
colourGreen
title24
Go to the letter/report parameters section, edit the necessary filters/fields (note that the system has set some default fields to be used as intended, e.g. Unit Enrolment Status, PDF as the default document type to be attached, etc.) and click the CREATE REPORT FOR COMMUNICATION EVENTS button.

This will take some time to complete, while each report is generated individually. The progress bar provides an indication of the rate of progress.

Image Removed

) Select the communication template that you want to use.

Tip

To edit your Communication Templates, refer to the Search, Add and Edit Content (e.g. Email Templates)knowledge article.

(

Status
colourGreen
title3
After generating the report to each student/recipient, you have the option to open a sample file attachment against each student/recipient to check the content, e.g. for CAN notices – check for the correct period and are attached for the correct person for a few of the records.
5
) Edit your message body as necessary / as required.

(

Status
colourGreen
title4
Select all the students on the list by clicking on the checkbox header section. Remove the student from the list by removing the checkmark on the checkbox against the student or by clicking on the REMOVE button.

Status
colourGreen
title4
Click the EMAIL SELECTED RECIPIENTS WITH ATTCHMENTS button. The emails have now been sent. Check the statuses of the sent emails to check if any failed sending under the Status column. These will need to be either resent or posted.

Image Removed

back to top

Expand

6
) After filling out the required fields and the email body, make sure that the Communication Status field is set to Sent, and click the SAVE NEW COMMUNICATIONS FOR LOADED STUDENTS button.

Image Added

2. After saving your communication/email body from the bulk list, proceed to

Status
titleoption 1
Send Bulk Communications WITH Attachments instructions below if you want your communication event to have attachments, else refer to
Status
titleoption 2
Send Bulk Communications WITHOUT Attachments.

Expand
titleOPTION 1: Send Bulk Communications WITH Attachments to the Bulk List of Students/Recipients

Status

colourBlue
title
step 4

option 1
Send Bulk Communications

WITHOUT

WITH Attachments


NOTE: The instructions below assume that you have already followed the

Status
colourBlue
titlestep 1
to
Status
colourBlue
titlestep 2
instructions above.

Status
colourBlue
titlestep 1
Create the Bulk List of Students as Recipients to the Communication Event

Status
colourBlue
titlestep 2
Save a New Communication Event to Selected Recipients

Status
colourGreen
title1
Tip

It is also assumed that the Reports/Attachments that you want to attach are already configured prior to following the steps below. Contact your Paradigm Administrator to check your reports/attachments setup and configuration, or contact our Support Team for more details.

1.After clicking the SAVE NEW COMMUNICATIONS FOR LOADED STUDENTS button, it will display all the students under the COMMUNICATION EVENT BULK LIST section with all details that you’ve filled out from

Status
colourBlue
titlestep 2
.

Status
colourGreen
title2
Select all the students on the list by clicking on the checkbox header section. Remove the student from the list by removing the checkmark on the checkbox against the student or by clicking on the REMOVE button.

Status
colourGreen
title3
Click the EMAIL SELECTED RECIPIENTS button. The emails have now been sent. Check the statuses of the sent emails to check if any failed sending under the Status column. These will need to be either resent or posted.

Image Removed

back to top

Video Tutorial

Widget Connector
overlayyoutube
_templatecom/atlassian/confluence/extra/widgetconnector/templates/youtube.vm
width700px
urlhttps://www.youtube.com/watch?v=-IV-T111GuE
height500px

Overview | Assumptions | Key Terms and Concepts | Implications | Workflow | Video | Related Pages | Further Reading

Paradigm Knowledge Base Home

  • Setup / Configuration

  • Merge Fields in Communication

  • Workflows

  1. Bulk List Generate (possible ways to generate list in bulk)

After generating: Ask: With or Without Attachments? If Without – proceed to 3, If With – proceed to2

2 With Attachment Workflow Continuation from Workflow 1

3 Without Attachment Workflow Continuation from Workflow 1

Sample Use Case:

The expand section below will give you a sample workflow (sending bulk communication emails) as one of the many bulk activities you can do in Paradigm with the use of the Report Builder menu.

Expand
titleExpand this section for the instructions on how to send bulk communications in Paradigm.

Video Tutorial Link: https://www.youtube.com/watch?v=-IV-T111GuE

Related Knowledge Articles: Bulk Course Edit, Bulk Generate Invoice, Communication Event

Workflow

NOTE

The instructions below assume that you are already familiar with our Communications Event feature both in the Student Communication Event and the Provider Search, Add and Edit Content (e.g. Email Templates) side of Paradigm.

Status
colourBlue
titlestep 1
Make sure that there is no student currently loaded in the system

Status
colourGreen
title1
Check above the Dashboard menu in Paradigm if you can see a student detail. If there is not, you can proceed with Leave this screen for now.

Image Added

2. Choose Reports > Letters menus on the side. Find the letter/report that you want to attach and click the GET REPORT button.

In the sample screenshot below, the COMMONWEALTH ASSISTANCE NOTICE report is selected.

Image Added

3. Go to the letter/report parameters section, edit the necessary filters/fields, and click the CREATE REPORT FOR COMMUNICATION EVENTS button.

NOTE:

The system has set some default fields to be used as intended, e.g. Unit Enrolment Status, PDF as the default document type to be attached, etc. However, for some reports, you still have to set the fields correctly for them to run/be generated properly. An example would be for CANs, make sure that your Census Dates are set accordingly, see Edit Time Period

Status
colourBlue
titleC
Add a Census Date Workflow. If you are sending other attachments ensure that the dates required for that type of attachment are correct e.g. Final Grades, Invoices, etc.

This will take some time to complete, while each report is generated individually. The progress bar provides an indication of the rate of progress.

Image Added

4. After generating the report to each student/recipient, you have the option to open a sample file attachment against each student/recipient to check the content, e.g. for CAN notices – check for the correct period, and if attached for the correct person for a few of the records.

5. Select all the students on the list by clicking on the checkbox header section. Remove the student from the list by removing the checkmark on the checkbox against the student or by clicking on the REMOVE button.

6. Click the EMAIL SELECTED RECIPIENTS WITH ATTACHMENTS button.

NOTE:

Closing the browser or navigating away, while sending will cancel any remaining emails from being sent.

The emails have now been sent. Check the statuses of the sent emails to check if any failed to send under the Status column. These will need to be either resent or posted.

Tip

To check the email statuses, you can either go to Student > Communication: COMMUNICATION EVENT SEARCH section or via System > Email Events.

Refer to the workflow: How to Resend Bulk Communications

Image Added

back to top

,

Expand
titleOPTION 2: Send Bulk Communications WITHOUT Attachments to the Bulk List of Students/Recipients

Status
titleoption 2
Send Bulk Communications WITHOUT Attachments


NOTE: The instructions below assume that you have already followed the

Status
colourBlue
titlestep

2 instructions. If there isImage Removed, unload the student record by choosing Student > Search menus on the side.

1
to
Status
colourBlue
titlestep 2

Check if the Census Date is updated to the current period

instructions above.

Status
colour

Green

Blue
title

1
step 1
Create the Bulk List of Students as Recipients to the Communication Event

Status
colour

Green

,

Status
colourGreen
title3
Choose System > Edit Time Period > Set Type: Census Period.1. After clicking the SAVE NEW COMMUNICATIONS FOR LOADED STUDENTS button, it will display all the students under the COMMUNICATION EVENT BULK LIST section with all details that you’ve filled out from
Status
colourGreen
title4
Click the SEARCH TIME PERIODS button. 

Image Removed

 

Status
colourBlue
titlestep 3
Generate a group of recipients to your email using Report Builder, refer to the Workflowinstructions above.

Status
colourBlue
titlestep 4
Create a Communication Event

Status
colourGreen
title1
Follow the rest of the instructions on this article: Communication Event to proceed with sending bulk communications to your selected or newly created recipients.

AnchorVideoLinkVideoLinkVideo Tutorial

Blue
titlestep 2
.

2.Select all the students on the list by clicking on the checkbox header section. Remove the student from the list by removing the checkmark on the checkbox against the student or by clicking on the REMOVE button.

3. Click the EMAIL SELECTED RECIPIENTS button. The emails have now been sent. Check the statuses of the sent emails to check if any failed to send under the Status column. These will need to be either resent or posted.

Tip

To check the email statuses, you can either go to Student > Communication: COMMUNICATION EVENT SEARCH section or via System > Email Events.

Refer to the workflow: How to Resend Bulk Communications

Image Added

back to top

Video Tutorial

The video tutorial below will guide you on how to send bulk communication emails with CANs attachments.

Widget Connector
overlayyoutube
_templatecom/atlassian/confluence/extra/widgetconnector/templates/youtube.vm
width700px
urlhttps://www.youtube.com/watch?v=-IV-T111GuE
height500px

...

Related Pages

Filter by label (Content by label)
showLabelsfalse
max5
showSpacefalse
cqllabel = "communication-event"

Overview | Assumptions | Key Terms and Concepts | Implications | Workflow | Video | Related Pages | Further Reading

...

Paradigm Knowledge Base Home