Groups

...

Questions

Questions are displayed within each Group 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 Questions display in numerical order from lowest to highest based within the Group on the number entered in the Group Question Sort Order field.

...

Expand
title Group Question Fields
Expand
title Question Fields
Group Question Field Name Required/Optional Group Question Field Description Group Question Field Type Group Question Field Options Template Engine Field Type 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	Static (Default) Velocity	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.	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.

Questions

Questions are displayed within each Group 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. Questions display in numerical order from lowest to highest based within the Group on the number entered in the Question Sort Order field.

...

Pre-populate Question Response from Question Field Name Required/Optional Question Field Description Question Field Type Question Field Options Field Type Required The selection here will be used to determine the question selection type. Dropdown Textbox Dropdown RadioButton Date SSN Autosize Dropdown MMDDYYYY Dropdown HyperlinkButton Text Only MMYYYY Dropdown Date Text Area Checkbox Currency - Whole Dollar Phone Data Type Required The Data Type entered here will determine how the value is saved in the database and the available operators in the Regent Query Tool. If this field is not selected, the question is not available as an option in the Regent Query Tool. Dropdown Text Amount Date Number 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 Static (Default) Velocity Question Required The text entered in this field is displayed as the question with the Group and Section on the Smart Form in the Student Portal. Textbox Help Text Optional The text entered here will display as help text beneath the question in the Smart Form. Textbox Code Required The text entered here will be used as a short name to identify the question in the Smart Form Manager. Textbox Allows alpha-numeric characters without spaces Sort Order Required The number entered here will be used to sort questions within the Group from the lowest Sort Order to the highest Sort Order. Numeric Optional If ‘Prior Smart Form’ is selected, the question response is pre-populated from the most recently completed Smart Form with the same Smart Form Type, regardless of the FAY scope. If ‘Prior Smart Form with same FAY’ is selected, the question response is pre-populated from the most recently completed Smart Form with the same Smart Form Type and the same FAY scope. If ‘None’ is selected, the question response presented in the Smart Form is not pre-populated. Dropdown None (Default) Prior Smart Form Prior Smart Form with same FAY Default Question Response Optional The text or input value entered here will be used to pre-populate the response for the question in the Smart Form based on predefined Regent data or one of the available options. Textbox Maximum Number of Characters Allowed in Response Optional The number entered here will be used to as the limit for the number of characters allowed in the user response for this question when completing the Smart Form. Numeric Maximum Characters: 10 Required Optional When this field is selected, the question requires a response in the Smart Form. If selected, this question is always displayed if the section and group are displayed and takes precedence over the ‘visible’ setting for the question. If dependency logic is desired for the question, the ‘visible’ setting should be used to display or hide the question from its initial default stateThe selection here will be used to determine the question selection type. Dropdown Textbox Dropdown RadioButton Date SSN Autosize Dropdown MMDDYYYY Dropdown HyperlinkButton Text Only MMYYYY Dropdown Date Text Area Checkbox Currency - Whole Dollar Phone Data Type Required The Data Type entered here will determine how the value is saved in the database and the available operators in the Regent Query Tool. If this field is not selected, the question is not available as an option in the Regent Query Tool. Dropdown Text Amount Date Number 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 Static (Default) Velocity Question Required The text entered in this field is displayed as the question with the Group and Section on the Smart Form in the Student Portal. Textbox Help Text Optional The text entered here will display as help text beneath the question in the Smart Form. Textbox Code Required The text entered here will be used as a short name to identify the question in the Smart Form Manager. Textbox Allows alpha-numeric characters without spaces Sort Order Required The number entered here will be used to sort questions within the Group from the lowest Sort Order to the highest Sort Order. Numeric Pre-populate Question Response from Optional If ‘Prior Smart Form’ is selected, the question response is pre-populated from the most recently completed Smart Form with the same Smart Form Type, regardless of the FAY scope. If ‘Prior Smart Form with same FAY’ is selected, the question response is pre-populated from the most recently completed Smart Form with the same Smart Form Type and the same FAY scope. If ‘None’ is selected, the question response presented in the Smart Form is not pre-populated. Dropdown None (Default) Prior Smart Form Prior Smart Form with same FAY Default Question Response Optional The text or input value entered here will be used to pre-populate the response for the question in the Smart Form based on predefined Regent data or one of the available options. Textbox Maximum Number of Characters Allowed in Response Optional The number entered here will be used to as the limit for the number of characters allowed in the user response for this question when completing the Smart Form. Numeric Maximum Characters: 10 Required Optional When this field is selected, the question requires a response in the Smart Form. If selected, this question is always displayed if the section and group are displayed and takes precedence over the ‘visible’ setting for the question. If dependency logic is desired for the question, the ‘visible’ setting should be used to display or hide the question from its initial default state. Checkbox Selected Not Selected (Default) Visible Optional If selected, the Question will be visible by default. If unselected, the Question will not be visible by default. Dependency logic can be used to display or hide the Question from its initial default state. Checkbox Selected Not Selected (Default) Read Only Optional When this selection is selected, no question options will be required or available. Checkbox Selected Not Selected (Default) Questions Additional Information and Advanced Settings Question Id A system-generated ID is created and associated when creating a new question. Created At This is the date upon which a new question is created. Modified At This is the last date upon which a question was modified. Reset Response if Hidden Optional When this field is selected, the question response will revert back to the original default response value (e.g. blank, unselected) if the question is subsequently hidden due to smart logic. For example, if a user answers ‘Yes’ to this question then changes a prior question that forces this question to no longer display, the response value is then reverted back to the original default response value. Checkbox Selected Not Selected (Default) Reset Response if Restarted Optional When this field is selected, the question response will revert back to the original default response value (e.g. blank, unselected) if the question is subsequently displayed after being hidden due to smart logic. Checkbox Selected Not Selected (Default) Auto Capitalize Optional When this field is selected, the response will be user response in the Smart Form is automatically updated to all capital letters. Checkbox Selected Not Selected (Default) Options Expression Optional This field allows an expression to be provided by the user when to display an option 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 Secure Optional This is a legacy setting and is no longer used. Checkbox Selected Not Selected (Default) Visible Optional If selected, the Question will be visible by default. If unselected, the Question will not be visible by default. Dependency logic can be used to display or hide the Question from its initial default state. Checkbox Selected Not Selected (Default) Read Only Optional When this selection is selected, no question options will be required or available. Checkbox Selected Not Selected (Default) Questions Additional Information and Advanced Settings Question Id A system-generated ID is created and associated when creating a new question. Created At This is the date upon which a new question is created. Modified At This is the last date upon which a question was modified. Reset Response if Hidden Optional When this field is selected, the question response will revert back to the original default response value (e.g. blank, unselected) if the question is subsequently hidden due to smart logic. For example, if a user answers ‘Yes’ to this question then changes a prior question that forces this question to no longer display, the response value is then reverted back to the original default response value. Checkbox Selected Not Selected (Default) Reset Response if Restarted Optional When this field is selected, the question response will revert back to the original default response value (e.g. blank, unselected) if the question is subsequently displayed after being hidden due to smart logic. Checkbox Selected Not Selected (Default) Auto Capitalize Optional When this field is selected, the response will be user response in the Smart Form is automatically updated to all capital letters. Checkbox Selected Not Selected (Default) Options Expression Optional This field allows an expression to be provided by the user when to display an option 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 Secure Optional This is a legacy setting and is no longer used. Checkbox Selected Not Selected (Default)

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 Not Required.

A Section, Group, or Question can have one or more Dependency groups. Each Dependency group is comprised of one or more Dependency rules. Each Dependency group uses a selected Compare Operator of ‘AND’ or ‘OR' when evaluating if the Dependency rule(s) are 'true’.

Dependency Comparison Operator

• The "AND" Compare Operator is used to determine if ALL Dependency Rules are true.

• The "OR" Compare Operator is used to determine if one or more Dependency Rules are true.

Tip: It's recommended that you set a Section/Groups/Questions visibility to a base visibility, and then only create rules which change the visibility. This way you do not have conflicting dependencies or dependency rules (one rule which makes it hidden, and another rule which makes it visible). If both rules evaluate to true, then it can be more complicated to determine which rules visibility applies. For instance, perhaps you set a Section's visibility to hidden, and then only create dependencies/dependency rules that make it visible. See the "Competing Dependencies Example" in Examples section below.

Dependency Rules

• Rules can be a two types: question based or expression based

  • Question based rules are the rules that makes target object dependant of the value of another question in the application.

  • Expression based rules are the rules that are evaluated using an expression provided by the user. This expression is based on the javascript language. A single rule expression can be build on one or more dependent questions using various logical and mathematical operations. Question values are referenced by using the following notation {questionCode}

• 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.

• The dependency rules are evaluated in the order they were added to the database.

• Every rule has the following information:

  • Comparison operator (=, >, <, >=, <=, !, <>, !=)

    • The symbols "<>" and "!=" are interchangeable operators that mean "not equal".

    • The Exclaimation point means logical not.

  • Dependent question option id

  • Expression

  • Required Flag

  • Visible Flag

• Rules can be a two types: question based or expression based

  • Question based rules are the rules that makes target object dependant of the value of another question in the application.

  • Expression based rules are the rules that are evaluated using an expression provided by the user. This expression is based on the javascript language. A single rule expression can be build on one or more dependent questions using various logical and mathematical operations. Question values are referenced by using the following notation {questionCode}

  • Logical evaluations can be strung together using logical AND (&&) and logical OR (||).  These kind of conditions allow multiple comparisons to determine the ultimate result of the expression.  The words "AND" and "OR" are interchangeable with "&&" and "||", respectively.

    • SnapUtility.EqualOfAny('hi', 'is', 'hi', 'here') && SnapUtility.IsCurrentDateBefore('01/01/2013') - returns false because both conditions must be true for the expression to be true.

    • SnapUtility.IsCurrentDateBefore('01/01/2013') || SnapUtility.EqualOfAny('hi', 'is', 'hi', 'here') - returns true because at least one of the conditions is true.

  • Several Helper functions are provided:

    • UpperCase - returns string - Converts the argument to UPPER CASE. eg: SnapUtility.UpperCase("upper case") returns "UPPER CASE".

    • Trim - returns string - Removes leading and trailing whitespace.  eg: SnapUtility.Trim("   Hello   ") returns "Hello".

    • TrimUpper - returns string - Performs both UpperCase and Trim commands.

    • EqualOfAny - returns boolean - Performs TrimUpper and checks if the first argument is in the list of remaining arguments (this function is case insensitive).  eg: SnapUtility.EqualOfAny("Hi", "Does", "hi", "exist") returns true.

    • IsNumber - returns number - Checks to see if the first argument is a number.  If it is not, the second argument is returned.  eg: SnapUtility.IsNumber("Dog", -1) returns -1.

    • CheckNumber

    • CompareDate - 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.

    • 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.

    • IsCurrentDateAfter - returns boolean - Checks if the current date falls after a specified date.  eg: SnapUtility.IsCurrentDateAfter('01/01/2013') 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'.

  • If a dependant question is hidden (visibleFlag = 0) then the dependency rule is not evaluated and always returns false.

  • 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.

  • Because visibility / required flags are set on the Rule level it is possible to have one rule which sets something to hidden and another rule which sets something to visible in the same dependency.

    • For AND dependencies, the visibility / required flag of the last rule will be used

    • For OR dependencies, the visibility / reguired flag of the first triggered rule (rule with conditions met) will be used. 

• If there are multiple Dependencies, each with its own set of Dependency Rules then the following evaluation process will take place:

  • All dependencies and its dependency rules are read from the database in the order they were added.

  • Application starts to evaluate dependency rules

  • Application checks the current rule’s dependant question’s status. If a dependant question is hidden then the rule is ignored.

  • In case of an expression based rule, application checks every question’s status that is met in the expression. If one of the questions is hidden and does not have status ignoring symbol then the whole expression is ignored.

Dependency Examples

1. /wiki/spaces/SNAP/pages/8716538

...

Validations

https://velocity.apache.org/engine/1.7/user-guide.html

https://www.geeksforgeeks.org/javascript-regexpregular-expression/

Document Requirement Persistence

1. Condition (expression) -> an optional javascript expression, similar to dependency / complex validator expressions which can be set. If it's set, the doc req will only attempt to persist if the expression results in true. Will handle {questionCode} formatting. No special logic for whether questions are hidden, visible, etc.

Will handle {questionCode} formatting.

Examples

Example 1

1. Student starts a Verification Worksheet smart form application.

2. Student indicates No, I have already filed a tax return SNAP smart form questionnaire.

3. Student completes and signs their Verification Worksheet.

4. A 2015 Student Filing Extension Granted by the IRS document requirement is created for the student.

5. Student starts a Verification Worksheet - Change smart form application.

6. Student indicates No, I have already filed a tax return.

7. Student completes and signs their Verification Worksheet.

8. A 2015 Student Filing Extension Granted by the IRS document requirement does not get created for the student.

...

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 Not Required.

A Section, Group, or Question can have one or more Dependency groups. Each Dependency group is comprised of one or more Dependency rules. Each Dependency group uses a selected Compare Operator of ‘AND’ or ‘OR' when evaluating if the Dependency rule(s) are 'true’.

Dependency Comparison Operator

• The "AND" Compare Operator is used to determine if ALL Dependency Rules are true.

• The "OR" Compare Operator is used to determine if one or more Dependency Rules are true.

Tip: It's recommended that you set a Section/Groups/Questions visibility to a base visibility, and then only create rules which change the visibility. This way you do not have conflicting dependencies or dependency rules (one rule which makes it hidden, and another rule which makes it visible). If both rules evaluate to true, then it can be more complicated to determine which rules visibility applies. For instance, perhaps you set a Section's visibility to hidden, and then only create dependencies/dependency rules that make it visible. See the "Competing Dependencies Example" in Examples section below.

Dependency Rules

• Rules can be a two types: question based or expression based

  • Question based rules are the rules that makes target object dependant of the value of another question in the application.

  • Expression based rules are the rules that are evaluated using an expression provided by the user. This expression is based on the javascript language. A single rule expression can be build on one or more dependent questions using various logical and mathematical operations. Question values are referenced by using the following notation {questionCode}

• 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.

• The dependency rules are evaluated in the order they were added to the database.

• Every rule has the following information:

  • Comparison operator (=, >, <, >=, <=, !, <>, !=)

    • The symbols "<>" and "!=" are interchangeable operators that mean "not equal".

    • The Exclaimation point means logical not.

  • Dependent question option id

  • Expression

  • Required Flag

  • Visible Flag

• Rules can be a two types: question based or expression based

  • Question based rules are the rules that makes target object dependant of the value of another question in the application.

  • Expression based rules are the rules that are evaluated using an expression provided by the user. This expression is based on the javascript language. A single rule expression can be build on one or more dependent questions using various logical and mathematical operations. Question values are referenced by using the following notation {questionCode}

  • Logical evaluations can be strung together using logical AND (&&) and logical OR (||).  These kind of conditions allow multiple comparisons to determine the ultimate result of the expression.  The words "AND" and "OR" are interchangeable with "&&" and "||", respectively.

    • SnapUtility.EqualOfAny('hi', 'is', 'hi', 'here') && SnapUtility.IsCurrentDateBefore('01/01/2013') - returns false because both conditions must be true for the expression to be true.

    • SnapUtility.IsCurrentDateBefore('01/01/2013') || SnapUtility.EqualOfAny('hi', 'is', 'hi', 'here') - returns true because at least one of the conditions is true.

  • Several Helper functions are provided:

    • UpperCase - returns string - Converts the argument to UPPER CASE. eg: SnapUtility.UpperCase("upper case") returns "UPPER CASE".

    • Trim - returns string - Removes leading and trailing whitespace.  eg: SnapUtility.Trim("   Hello   ") returns "Hello".

    • TrimUpper - returns string - Performs both UpperCase and Trim commands.

    • EqualOfAny - returns boolean - Performs TrimUpper and checks if the first argument is in the list of remaining arguments (this function is case insensitive).  eg: SnapUtility.EqualOfAny("Hi", "Does", "hi", "exist") returns true.

    • IsNumber - returns number - Checks to see if the first argument is a number.  If it is not, the second argument is returned.  eg: SnapUtility.IsNumber("Dog", -1) returns -1.

    • CheckNumber

    • CompareDate - 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.

    • 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.

    • IsCurrentDateAfter - returns boolean - Checks if the current date falls after a specified date.  eg: SnapUtility.IsCurrentDateAfter('01/01/2013') 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'.

  • If a dependant question is hidden (visibleFlag = 0) then the dependency rule is not evaluated and always returns false.

  • 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.

  • Because visibility / required flags are set on the Rule level it is possible to have one rule which sets something to hidden and another rule which sets something to visible in the same dependency.

    • For AND dependencies, the visibility / required flag of the last rule will be used

    • For OR dependencies, the visibility / reguired flag of the first triggered rule (rule with conditions met) will be used. 

• If there are multiple Dependencies, each with its own set of Dependency Rules then the following evaluation process will take place:

  • All dependencies and its dependency rules are read from the database in the order they were added.

  • Application starts to evaluate dependency rules

  • Application checks the current rule’s dependant question’s status. If a dependant question is hidden then the rule is ignored.

  • In case of an expression based rule, application checks every question’s status that is met in the expression. If one of the questions is hidden and does not have status ignoring symbol then the whole expression is ignored.

Dependency Examples

1. /wiki/spaces/SNAP/pages/8716538

...

Validations

https://velocity.apache.org/engine/1.7/user-guide.html

https://www.geeksforgeeks.org/javascript-regexpregular-expression/

Document Requirement Persistence

1. Condition (expression) -> an optional javascript expression, similar to dependency / complex validator expressions which can be set. If it's set, the doc req will only attempt to persist if the expression results in true. Will handle {questionCode} formatting. No special logic for whether questions are hidden, visible, etc.

Will handle {questionCode} formatting.

Examples

Example 1

1. Student starts a Verification Worksheet smart form application.

2. Student indicates No, I have already filed a tax return SNAP smart form questionnaire.

3. Student completes and signs their Verification Worksheet.

4. A 2015 Student Filing Extension Granted by the IRS document requirement is created for the student.

5. Student starts a Verification Worksheet - Change smart form application.

6. Student indicates No, I have already filed a tax return.

7. Student completes and signs their Verification Worksheet.

8. A 2015 Student Filing Extension Granted by the IRS document requirement does not get created for the student.

Example 2

Given:

1. Verification Worksheet for FAY

   1. W-2 document, scope uniqueness is turned off in REM

   2. Student selects "Will Not File"

   3. Student indicates that they received a W-2 from Employer 1 and provides information for Employer 1

   4. Student indicates that they received a W-2 from Employer 2 and provides information for Employer 2

When:

1. Student completes and signs the Verification Worksheet - Change smart form for same FAY

   1. Student selects "Will Note File"

   2. Student indicates that they received a W-2 from Employer 1 and provides information for Employer 1 (Employer A)

   3. Student indicates that they received a W-2 from Employer 2 and provides information for Employer 2 (Employer B)

   4. Student indicates that they received a W-2 from Employer 3 and provides information for Employer 3 (Employer C)

Then:

1. A new, needed, W-2 document is created in REM, with the reason set to the name of Employer 3 (Employer C)

Example 3

Given:

1. Verification Worksheet for FAY

   1. W-2 document, scope uniqueness is turned off in REM

   2. Student selects "Will Not File"

   3. Student indicates that they received a W-2 from Employer 1 and provides information for Employer 1 (Employer A)

   4. Student indicates that they received a W-2 from Employer 2 and provides information for Employer 2 (Employer B)

When:

1. Student completes and signs the Verification Worksheet - Change smart form for same FAY

   1. Student selects "Will Note File"

   2. Student updates the information for Employer 1 to Employer B

   3. Student updates the information for Employer 2 to Employer C

   4. Student deletes the information for Employer 3

Then:

1. The W-2 for Employer A is waived

2. The W-2 for Employer B remains unchanged

3. The W-2 for Employer C is created with a needed status

Example 4

Given:

1. Verification Worksheet for FAY

   1. W-2 document, scope uniqueness is turned off in REM

   2. Student selects "Will Not File"

   3. Student indicates that they received a W-2 from Employer 1 and provides information for Employer 1 (Employer A)

   4. Student indicates that they received a W-2 from Employer 2 and provides information for Employer 2 (Employer B)

When:

1. User changes W-2 for Employer A to satisfied in REM

2. Student completes and signs the Verification Worksheet - Change smart form for same FAY

   1. Student selects "Will Note File"

   2. Student indicates that they received a W-2 from Employer 1 and provides information updates the information for Employer 1 (to Employer A)B

   3. Student indicates that they received a W-2 from Employer 2 and provides updates the information for Employer 2 (to Employer B)C

   4. Student indicates that they received a W-2 from Employer 3 and provides deletes the information for Employer 3 (Employer C)

   5. REM

Then:

1. A new, needed, The W-2 for Employer A is unchanged

2. The W-2 for Employer B remains unchanged

3. The W-2 document for Employer C is created in REM, with the reason set to the name of Employer 3 (Employer C)

Example 3

Given:

1. Verification Worksheet for FAY

   1. W-2 document, scope uniqueness is turned off in REM

   2. Student selects "Will Not File"

   3. Student indicates that they received a W-2 from Employer 1 and provides information for Employer 1 (Employer A)

   4. Student indicates that they received a W-2 from Employer 2 and provides information for Employer 2 (Employer B)

When:

1. Student completes and signs the Verification Worksheet - Change smart form for same FAY

   1. Student selects "Will Note File"

   2. Student updates the information for Employer 1 to Employer B

   3. Student updates the information for Employer 2 to Employer C

   4. Student deletes the information for Employer 3

Then:

1. The W-2 for Employer A is waived

2. The W-2 for Employer B remains unchanged

3. The W-2 for Employer C is created with a needed status

Example 4

Given:

1. Verification Worksheet for FAY

   1. W-2 document, scope uniqueness is turned off in REM

   2. Student selects "Will Not File"

   3. Student indicates that they received a W-2 from Employer 1 and provides information for Employer 1 (Employer A)

   4. Student indicates that they received a W-2 from Employer 2 and provides information for Employer 2 (Employer B)

When:

1. User changes W-2 for Employer A to satisfied in REM

2. Student completes and signs the Verification Worksheet - Change smart form for same FAY

   1. Student selects "Will Note File"

   2. Student updates the information for Employer 1 to Employer B

   3. Student updates the information for Employer 2 to Employer C

   4. Student deletes the information for Employer 3

   5. REM

Then:

1. The W-2 for Employer A is unchanged

2. The W-2 for Employer B remains unchanged

3. The W-2 for Employer C is created with a needed status

Technical Details

1. Condition (expression) -> an optional javascript expression, similar to dependency / complex validator expressions which can be set. If it's set, the doc req will only attempt to persist if the expression results in true. Will handle {questionCode} formatting. No special logic for whether questions are hidden, visible, etc.

2. 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):

3. Update On Match Statuses: (selected document statuses)

4. Create On Match Statuses: (selected document statuses)

5. Otherwise ignore

6. Can configure to create the document if there is no match

7. Scope: STUDENT or FEDERALAWARDYEAR

8. Status: NEEDED,SATISFIED,UNSATISFIED,RECEIVED,INCOMPLETE,WAIVED

9. Status doc will be saved as if the questionnaire is not an esign questionnaire, or it is an esign questionnaire but user did not esign (they paper signed instead)

10. ESignedStatus: NEEDED,SATISFIED,UNSATISFIED,RECEIVED,INCOMPLETE,WAIVED

11. Document will be created or updated with this status if it's an ESIGN questionnaire and the user did choose to E-sign

12. FEDERALAWARDYEAR will be set to Federal Award Year of questionnaire

13. Supported entry types: AddressRelated, AwardRelated, AuditRelated, COARelated, CODRelated, DisbursementRelated, DocumentRelated, EnrollmentRelated, ISIRRelated, NeedRelated, PLUSRelated, PJRelated, QARelated, ResourceRelated, R2T4Related, SAPRelated, SBLLoad, ServiceRelated, VerificationRelated, CommunicationRelated, Other, ESTRelated, WorkStudyRelated

14. Attachment Type: None, PdfTemplate, FAFSA

15. None - no attachment stored in REM

16. PdfTemplate - Indicates a PDF attachment will be created based on the value of Attachment Template

17. FAFSA - The standard Dept. Of Ed. FAFSA (that matches fed award year of questionnaire) will be pre-populated from the SNAP questionnaire.

10. Attachment File Name: string of file name as stored in REM

11. Attachment Template - string field which will take a named velocity template. Note - this velocity template MUST exist in the theme the questionnaire is processed with, otherwise an "Template 'templatename' does not exist." error will be thrown at time of application processing.

1. Notes about fields which are not configurable

2. Letter correspondence date -> ignored by snap

3. Email correspondence date -> ignored by snap

4. Activity Source Type - STUDENTACTION always used

5. Message - will use the message as set up in REM document setup

6. Reason - will use the reason as set up in REM document setup

7. Received Date - Will rely on REM services automatically setting to current datetime if existing received date is null (or we are creating doc) and status is RECEIVED or SATISFIED

8. Reviewed Date - Will rely on REM services automatically setting to current datetime if existing reviewed date is null (or we are creating doc) and status is SATISFIED

9. This configuration will be included in when a questionnaire is copied, exported, or imported.

10. EFAFSA:

11. Will persist as the current EnableEFAFSAPersistence configuration setting dictates (which can be scoped for the whole snap instance, or scoped to questionnaire which takes precedence)

12. Student demographic fields: These will be handled in another JIRA issue to facilitate testing

13. Management screens in SNAP admin pages (Persistence link/button on questionnaire detail page).

Related Tickets

SNAP-2899 - SNAP questionnaires can be configured to persist document requirements to REM upon app completion

...

1. with a needed status

Technical Details

1. Condition (expression) -> an optional javascript expression, similar to dependency / complex validator expressions which can be set. If it's set, the doc req will only attempt to persist if the expression results in true. Will handle {questionCode} formatting. No special logic for whether questions are hidden, visible, etc.

2. 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):

3. Update On Match Statuses: (selected document statuses)

4. Create On Match Statuses: (selected document statuses)

5. Otherwise ignore

6. Can configure to create the document if there is no match

7. Scope: STUDENT or FEDERALAWARDYEAR

8. Status: NEEDED,SATISFIED,UNSATISFIED,RECEIVED,INCOMPLETE,WAIVED

9. Status doc will be saved as if the questionnaire is not an esign questionnaire, or it is an esign questionnaire but user did not esign (they paper signed instead)

10. ESignedStatus: NEEDED,SATISFIED,UNSATISFIED,RECEIVED,INCOMPLETE,WAIVED

11. Document will be created or updated with this status if it's an ESIGN questionnaire and the user did choose to E-sign

12. FEDERALAWARDYEAR will be set to Federal Award Year of questionnaire

13. Supported entry types: AddressRelated, AwardRelated, AuditRelated, COARelated, CODRelated, DisbursementRelated, DocumentRelated, EnrollmentRelated, ISIRRelated, NeedRelated, PLUSRelated, PJRelated, QARelated, ResourceRelated, R2T4Related, SAPRelated, SBLLoad, ServiceRelated, VerificationRelated, CommunicationRelated, Other, ESTRelated, WorkStudyRelated

14. Attachment Type: None, PdfTemplate, FAFSA

15. None - no attachment stored in REM

16. PdfTemplate - Indicates a PDF attachment will be created based on the value of Attachment Template

17. FAFSA - The standard Dept. Of Ed. FAFSA (that matches fed award year of questionnaire) will be pre-populated from the SNAP questionnaire.

10. Attachment File Name: string of file name as stored in REM

11. Attachment Template - string field which will take a named velocity template. Note - this velocity template MUST exist in the theme the questionnaire is processed with, otherwise an "Template 'templatename' does not exist." error will be thrown at time of application processing.

1. Notes about fields which are not configurable

2. Letter correspondence date -> ignored by snap

3. Email correspondence date -> ignored by snap

4. Activity Source Type - STUDENTACTION always used

5. Message - will use the message as set up in REM document setup

6. Reason - will use the reason as set up in REM document setup

7. Received Date - Will rely on REM services automatically setting to current datetime if existing received date is null (or we are creating doc) and status is RECEIVED or SATISFIED

8. Reviewed Date - Will rely on REM services automatically setting to current datetime if existing reviewed date is null (or we are creating doc) and status is SATISFIED

9. This configuration will be included in when a questionnaire is copied, exported, or imported.

10. EFAFSA:

11. Will persist as the current EnableEFAFSAPersistence configuration setting dictates (which can be scoped for the whole snap instance, or scoped to questionnaire which takes precedence)

12. Student demographic fields: These will be handled in another JIRA issue to facilitate testing

13. Management screens in SNAP admin pages (Persistence link/button on questionnaire detail page).

Related Tickets

SNAP-2899 - SNAP questionnaires can be configured to persist document requirements to REM upon app completion

Student Portal: Create new function for Document Requirement Persistence (DRP) Reason Expression

Expressions

When configuring a DRP, 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'.

Shortkeys:

Expand
title Shortkeys
Shortcut Name Description {fay) Automatically inserts the Federal Award Year of the Smart Form (e.g. 2024-2025). {YearDescription} Name of smart form {YearCode} This returns a special int which is essentially (max year of FAY)-2010. So for 2018-2019 FAY, the year code would be 9. {InstitutionExternalId} {LocationName} legacy {LocationExternalId} legacy {CampusName} {CampusExternalId} {SiteName} {SiteExternalId} {ProgramName} {ProgramExternalId} {ProgramType}

When configuring a DRP, 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'.

Shortkeys:

Expand
title Shortkeys
Shortcut Name Description {fay) Automatically inserts the Federal Award Year of the Smart Form (e.g. 2024-2025). {YearDescription} Name of smart form {YearCode} This returns a special int which is essentially (max year of FAY)-2010. So for 2018-2019 FAY, the year code would be 9. {InstitutionExternalId} {LocationName} legacy {LocationExternalId} legacy {CampusName} {CampusExternalId} {SiteName} {SiteExternalId} {ProgramName} {ProgramExternalId} {ProgramType}