Automatically customize unit content using replace strings
- James Croft (Unlicensed)
A replacement string allows instructors to customize unit content and communications in Connect by incorporating the intended learner's personalized information, such as their name, automatically. This feature can help instructors build better relationships with learners, increase engagement levels, and improve the overall learning experience.
Replace strings, sometimes referred to as display configuration variables, are configuration variable names enclosed in curly braces {} that are automatically replaced by the corresponding configuration variable values. For example, if you enter the text {OrgUnitID} into a document, when you view the document you will see the Organization Unit ID (ou #) of the unit.
Replace strings are used in all tools that use HTML Editor. However, evaluation rules for the replace strings vary with the tool as follows:
- For the Content tool, curly braces are stripped even if the string is not a valid configuration variable or a replace string that does not apply to the Content tool. Then, 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 unit 'A' and later copy that topic into unit 'B', the ou # of unit 'A' unit will display in the topic in unit 'B'.
For all other tools, any curly braces are NOT stripped if the string is not a valid configuration variable or a replace string that does not apply to the tool. Then the 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 unit 'A' and later copy that topic into unit 'B', the ou # of unit 'B' will display in the post in unit 'B'.
- Not all replace strings apply to all tools as described below.
Replace strings are particularly useful within the following:
- Announcements
- Grades when adding bulk feedback
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 the Content tool) | 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 the Content tool) | 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 |
Watch how to use replacement strings for personalization