Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This documentation is effective as of Regent Release 6.5.0.0. In Regent’s Smart Form Manager tool, clients with a Regent Fund or Regent Review license can create new smart forms, edit client-created smart forms, and import smart forms from different instances (e.g. QA to Production). Smart forms can be designed using conditional logic to tailor each question to the individual completing the form. Document workflows can leverage the use of smart forms in managing the notification, submission, and review of an application.

Clients are not required to create, edit, or manage their own custom smart forms. Clients may continue to engage Regent for support in creating, editing, or updating any custom smart forms.Please

Note

...

Note

PLEASE NOTE the following important warnings and guidance regarding Smart Form Manager:

  • Clients must not make changes to any of Regent’s standard smart forms, including:

    • All Verification Worksheets

    • FERPA Authorizations

    • Thank You Note

    • Title IV Authorizations

    • MHEC Remain Drug Free

Clients must contact their Regent Account Manager/Project Manager prior to
    • Any forms related to State Fund awarding

  • Clients must follow the procedures below when making changes to any existing customsmart form.

  • Clients should never create or edit smart forms directly in Production. Always create/edit and fully validate smart forms in a QA instance, then export and import/upload a successfully validated smart form to Production.

  • Clients should export smart forms drafted in a QA to prevent overwriting by scheduled or ad-hoc restores.

  • Any data clean-up efforts that are required as a result of client actions on smart forms may require a Statement of

Work (SOW) with associated costs paid by the client
  • Work (SOW) with associated costs paid by the client.

Procedures for Updating Forms Using Smart Form Manager

  1. Create a CZ ticket to communicate updates to the form and provide a clear description of the changes being made.

  2. Make a copy of the form in Smart Form Manager and increment the Revision Number on the Information tab.

  3. After changes are made, export the Smart Form and attach the file to the ticket, including the revision number in the file name.

  4. After testing of changes, when the new version is imported into the Production environment, select ‘Invalidate Smart Forms with the same name.’

  5. If future changes to the form are requested from Regent, the latest revision of the form must be included in the ticket to ensure Regent is working from the correct version.

Table of Contents

Table of Contents
minLevel1
maxLevel4
include
outlinefalse
indent
exclude
typelist
class
printablefalse

...

To use the Smart Form Manager, a client must:

  1. Submit a Customer Zone Support ticket requesting Smart Form Manager and Admin Panel Tools be enabled on the backend by Regent

  2. Be on Regent Release 6.5.0.0 or a subsequent Release.

  3. Update Global Permissions → Tools Permissions → Smart Form Manager for applicable user role(s).

  4. Ensure all Active (able to be used) and Inactive (not in use) smart forms are visible.

...

In the UI, the user will be presented with key data fields to be completed. Fields names indicated in red textare required. After the data on this screen is saved, other setup tabs for the smart form are presented and the form is available in either the Active Smart Forms or Inactive Smart Forms menu, depending on the Start Date and End Date values that were entered. Four tabs are used to setup the general information for the smart form:

...

Expand
titleInformation Tab Fields

Information Field Name

Required/Optional

Description

Field Type

Field Options

Name

Required

The text entered in this field is the smart form name displayed in the Smart Form Manager and the Query Tool in Regent. Note: This is not the smart form name displayed in the Student Portal.

Textbox

Federal Award Year

Required

All smart forms require a FAY selection. A FAY scope document configured is linked to the applicable smart form with the corresponding FAY selected here. If the document is configured as student scope, any FAY selection is acceptable.

Dropdown

  • 2010-2011 through 2049-2050

Start Date

Required

The date entered here will be used as the effective start date for the smart form.

Calendar Date

End Date

Required

The date entered here will be used as the effective end date for the smart form.

Calendar Date

Smart Form Type

Required

The Smart Form Type selected is used to link the smart form to the document in Document Setup.

Checkbox

  • Use Smart Form Code

  • Lists all existing Smart Form Types

Code

Required

The text entered here will be used as a short name to identify the smart form in the Smart Form Manager and Query Tool.

Textbox

Allows alpha-numeric characters without spaces

Revision Number

Required

This field allows users to track different versions of a Smart Form when changes are made.

Numeric

Make Regent Data Available

Demographic Information

Optional

When this option is selected, the Demographic Information saved in Regent is made available to the smart form.

Checkbox

  • Selected

  • Not Selected (Default)

ISIR Information

Optional

When this is selected, the ISIR Information saved in Regent is made available to the smart form.

Checkbox

  • Selected

  • Not Selected (Default)

Student Portal Authorizations

Optional

When this is selected, the Student Portal Authorizations saved in Regent is made available to the smart form.

Checkbox

  • Selected

  • Not Selected (Default)

UDF Information

Optional

When this is selected, User Defined Field information saved in Regent is made available to the smart form.

Checkbox

  • Selected

  • Not Selected (Default)

Regent Access

Optional

When this is selected, the Regent Access configured state code saved in Regen is made available to the smart form.

Note: This is only applicable to clients that have a Regent Access license.

Checkbox

  • Selected

  • Not Selected (Default)

Fund Information

Optional

When this is selected, the Fund Name and Donor Name are made available to the smart form.

Checkbox

  • Selected

  • Not Selected (Default)

Additional Information and Advanced Settings

Smart Form Id

A system-generated ID that is created and associated when creating a new smart form.

Textbox (Read-only)

Created At

The date on which a new smart form was created.

Textbox (Read-only)

Modified At

The last date on which a smart form was modified.

Textbox (Read-only)

...

Expand
titleShortkeys

Shortcut Name

Description

  • {fay}

Automatically inserts the Federal Award Year of the smart form (e.g. 2024-2025).

  • {YearDescription}

This is the smart form Name

Note: This is a legacy field that was used when all smart forms were FAY scope but is still available for use.

  • {YearCode}

This returns a special int essentially (max year of FAY)-2020. So for 2023-2024 FAY, the year code would be 4.

  • {InstitutionExternalId}

This returns the Institution External ID from Regent

  • {LocationName}

This is a legacy shortcut that is no longer used.

  • {LocationExternalId}

This is a legacy shortcut that is no longer used.

  • {CampusName}

This returns the Campus Name from Regent

  • {CampusExternalId}

This returns the Campus External ID from Regent

  • {SiteName}

This returns the Site Name from Regent

  • {SiteExternalId}

This returns the Site External ID from Regent

  • {ProgramName}

This returns the Program Name from Regent

  • {ProgramExternalId}

This returns the Program External ID from Regent

  • {ProgramType}

This returns the Program Type from Regent

  • {sectionCode}

This returns the Section Code from Regent

  • {groupCode}

This returns the Campus ID from Regent

  • {questionCode}

Question values are referenced by using the following notation {questionCode}

Expand
titleHelper Functions

Helper Functions

Description

  • UpperCase

  • Returns string

  • Converts the argument to UPPER CASE.

  • Example: SnapUtility.UpperCase("yes") returns "YES”

  • Trim

  • Returns string

  • Removes leading and trailing whitespace.

  • Example: SnapUtility.Trim("   Hello   ") returns "Hello"

  • EqualOfAny

  • Returns boolean

  • Performs TrimUpper and checks if the first argument is in the list of remaining arguments Note: This function is case insensitive.

  • Example: SnapUtility.EqualOfAny("Hi", "Does", "hi", "exist") returns true.

  • IsNumber

  • Returns number

  • Check to see if the first argument is a number. If it is not, the second argument is returned.  

  • Example: SnapUtility.IsNumber("Dog", -1) returns -1

  • CheckNumber

  • Returns number

  • Check to see if the first argument is a number. If it is not, the second argument is returned.  

  • Example: SnapUtility.IsNumber("Dog", -1) returns -1

  • CompareDate

  • Returns number

  • Check to see how the two dates compare.  If the first date is after the second date, the function will return a positive number.  If the second date is after the first one, the function will return a negative number.  If the dates are the same, the function will return 0.  If the arguments cannot be resolved to dates, the function returns NaN.  eg: SnapUtility.CompareDate('07/19/2013', '08/01/2013') returns -1.

  • IsCurrentDateBetween

  • returns boolean - Checks to see if the current date falls in a range (non-inclusive).  eg: SnapUtility.IsCurrentDateBetween('01/01/2013', '01/01/3000') returns true.

  • IsCurrentDateBefore

  • returns boolean - Checks if the current date falls before a specified date.  eg: SnapUtility.IsCurrentDateBefore('01/01/2013') returns false.

  • AddDaysToDate

  • - returns Date - Adds a specified number of days to the specified date.  eg: SnapUtility.AddDaysToDate('01/01/2013', 9) returns '01/10/2013'.

Expand
titleChange Log

Date

Desription of Change

Editor

4/4/2024

  • Added new ‘Make Queryable’ field

  • Updated helptext for Data Type field

  • Separated the ‘Date’ Data Type into two:

    • Long Date

    • Short Date

4/8/2024

  • Added Revision Number

12/9/24

Added procedures for using Smart Form Manager

Heather Smith