Difference between revisions of "Message Templates"

From Studentnet Wiki
Jump to navigation Jump to search
 
(36 intermediate revisions by 4 users not shown)
Line 1: Line 1:
  
−
A range of templates for messaging can be created and organised with the message templates list. The New Message Template button leads to a choice between a Welcome Email template and a Forgotten password template.
+
A range of templates for messaging can be created and organised with the Message Templates List.  
  
−
=== Welcome Email template ===
+
When you select '''Message Templates''' from the Cloudwork dashboard menu, the Message Templates List displays. This includes a list of existing templates as well as the option to create a New Message Template.
  
−
This template can be used when sending welcome messages to new users.
+
==Create a new message template==
  
−
You can use the following special formatting options in this message:
+
Click the '''New Message Template''' button to display a list of template types for your school. These may include:
  
−
*$user_name: The new user's username.
+
{| class="wikitable"
−
*$email: The new user's email address.
+
|+ Message Template
−
*$first_name: The new user's first name.
+
|-
−
*$last_name: The new user's last name.
+
! Message Template Type !! Description !! Wiki Documentation
−
*$password_reset_link: A link to start the Password Recovery process.
+
|-
−
*$change_password_link: A unique link for this user to immediately change their password.
+
| '''Welcome Email'''|| Welcome Messages can be used to send welcome messages to new users || [https://wiki.studentnet.net/index.php/Welcome_Message_Templates Welcome Message Template]
−
*$recovery_email: The new user's recovery email address.
+
|-
−
*$recovery_phone: The new user's recovery phone number.
+
| '''Forgot Password Email'''|| Forgot Password Emails can be used when sending recovery codes via email for users who are attempting to reset their password|| [https://wiki.studentnet.net/index.php/Forgotten_Password_Email_Template Forgot Password Email Template ]
 +
|-
 +
| '''Forgot Password SMS'''|| Forgot Password SMS can be used when sending recovery codes via SMS for users who are attempting to reset their password|| [https://wiki.studentnet.net/index.php/Forgotten_Password_SMS_Template Forgot Password SMS]
 +
|-
 +
| '''Forgot Username Email'''|| Forgot Username Emails can be used when sending a reminder via email to a user who has forgotten their username|| [https://wiki.studentnet.net/index.php/Forgotten_Username_Email_Template Forgot Username Email]
 +
|}
  
−
You can also use any extra attributes your users might have, such as $salutation or $SIS_ID. Please note that a formatting option that does not match the above list or a user's custom attributes will be left in your email unchanged.
+
Select the type of message template to be created and complete the required details.
  
−
An example of the form for writing a Welcome Email template can be found below.
+
==Edit Message Template==
 +
All our Message Templates can be edited if changes need to be made to a template.
  
−
[[File:welcome_email.png|700px]]
+
[[File:Editmessageexample.PNG]]
  
−
=== Forgotten Password template ===
+
1. Select '''Message Templates''' from the Cloudwork dashboard menu to display the Message Templates List.
  
−
This template can be used when sending recovery codes via email for users who are attempting to reset their password.
+
2. Click the link for the template to be updated.
  
−
You can use the following special formatting options in this message:
+
3. In the window that opens, click '''Edit''' and update the template details as needed.
  
−
*$user_name: The user's username.
+
4. Click '''Submit'''.
−
*$code: The recovery code needed by the user to reset their password.
 
−
*$continue_link: A link to continue the Password Recovery process.
 
−
*$email: The user's email address.
 
−
*$first_name: The user's first name.
 
−
*$last_name: The user's last name.
 
−
*$password_reset_link: A link to initiate Password Recovery.
 
−
*$recovery_email: The user's recovery email address.
 
−
*$recovery_phone: The user's recovery phone number.
 
  
−
An example of the form for writing a forgotten password template and an example of a message can be found below.
+
==Delete Message Template==
  
−
[[File:password_template.png|700px]]
+
If a Message Template is no longer needed, it can be deleted.
  
−
==== Example Password recovery message ====
+
[[File:Deletemessageexample.PNG]]
  
−
<p>Hi $first_name,</p>
+
1. Select '''Message Templates''' from the Cloudwork dashboard menu to display the Message Templates List.
  
−
<p>You've recently made a request to reset your Cloudwork password. <a href="$continue_link">Click here to reset your password</a>, or provide the following code in your browser:</p>
+
2. Click the link for the template to be deleted.
−
<p>$code</p>
+
 
−
<p>If you did not try to reset your password, please ignore this email.</p>
+
3. In the window that opens, confirm that you have selected the correct template and click '''Delete''' near the top of the page.
−
<br>
+
 
−
<p>Sincerely,</p>
+
4. Confirm the delete request.
−
<br>
+
 
−
<p>The Studentnet Support Team</p>
+
==Variables for message templates==
 +
 
 +
For each type of message template there are standard variables which may be included in any field, for example $first_name and $last_name. When the message is sent the variables will be replaced with the relevant values for the individual user.
 +
   
 +
You can also use as variables any extra attributes you have set up for your users, such as $salutation or $SIS_ID.
 +
 
 +
Note that a variable that cannot be resolved (i.e. it is not one of the standardised variables or one of a user's custom attributes) will be left in the message unchanged.
 +
 
 +
A single dollar sign ($) precedes the variable name. If you need to include an actual dollar sign in your message, type two dollar signs ($$).
  
 
  [[Category:Cloudwork Dashboard]]
 
  [[Category:Cloudwork Dashboard]]

Latest revision as of 00:29, 15 February 2023

A range of templates for messaging can be created and organised with the Message Templates List.

When you select Message Templates from the Cloudwork dashboard menu, the Message Templates List displays. This includes a list of existing templates as well as the option to create a New Message Template.

Create a new message template

Click the New Message Template button to display a list of template types for your school. These may include:

Message Template
Message Template Type Description Wiki Documentation
Welcome Email Welcome Messages can be used to send welcome messages to new users Welcome Message Template
Forgot Password Email Forgot Password Emails can be used when sending recovery codes via email for users who are attempting to reset their password Forgot Password Email Template
Forgot Password SMS Forgot Password SMS can be used when sending recovery codes via SMS for users who are attempting to reset their password Forgot Password SMS
Forgot Username Email Forgot Username Emails can be used when sending a reminder via email to a user who has forgotten their username Forgot Username Email

Select the type of message template to be created and complete the required details.

Edit Message Template

All our Message Templates can be edited if changes need to be made to a template.

Editmessageexample.PNG

1. Select Message Templates from the Cloudwork dashboard menu to display the Message Templates List.

2. Click the link for the template to be updated.

3. In the window that opens, click Edit and update the template details as needed.

4. Click Submit.

Delete Message Template

If a Message Template is no longer needed, it can be deleted.

Deletemessageexample.PNG

1. Select Message Templates from the Cloudwork dashboard menu to display the Message Templates List.

2. Click the link for the template to be deleted.

3. In the window that opens, confirm that you have selected the correct template and click Delete near the top of the page.

4. Confirm the delete request.

Variables for message templates

For each type of message template there are standard variables which may be included in any field, for example $first_name and $last_name. When the message is sent the variables will be replaced with the relevant values for the individual user.

You can also use as variables any extra attributes you have set up for your users, such as $salutation or $SIS_ID.

Note that a variable that cannot be resolved (i.e. it is not one of the standardised variables or one of a user's custom attributes) will be left in the message unchanged.

A single dollar sign ($) precedes the variable name. If you need to include an actual dollar sign in your message, type two dollar signs ($$).

Retrieved from "https://wiki.studentnet.net/index.php?title=Message_Templates&oldid=2038"