-
Notifications
You must be signed in to change notification settings - Fork 10
[Expanded logic] Add documentation for new visibility and eligibility logic #594
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e02edc4
[Expanded logic] Add documentation for new visibility and eligibility…
AlvieH 9a7fa96
Respond to feedback - update SUMMARY.md
AlvieH c1cd539
Respond to feedback - update screenshots
AlvieH aa6b013
Update screenshot
AlvieH 1ced18d
Revert package-lock changes
AlvieH File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+33.1 KB
docs/.gitbook/assets/eligibility-condition-highlight-add-subcondition.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+48.6 KB
docs/.gitbook/assets/eligibility-condition-mutliple-subconditions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
105 changes: 105 additions & 0 deletions
105
docs/user-manual/civiform-admin-guide/manage-predicates.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| # Manage program eligibility and visibility | ||
|
|
||
| *Note: Unless otherwise noted, assume that directions apply to both eligibility and visibility logic.* | ||
|
|
||
| ## Eligibility | ||
|
|
||
| There are programs that may have strict criteria for eligibility. For example, if an Applicant’s date of birth is earlier than the qualifying year, they are ineligible for the program. | ||
|
|
||
| Using eligibility conditions, CiviForm Admins can screen applicants who don't meet the minimum requirements for a program early in the application process, as well as show applicants cases when there is a program they may qualify for, based on their previous answers. | ||
|
|
||
| ## Visibility | ||
|
|
||
| CiviForm Admins may wish to hide or show certain screens in certain cases to better control program flow. For example, if an Applicant stated they have no dependents in their most recent taxes, they can skip the screen in which applicants provide information on dependents. | ||
|
|
||
| Using visibility conditions, CiviForm Admins can show or hide certain program screens for applicants, based on their answers to questions on previous screens. | ||
|
|
||
| ## Adding new conditions | ||
|
|
||
| When viewing a screen in the program edit view, access to eligibility and visibility conditions are available at the "Add eligibility conditions" / "Add visibility conditions" buttons: | ||
|
|
||
|  | ||
|
|
||
| Clicking one of those will bring you to the edit view. You can add a new condition using the "Add Condition" button. | ||
|
|
||
|  | ||
|
|
||
| ### A note on available questions | ||
|
|
||
| There may be no available questions to use within conditions. Invalid question types include: | ||
|
|
||
| * File questions | ||
| * Enumerator questions. | ||
|
|
||
| If there are no available questions to use, you may see an alert like the following: | ||
|
|
||
|  | ||
|
|
||
| **Visibility conditions** take their questions from all previous program screens, so the alert will show as the following: | ||
|
|
||
|  | ||
|
|
||
| ## Editing conditions | ||
|
|
||
| On adding a condition, you will be greeted with an empty condition block: | ||
|
|
||
|  | ||
|
|
||
| On selecting a question, you will be able to enter values and control the logical conditions. | ||
|
|
||
| Admins can configure: | ||
| * **Question:** The question controlling the logic for this subcondition. | ||
| * **Field:** For question types with multiple pieces of data (e.g. "First Name", "Last Name"), which field is used for this subcondition. | ||
| * **State:** The logical operator for this subcondition (e.g. "Greater than", "Less than", "Equal to") | ||
| * **Value:** The value compared to the applicant's answer to this question, for eligibility and visibility decisions. | ||
|
|
||
| ***Example:** The following applicant will be eligible if they are between the ages of 18 and 35.* | ||
|
|
||
|  | ||
|
|
||
| ### Adding subconditions | ||
|
|
||
| You can add multiple *subconditions* within a condition using the "Add subcondition" button: | ||
|
|
||
|  | ||
|
|
||
| ***Example:** The following applicant will be eligible if they are between the ages of 18 and 35 **AND** they think a scoop of ice cream should cost $1.* | ||
|
|
||
|  | ||
|
|
||
| ### Multiple conditions | ||
|
|
||
| Multiple conditions can be composed together for more complex logic. | ||
|
|
||
| ***Example:** The following applicant will be eligible if (They are between the ages of 18 and 35 **AND** they think a scoop of ice cream should cost $1) **OR** They own a toaster.* | ||
|
|
||
|  | ||
|
|
||
| ## Saving conditions | ||
|
|
||
| Clicking the "Save and Exit" button at the bottom of the edit page brings you back to the program view. | ||
|
|
||
|  | ||
|
|
||
| The program view will now display the conditions that you set: | ||
|
|
||
|  | ||
|
|
||
| Clicking the "Edit eligibility conditions" button will return you to the edit view. | ||
|
|
||
|  | ||
|
|
||
| If a screen has *visibility conditions*, the program view will show an icon next to the screen title: | ||
|
|
||
|  | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Unable to add new conditions | ||
|
|
||
| **Problem:** In the rare case of a CiviForm internal error, you may see the following alert: | ||
|
|
||
|  | ||
|
|
||
| **Possible causes and solutions:** | ||
| - **Endpoint failures:** This could be due to a transient issue. Save, wait for a few (3-5) minutes and retry. If issues persist, check your endpoint logs for any errors during CiviForm's attempts to add new conditions. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.