You are here

Suggest an update Email this article

Replace Strings

Printer-friendly version

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 {OrgUnitName} into a news item, when you view the item you'll see the Unit Offering Name 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 Content 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:

  • Unit Homepage Widgets
  • Custom Navigation Bar Links
  • Navigation Bars
  • Mail Templates

For example, if the text {UserName} is in the code of a custom widget for a unit home page, users in that unit will see their user names displayed.

The available replace strings are:

organisation replace string Description
{OrgId} ID number of the organisation.
{OrgName} Name of the organisation.
Org Unit replace string Description
{OrgUnitId} ID # of the organisation unit.
{OrgUnitName} Name of the organisation unit.
{OrgUnitCode} Code for the organisation unit.
{OrgUnitTypeId} ID number of the type of the organisation unit.
{OrgUnitPath} Path to files for the organisation 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} organisation 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.

See Also