Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 54

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.  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 that corresponds to a component of the Student Experience Portal.  A user must have access to the "View/Edit Portal Settings" permission to view any of the configurations documented below.  Regent recommends to use 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).

Student Experience Licensing

The Configuration Settings (tabs) will be available to schools based on product licensing, as outline below:

Regent Award License

  • General
  • Account Management
  • Useful Links
  • Message Center
  • Financial Aid
  • Documents

Regent Review License

  • General
  • Account Management
  • Useful Links
  • Message Center
  • Documents
  • Smart Form (including VWS)
  • E-Signature

Regent Plan License

  • Advisor Assist

Portal Tab

Publish Portal Configuration

A permission-based button is located on the Portal Tab of Institution set up with the label "Publish Portal Configuration."  A school may make modifications to the various configuration items, but those new settings will not be used by the Student Experience portal until they've 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 In to the application.  If a school makes changes to their Institution, Campus and or Site names, the "Publish Portal Configuration" button will also make those new names available to the Student Experience portal.  There is no need to also choose "Reload RNA" from Enterprise Setup when publishing Portal Configurations.    

General Subtab

Field NameDescriptionRequired/OptionalTypeValueBusiness Rule
Branding Settings
Site LogoThe logo URL provided here will display in the Header throughout the portal.  The URL must be publically 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. OptionalTextbox
URLs provided for the links must be valid, meaning they begin with http:// or https://
PDF LogoThe logo URL entered here will display at the top of the downloadable PDF for any Smart Form. The URL must be publically 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.OptionalTextbox
URLs provided for the links must be valid, meaning they begin with http:// or 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:

  • Selected Menu Item
  • Header Bar
  • Direct Cost Widget Title
  • Direct Cost Widget Border
  • Component Help
  • Payment Link and Amount
  • Tile Close Text
  • Remaining Direct Cost Title
  • Payment Link and Amount
  • Payment Details Field Titles
  • Dropdown Caret
  • Menu / Expand Collapse Icon
  • Unread Email Heading
  • Button (All button text is white)
  • Instructional Message Border
  • Instructional Message "Show Full Info" Text
  • Tile Expansion Text
  • Profile Horizontal Rule Bar
  • Email Icon
  • Password Icon
  • Selected Button
  • Unselected Button Text
  • Button Border
RequiredHexidecimal Color SelectorDefault 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:

  • Title Bar
  • Statement of Understanding Background
  • Student Profile icon and Student name in the Header bar
RequiredHexidecimal Color SelectorDefault 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:

  • Background
  • Sign In Background
RequiredHexidecimal Color SelectorDefault 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:

  • Menu
  • Instructional Message Background
  • Direct Cost Widget Background
  • Input field Background
RequiredHexidecimal Color SelectorDefault Value = #E0E8FF
Enable Maintenance PageWhen 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.OptionalCheckboxUnselected by default
Dashboard Settings
Display Instructional MessageWhen this checkbox is selected, the Instructional Header and Message configured will display at the top of the Dashboard screen.OptionalCheckboxUnselected 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 SelectedTextAlphanumeric

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 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 Instructional Message" is SelectedEditorAlphanumeric and HTMLWhen "Display Instructional Message" is selected, this field is required.
Portal and Questionnaire Display Settings
Office NameThis text will be used throughout the portal, in portal communications and Smart Forms where the Office name is displayed.RequiredTextboxThe default value is "Financial Aid Office."50 characters max
Job TitleThis text will be used throughout the portal, in portal communications and in Smart Forms where the Job Title is displayed.OptionalTextboxThe default value is "Financial Aid Advisor."50 characters max
Office PhoneThis text will be used throughout the portal, in portal communications and in Smart Forms where the Office phone number is displayed.OptionalTextbox
15 characters max
Office EmailThis text will be used throughout the portal, in portal communications and in Smart Forms where the Office email address is displayed.OptionalTextbox
50 characters max
Display Current Program

(warning) Reserved for future use.

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.

RequiredDrop-down
  • Yes (default)
  • No

Display School Name

(warning) Reserved for future use.

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.

RequiredDrop-down
  • Yes (default)
  • No

School Name Display Value

(warning) Reserved for future use.

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" = YesDrop-down
  • Current Site (default)
  • Current Campus
  • Current Institution
When "Display School Name" is selected, this field is required.
Display Footer TextWhen 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.OptionalCheckboxSelected 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.EditorAlphanumeric and HTMLWhen "Display Footer Text" is selected, this field is required.
BETA IIDisplay Sign In Instructional Message

When this checkbox is selected, the Sign In Instructional Message configured will display at the bottom of the Sign In screen.

OptionalCheckboxUnselected by default
BETA IISign In Instructional Message Text

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 SelectedEditorAlphanumeric and HTMLWhen "Display Sign In Instructional Message" is selected, this field is required.
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.

OptionalDrop-downA list of communications from "Communication Setup" where the "Communication Recipient" field is set to a value of "Parent Spouse."
Student Account Registration EmailProvides a list of communications, from Communication Setup, that could be used to notify the Student that their Account Registration is complete.OptionalDrop-downA list of communications from "Communication Setup" where the "Communication Recipient" field is set to a value of "Student."
Parent Account Registration EmailProvides a list of communications, from Communication Setup, that could be used to notify the Parent that their Account Registration is complete.OptionalDrop-downA list of communications from "Communication Setup" where the "Communication Recipient" field is set to a value of "Parent Spouse."
AVAILABLE IN 4.9.1Student Password Reset EmailProvides a list of communications, from Communication Setup, that could be used to notify the Student that their Password as been Reset.OptionalDrop-downA list of communications from "Communication Setup" where the "Communication Recipient" field is set to a value of "Student."
AVAILABLE IN 4.9.1Parent Password Reset EmailProvides a list of communications, from Communication Setup, that could be used to notify the Parent that their Password has been reset.OptionalDrop-downA list of communications from "Communication Setup" where the "Communication Recipient" field is set to a value of "Parent Spouse."
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.

OptionalText boxAlphanumeric and HTML
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.OptionalCheckboxUnselected by default

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.

OptionalText box

Default text: 

Our website is currently undergoing scheduled maintenance.  We apologize for the inconvenience.  Please try again later.



Account Management Subtab

Field NameDescriptionRequired/OptionalTypeValueBusiness Rule
General Settings
Active Students Only

(warning) Reserved for future use.

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.

RequiredDrop-down
  • Yes (default)
  • No

Login MethodThis setting will determine the method used by students when logging into the portal.RequiredDrop-down
  • Non-SSO (default)
  • SSO

SSO Settings
This section will display only if “SSO” is chosen for “Login Method.”
External ID 1The 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.


CheckboxCheckboxSelected by Default
External ID 1 Attribute NameOptionalTextboxAlphanumeric50 character max
External ID 2OptionalCheckboxUnselected by Default
External ID 2 Attribute NameOptionalTextboxAlphanumeric50 character max
Logout RedirectThe URL entered here will be used to redirect the student to a specific page upon exiting the portal.  OptionalTextboxAlphanumeric

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 NameIf selected, First and Last Name will be used to verify the student's account in Step 3 of the account registration process.RequiredDrop-down
  • Yes (default)
  • No

BETA IIDisplay School NameWhen "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.RequiredDrop-down
  • Yes (default)
  • No

BETA IISchool Name Display ValueThe 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" = YesDrop-down
  • Site (default)
  • Campus
  • Institution
When "Display School Name" is selected, this field is required.
External ID 1The 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.

RequiredDrop-down
  • Yes (default)
  • No 

External ID 2RequiredDrop-down
  • Yes 
  • No (default)

Email AddressIf selected, Email Address will be used to verify the student's account in Step 3 of the account registration process.RequiredDrop-down
  • Yes (default)
  • No

Useful Links Subtab

Field NameDescriptionRequired/OptionalTypeValueBusiness Rule
Useful Links Settings
Display Useful Links on DashboardWhen 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.OptionalCheckboxSelected 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 MessageWhen this checkbox is selected, the Instructional Header and Message configured will display at the top of the Useful Links screen.OptionalCheckboxUnselected 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 SelectedTextAlphanumeric

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 Useful Links 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 Instructional Message" is SelectedEditorAlphanumeric and HTMLWhen "Display Instructional Message" is selected, this field is required.
Useful Link Setup Table
This table is used for configuring the links that will appear in the Useful Links component.  The first three links configured will display on the Useful Links Dashboard widget. These links will display in the order configured. Click on and move each row to arrange the order.  There is no limit to the number of links that can be configured here.
Order #The display order of the configured links.  Users may re-order the links by clicking and holding on a row their mouse and dragging the row a higher or lower placement in the table. N/ANot editable

Link TextThe text to be displayed as the hyperlink of the URL.RequiredTextSee Default Useful Link Configurations50 character max
URLA valid website address / URL beginning with http:// or https://.RequiredTextSee Default Useful Link ConfigurationsURLs provided for the links must be valid, meaning they begin with http:// or https://
URL DescriptionThe description of the website that will display next to the link.RequiredTextSee Default Useful Link Configurations250 character max
RemoveRemoves the entire row of data from the table.N/AButtonSee Default Useful Link Configurations


Default Useful Link Configurations

The following 5 links should be pre-configured on each instance. These are editable and can be deleted.

Link TextURLURL Description
Federal Direct Loan informationhttps://www.studentloans.govFederal website students access to sign Master Promissory Notes (MPNs), complete Loan Counseling, find out about loan repayment options, complete TEACH counseling and Agreements to Serve, etc.
Borrowing history informationhttps://nslds.ed.gov/nslds/nslds_SA/Students access the National Student Loan Data System for detailed information about their loans and grants including total amounts borrowed and to complete Loan Exit Counseling.
Managing loan repaymenthttps://studentaid.ed.gov/repay-loansThis site contains information about Direct Loans including loan repayment options and responsibilities, forbearance and deferment, loan consolidation, loan cancellation, and how to avoid delinquency and default.
Loan payment calculatorhttp://www.finaid.org/calculators/loanpayments.phtmlAllows borrowers to enter information about their existing or potential loan debt and get an estimate of the monthly payment and total interest amounts.
Federal Student Aid informationhttps://www.studentaid.gov/saThis is the main student financial aid information site for the U.S. Department of Education and includes information about applying for and receiving federal student aid and about loan repayment. This site also includes a link to the FAFSA application.

Message Center Subtab

Field NameDescriptionRequired/OptionalTypeValueBusiness Rule
Message Center Settings
Display Message Center on DashboardWhen this checkbox is selected, the Message Center 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.OptionalCheckboxSelected by defaultWhen this field is unselected, all other fields on the screen are disabled.
Student Message are Read Only When this checkbox is selected, students will be able to read messages from FA Staff, but will not be able to respond to or send new messages to FA Staff.  This creates, effectively, one way messaging from the FA Staff to the student.OptionalCheckboxSelected by default
Display Instructional Message

When this checkbox is selected, the Instructional Header and Message configured will display at the top of the Message Center screen.

OptionalCheckboxUnselected by default
Instructional Message Header Text

The text entered here will display as a customized Header on the Message Center 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 SelectedTextAlphanumeric

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 Message Center 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 Instructional Message" is SelectedEditorAlphanumeric and HTMLWhen "Display Instructional Message" is selected, this field is required.

Financial Aid Subtab

Field NameDescriptionRequired/OptionalTypeValueBusiness Rule
Financial Aid Settings
Display Financial Aid on Dashboard

When this checkbox is selected, the Financial Aid 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.

When this field is selected, an additional field is available on Fund Setup titled "Display on Financial Aid Portlet" which will determine whether or not the fund will appear on the Financial Aid component of the Student Experience portal for students.  Simply unselect this field on the Fund level to hid the award on the portal.

OptionalCheckboxSelected by defaultWhen this field is unselected, all other fields on the screen are disabled.
Display Instructional MessageWhen this checkbox is selected, the Instructional Header and Message configured will display at the top of the Finacial Aid screen.OptionalCheckboxUnselected by default
Instructional Message Header Text

The text entered here will display as a customized Header on the Finacial Aid 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 SelectedTextAlphanumeric

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 Finacial Aid 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 Instructional Message" is SelectedEditorAlphanumeric and HTMLWhen "Display Instructional Message" is selected, this field is required.
Cost of Attendance Settings
Display Full Cost of AttendanceWhen this checkbox is selected, the student's full Cost of Attendance will display on the Financial Aid main screen.Optional CheckboxSelected by default
Display Direct Costs SummaryWhen this checkbox is selected, a summary of the student's Direct Costs for the Academic Year will display within each Award tile, when the Award tile is expanded, on the Financial Aid main screen.OptionalCheckboxSelected by default
Statement of Understanding (SOU) Settings
BETA IISOU Short Description

The text entered here will display on the Financial Aid component above the "Read Statement of Understanding" button.  If no text is configured here, only the "Read Statement of Understanding" button will be displayed.

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.

OptionalEditorAlphanumeric and HTML
Statement of Understanding Text

The text entered here will display as the Statement of Understanding on the Financial Aid screen. Whether or not the Statement of Understanding is displayed is controlled by the Fund-level setting "Require student to request fund on Student Portal."

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.

OptionalEditorAlphanumeric and HTML
Payment Period Display Settings
Term-based DisplayThe option chosen here will determine how the Term is displayed to the student on Financial Aid screen. This applies to Term-based programs only. All Nonterm programs are displayed with the Payment Period Start and End Date.RequiredDrop-down
  • Term Name (default)
  • Term Start and End Dates

Payment Period Details Settings
Help Text

The text configured here will display as instructional or "help" text at the top of the Payment Period Details screen.

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.

OptionalTextboxAlphanumeric250 characters max
Parent PLUS Settings
Allow Actions on "Accepted" AwardsIf "Yes" is selected here, the student will have the ability to take any type of action, within the Financial Aid screen, on a Parent PLUS Loan in an "Accepted" status. This will allow the student to reduce or decline a previously accepted PLUS loan on behalf of their parent.RequiredDrop-down
  • Yes
  • No (default)

Allow Actions on "Offered" AwardsIf "Yes" is selected here, the student will have the ability to take any type of action, within the Financial Aid screen, on a Parent PLUS Loan in an "Offered" status. This will allow the student to accept a PLUS loan on behalf of their parent.RequiredDrop-down
  • Yes
  • No (default)

Award Settings
Display "Declined" AwardsIf "Yes" is selected here, the student will have the ability to see awards in a "Declined" status on the Financial Aid screen.RequiredDrop-down
  • Yes
  • No (default)

Display "Cancelled" AwardsIf "Yes" is selected here, the student will have the ability to see awards in a "Cancelled" status on the Financial Aid screen.RequiredDrop-down
  • Yes
  • No (default)

Display "Estimated" AwardsIf "Yes" is selected here, the student will have the ability to see awards in an "Estimated" status on the Financial Aid screen.RequiredDrop-down
  • Yes
  • No (default)

Display Option to Accept Awards at Direct Cost AmountIf "Yes" is selected here, the option to "Accept the Gross Amount Available up to the Amount of my Remaining Direct Costs" will be available on each award. If "No" is selected, this option will not be shown on the Financial Aid component for any award.RequiredDrop-down
  • Yes (default)
  • No 

Hide Awards and Costs when Overlap ExistsIf "Yes" is selected here, Awards and Costs will not be displayed for the student on the Financial Aid main screen if the student has either the "Review Overlapping Loan Period from ISIR" or the "Review Overlapping Academic Year from NSLDS" task. Awards and Costs will not display for the Academic Year that the task is associated with, nor any future academic years, until the task is resolved.RequiredDrop-down
  • Yes (default)
  • No

Overlap Message

The text configured here will display when the student's Awards and Costs are hidden due to the existence of the "Review Overlapping Loan Period from ISIR" or the "Review Overlapping Academic Year from NSLDS" task.

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.

OptionalTextboxAlphanumeric250 characters max
Academic Year Settings
Display Academic Year 0If "Yes" is selected here, the student will have the ability to select Academic Year "0" in the Academic Year dropdown on the Financial Aid screen.RequiredDrop-down
  • Yes
  • No (default)

Academic Years to DisplayIf "Current AY and one Future AY" is selected here, the student will have the ability to select their current academic year, or their next future academic year from the Academic Year dropdown on the Financial Aid screen. If "All AYs" is selected here, the student will have the ability to select any academic year on their academic plan (unless AY0s are not configured to display) from the Academic Year dropdown on the Financial Aid screen.RequiredDrop-down
  • Current AY and one Future AY (default)
  • All AYs

Document Subtab

Field NameDescriptionRequired/OptionalTypeValueBusiness Rule
Document Settings
Display Required Documents on DashboardWhen this checkbox is selected, the Documents 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.OptionalCheckboxSelected by defaultWhen this field is unselected, all other fields on the screen are disabled.
Display Instructional Message for StudentWhen this checkbox is selected, the Instructional Header and Message configured will display at the top of the Document screen when the student accesses the component.OptionalCheckboxUnselected by default
Instructional Message Header (Student)

The text entered here will display as a customized Header on the Document Instructional Text when the student accesses the component.

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 SelectedTextboxAlphanumeric

When "Display Instructional Message" is selected, this field is required.

50 characters max

Instructional Message Text (Student)

The text entered here will display as instructional text on the Document screen when the student accesses the Documents component.  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 Instructional Message" is SelectedEditorAlphanumeric and HTMLWhen "Display Instructional Message" is selected, this field is required.
Display Instructional Message for ParentWhen this checkbox is selected, the Instructional Header and Message configured will display at the top of the Document screen when the parent accesses the component.  OptionalCheckboxUnselected by default
Instructional Message Header (Parent)

The text entered here will display as a customized Header on the Document Instructional Text when the parent accesses the component.

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 SelectedTextboxAlphanumeric

When "Display Instructional Message" is selected, this field is required.

50 characters max

Instructional Message Text (Parent)

The text entered here will display as instructional text on the Document screen when the parent accesses the component.  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 Instructional Message" is SelectedEditorAlphanumeric and HTMLWhen "Display Instructional Message" is selected, this field is required.
Document Reason Heading Text

The text entered here will display as a customized Header or field title for the Document Requirement "Reason" text (from Regent Award) on the Document Details Tile.

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.

OptionalTextboxAlphanumeric50 character max
Term-based DisplayThe option chosen here will determine how the Term is displayed to the student on the Required Documents screen for Payment Period scoped documents. This applies to Term-based programs only. All Nonterm programs display the Payment Period Start and End Date.RequiredDrop-down
  • Term Name (default)
  • Term Start and End Dates

Display "Unsatisfied" DocumentsIf "No" is selected here, documents with an "Unsatisfied" status in Regent Award will never display to the student, even when the student chooses "Show All Documents."RequiredDrop-down
  • Yes
  • No (default)

Display "Waived" DocumentsIf "No" is selected here, documents with a "Waived" status in Regent Award will never display to the student, even when the student chooses "Show All Documents."RequiredDrop-down
  • Yes
  • No (default)

Display "Upload" for Documents in a "Received" StatusIf "No" is selected here, students will be able to upload attachments when the Regent Award document status is "Needed" or "Incomplete." If "Yes" is selected here, students will be able to upload attachments when the Regent Award document status is "Needed" or "Incomplete" or "Received," allowing for multiple attachments to be added to a document requirement by the student.RequiredDrop-down
  • Yes
  • No (default)

Sort Settings
Default SortThe option chosen here will apply to both the order that documents are displayed on the Document component per scope and the order of documents by date within each scope. Student scoped documents will always display first, followed by Federal Award Year scoped documents in the sort order chosen here, then Academic Year scoped documents in the sort order chosen here, and finally Payment Period scoped documents in the sort order chosen here.  The date used for sorting is the Status Change Date, if available, otherwise the Created Date of the document. RequiredDrop-down
  • Newest First (default)
  • Oldest First

Smart Form Subtab

Field NameDescriptionRequired/OptionalTypeValueBusiness Rule
Smart Form Settings
Allow Personal Information Updates

When "Yes" is chosen for this setting, the student's address can be updated, by the Student, on the Personal Information section of the questionnaire.

These updates are not persisted into Regent Award at this time.

RequiredDropdown
  • Yes (default)
  • No

Display Message for ISIR Dependency Reject StatusWhen "Yes" is chosen for this setting, a message is displayed to students when the ISIR dependency status equals X or Y and the Smart Form is set to pre-populate using ISIR data, which will prevent access to the Smart Form.RequiredDropdown
  • Yes (default)
  • No

Display Instructional Message for StudentWhen this checkbox is selected, the Instructional Header and Message configured will display at the top of the Smart Form when the Student accesses the Smart Form.OptionalCheckboxUnselected by default
Instructional Message Header Text (Student)

The text entered here will display as a customized Header on the Smart Form 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 for Student" is SelectedTextboxAlphanumeric

When "Display Instructional Message for Student" is selected, this field is required.

50 character maximum

Instructional Message Text (Student)

The text entered here will display as instructional text on the Smart Form.  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 Instructional Message for Student" is SelectedEditorAlphanumeric and HTMLWhen "Display Instructional Message for Student" is selected, this field is required.
Display Instructional Message for ParentWhen this checkbox is selected, the Instructional Header and Message configured will display at the top of the Smart Form when the Parent accesses the Smart Form.OptionalCheckboxUnchecked by default
Instructional Message Header Text (Parent)

The text entered here will display as a customized Header on the Smart Form 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 for Parent" is SelectedTextboxAlphanumeric

When "Display Instructional Message for Parent" is selected, this field is required.

50 character maximum

Instructional Message Text (Parent)

The text entered here will display as instructional text on the Smart Form.  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 Instructional Message for Parent" is Selected

Editor

Alphanumeric and HTMLWhen "Display Instructional Message for Parent" is selected, this field is required.
PDF Settings
External IDIn this field, the school can select the Student ID that will be displayed on the PDF generated by the Smart Form.RequiredDropdown
  • External ID 1 (default)
  • External ID 2

Verification Worksheet Settings
4.9.0.0Enable VWS Marital Status ChangeWhen this setting is turned on, the Student Experience portal will present a new workflow within the Verification Worksheet when the student has a marital status change.RequiredDropdown
  • Yes 
  • No (default)

E-Signature Subtab

Field NameDescriptionRequired/OptionalTypeValueBusiness Rule
E-Signature Settings
Student Signature Confirmation Options
Schools must choose a minimum of three fields below to be used to verify the student's identity during the e-Signature process.  The options selected here will be used in Step 3 of the Student E-Signature process to verify the Student's identity.
First NameIf this option is chosen, First Name will be one of three fields the student must validate when e-Signing.OptionalCheckboxUnselected by default
Last NameIf this option is chosen, Last Name will be one of three fields the student must validate when e-Signing.OptionalCheckboxUnselected by default
Student ID

This field will display a non-editable value for the Student ID, that aligns with the value the school chose on the Account Management configuration under either the SSO or Non-SSO settings.

If Student ID is chosen, the External ID value chosen on the Account Management settings will be one of three fields the student must validate when e-Signing.

OptionalCheckboxUnselected by default
PasswordIf this option is chosen, Password will be one of three fields the student must validate when e-Signing.OptionalCheckboxUnselected by default
Parent Signature Confirmation Options
Schools must choose a minimum of three fields below to be used to verify the parent's identity during the e-Signature process.  The options selected here will be used in Step 3 of the Parent E-Signature process to verify the Parent's identity.
First NameIf this option is chosen, First Name will be one of three fields the parent must validate when e-Signing.OptionalCheckboxUnselected by default
Last NameIf this option is chosen, Last Name will be one of three fields the parent must validate when e-Signing.OptionalCheckboxUnselected by default
Student ID

This field will display a non-editable value for the Student ID, that aligns with the value the school chose on the Account Management configuration under either the SSO or Non-SSO settings.

If Student ID is chosen, the External ID value chosen on the Account Management settings will be one of three fields the parent must validate when e-Signing.  The parent/guardian will need to know and provide the Student ID of the student who invited them to sign.

OptionalCheckboxUnselected by default
PasswordIf this option is chosen, Password will be one of three fields the parent must validate when e-Signing.OptionalCheckboxUnselected by default

This checkbox will be disabled if the school chose "SSO" for Login Method on Account Management.

  • No labels