Using Replace Strings
If you choose to have an intelligent agent send emails to students identified by the agent, you have two options:
- Compose a generic email and have the same version sent to each student.
- Personalize each email with the student’s name, last login date etc., which can be done automatically by using so-called ‘replace strings’.
Replace strings are special codes that can be used in automated emails in places where receiver-specific information would normally be found. When creating intelligent agents, replace strings can be used in:
1. Email recipient field (To, CC, and Bcc)
If you want the Brightspace system to autofill the address of the student identified by the intelligent agent, use the {InitiatingUser} replace string in the recipient field. (For more information on creating intelligent agent emails, view the ‘Actions’ section on the ‘Creating Intelligent Agents’ page.)
2. Body of the email
An example of a replace string that can be used in the email body is {InitiatingUserFirstName}. If an email containing this code is sent out by an intelligent agent, the system removes the replace string and inserts the student’s first name in its place. Thus, an email like this:
Hello {InitiatingUserFirstName},
I would like to congratulate you on the high grade you received on Quiz 4 in your {OrgUnitName} course. Well done and keep up the good work!
Cheers,
Dr. Smith
…would be delivered to a student named Rebecca with her own name in place of the replace string:
Hello Rebecca,
I would like to congratulate you on the high grade you received on Quiz 4 in your Economics 101 course. Well done and keep up the good work!
Cheers,
Dr. Smith
Commonly Used Replace Strings
The chart below lists the most common replace strings available to use in the subject line and message of emails sent out by intelligent agents, along with the type of information they generate.
| Replace String | Information Brightspace will autofill |
| {InitiatingUser} | The name of the user who performs the action that meets the agent’s criteria, e.g. the student’s name |
| {InitiatingUserFirstName} | The first name of the initiating user |
| {InitiatingUserFirstName} | The last name of the initiating user |
| {LastLoginDate} | The date the initiating user last logged in to Brightspace |
| {LastCourseAccessDate} | The date the initiating user last accessed the course |
| {OrgName} | The name of the organization |
| {OrgUnitName} | The name of the Org Unit (i.e. course name) |
For a complete list of replace strings that can be used with intelligent agents, please visit this Brightspace resource.