Skip to content

Commit 61ca304

Browse files
Add config documentation to README
Also correct old config name used in `minimal_interview.yml` (mostly unused, except for documentation).
1 parent 85d9222 commit 61ca304

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,22 @@ Main interviews of import:
99
* any_filing_interview.yml: allows you to make any type of filing, initial or subsequent
1010
* admin_interview.yml: lets you handle admin / user functionality, outside of the context of cases and filings
1111

12-
In progress!
12+
## Config
13+
14+
Different parts of this package expect the below to be present in Docassemble's
15+
config.
16+
17+
```yaml
18+
efile proxy:
19+
# The URL where the Efile Proxy Server is running
20+
url: https:...
21+
# The Proxy Server's API Key (should be provided to you by the sever admins)
22+
api key: ...
23+
# If you're given an EFSP global fee waiver ID for your jurisdiction, put it here
24+
global waivers:
25+
illinois: ...
26+
massachusetts: ...
27+
```
1328
1429
## Authors
1530

docassemble/EFSPIntegration/data/questions/minimal_interview.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ code: |
5151
tyler_login
5252
lead_contact = users[0]
5353
main_document.completed
54-
tyler_payment_id = get_config('efile proxy', {}).get('global waiver', '')
54+
tyler_payment_id = get_config('efile proxy', {}).get('global waivers', [''])[0]
5555
ready_to_efile
5656
efile
5757
ending_screen

0 commit comments

Comments
 (0)