Using CustomHTML

Owned by Former user (Deleted)
Last updated: Jul 24, 2019 by Richard Kennedy (Unlicensed)Version comment
3 min read

You can sometimes customise the text that appears in a tab using CustomHTML values. The CustomHTML values can contain:

  • regular text
  • HTML tags including hyperlinks, images and tables
  • replaceable fields
  • Include files.

Note: CustomHTML values have a limit of approximately 1000 words. If you need to display a lot of text on a tab, use an Include file. See Using Include files in the Community Portal Configuration manual.

Replaceable fields
Replaceable fields are placeholders for values that are read from the database according to which user is viewing the page. For example, {LoggedInUserName} tells the portal to display the user name of the logged in user. If the user name was John Smith, the CustomHTML "Welcome, {UserName}." would display "Welcome, John Smith." The following replaceable fields can be used in any CustomHTML setting.

Replaceable field

Description

{IncludeFile}{/IncludeFile}

Displays the contents of the file specified between the tags, for example "{IncludeFile}sample.txt{/IncludeFile}" would display the contents of the file "sample.txt". See Using Include files in the Community Portal Configuration manual.

{LastLoginDateTimeBeforeToday}

The date and time this user last logged in prior to today.

{LoggedInUserName}

The user name of the user who is logged in.

{StudentFullName}

The full name of the currently selected student.

{StudentGiven1}

The first name of the currently selected student.
 

Note: This field is a renamed version of the obsolete {StudentGiven} replaceable field used in previous versions of the Community Portal.

{StudentPreferred}

Preferred name of the currently selected student.

{StudentNamesCommaSeparated}

A comma-separated list of the names of the students viewable by the user. For example: "Jack, John and Bethany".


Replaceable form fields
Some replaceable fields display pre-filled text fields and buttons. These fields are taken from stored procedures in the database. Contact Synergetic Management Systems if you require fields not listed in the table below.

Replaceable form fields

Displays a...

{AddressComma}

Text field with the user's postal address.

{DefaultEmail}

Text field with the user's primary email address.

{DefaultMobilePhone}

Text field with the user's mobile phone number.

{FreeText}

Blank text field.

{FreeTextMultiline}

Blank multiple-line text field.

{Given1}

Text field with the user's given name.

{MailNamePrimary}

Text field with the user's title, initials and surname. For example: "Mr J Smith".

{SpouseDefaultEmail}

Text field with the user's spouse's primary email address.

{SpouseDefaultMobilePhone}

Text field with the user's spouse's mobile phone number.

{SpouseGiven1}

Text field with the user's spouse's given name.

{SpouseMailNamePrimary}

Text field with the user's spouse's title, initials and surname, for example: "Mrs M Smith".

{SpouseSurname}

Text field with the user's spouse's surname.

{SubmitButton}

Submit button.

{Surname}

Text field with the user's surname.

{UserLoginName}

Text field with the user's network login.

{UserPassword}

Text field with the user's network password.

{ID}

Text field with the user's Synergetic ID.

{Title}

Text field with the user's title.

{Preferred}

Text field with the user's preferred name.

{Report}

Embed a Crystal Report in a header or footer. See Embedding Crystal Reports in CustomHTML in the Community Portal Configuration manual.

{SpouseID}

Text field with the user's spouse's Synergetic ID.

{SpouseTitle}

Text field with the user's spouse's title.

{SpousePreferred}

Text field with the user's spouse's preferred name.

{SpouseDefaultEmail}

Text field with the user's spouse's primary email address.

{SpouseDefaultMobilePhone}

Text field with the user's spouse's mobile phone number.

{NewValue}

Text field with the new contact information.

{OldValue}

Text field with the old contact information.

{ChangedIndicator}

Displays (Changed) if the contact information has been updated. The text displayed can be customised. See SchoolAdmin_ChangedIndicator configuration setting or StudentContact_ChangedIndicator configuration setting in the Community Portal Configuration manual.

{LoggedInUserName}

Text field with the user's network login.

{LoggedInID}

Text field with the user's Synergetic ID.

{ChangedValues}

Text field listing the user's changed contact details.

{UnchangedValues}

Text field listing the user's unchanged contact details.

{AllValues}

Text field listing all user's contact details.