Skip to content

Commit

Permalink
Add documentation of using rake task to request full dumps from SCSB
Browse files Browse the repository at this point in the history
  • Loading branch information
maxkadel committed May 31, 2024
1 parent 63241db commit 3f587cf
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/scsb/request_full.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
# Request partners full dump from SCSB
## Using a rake task
1. You must have the `SCSB_AUTH_KEY` for the SCSB environment you want to request records from - either `uat` or `production`. You can find these in the bibdata vault in Prancible.
1. Run the rake task for requesting the full dumps, once for each institution you wish to request. The options are `CUL`, `HL`, or `NYPL` Include the email that you want updates to be sent to. For some shells you will need to escape the brackets used to surround the variables, as shown below. Also, note that there are no spaces after the commas in the list of variables.
```bash
bundle exec rake scsb:request_records\[ENVIRONMENT,YOUR_EMAIL,INSTITUTION\] SCSB_AUTH_KEY=some-long-hash

e.g.
bundle exec rake scsb:request_records\[production,[email protected],CUL\] SCSB_AUTH_KEY=some-long-hash
```

## Through the UI

Expand Down

0 comments on commit 3f587cf

Please sign in to comment.