This documentation is effective as of Regent Release 6.5.0.0.
...
Note |
---|
PLEASE NOTE the following important warnings and guidance regarding 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, which can subsequently be imported into another environment via the Import Smart Form in the treeview menu.
...
General Smart Form Setup
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:
...
Note |
---|
Clients must use caution when adding document persistence for documents that are configured to ‘Block Packaging’ or ‘Block Disbursements’. If incorrectly addedpersistence is inaccurate, funds can be may not be packaged and/or disbursed as expected. |
Persistence is the automated creation or assignment of defined data within Regent. Document Persistence allows users to create rules using regular expressions to add or update a document requirement in Regent -- see https://www.geeksforgeeks.org/javascript-regexpregular-expression/. Persisted document requirements are added and updated upon the completion of the smart form, including signature(s). The document requirement is only added or updated if the expression results are true. For example, if a student selects the response, ‘I was married at the time of FAFSA completion but am no longer married’ to a smart form question, Document Persistence can be created to add a Divorce Decree document requirement with a status of ‘Needed’ to collect the additional documentation required based on the student response.
...
A smart form is comprised of Sections, which are comprised of Groups, which are comprised of 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.
...
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 whether 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. The individual rules have configurable options for visible and required. When different rules in the same Dependency Group have different visible and required options, the first rule that is evaluated will be honored, and all subsequent rules in the Dependency Group will be ignored. 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’.
...
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 in this 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 is in curly braces.
The SnapUtility.ReasonEqualToAny is a special function that cannot 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, if one of the dependent questions is hidden. then the whole expression will not be evaluated. However, including“@” before the question code in the expression will allow the smart form to evaluate the question even if it is hidden. Example: (@{studentsMaritalStatus})
Comparison operators (=, >, <, >=, <=, !, <>, !=)
The following comparison operators are used within the expressions:
=
>
<
>=
<=
!
<>
!=
Note: "<>" and "!=" are interchangeable operators that mean "not equal".
...
“!” means logical not.
...
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.
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
...
|
Expand | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
...
|
...
|
...
|
...
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?
Status doc will be saved as if the questionnaire is not an esign questionnaire, or it is an esign questionnaire but user did not resign (they paper signed instead)
...
Does this statement apply to DRP?
No special logic for whether questions are hidden, visible, etc.
Is this correct?
...
|