Versions Compared

Key

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

Introduction

...

The Smart Form Manager Tool is available in the Regent Tools menu for users with the ‘Smart Form Manager Tool’ permission enabled.

The Document Assignment Tool is comprised of a top section with selection options for Institution Name and Query Name and a bottom section for the selection of Documents to be assigned.

NOTE: This tool is designed to be used at the Institution level. Only one Campus per Institution should be configured.

Getting Started

Schools will need to:

  1. Be on or upgrade to the Regent Award 6.5.0.0 Release or a subsequent Release

  2. Update Enterprise Permission

  3. Create Smart Form

  4. Update Document Tracking Setup

...

Document Setup must be considered when adding DRP. If a document is configured to Enforce Scope Uniqueness, a new document is not added if it already exists but the status of an existing document can be updated. If documents are configured to be added upon ISIR import, DRP can be used to update the document status on an existing document(s).

Expand
titleDocument Requirement Persistence Fields

DRP Field Name

Required/Optional

DRP Field Description

DRP Field Type

Question Field Options

Document Name

Required

This is the name of the document configured in Regent to update or create based on the persistence logic.

When configuring a

DRPStudent Persistence updates the Student Portal Authorization fields in Regent based on Student Authorizations and update add or update a student document requirement in Regent

Document Persistence, the ‘Name’ must match the name of the document configured in Document Setup. Use caution when Document Names have special characters such as an apostrophe or dash that it is using the identical Document Name and has not been updated by the editor. If no match is found to an existing Document Name configured when executing the DRP expression, an error message is displayed, ‘Document name of <Document Name> is not found'.

Expand
titleDocument Requirement Persistence Fields
DRP Field Name/OptionalDefault For Transfer

Textbox

Scope

Required

DRP Field Description

DRP Field Type

Question Field Options

Document Name

This is the document scope associated with the document requirement to update or create.

Dropdown

  • Student

  • Federal Award Year

  • Student and Reason

  • Federal Award Year and Reason

Note: Payment Period and Academic Year scopes are not available options.

Default Status

Required

This is the name of status the document configured in Regent to update or create based on the persistence logic.

When configuring a Document Persistence, the ‘Name’ must match the name of the document configured in Document Setup. Use caution when Document Names have special characters such as an apostrophe or dash that it is using the identical Document Name and has not been updated by the editor. If no match is found to an existing Document Name configured when executing the DRP expression, an error message is displayed, ‘Document name of <Document Name> is not found'.

Textbox

Scoperequirement is set to upon the completion of the Smart Form.

Although required, this status is only used when the Smart Form is not configured for electronic signatures.

Dropdown

  • Static

  • Velocity

Activity Log Entry Status

Required

This is the document scope associated with the document requirement to update or createActivity Type for the
Activity Log Entry in Regent logging status changes and new document requirements.

Dropdown

  • Student

  • Federal Award Year

  • Student and Reason

  • Federal Award Year and Reason

Note: Payment Period and Academic Year scopes are not available options.

Esigned Status

Required

This is the status the document requirement is set to upon the completion of the Smart Form.

Although required, this status is only used when the Smart Form is not configured for electronic signatures.

Dropdown

  • Static

  • Velocity

Activity Log Entry StatusTextbox

Condition Expression

Required

This is the Activity Type for the
Activity Log Entry in Regent logging status changes and new document requirements.

Dropdown

Esigned Status

Required

This is the status the document requirement is set to upon the completion of the Smart Form.

Although required, this status is only used when the Smart Form is configured for electronic signatures.

Textbox

Condition Expression

Required

Any valid, Boolean expression. Answers to questions in the corresponding smart form can be accessed by wrapping the question code in curly braces. Logical operators, such as, AND (&&), and OR (||) may be used in combination with built-in expressions, such as, SnapUtility.EqualOfAny, and SnapUtility.ReasonEqualToAny. The SnapUtility.ReasonEqualToAny is a special function that can not be used in combination with other expressions and will perform the requested action on existing, student documents where the document reason matches any of the values provided to the function. If an expression did not evaluate to true or false, that means the expression is not valid and contains syntax errors. If the expression is invalid, persistence actions for this document requirement will be ignored.

Textbox

Create on No Match

Optional

If checked, the DRP will be create in REM even if the smart form document can not be found for the specified create statuses. The document will be created based on the "Attachment Type" field selection.

Checkbox

  • Selected

  • Unselected (Default)

Any valid, Boolean expression. Answers to questions in the corresponding smart form can be accessed by wrapping the question code in curly braces. Logical operators, such as, AND (&&), and OR (||) may be used in combination with built-in expressions, such as, SnapUtility.EqualOfAny, and SnapUtility.ReasonEqualToAny. The SnapUtility.ReasonEqualToAny is a special function that can not be used in combination with other expressions and will perform the requested action on existing, student documents where the document reason matches any of the values provided to the function. If an expression did not evaluate to true or false, that means the expression is not valid and contains syntax errors. If the expression is invalid, persistence actions for this document requirement will be ignored.

Textbox

Create on No Match

Optional

If checked, the DRP will be create in REM even if the smart form document can not be found for the specified create statuses. The document will be created based on the "Attachment Type" field selection.

Checkbox

  • Selected

  • Unselected (Default)

For Transfer

Optional

This is a legacy setting and is no longer used.

Checkbox

  • Selected

  • Unselected (Default)

REM Linked Document

Optional

If selected, the Document Persistence associates the document being created or updated to a Document in Regent Enterprise Management (REM).

An unselected REM Linked Document field is legacy code that is no longer supported.

Checkbox

  • Selected (Default)

  • Unselected

Document Reason

Optional

If added, the Document Reason, which is defined as an expression will be added to the ‘reason’ field on the associated Document Requirement when creating or updating the document in Regent.

Textbox

Update Statuses

Optional

A Document Requirement is updated in Regent to the Default Status or Esigned Status if a Document Requirement in Regent has one of the statuses listed in this column upon completion of the Smart Form.

Drag-and-Drop, Multi-selection

  • Selected Document Statuses from the Available Statuses

Available Statuses

Optional

The list of available document requirement statuses to select the ‘update’ or ‘create’ statuses from.

Drag-and-Drop, Multi- selection

Create Statuses

Optional

A Document Requirement is created in Regent if a Document Requirement does not exist with one of the statuses listed in this column upon completion of the Smart Form.

Drag-and-Drop, Multi- selection

Document Persistence Additional Information & Advanced Settings

File Name

Optional

This is a legacy setting and is no longer used.

CheckboxTextbox

  • Selected

  • Unselected (Default)

REM Linked Document

Optional

If checked, the DRP document

Checkbox

  • Selected (Default)

  • Unselected

Document Reason

Optional

Textbox

Update Statuses

Optional

The DRP student document requirement in REM, will have its status set to the default or esigned status if the smart form document status is in the list of updated statuses.

Available Statuses

Optional

The list of available document requirement statuses.

Create Statuses

Optional

When the current student document status matches a status in the list of create statuses, a new document is created.

Document Persistence Additional Information & Advanced Settings

File Name

Optional

This is a legacy setting and is no longer used.

Textbox

Template Name

Required

This is a legacy setting and is no longer used.

Textbox

Attachment Type

This is a legacy setting and is no longer used.

Dropdown

  • Pdf Template

  • FAFSA

Student Persistence

Template Name

Required

This is a legacy setting and is no longer used.

Textbox

Attachment Type

This is a legacy setting and is no longer used.

Dropdown

  • Pdf Template

  • FAFSA

Student Persistence

Student Persistence updates the Student Portal Authorization fields in Regent based on Student Authorizations and update add or update a student document requirement in Regent. Student Persistence is added and updated upon the completion of the Smart Form, including all required signature(s).

Expand
titleStudent Persistence Fields

DRP Field Name

Required/Optional

DRP Field Description

DRP Field Type

Question Field Options

Credit Balance Option

Optional

This field is associated to the Portal Credit Balance Option in Regent and the Smart Form response from the question code selected is persisted to the associated field.

Dropdown

  • All question codes in sequential order within the Smart Form

Hold Excess Title4

Optional

This field is associated to the Hold Excess Title IV in Regent and the Smart Form response from the question code selected is persisted to the associated field.

Dropdown

  • All question codes in sequential order within the Smart Form

Pay Prior Year Minor Charges

Optional

This field is associated to the Pay Prior Year Minor Charges in Regent and the Smart Form response from the question code selected is persisted to the associated field..

Dropdown

  • All question codes in sequential order within the Smart Form

Pay Non Institutional Charges

Optional

This field is associated to the Pay Non-Institutional Charges in Regent and the Smart Form response from the question code selected is persisted to the associated field.

Dropdown

  • All question codes in sequential order within the Smart Form

Parent/Spouse Persistence

Parent/Spouse Persistence updates the Parent/Spouse Reference fields in Regent based on . Document Requirements are added and updated upon the completion, including signature(s), of the Smart Form. The document requirement is only added or updated if the expression results are true.

Expand
titleStudent Persistence Fields

DRP Field Name

Required/Optional

DRP Field Description

DRP Field Type

Question Field Options

Credit Balance Option

Optional

This field is associated to the Portal Credit Balance Option in Regent and the Smart Form response from the question code selected is persisted to the associated field.

Dropdown

  • All question codes in sequential order within the Smart Form

Hold Excess Title4

Optional

This field is associated to the Hold Excess Title IV in Regent and the Smart Form response from the question code selected is persisted to the associated field.

Dropdown

  • All question codes in sequential order within the Smart Form

Pay Prior Year Minor Charges

Optional

This field is associated to the Pay Prior Year Minor Charges in Regent and the Smart Form response from the question code selected is persisted to the associated field..

Dropdown

  • All question codes in sequential order within the Smart Form

Pay Non Institutional Charges

Optional

This field is associated to the Pay Non-Institutional Charges in Regent and the Smart Form response from the question code selected is persisted to the associated field.

Dropdown

  • All question codes in sequential order within the Smart Form

...

Sections

Section names are displayed on the Smart Form menu within the Student Portal. Sections are displayed in numerical order from lowest to highest based on the number entered in the Section Sort Order field.

...