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.
...
Be on Regent Release 6.5.0.0 or a subsequent Release.
Update Global Permissions → Tools Permissions → Smart Form Manager for applicable user role(s).
Ensure all Active (able to be used) and Inactive (not in use) smart forms are visible.
...
To access the Smart Form Manager, go to Tools in the left navigation menu and click Smart Form Manager. The following options are available in the Smart Form Manager tab tree-view:
+ Create Smart Form – Begin the creation of a new smart form
+ Import Smart Form – Import/upload a smart form from one instance to another, e.g. QA to Production
→ Active Smart Forms – Access an existing ‘Active' smart form. A smart form is considered ‘Active’ if today’s date falls within the effective Start Date and End Date defined on the Smart Form Information tab.
→ Inactive Smart Forms – Access an existing ‘Inactive’ smart form. A smart form is considered ‘Inactive’ if today’s date does not fall within the effective Start and End Date defined on the Smart Form Information tab.
...
To create a new smart form from scratch, select the “Create Smart Form” option in the Smart Form Manager.
...
To export an existing smart form as the starting point for a new smart form, select the existing smart form from the nested list under Active Smart Forms or Inactive Smart Forms and click the Export tab. The existing smart form will be exported as an eXtensible Markup Language (XML) file to the user’s computer.
...
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:
Information tab
Document Persistence tab
Student Persistence tab
Parent/Spouse Persistence tab
The Information tab provides basic smart form setup information. Once entered 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 effective dates.
| Expand |
|---|
| title | Information Tab Fields |
|---|
|
Information Field Name | Required/Optional | Description | Field Type | Field Options |
|---|
Name | Required | The text entered in this field is displayed at the top of the smart form in the Student Experience portal. | Textbox | | Federal Award Year | Required | This value is used when creating or updating the smart form document requirement, if the document is configured as a FAY scope, by ensuring only the smart form document requirement with the associated FAY is created or updated upon completion. If a document is configured as student scope, the smart form FAY is ignored when creating the smart form document requirement or updating upon completion. | Dropdown | | Start Date | Required | This value used as the effective begin date to allow students to access the smart form within the Student Experience portal. | Calendar Date | | End Date | Required | This value is used as the effective end date to allow students to access the smart form within the Student Experience portal. | Calendar Date | | Smart Form Type | Required | This value is used to link a document to an active smart form to make it available via the Student Experience portal. | Checkbox | | Code | Required | This value is used as a short name to identify the smart form in the Smart Form Manager. | Textbox Allows alpha-numeric characters without spaces | | Make Regent Data Available | Demographic Information | Optional | When this option is selected, the student’s demographic information is available to pull into the smart form. | Checkbox | Selected Not Selected (Default)
| ISIR Information | Optional | When this option is selected, the student’s ISIR Information is available to pull into the smart form. | Checkbox | Selected Not Selected (Default)
| Student Portal Authorizations | Optional | When this option is selected, the student’s Portal Authorizations are available to pull into the smart form. | Checkbox | Selected Not Selected (Default)
| UDF Information | Optional | When this option is selected, the student’s UDF Information is available to pull into the smart form. | Checkbox | Selected Not Selected (Default)
| Regent Access | Optional | When this option is selected, the student’s Regent Access information is available to pull into 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 option is selected, the student’s fund information is available to pull into 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) | |
|
| Note |
|---|
Clients must use caution when adding document persistence for documents that are configured to ‘Block Packaging’ or ‘Block Disbursements’. If incorrectly added, funds can be |
...
| Expand |
|---|
| title | Document Requirement Persistence Fields |
|---|
|
Document Persistence Field Name | Required/Optional | Description | Field Type | Field Options |
|---|
Document Name | Required | This value is the name of the document configured in Regent to update or create based on the persistence logic. When configuring 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 Document Persistence expression, an error message is displayed, ‘Document name of <Document Name> is not found'. | Textbox | | Scope | Required | This is the scope value associated with the document requirement to update or create. | Dropdown | Note: Payment Period and Academic Year scopes are not available options. | Default Status | Required | This is the status value 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 or when the paper signature option is selected. | Dropdown | | Activity Log Entry Status | Required | This is the value for the
Activity Log Entry in Regent logging status changes and new document requirements. | Dropdown | | Esigned Status | Required | This is the status value 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. | Dropdown | | Condition Expression | Required | A Boolean Expression is defined using logical operator such as, AND (&&) and OR (||), which can be used in combination with built-in expressions (see Shortkeys and Helper Functions under the Expressions section for additional information) to result in a ‘true’ or ‘false’. Question responses are wrapped in braces {curly brackets} within the expression. If an expression does not result in a ‘true’ or 'false', syntax errors are present and the expression is considered invalid. Document Persistence is ignored when an invalid expression exists. | Textbox | | Create on No Match | Optional | If checked, the Document Persistence will be created in Regent 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 checked, Document Persistence associates the document being created or updated to a Document in Regent Enterprise Management (REM). An unchecked 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 | | 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 | | 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 | |
|
Student Persistence updates the Student Portal Authorization fields in Regent based on the smart form question response(s). Student Persistence is added and updated upon the completion of the smart form, including all required signature(s).
| Expand |
|---|
| title | Student Persistence Fields |
|---|
|
Student Persistence Field Name | Required/Optional | Description | Field Type | 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 | | 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 | | 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 | | 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 | |
|
Parent/Spouse Persistence updates the Parent/Spouse Reference Information fieldsin Regent based on the smart form question response(s). Parent/Spouse Persistence is added and updated upon the completion of the smart form, including all required signature(s).
| Expand |
|---|
| title | Student Persistence Fields |
|---|
|
Parent/Spouse Persistence Field Name | Required/Optional | Description | Field Type | Field Options |
|---|
Contact Type | Optional | Upon the completion of the smart form, the question response for the question code selected here is persisted to the Contact Type field in the Parent/Spouse Reference Information section on the Student Details screen in Regent. | Dropdown | | SSN | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the SSN field in the Parent/Spouse Reference Information section on the Student Details screen in Regent. | Dropdown | | First Name | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the First Name field in the Parent/Spouse Reference Information section on the Student Details screen in Regent. | Dropdown | | Birth Date | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Date of Birth field in the Parent/Spouse Reference Information section on the Student Details screen in Regent. | Dropdown | | Middle Name | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Middle Name field in the Parent/Spouse Reference Information section on the Student Details screen in Regent. | Dropdown | | Citizenship Status | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Citizenship Status field in the Parent/Spouse Reference Information section on the Student Details screen in Regent. | Dropdown | | Last Name | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Last Name field in the Parent/Spouse Reference Information section on the Student Details screen in Regent. | Dropdown | | Ferpa | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the FERPA field in the Parent/Spouse Reference Information section on the Student Details screen in Regent. | Dropdown | | Manual plus borrower | Optional | This is a legacy setting and is no longer used. | Dropdown | | Note | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Note field in the Parent/Spouse Reference Information section on the Student Details screen in Regent. | Dropdown | | Phone Info | Type | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Phone Type field in the Parent/Spouse Reference Information → Phone Details on the Student Details screen in Regent. | Dropdown | | Source Type | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Source Type field (not editable) in the Parent/Spouse Reference Information → Phone Details on the Student Details screen in Regent. | Dropdown | | Number | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Number field in the Parent/Spouse Reference Information → Phone Details on the Student Details screen in Regent. | Dropdown | | Email Info | Type | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Email Type field in the Parent/Spouse Reference Information → Email Details on the Student Details screen in Regent. | Dropdown | | Source Type | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Source Type field (not editable) in the Parent/Spouse Reference Information → Email Details on the Student Details screen in Regent. | Dropdown | | Email | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Email Address field in the Parent/Spouse Reference Information → Email Details on the Student Details screen in Regent. | Dropdown | | Address Info | Type | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Address Type field in the Parent/Spouse Reference Information → Address Details on the Student Details screen in Regent. | Dropdown | | Source Type | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Source Type field (not editable) in the Parent/Spouse Reference Information → Address Details on the Student Details screen in Regent. | Dropdown | | Line 1 | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Line 1 field in the Parent/Spouse Reference Information → Address Details on the Student Details screen in Regent. | Dropdown | | Line 2 | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Line 2 field in the Parent/Spouse Reference Information → Address Details on the Student Details screen in Regent. | Dropdown | | City | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the City field in the Parent/Spouse Reference Information → Address Details on the Student Details screen in Regent. | Dropdown | | Zip Code | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the Postal Code field in the Parent/Spouse Reference Information → Address Details on the Student Details screen in Regent. | Dropdown | | State | Optional | Upon the completion of the Smart Form, the question response for the question code selected here is persisted to the State field in the Parent/Spouse Reference Information → Address Details on the Student Details screen in Regent. | Dropdown | |
|
Sections/Groups/Questions
Sections
In the Student Experience portal, each smart form Section will be listed in the menu for the smart form. Sections are presented in order based on the number entered in the Section > Sort Order field.
Two tabs are used to setup sections in the Smart Form Manager:
...
The Information tab provides basic setup information for the smart form Section, including Section Name and Sort Order.
| Expand |
|---|
|
Section Field Name | Required/Optional | Description | Field Type | Field Options |
|---|
Template Engine | Required | If static is selected, the field content is displayed in the same manner provided. If velocity is selected, a velocity templating engine is used that will allow for dynamic logic and display (see https://velocity.apache.org/engine/1.7/user-guide.html). | Dropdown | | Section Name | Required | The text entered in this field is displayed in the Smart Form menu in the Student Portal as the Menu Section Name. Section Names should be unique within the smart form. | Textbox | | Code | Required | The text entered here will be used as a short name to identify the Section in the Smart Form Manager. | Textbox Allows alpha-numeric characters without spaces | | Sort Order | Required | The number entered here will be used to sort Sections in the smart form from the lowest Sort Order to the highest Sort Order. | Numeric box | | Visible | Optional | If selected, the Section will be visible by default. If unselected, the Section will not be visible by default. Dependency logic can be used to display or hide the Section from its initial default state. | Checkbox | | Additional Information & Advanced Settings | Section Id | | A system-generated ID is created and associated when creating a new section. | Textbox (Read-only) | | Created At | | This is the date upon which a new section is created. | Textbox (Read-only) | | Modified At | | This is the last date upon which a section was modified. | Textbox (Read-only) | | Section Title | Optional | The text entered in this field is displayed at the top of the smart Form page. | Textbox | | Section Information | Optional | The text entered in this field is displayed at the top of the smart form page beneath the Section Title, if configured | Text Area | | Parent Information | Optional | The selection(s) in this section can be used as an identifier or in validation and dependency logic in the smart form. | Checkbox | Selected Unselected (Default)
|
|
Dependencies determine when a section will be presented within the smart form based on set rules. Dependencies can be applied at the Section, Group, and Question level. See Dependencies section below for more information.
Groups are used within each section to categorize questions. Each group is comprised of one or more questions. All questions contained within a group are organized beneath the Group name defined and displayed within each section. Groups display in the smart form in order based on the number entered in the Group Sort Order field.
...
Information - After the ‘Information’ screen is Saved for a newly created Group, the Dependencies screen is presented.
Dependencies
...
The Information tab provides basic setup information for the smart form Group, including Group Name and Sort Order.
| Expand |
|---|
|
Group Field Name | Required/Optional | Description | Field Type | Field Options |
|---|
Template Engine | Required | If static is selected, the field content is displayed in the same manner provided. If velocity is selected, a velocity templating engine is used that will allow for dynamic logic and display (see https://velocity.apache.org/engine/1.7/user-guide.html). | Dropdown | | Group Name | Required | The text entered in this field is displayed as a Group Title for a set of one or more questions within the smart form in the Student Portal. Group Names should be unique within the smart form. | Textbox | | Group Instructions | Optional | The text entered here is displayed as instructional messaging for the questions within the group. | Textbox | | Code | Required | The text entered here will be used as a short name to identify the Group in the Smart Form Manager. | Textbox Allows alpha-numeric characters without spaces | | Sort Order | Required | The number entered here will be used to sort Groups within the Section from the lowest Sort Order to the highest Sort Order. | Numeric | | Visible | Optional | If selected, the Group will be visible by default. If unselected, the Group will not be visible by default. Dependency logic can be used to display or hide the Group from its initial default state. | Checkbox | Selected Not Selected (Default)
| Page Index | Required | Groups can be displayed on different pages within each Section. The number entered here will be used to determine which page the Group is displayed on. | Numeric | | Groups Additional Information & Advanced Settings | Group Id | | A system-generated ID is created and associated when creating a new group. | | | Created At | | This is the date upon which a new group is created. | | | Modified At | | This is the last date upon which a group was modified. | | |
|
Dependencies determine when a group will be presented within the form based on set rules. Dependencies can be applied at Section, Group, and Question level. See Dependencies section below for more information.
Questions are displayed within each group. Each group is comprised of one or more questions. All questions contained within a group are organized beneath the group name defined and displayed within each section. Questions display in the smart form in order based on the number entered in the Question Sort Order field.
...
Information - After the ‘Information’ screen is Saved for a newly created Group, the other tabs are presented.
Dependencies
Validators
Options
...
The Information tab provides basic setup information for the smart form question, including Question Name and Sort Order.
...
| Expand |
|---|
|
Option Field Name | Required/Optional | Description | Field Type | Field Options |
|---|
Template Engine | Optional | If static is selected, the field content is displayed in the same manner provided. If velocity is selected, a velocity templating engine is used that will allow for dynamic logic and display (see https://velocity.apache.org/engine/1.7/user-guide.html). | Dropdown | | Option Text | Required | The text entered here displays as the option choice in the Smart Form (e.g. Yes, I am 18 years of age or older. No, I am not 18 years of age or older. | Textbox | | Option Value | Required | The text entered here will be used as a short name to identify the Option response for a completed Smart Form. This value is also used when writing expressions for Dependencies, Validation, and Document Persistence or when using Velocity templating language. | Textbox | | Sort Order | Required | The number entered here will be used to sort question options within the Field Type (e.g. dropdown) from the lowest Sort Order to the highest Sort Order. | Numeric | | Additional Information and Advanced Settings | Visible Expression | Optional | This field allows an expression to be provided by the user when to make an option visible under the defined conditions. Expressions use JavaScript language (see https://www.geeksforgeeks.org/javascript-regexpregular-expression/) to perform logical and mathematical operations to determine if the expression is true or false. | Textbox | | Program Types | Optional | This is legacy shortcut that is no longer used. | Textbox | | Program Years | Optional | This is legacy shortcut that is no longer used. | Textbox | |
|
Dependencies determine when a question will be presented within the form based on set rules. Dependencies can be applied at Section, Group, and Question level. See Dependencies section below for more information.
A validator can be created to prevent students from entering an invalid response for the question in the smart form, and display messaging to the user to indicate a valid response.
...
| Expand |
|---|
|
Validator Field Name | Required/Optional | Description | Field Type | Field Options |
|---|
Validator | Required | The selection here allows different types of validation logic to be entered. If the validation results in ‘true’ or ‘false’. | Dropdown | | Compare to Value | Optional | The value entered here is used to compare the Question response entered using the Compare Operator selected to determine if it is ‘true’ or ‘false’. For example, a Compare to Value = 1 (selected) and the Question response = 2 (unselected). If using an equals (=) operator, the compare logic will be ‘false’ and the Error Message will display. This field only displays when the Validator = Compare Validator. | Textbox | | Compare Operator | Optional | The operator selected here is used as the relationship between the Compare to Value and the Question response entered to determine if it is ‘true’ or ‘false’. For example, a Compare to Value = 1 (selected) and the Question response = 2 (unselected). If using an equals (=) operator, the compare logic will be ‘false’ and the Error Message will display. This field only displays when Validator = Compare Validator. | Dropdown | | Range min value | Optional | The value entered here is used as the minimum | | |
|
Question > Options
dkdfdkfjlkdjflkajdkl
| Expand |
|---|
|
Option Field Name | Required/Optional | Description | Field Type | Field Options |
|---|
Template Engine | Optional | If static is selected, the field content is displayed in the same manner provided. If velocity is selected, a velocity templating engine is used that will allow for dynamic logic and display (see https://velocity.apache.org/engine/1.7/user-guide.html). | Dropdown | | Option Text | Required | The text entered here displays as the option choice in the Smart Form (e.g. Yes, I am 18 years of age or older. No, I am not 18 years of age or older. | Textbox | | Option Value | Required | The text entered here will be used as a short name to identify the Option response for a completed Smart Form. This value is also used when writing expressions for Dependencies, Validation, and Document Persistence or when using Velocity templating language. | Textbox | | Sort Order | Required | The number entered here will be used to sort question options within the Field Type (e.g. dropdown) from the lowest Sort Order to the highest Sort Order. | Numeric | | Additional Information and Advanced Settings | Visible Expression | Optional | This field allows an expression to be provided by the user when to make an option visible under the defined conditions. Expressions use JavaScript language (see https://www.geeksforgeeks.org/javascript-regexpregular-expression/) to perform logical and mathematical operations to determine if the expression is true or false. | Textbox | | Program Types | Optional | This is legacy shortcut that is no longer used. | Textbox | | Program Years | Optional | This is legacy shortcut that is no longer used. | Textbox |
|
...
Dependencies
...
Smart forms can be designed to use conditional logic to tailor each Question to an individual applicant and minimize the number of Questions an applicant is required to answer by using Dependency logic. Dependencies use dynamic logic for Sections, Groups, and Questions to make visible or hide based on responses to Questions within the smart form. Dependencies also control if a Question is required when made visible or not. For example, a Dependency can be created to hide a Question, make a Question visible and required, or make a Question visible and optional (not required).
...
Dependency Groups can have multiple Dependency Rules with a different visibility or required field set for each. In the event of multiple Dependency Rules, a Dependency Group Type of ‘AND’ evaluates if all Dependency Rules are ‘true’ and makes the visible and required determination off of the last Dependency Rule evaluated to make the Dependency Group ‘true’. A Dependency Group Type of ‘OR’ evaluates if at least one Dependency Rule is ‘true’ and makes the visible and required determination off of the first Dependency Rule where the conditions are ‘true’.
Question-Based Dependency:
...
Expression-Based Dependency:
...
| Expand |
|---|
| title | Dependency Group Fields |
|---|
|
Dependency Group Field Name | Required/Optional | Description | Field Type | Field Options |
|---|
Description | Required | This field can be used to describe the logic of what the rules are intended to accomplish. For example, a Dependency Group Description may be called, ‘Student is Not Married' while the Dependency Rule(s) are made up of all non-married marital statuses. | Textbox | | Type | Required | This field determines the operator type that is used to evaluate the dependency rules. The ‘And’ operator type is used to determine if all Dependency Rules within the Dependency Group are ‘true’. The ‘Or’ operator type is used to determine if one or more Dependency Rules within the Dependency Group are ‘true’. | Dropdown | |
|
| Expand |
|---|
| title | Dependency Rule Fields |
|---|
|
Dependency Rule Field Name | Required/Optional | Description | Field Type | Field Options |
|---|
Rule Type | Required | A Question Based rule allows a user to select the Dependent Question from a dropdown with the applicable question response while an Expression Based rule allows a user to create a Boolean Expression which results in ‘true’ or ‘false’. | Dropdown | Question Based Expression Based
| Dependent Question | Required | The Smart Form Question selected here is used as part of the dependency logic determination. This field only displays when the Rule Type = Question Based. | Dropdown | | Question Option | Required | The Smart Form question response selected here is used as part of the dependency logic determination. This field only displays when the Rule Type = Question Based. | Dropdown | | Expression | Required | A Boolean Expression is built using javascript language to apply logical and mathematical operations for one or more Smart Form question(s) and response(s) as part of the dependency logic determination. This field only displays when the Rule Type = Expression Based. | Textbox | | Comparison Operator | Required | The operator selected here is used as the relationship between the Dependent Question and the Question Option. For example, a Dependent Question = ‘Are you married?’ and the Question Option = ‘Yes'. If using an equals (=) operator, the dependency logic would be, if Married question = Yes, dependency rule is ‘true’ and will be applied. This field only displays when the Rule Type = Question Based. | Dropdown | | Required | Optional | A selection here will make the Section, Group, or Question required if it is made visible. If unselected and the Section, Group, or Question is made visible but optional (not required). | Checkbox | | Visible | Optional | A selection here will make the Section, Group, or Question visible. If unselected, the Section, Group, or Question will not be visible. | Checkbox | | Additional Information and Advanced Settings | Rule Id | | A system-generated ID is created and associated when creating a new rule. | | | Created At | | This is the date upon which a new rule is created. | | | Modified At | | This is the last date upon which a rule was modified. |
|
...
Expressions
Expressions use JavaScript language (see https://www.geeksforgeeks.org/javascript-regexpregular-expression/) to perform logical and mathematical operations to determine if the expression is valid.
Document Persistence and Validators use Boolean Expressions to create a ‘true’ or ‘false’ statement. A Boolean Expression is defined using logical operator such as, AND (&&) and OR (||), which can be used in combination with built-in expressions (see Shortkeys and Helper Functions under the Expressions section for additional information), to result in a ‘true’ or ‘false’. Question responses are wrapped in braces (curly brackets) within the expression.the question code in curly braces. If an expression does not result in a ‘true’ or false', syntax errors are present and the expression is considered invalid. Document Persistence is ignored when an Invalid expression exists.
used 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.
For the expression based rules, by placing “@” symbol before the question code in expression, points the application to evaluate this question even if it is hidden. (@{studentsMaritalStatus})
If one of the dependant questions (in case of an expression based rule) is hidden then the whole expression will not be evaluated.
Comparison operator (=, >, <, >=, <=, !, <>, !=)
The symbols "<>" and "!=" are interchangeable operators that mean "not equal".
The Exclaimation point means logical not.f
The individual rules have the flags for visible and required. When different rules in the same dependency have different values for those flags, the first rule that is evaluated will trigger, and all subsequent rules in the dependency will be ignored.
Shortkeys:
| Expand |
|---|
|
Shortcut Name | Description |
|---|
| Automatically inserts the Federal Award Year of the smart form (e.g. 2024-2025). | | 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. | | This returns a special int which is essentially (max year of FAY)-2020. So for 2023-2024 FAY, the year code would be 4. | | This returns the Institution External ID from Regent | | This is legacy shortcut that is no longer used. | | This is legacy shortcut that is no longer used. | | This returns the Campus Name from Regent | | This returns the Campus External ID from Regent | | This returns the Site Name from Regent | | This returns the Site External ID from Regent | | This returns the Program Name from Regent | | This returns the Program External ID from Regent | | This returns the Program Type from Regent | | This returns the Section Code from Regent | | This returns the Campus ID from Regent | | Question values are referenced by using the following notation {questionCode} |
|
| Expand |
|---|
|
Helper Functions | | |
|---|
| | | | | | | 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.
| | | Returns number Checks 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
| | | Returns number Checks 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
| | | Returns number Checks to see how 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.
| | | | | | | | | | |
|
Questions:
Match configuration
Capability to create, update, or do nothing if a matched document for the student already exists based on the existing doc requirement status. User can select multiple statuses for update vs create. Status selection will be mutually exclusive (a doc status can only exist in one of the following items):
Does this mean that the ‘Status’ field is used to determine document status when paper sign option is selected?
Does this statement apply to DRP?
Where should this reside?
If changes are made, the client should use extreme caution by first making a copy and updating the Document configuration Smart Form Type/Code to use the client-created Smart Form. Any changes made directly to a Regent maintained Smart Form will be overridden upon a new release if enhancements or changes are made. Regent will not make changes to or maintain a ‘copy of’ a Regent-maintained Smart Form.
Is this correct?
...