Personalise communication (Replace strings)

Personalise communication (Replace strings)

Replace Strings are display configuration variable enclosed in curly braces { } that are automatically replaced by the corresponding values.

Replace strings are particularly useful within the following:

Note: It is not possible to use replacement strings in emails that you send through Brightspace.

To see more information click on the + next to the option below:

Here is an example of a Replace Strings, if you enter the text {OrgUnitName} into an HTML file, when you view the document you will see the Organization Unit name of the course (see Figure 1 and 2 below).

 

Replace strings are used in all tools that use HTML Editor. However, evaluation rules for the replace strings vary with the tool being used.

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. We encourage you to test it.

 

  1. First Create a File in your Sandbox then copy/paste {OrgUnitName} somewhere in the HTML editor and click Publish. You will see a similar result as Figure 2.
  2. Then click the drop down arrow at that file and click Edit HTML. You will notice that the replace string is gone, leaving the actual course name.

 

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. 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 course ‘A’ and later copy that topic into course ‘B’, the name of course ‘B’ will display in the post in course ‘B’.

The following table lists the strings that are available in Brightspace:

Organization replace string Description

{OrgId}

ID number of the organization

{OrgName}

Name of the organization

{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

 

Replace String for intelligent agents Description For Use In

{InitiatingUser}

The user who performs the action that meets the agent’s criteria Email address field

{InitiatingUserAuditors}

The auditors for the user who performs the action

that meets the agent’s criteria

Email address field

{OrgName}

Name of the organization Email body

{OrgUnitCode}

The code for the Org Unit Email body

{OrgUnitName}

The name of the Org Unit Email address field

{OrgUnitStartDate}

The start date specified for the Org Unit Email body

{OrgUnitEndDate}

The end date specified for the Org Unit Email body

{OrgUnitId}

The org unit ID required to make quicklinks works Email subject line and email body

{InitiatingUserFirstName}

The first name of the initiating user Email body

{InitiatingUserLastName}

The last name of the initiating user Email body

{InitiatingUserUserName}

The username of the initiating user Email body

{InitiatingUserOrgDefinedId}

The Org Defined ID of the initiating user Email body

{LastCourseAccessDate}

The date the initiating user last accessed the course Email subject line and email body

{LastLoginDate}

The date the initiating user last logged in Email subject line and email body

{LoginPath}

The address of the login path for the site Email body

 

Contact us

Please send us an email and we'll get back to you.

Sending

Log in with your credentials

Forgot your details?

By continuing to use this website, you agree with the use of cookies. More information

This website uses cookies of multiple categories: strictly necessary cookies, performance cookies and advertisement cookies. The strictly necessary cookies are used to verify whether you have given consent to the cookies before, whereas the performance cookies are used for insights in the usage of the website. Using the latter allows the admin of this domain to improve the experience on the website in the future. Some of the cookies are third-party, such as YouTube and Google Analytics.

The cookie settings on this website are set to "allow cookies" to give you the best browsing experience possible. If you continue to use this website without changing your cookie settings or you click "Accept" below then you are consenting to this.

Close