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/index.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,8 @@ An **eligibility screener** is a web-based form that:
16
16
2. Evaluates that information against defined eligibility rules
17
17
3. Displays eligibility results based on the evaluation
18
18
19
+

20
+
19
21
Each screener has two primary components that work together:
20
22
21
23
### 2.1 User Interface
@@ -28,8 +30,6 @@ The eligibility logic defines how user inputs are evaluated. It applies the bene
28
30
29
31
BDT allows you to configure both the user interface form and back-end eligibility logic in low-code editors and then publishes them together as a single, accessible URL.
30
32
31
-
> TODO: Insert example screenshot of a published screener
Copy file name to clipboardExpand all lines: docs/user-docs/docs/user-guide.md
+18-14Lines changed: 18 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@ This guide walks through how to create, configure, test, and publish an eligibil
8
8
9
9
After signing in, you will land on the **Screeners** view. This page displays all of your existing screener projects and serves as your starting point for creating and managing screeners.
10
10
11
+

12
+
11
13
From here, you can:
12
14
13
15
- View all of your existing screeners
@@ -20,8 +22,6 @@ Select **Create New Screener** and provide a name for your screener. The name sh
20
22
21
23
After the screener is created, you are automatically taken to the **Screener Dashboard**.
22
24
23
-
> TODO: Add image of Screeners view
24
-
25
25
---
26
26
27
27
## 2. The Screener Dashboard
@@ -37,8 +37,6 @@ At the top of the page, the navigation bar contains four tabs representing the m
37
37
38
38
Work through these tabs in order when building a screener for the first time. The eligibility logic you define in **Manage Benefits** informs what inputs the **Form Editor** needs to collect, and both must be complete before **Preview** and **Publish** are meaningful.
@@ -58,20 +56,22 @@ A single screener can evaluate eligibility for one or multiple benefits. Each be
58
56
59
57
The **Manage Benefits** tab displays all benefits configured for your screener as a list of cards.
60
58
59
+

60
+
61
61
From this view, you can:
62
62
63
63
-**Create** a new benefit by selecting **Create New Benefit** and providing a name and description
64
64
-**Edit** a benefit by selecting **Edit** on its card, which opens the **Configure Benefit** page
65
65
-**Remove** a benefit by selecting **Remove** on its card
66
66
67
-
> TODO: Add image of Manage Benefits view
68
-
69
67
---
70
68
71
69
## 4. Configuring a Benefit
72
70
73
71
The **Configure Benefit** page is where you define the rules that determine whether a user qualifies for a specific benefit. You access it by selecting **Edit** on any benefit card.
74
72
73
+

74
+
75
75
Each benefit contains one or more **Eligibility Checks**.
76
76
77
77
> A user is considered **eligible for the benefit only if every eligibility check evaluates to `True`.**
@@ -106,7 +106,7 @@ Each row in the list shows the check name, a brief description, and its version.
106
106
107
107
Once added, the check appears as a card in the right panel under the benefit's configured checks.
108
108
109
-
> TODO: Add image of Configure Benefit page showing the check list and selected checks panel
109
+

110
110
111
111
### 4.3 Configuring Check Parameters
112
112
@@ -118,7 +118,7 @@ To configure the parameters for an added check, click on its card in the right p
118
118
119
119
Fill in the value for each parameter and select **Confirm** to save. Required parameters are marked with a red asterisk (`*`).
120
120
121
-
> TODO: Add image of Configure Check modal
121
+

122
122
123
123
### 4.4 Removing a Check
124
124
@@ -132,16 +132,18 @@ The **Form Editor** tab is where you build the user-facing form that collects th
132
132
133
133
The editor provides a visual drag-and-drop canvas powered by Form-JS. You can add, arrange, and configure form fields without writing any code.
134
134
135
+

136
+
135
137
**Saving your work**:
136
138
137
139
Select **Save** to persist your form. The save button turns yellow when there are unsaved changes, so you can tell at a glance whether your current edits have been saved.
138
140
139
-
> TODO: Add image of Form Editor
140
-
141
141
### 5.1 Connecting Form Fields to Eligibility Checks
142
142
143
143
For the screener to evaluate eligibility correctly, the form must collect all of the inputs that the configured eligibility checks require. Each form field has a **key** that identifies the data it collects — this key must match the input name expected by the corresponding eligibility check.
144
144
145
+

146
+
145
147
The **Validate Form Outputs** drawer (accessible via a button at the bottom-right of the editor) helps you verify that your form covers all required inputs. It shows:
146
148
147
149
-**Form Outputs** — a list of all fields currently defined in the form and the data they will collect
@@ -150,7 +152,7 @@ The **Validate Form Outputs** drawer (accessible via a button at the bottom-righ
150
152
151
153
Use this drawer to identify gaps between your form and your eligibility logic, and resolve any missing inputs before moving to the Preview step.
152
154
153
-
> TODO: Add image of Validate Form Outputs drawer
155
+

154
156
155
157
---
156
158
@@ -164,6 +166,8 @@ The preview screen is divided into two sections:
164
166
165
167
Displays your screener form as it will appear to end users. Fill in the fields and select **Submit** to run the eligibility evaluation.
166
168
169
+

170
+
167
171
**Results section**:
168
172
169
173
After submitting, the results section displays the outcome for each benefit:
@@ -172,12 +176,12 @@ After submitting, the results section displays the outcome for each benefit:
172
176
-**Ineligible** (red) — one or more eligibility checks returned `False`
173
177
-**Need more information** (yellow) — one or more checks could not determine eligibility from the inputs provided
174
178
179
+
![Results section of a benefits eligibility tool. The Inputs section shows the following data: simpleChecks: { "livesInPhiladelphiaPa": true, "ownerOccupant": true }, people: { "applicant": { "dateOfBirth": "1990-02-01", "enrollments": [ "Food Assistance" ] } }. The Benefits section shows the following eligibility results: Food Assistance: Eligible, lives-in-philadelphia-pa (residence v0.6.0), person-in-phil-age (age v0.6.0), minAge=18, personId=applicant, asOfDate=2026-02-28. Heating Assistance: Eligible, person-enrolled-in-benefit (enrollment v0.6.0), personId=applicant, benefit=Food Assistance, person-min-age (age v0.6.0), minAge=18, personId=applicant, asOfDate=2026-02-28, owner-occupant (residence v0.6.0).](images/preview-results.png)
180
+
175
181
Each benefit's result also shows a breakdown of how each individual eligibility check evaluated, including whether it passed, failed, or was unable to determine, and what parameter values were used. This detail is useful for debugging eligibility logic during development.
176
182
177
183
> Use the Preview tab iteratively as you build your screener to confirm that each benefit evaluates correctly across a range of test inputs.
178
184
179
-
> TODO: Add image of Preview tab with a sample result
180
-
181
185
---
182
186
183
187
## 7. Publishing Your Screener
@@ -197,7 +201,7 @@ The Publish tab shows:
197
201
198
202
If you update your screener after publishing, return to the **Publish** tab and select **Deploy Screener** again to push the updated version to the public URL.
199
203
200
-
> TODO: Add image of Publish tab showing public URL
204
+

0 commit comments