You can use replace strings to customize course content and communications in Brightspace. Replace strings automatically incorporate your student 's personalized information, such as their name or user ID. This enables you to developer better relationships with your students , increase engagement levels, and improves the overall learning experience.
About replace strings
Replace strings, sometimes referred to as display configuration variables, are configuration variable names enclosed in curly brackets {} that are automatically replaced by the corresponding configuration variable values. For example, if you enter the text {OrgUnitID} into a field in a tool or widget settings you will see the Organization Unit ID (ou #) of the course when you view the tool or widget. Replace strings are used in all tools that use Brightspace Editor. However, evaluation rules for the replace strings vary depending on the tool.
Evaluation rules for Content topics
For topics created in Content, replace strings are evaluated only once when first entered. Thereafter, there is no record of a replacement string having been entered. For example, if you enter {OrgUnitID} into a Content topic in course 'A' and later copy that topic into course 'B', the ou # of course 'A' course will display in the topic in course 'B'.
Evaluation rules for all other tools
For all other tools a replace string is evaluated each time the document containing the replace string is viewed. For example, if you enter {OrgUnitID} into a Discussion topic in course 'A' and later copy that topic into course 'B', the ou # of course 'B' will display in the post in course 'B'.
- Not all replace strings apply to all tools as described below.
Replace strings are particularly useful within the following:
- Course Homepage Widgets
- Custom Navigation Bar Links
- Navigation Bars
- Mail Templates
- Grades when adding bulk feedback
Use replace strings with various widgets and tools
The available replace strings are:
|
Organization replace string
|
Description
|
|---|
|
{OrgId}
|
ID number of the organization
|
|
{OrgName}
|
Name of the organization
|
|
Org Unit replace string
|
Description
|
|---|
|
{OrgUnitId}
|
ID number of the organization unit
|
|
{OrgUnitName}
|
Name of the organization unit
|
|
{OrgUnitCode}
|
Code for the organization unit
|
|
{OrgUnitTypeId}
|
ID number of the type of the organization unit
|
|
{OrgUnitPath}
|
Path to files for the organization unit
|
|
User replace string (Unavailable in Content topics)
|
Description
|
|---|
|
{UserId}
|
ID number of the user. This value is used internally by the system
|
|
{UserName}
|
Full name of the user or the username entered to log on
|
|
{OrgDefinedId}
|
Organization ID. This is an identifier specified by the campus for the user
|
|
{FirstName}
|
First name of the user
|
|
{LastName}
|
Last name of the user
|
|
{Email}
|
User's internal email address
|
|
{ExternalEmail}
|
User's external email address
|
|
{InternalEmail}
|
User's internal email address
|
|
Role replace string (Unavailable in Content topics)
|
Description
|
|---|
|
{RoleId}
|
Internal ID number for user's role
|
|
{RoleCode}
|
Code for user's role
|
|
{RoleName}
|
Name of user's role
|
|
Mail Template replace string
|
Description
|
|---|
|
{HelpDeskEmail}
|
Email address of the Help Desk
|
|
{HelpDeskName}
|
Name for the Help Desk
|
|
{LoginPath}
|
URL of the login path for this site
|
|
{PasswordResetLink}
|
Link for users to reset their passwords
|
Example: Use replace strings to display a user's name in the course banner
Although there are various replace strings available, as well as various tools that they can be applied in, here is one example. You can use replace strings to display your student 's name in your course banner.
To display your
student 's name your course banner
-
From your course home page, locate the course banner.
-
Click Banner Settings (...) and select Customize Banner T ext.
Figure: The Customize Banner Text option of Banner Settings.
-
From the Customize Banner Text dialog, select Custom.
-
Enter the desired text and add the replace string {FirstName}.
Figure: An example of the {FirstName} replace string used in banner text settings.
-
Click Save.
Your home page banner updates and displays the name of your student .
Figure: The updated home page banner with the {FirstName} replace string applied.