You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user-docs/docs/user-guide.md
+45-18Lines changed: 45 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Building an Eligibility Screener
1
+
# User Guide
2
2
3
3
This section explains how to create, configure, test, and publish an eligibility screener using the Benefit Decision Toolkit (BDT).
4
4
@@ -48,45 +48,72 @@ These tabs represent the main stages of screener development.
48
48
49
49
The **Manage Benefits** tab is where you define the eligibility logic used by your screener.
50
50
51
-
A single screener can evaluate eligibility for one or multiple benefits. The evaluation logic for each benefit is configured separately. This design a single BDT screener to screens users for multiple related programs, while keeping management of each benefit seperate.
51
+
In the BDT platform, a **Benefit** is a configured set of eligibility rules that evaluates whether a user qualifies for a specific program.
52
52
53
-
> TODO: Add image of Manage Benefits tab
53
+
When a user submits information through the screener form:
54
54
55
-
### 3.1 Benefits Overview
55
+
1. The screener collects the user’s inputs.
56
+
2. BDT passes those inputs to each configured Benefit.
57
+
3. Each Benefit evaluates its eligibility rules.
58
+
4. The Benefit returns an eligibility result.
59
+
5. The result is displayed to the user on the front-end form.
56
60
57
-
When you open the **Manage Benefits** tab, you will see a list of benefits associated with the screener.
61
+
A single screener can evaluate eligibility for one or multiple benefits. Each benefit’s logic is configured independently within the **Manage Benefits** tab.
62
+
63
+
This allows a single screener to assess users for multiple related programs while keeping the eligibility rules for each benefit separate and manageable.
64
+
65
+
### 3.1 Manage Benefits Overview
66
+
67
+
The **Manage Benefits** tab displays all benefits configured for your screener.
58
68
59
69
From this page, you can:
60
70
61
-
- Create a new benefit
62
-
- Edit an existing benefit
63
-
-Remove a benefit
71
+
-**Create** a new benefit
72
+
-**Edit** an existing benefit
73
+
-**Delete** a benefit
64
74
65
-
Selecting a benefit opens the **Configure Benefit** page.
75
+
Selecting a benefit opens the **Configure Benefit** page, where you define or modify its eligibility rules.
66
76
67
77
> TODO: Add image of Configure Benefit page
68
78
69
79
---
70
80
71
81
## 4. Configuring a Benefit
72
82
73
-
The **Configure Benefit** page is where you define the rules that determine eligibility.
83
+
The **Configure Benefit** page is where you define the rules that determine whether a user qualifies for a specific benefit.
74
84
75
-
Eligibility logic in BDT is built using **Eligibility Checks**.
85
+
Each benefit contains one or more **Eligibility Checks**.
86
+
87
+
> A user is considered **eligible for the benefit only if all eligibility checks evaluate to `True`.**
88
+
89
+
---
76
90
77
91
### What Is an Eligibility Check?
78
92
79
93
An **Eligibility Check** is a reusable rule component that:
80
94
81
-
- Accepts one or more user inputs
95
+
- Accepts one or more user inputs (from your form)
82
96
- Evaluates a defined condition
83
-
- Returns a boolean result (True or False)
97
+
- Returns a boolean result (`True` or `False`)
98
+
99
+
You configure each check by selecting a check type and setting its parameters.
100
+
101
+
#### Example
102
+
103
+
Suppose a benefit requires that applicants:
104
+
105
+
- Be at least 65 years old
106
+
- Live in the state of California
107
+
108
+
You could configure:
84
109
85
-
For example, a rule might require applicants to be at least 65 years old. You could add a _Person Minimum Age_ check and configure the minimum age parameter to `65`.
110
+
- A **Person Minimum Age** check with a minimum age of `65`
111
+
- A **State of Residence** check set to `California`
86
112
87
-
By combining multiple checks, you define the full set of eligibility rules for a benefit.
113
+
If **both** checks return `True`, the user is eligible.
114
+
If **either** check returns `False`, the user is not eligible.
88
115
89
-
Currently, a benefit evaluates as **eligible** only if _all_ of its eligibility checks return `True`.
116
+
By combining multiple eligibility checks, you define the complete eligibility criteria for a benefit.
90
117
91
118
---
92
119
@@ -103,11 +130,11 @@ To use a check:
103
130
104
131
1. Select the check from the list
105
132
2. Click **Add**
106
-
3.Configure its parameters
133
+
3.Add values for each of its required configuration parameters
107
134
108
135
Once added, the check appears in the benefit’s list of configured checks.
109
136
110
137
> TODO: Add image of check list
111
138
> TODO: Add image of check parameter configuration
112
139
113
-
For information about creating reusable custom checks, see **Creating Custom Checks**.
140
+
For information about creating reusable custom checks, see [Custom Checks](custom-checks.md).
0 commit comments