Student Experience Portal Data Elements
Overview
Configuration for the Student Experience Portal is located within Institution Setup in Regent Award. For a school with multiple Institutions and only one Student Experience Portal site, configuration is managed at a single Institution. However, when using E-Signature for Regent Review, this must be configured at each Institution level. At the time of implementation, your Account Manager will work with you to determine which Institution will house your Student Experience Portal settings. If a school has multiple Student Experience sites, Regent will work with them to determine the appropriate Institution setup linkage with each site.
The configuration is organized using sub-tabs corresponding to a Student Experience Portal component. A user must have access to the "View/Edit Portal Settings" permission to view any of the configurations documented below. Regent recommends using the "View/Edit Portal Settings" permission to allow the appropriate user(s) to access the Portal settings at ONLY the Institution being used for the Student Experience Portal settings and hide the configuration settings at all other Institutions.
Unless otherwise noted, throughout the documentation below, when referencing the number of allowable characters in a field, these are alphanumeric characters, symbols, any HTML code entered, and spaces (spaces are included in the "character" count).
The User Guide: Student Experience provides additional details on how these configuration settings display or function within the Portal.
- 1 Overview
- 2 Portal Tab
- 2.1 Publish Portal Configuration
- 2.2 General Subtab (User Guide: Student Experience-Branding)
- 2.3 Account Management Subtab (User Guide: Student Experience)
- 2.4 Useful Links Subtab
- 2.5 Message Center Subtab
- 2.6 Financial Aid Subtab (User Guide: Student Experience)
- 2.7 SP Progress Disb Subtab
- 2.8 Documents Subtab (User Guide: Student Experience)
- 2.9 Smart Form Subtab (Student Portal Access-Verification Worksheet)
- 2.10 E-Signature Subtab (Student Portal Access-Verification Worksheet)
- 2.11 Tokens Sub-tab (Informational Only)
Student Experience Licensing
The Configuration Settings (tabs) will be available to schools based on product licensing, as outlined below:
Portal Tab
Publish Portal Configuration
"Publish Portal Configuration" is a permission-based button located on Institution Setup for the designated Primary Institution only. A school can modify various configuration items, but the Student Experience portal will not utilize those new settings until they have been "published" using this button. Once the configuration items are published, they will be immediately available to the student without the need to re-sign into the application. If a school changes its Institution, Campus, or Site names, the "Publish Portal Configuration" button will also update the new names in the Student Experience portal. There is no need to also choose "Reload RNA" from Enterprise Setup when publishing Portal Configurations.
Updates to configuration changes should first be published and tested in a client QA environment before being configured in Production. Clients can request that a recent copy of Production be restored to a QA environment via Customer Zone.
** IMPORTANT NOTE** - clients must publish portal configuration after restoring Production to a lower QA environment to avoid errors when testing.
General Subtab (User Guide: Student Experience-Branding)
Field Name | Description | Required/Optional | Type | Value | Business Rule |
---|---|---|---|---|---|
Branding Settings | |||||
Site Logo | The logo URL provided here will display in the Header throughout the portal. The URL must be publicly available, it cannot be on a password-protected site. The recommended size of the logo is an approximate width of 120px and a height of 32px, or generally, a 3.75:1 ratio. Clients are encouraged to preview their available logos on the portal and adjust the logo files as needed for optimal display. | Optional | Textbox | URLs provided for the links must be valid, meaning they begin with https:// | |
Site Logo Alt Text | Brief text description of the logo for visually impaired users. The text is available to screen readers as the alternative text ("Alt-Text") for the image in the Site Logo. 100 characters maximum. If Site Logo is not blank, the Site Logo Alt Text is required. | Required if Site Logo is not blank; Optional otherwise. | Textbox | 100 characters maximum. If Site Logo is not blank, the Site Logo Alt Text is required. | |
PDF Logo | The logo URL entered here will display at the top of the downloadable PDF for any Smart Form. The URL must be publicly available, it cannot be on a password-protected site. The recommended size of the logo is an approximate width of 120px and a height of 32px, or generally, a 3.75:1 ratio. Clients are encouraged to preview their available logos on the pdf output and adjust the logo files as needed for optimal display. | Optional | Textbox | URLs provided for the links must be valid, meaning they begin with https:// | |
Primary Color | The hexadecimal color code entered here will be used for the primary color throughout the portal. Use the slider bars located at the bottom of the color grid and within the color grid to choose a color, or enter the hexadecimal color code value in the input field. Then click "Apply." The primary color will be applied to the following site elements: | Required | Hexidecimal Color Selector | Default Value = #2F63FF | |
Secondary Color | The hexadecimal color code entered here will be used for the secondary color throughout the portal. Use the slider bars located at the bottom of the color grid and within the color grid to choose a color, or enter the hexadecimal color code value in the input field. Then click "Apply." The secondary color will be applied to the following site elements: | Required | Hexidecimal Color Selector | Default Value = #CBD8FF | |
Primary Background Color | The hexadecimal color code entered here will be used for the primary background color throughout the portal. Use the slider bars located at the bottom of the color grid and within the color grid to choose a color, or enter the hexadecimal color code value in the input field. Then click "Apply." The primary background color will be applied to the following site elements: | Required | Hexidecimal Color Selector | Default Value = #F4F7FF | |
Secondary Background Color | The hexadecimal color code entered here will be used for the secondary background color throughout the portal. Use the slider bars located at the bottom of the color grid and within the color grid to choose a color, or enter the hexadecimal color code value in the input field. Then click "Apply." The secondary background color will be applied to the following site elements: | Required | Hexidecimal Color Selector | Default Value = #E0E8FF | |
Dashboard Settings | |||||
Display Instructional Message | When this checkbox is selected, the Instructional Header and Message configured will display at the top of the Dashboard screen. | Optional | Checkbox | Unselected by default | |
Instructional Message Header Text | The text entered here will display as a customized Header on the Dashboard Instructional Text. The text configured in the Office Name, Office Phone and Office Email fields can be inserted into the text configured here using: {OfficeName}, {OfficePhone} or {OfficeEmail} As a result, if the Office Name, Phone or Email changes, the update can be made in one place and all related messaging that used that data will automatically be updated. | Optional unless "Display Instructional Message" is Selected | Text | Alphanumeric | When "Display Instructional Message" is selected, this field is required. 50 characters max |
Instructional Message Text | The text entered here will display as instructional text on the Dashboard screen. The editor allows the user to apply formatting to the text and provide HTML to manipulate the display. There is no character limit. The text configured in the Office Name, Office Phone, and Office Email fields can be inserted into the text configured here using: {OfficeName}, {OfficePhone} or {OfficeEmail} As a result, if the Office Name, Phone, or Email changes, the update can be made in one place, and all related messaging that uses that data will automatically be updated. To get the best results when using this editor, follow these steps:
By following these steps, you'll have a smoother experience, and your text will look great! | Optional unless "Display Instructional Message" is Selected | Editor | Alphanumeric and HTML | When "Display Instructional Message" is selected, this field is required. |
Display Provisional Independent Status Message | When this checkbox is selected, the Provisional Header and Message configured will display at the top of the Dashboard screen. | Optional | Checkbox | Unselected by default | |
Provisional Independent Status Message Header Text | The text entered here will display as a customized Header on the Dashboard under the Instructional Message. | Optional unless "Display Provisional Independent Status Message" is Selected | Text | Alphanumeric | When "Display Provisional Independent Status Message" is selected, this field is required. 50 Characters max |
Provisional Independent Status Message Text | The text entered here will display on the Dashboard screen under the Instructional Message. The editor allows the user to apply formatting to the text, and provide HTML to manipulate the display. There is no character limit. The best practice for using this editor is to type your text directly into the editor, and then format it using the tools provided. Or, type the text into Notepad, and then copy and paste the text into the editor. If you copy the text from another editor, you may find that the formatting is copied from the editor and displays in an unexpected manner. | Optional unless "Display Provisional Independent Status Message" is Selected | Editor | Alphanumeric and HTML | When "Display Provisional Independent Status Message" is selected, this field is required. |
Portal and Questionnaire Display Settings | |||||
Office Name | This text will be used throughout the portal, in portal communications and Smart Forms where the Office name is displayed. | Required | Textbox | The default value is "Financial Aid Office." | 50 characters max |
Job Title | This text will be used throughout the portal, in portal communications and in Smart Forms where the Job Title is displayed. | Optional | Textbox | The default value is "Financial Aid Advisor." | 50 characters max |
Office Phone | This text will be used throughout the portal, in portal communications and in Smart Forms where the Office phone number is displayed. | Optional | Textbox | 15 characters max | |
Office Email | This text will be used throughout the portal, in portal communications and in Smart Forms where the Office email address is displayed. | Optional | Textbox | 50 characters max | |
Display Current Program | When "Yes" is selected, the student's current program will display throughout the portal, in portal communications and in Smart Forms where the student's current active program is displayed. | Required | Drop-down |
| |
Display School Name | When "Yes" is selected, the value chosen under "School Name Display Value" will display throughout the portal, in portal communications and in Smart Forms where the School Name is displayed. | Required | Drop-down |
| |
School Name Display Value | The value chosen here will be used throughout the portal, in portal communications and in Smart Forms where the School Name is displayed. The system will use the "Display Name" field from Institution, Campus, or Site when determining the text to display. | Optional unless "Display School Name" = Yes | Drop-down |
| When "Display School Name" is selected, this field is required. |
Display Footer Text | When this is selected, the configured footer text will display on all portal screens, except the Sign-in and Dashboard pages, which display a fixed copyright footer. | Optional | Checkbox | Selected by default | |
Footer Text | The text entered here will be displayed as a footer on all screens throughout the portal, except the Sign-in and Dashboard pages, which display a fixed copyright footer. The editor allows the user to apply formatting to the text, and provide HTML to manipulate the display. There is no character limit, so be mindful when creating the Footer text such that the final display will be the desired length. The text configured in the Office Name, Office Phone and Office Email fields can be inserted into the text configured here using: {OfficeName}, {OfficePhone} or {OfficeEmail} As a result, if the Office Name, Phone or Email changes, the update can be made in one place and all related messaging that used that data will automatically be updated. The footer text is not "Sticky" meaning it is displayed at the bottom of each page, below the configured items/text/widgets for that page and the user may need to scroll down to see the full footer text. The best practice for using this editor is to type your text directly into the editor, and then format it using the tools provided. Or, type the text into Notepad, and then copy and paste the text into the editor. If you copy the text from another editor, you may find that the formatting is copied from the editor and displays in an unexpected manner. | Optional unless "Display Footer Text" is selected. | Editor | Alphanumeric and HTML | When "Display Footer Text" is selected, this field is required. |
Display Login Instructional Message | When this field is selected, the text configured in "Login Instructional Message" will be displayed on the Login screen under the Username and Password. | Optional | Checkbox | Unselected by default | This setting is only applicable for Non-SSO students |
Login Instructional Message | The text entered here will display as instructional text on the Sign In screen. The editor allows the user to apply formatting to the text, and provide HTML to manipulate the display. There is no character limit. The text configured in the Office Name, Office Phone and Office Email fields can be inserted into the text configured here using: {OfficeName}, {OfficePhone} or {OfficeEmail} As a result, if the Office Name, Phone or Email changes, the update can be made in one place and all related messaging that used that data will automatically be updated. The best practice for using this editor is to type your text directly into the editor, and then format it using the tools provided. Or, type the text into Notepad, and then copy and paste the text into the editor. If you copy the text from another editor, you may find that the formatting is copied from the editor and displays in an unexpected manner. | Optional unless "Display Sign In Instructional Message" is Selected | Editor | Alphanumeric and HTML | This text will only be displayed to Non-SSO students |
Display Student Portal Header Text | When this field is selected, the text configured in "Student Portal Header Text" will be displayed within the header on the student portal. | Optional | Checkbox | Unselected by default | |
Student Portal Header Text | Text entered here will display in the header on the Student Portal, The text color of the configured header message will be the Secondary Color configured for the portal, unless text is entered as HTML and color is specified within the code. Configured characters and line spaces should be minimized to avoid creating a header that obstructs view of other objects on the page. | Optional | Editor | Alphanumeric and HTML | Available when the ‘Display Student Portal Header Text’ setting is enabled. |
Display Parent Portal Header Text | When this field is selected, the text configured in "Parent Portal Header Text" will be displayed within the header on the parent portal. | Optional | Checkbox | Unselected by default | |
Parent Portal Header Text | Text entered here will display in the header on the Parent Portal, The text color of the configured header message will be the Secondary Color configured for the portal, unless text is entered as HTML and color is specified within the code. Configured characters and line spaces should be minimized to avoid creating a header that obstructs view of other objects on the page. | Optional | Editor | Alphanumeric and HTML | Available when the ‘Display Parent Portal Header Text’ setting is enabled. |
Communications Settings | |||||
Parent Signature Request Email | Provides a list of communications, from Communication Setup, that could be used to notify the Parent that their signature is requested on Student documents. If multiple Institutions are configured in Regent Award each Institution will need to be configured. | Optional | Drop-down | A list of communications from "Communication Setup" where the "Communication Recipient" field is set to a value of "Parent Spouse." | This communication is available for SSO and Non-SSO parents and spouse |
Student Account Registration Email | Provides a list of communications, from Communication Setup, that could be used to notify the Student that their Account Registration is complete. If multiple Institutions are configured in Regent Award each Institution will need to be configured. | Optional | Drop-down | A list of communications from "Communication Setup" where the "Communication Recipient" field is set to a value of "Student." | This communication is only available to Non-SSO students |
Parent Account Registration Email | Provides a list of communications, from Communication Setup, that could be used to notify the Parent that their Account Registration is complete. If multiple Institutions are configured in Regent Award each Institution will need to be configured. | Optional | Drop-down | A list of communications from "Communication Setup" where the "Communication Recipient" field is set to a value of "Parent Spouse." | This communication is available for SSO and Non-SSO parents and spouse |
Student Password Reset Email | Provides a list of communications, from Communication Setup, that could be used to notify the Student that their Password as been Reset. If multiple Institutions are configured in Regent Award each Institution will need to be configured. | Optional | Drop-down | A list of communications from "Communication Setup" where the "Communication Recipient" field is set to a value of "Student." | This communication is only available to Non-SSO students |
Parent Password Reset Email | Provides a list of communications, from Communication Setup, that could be used to notify the Parent that their Password has been reset. If multiple Institutions are configured in Regent Award each Institution will need to be configured. | Optional | Drop-down | A list of communications from "Communication Setup" where the "Communication Recipient" field is set to a value of "Parent Spouse." | This communication is available for SSO and Non-SSO parents and spouse |
Smart Form Submitted Email | Provides a list of communications, from Communication Setup, that could be used to notify the Student that a Smart Form has been submitted successfully. If multiple Institutions are configured in Regent Award each Institution will need to be configured. | Optional | Drop-down | A list of communications from "Communication Setup" where the "Communication Recipient" field is set to a value of "Student." | This communication is available for SSO and Non-SSO students. |
Email Address Override | The email address(es) entered here (with a semi-colon after each address) will receive emails from Regent Award in QA environments only, for portal related communications that are configured in Regent Award. Account creation/registration emails will always be sent to the email address used when registering an account on Account Registration Step 1 regardless of whether the environment is QA or Production. Account creation/registration emails are the account validation email that allows a user to proceed from Registration Step 2 to Step 3, and password reset emails. If multiple Institutions are configured in Regent Award each Institution will need to be configured. | Optional | Text box | Alphanumeric and HTML | This setting is used for "Testing Purposes" only and should never be utilized in Production |
Maintenance Settings | |||||
Enable Maintenance Page | When this checkbox is selected, the Maintenance Page will be displayed when a user attempts to access the Student Experience portal, either via SSO or non-SSO. | Optional | Checkbox | Unselected by default | Page used to display in the portal during upgrades or regularly scheduled maintenance |
Maintenance Page Message | The text entered here will display as the message on the Maintenance Page, if enabled. The editor allows the user to apply formatting to the text, and provide HTML to control the display. The best practice for using the editor is to type text directly into the editor and then format it using the tools provided. Users may also type the text into Notepad and copy/paste the text into the editor. If text is copied and pasted from another editor, the correct formatting may not be applied. Reference the User Guide: Student Experience- Maintenance Page for additional details. | Optional | Text box | Default text: Our website is currently undergoing scheduled maintenance. We apologize for the inconvenience. Please try again later. | |
Account Creation Message Settings | |||||
Display Account Creation Message | When this checkbox is selected, the Account Creation Message Text configured will display on the 'Registration Step 1 of 3: Account Creation' page, for the users selected in the ‘Display To’ field. | Optional | Checkbox | Unselected by default | |
Display To | Options selected here determine if the text entered in 'Account Creation Message Text' field will display on the 'Registration Step 1 of 3: Account Creation' page to the student, the parent, or both the student and parent. | Optional | Multi-select checkboxes | Options:
| Will only show if ‘Display Account Creation Message’ is selected. |
Account Creation Message Text | The text entered here will display on the 'Registration Step 1 of 3: Account Creation' page, to the student, to the parent, or to both the student and parent, based on the ‘Display To’ option(s) selected. | Optional | Editor | Will only show if ‘Display Account Creation Message’ is selected. |
Account Management Subtab (User Guide: Student Experience)
Field Name | Description | Required/Optional | Type | Value | Business Rule |
---|---|---|---|---|---|
General Settings | |||||
Active Students Only | When "Yes" is selected, only active students will have access to the portal, inactive students will not. When "No" is selected, all students will have access to the portal regardless of their active status. | Required | Drop-down |
| |
Login Method | This setting will determine the method used by students when logging into the portal. | Required | Drop-down |
| |
SSO Settings | |||||
This section will display only if “SSO” is chosen for “Login Method.” | |||||
External ID 1 | The School will have the option of selecting the External ID that will be used for SSO validation as well as provide the school's specific attribute name for the External ID being used. Either External ID 1 or External ID 2 can be enabled, but not both. At least one of the two MUST be enabled. | Checkbox | Checkbox | Selected by Default | Reference the User Guide: Student Experience for additional information on Single Sign-On- SAML 2.0 |
External ID 1 Attribute Name | Optional | Textbox | Alphanumeric | 50 character max | |
External ID 2 | Optional | Checkbox | Unselected by Default | ||
External ID 2 Attribute Name | Optional | Textbox | Alphanumeric | 50 character max | |
Logout Redirect | The URL entered here will be used to redirect the student to a specific page upon exiting the portal. | Optional | Textbox | Alphanumeric | 250 character max URLs provided for the links must be valid, meaning they begin with http:// or https:// |
Non-SSO Settings | |||||
This section will display only if “Non-SSO” is chosen for “Login Method.” | |||||
First and Last Name | If selected, First and Last Name will be used to verify the student's account in Step 3 of the account registration process. | Required | Drop-down |
| |
Display School Name | When "Yes" is selected, the student's Institution, Campus or Site (dependent upon the value chosen in the "School Name Display Value" field) will be used to verify the student's account in Step 3 of the account registration process. | Required | Drop-down |
| |
School Name Display Value | The value chosen here will be on Step 3 of User Account Registration to validate the user's location. The Institution, Campus or Site must be set to "Active" in order to be used for this validation. The system will use the "Display Name" field from Institution, Campus, or Site when determining the text to display. | Optional unless "Display School Name" = Yes | Drop-down |
| When "Display School Name" is selected, this field is required. |
External ID 1 | The School will have the option of selecting the External ID used to verify the student's account in Step 3 of the account registration process. Either External ID 1 or External ID 2 can be enabled, but not both. At least one of the two MUST be enabled. | Required | Drop-down |
| |
External ID 2 | Required | Drop-down |
| ||
Email Address | If selected, Email Address will be used to verify the student's account in Step 3 of the account registration process. The email address is any email address for the student in the database (which may/may not be the same email address used to create the account). | Required | Drop-down |
|
Useful Links Subtab
Field Name | Description | Required/Optional | Type | Value | Business Rule |
---|---|---|---|---|---|
Useful Links Settings | |||||
Display Useful Links on Dashboard | When this checkbox is selected, the Useful Links feature will display on the Dashboard and Menu. If a user attempts to access a component that is configured not to display by entering the URL directly, the user is directed to the Dashboard or the Sign In page if they are not logged in. | Optional | Checkbox | Selected by default | When this field is unselected, all other fields on the screen are disabled. When this field is selected, at least one link must be configured in the Useful Links table. |
Display Instructional Message | When this checkbox is selected, the Instructional Header and Message configured will display at the top of the Useful Links screen. | Optional | Checkbox | Unselected by default | |
Instructional Message Header Text | The text entered here will display as a customized Header on the Useful Links Instructional Text. The text configured in the Office Name, Office Phone and Office Email fields can be inserted into the text configured here using: {OfficeName}, {OfficePhone} or {OfficeEmail} As a result, if the Office Name, Phone or Email changes, the update can be made in one place and all related messaging that used that data will automatically be updated. | Optional unless "Display Instructional Message" is Selected | Text | Alphanumeric | When "Display Instructional Message" is selected, this field is required. 50 characters max |
Instructional Message Text |