This chart of replace strings available in Brightspace provides a description and example of each, and indicates whether the replace string works in the Announcement tool and/or in the Intelligent Agents tool email.
Note that the Intelligent Agents tool email function uses a different subset of replace strings than in the intelligent agents’ descriptions and other Brightspace tools. Certain common replace strings, such as {FirstName}, that can be used in most cases, cannot be used in the email that Intelligent Agents sends out. Those available for use in the description are the same as in Announcements shown below.
Replace strings can be used in several tools but Announcements and Intelligent Agents are the most common. To check which replace strings are applicable for which tool, use the Replace String Search Table.xlsx spreadsheet. Note: Replace strings can be used in Content descriptions like other tools. However, when used under "Create a File", the replace string captures the information of the creator and is irreversible after creation. It is not advised to use replace strings in Content > Create a File for this reason.
|
Replace String
|
Announcements
|
Intelligent Agents Email
|
Description
|
Displays / Example
|
|
{Email}
|
Yes
|
No
|
Brightspace email of the user.
|
jsmith@uwindsor.brightspace.com
|
|
{ExternalEmail}
|
Yes
|
No
|
Brightspace’s record of external email (usually UWindsor email) of the user.
|
jsmith@uwindsor.ca
|
|
{FirstName}
|
Yes
|
No
|
First name (or “preferred name from UWinSite”) of the user.
|
Jane
|
|
{InitiatingUserFirstName}
|
No
|
Yes
|
First name of the user who satisfied the intelligent agent’s criteria. Can only be used in Intelligent Agents.
|
Jane
|
|
{InitiatingUserLastName}
|
No
|
Yes
|
Last name of the user who satisfied the intelligent agent’s criteria. Can only be used in Intelligent Agents.
|
Smith
|
|
{InitiatingUserOrgDefinedId}
|
No
|
Yes
|
Organization-defined id of the user (student number for students, UWinID for staff). Can only be used in Intelligent Agents.
|
123456789
|
|
{InitiatingUserUserName}
|
No
|
Yes
|
The username of the user (UWinID). Can only be used in Intelligent Agents.
|
jsmith
|
|
{InitiatingUser}
|
No
|
Yes*
|
Email of the user who satisfied the intelligent agent’s criteria. Can only be used in address fields of Intelligent Agents.
|
jsmith@uwindsor.ca
|
|
{InternalEmail}
|
Yes
|
No
|
Brightspace’s record of internal email (usually Brightspace email) of the user.
|
jsmith@uwindsor.brightspace.com
|
|
{LastCourseAccessDate}
|
No
|
Yes
|
The date the user last accessed the course. Can only be used in Intelligent Agents.
|
Wednesday, March 6, 2024 2:36 PM ET
|
|
{LastLoginDate}
|
No
|
Yes
|
The date the user last logged in. Can only be used in Intelligent Agents.
|
Wednesday, March 6, 2024 3:35 PM ET
|
|
{LastName}
|
Yes
|
No
|
Last name of the user.
|
Smith
|
|
{LoginPath}
|
No
|
Yes
|
The URL address to log into Brightspace.
|
https://brightspace.uwindsor.ca
|
|
{OrgDefinedId}
|
Yes
|
No
|
Organization-defined id of the user (student number for students, UWinID for staff).
|
123456789
|
|
{OrgId}
|
Yes
|
No
|
The id of the organization (university).
|
6606
|
|
{OrgName}
|
Yes
|
Yes
|
The name of the organization.
|
University of Windsor
|
|
{OrgUnitCode}
|
Yes
|
Yes
|
The code for the org unit (course site).
|
SNBX-jsmith
|
|
{OrgUnitEndDate}
|
No
|
Yes
|
The end date for the org unit (course site). Can only be used in Intelligent Agents.
|
The end date in date format, or “this org unit has no start date”.
|
|
{OrgUnitId}
|
Yes
|
Yes
|
The id for the org unit (course site).
|
6797
|
|
{OrgUnitName}
|
Yes
|
Yes
|
The name of the org unit (course site).
|
A sandbox for jsmith
|
|
{OrgUnitPath}
|
Yes
|
No
|
Path to files for the org unit (course site).
|
/content/enforced/6797-SNBX-jsmith
|
|
{OrgUnitStartDate}
|
No
|
Yes
|
The start date of the org unit (course site). Can only be used in Intelligent Agents.
|
The start date in date format, or “this org unit has no start date”.
|
|
{RoleId}
|
Yes
|
No
|
The id for user’s role that Brightspace assigned.
|
109
|
|
{RoleName}
|
Yes
|
No
|
The user’s role.
|
Instructor
|
|
{UserName}
|
Yes
|
No
|
The UWinID of the user.
|
jsmith
|