Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

Commit

Permalink
add in the error table (#1267)
Browse files Browse the repository at this point in the history
  • Loading branch information
whaught authored Dec 4, 2020
1 parent 82a5e9d commit bfb2a59
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions docs/case-worker-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,24 +51,30 @@ This allows the user to upload a .csv file and issue many codes at once to a lis

The bulk uploader is written as a javascript client. Rather than uploading the file, it parses on the client and makes requests to the issue API. This allows the server to discard phone numbers after sending the SMS without storing them. The uploader may be canceled and resumed, respects the server's rate-limiting throttle, and prevents the user from sending an SMS to the same phone twice using a retry code.

### CSV Format
#### CSV Format
`patient phone`,`test date`, [optional] `symptom date`

* The patient phone must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
* All dates must be in [ISO-8601 format](https://www.iso.org/iso-8601-date-and-time-format.html).

![bulk issue codes](images/issue/bulk_issue.png "bulk issue codes")

### Select a file
### Fields
#### Select a file
Select .CSV file in the format: phone, symptom-date

### Start at line
#### Start at line
Select a line to start at. This defaults to 0 for a new file, but allows the upload to resume if it fails or is canceled in the middle.

### Retry code
#### Retry code
The user is provided a unique retry-code, although the user may alternatively enter their own, memorable, unique string. If the user is resuming a previous upload, they should enter the retry-code that was used for that upload.

This code is a unique string which is used to one-way hash each phone number to a UUID which is then stored for tracking purposes. This prevents the server from sending an SMS to the same phone number twice if a .CSV is uploaded with the same retry-code. The server will respond with status `Conflict` if it receives the same UUID more than once. The user should keep the value of their retry-code a secret, so that no other user can discover if a phone number has been used by the system.

### Remember code
#### Remember code
This checkbox to saves the retry code as a browser cookie for 1 day. Alternatively you may remember the retry-code yourself.

### After processing
After processing, a message will appear at the top with the count of successfully issued codes and a count of failures. If there are errors, they will be presented in a table with the line number of the failure and the error message received. The user may correct the entries and retry the failed lines.

![bulk issue errors](images/issue/bulk_issue_done.png "bulk issue errors")
Binary file added docs/images/issue/bulk_issue_done.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bfb2a59

Please sign in to comment.