Specs for granthub UI and metadata
Updated 21 Dec
Workflow for applying a grant from Granthub to collections, books, and chapters
Requirements
- Allow more than one grant to be added to each level
- a collection (not a requirement now but should be expected in the future)
- a book (whether wholebook or chapter-processed)
- a chapter
- When applying grant(s) from one level to another, e.g. from a book to chapter:
- the user should be able to specify which grants should be applied if there is more than one
- the grant(s) applied will not be editable at the chapter level
- this should not block the user from adding additional grants to the chapter -- therefore don't disable granthub search at the chapter level
- It's possible, but very rare, for a grant to be updated, but we should allow for this in case a grant has been applied in error.
Collection level
- From the collection metadata UI, Sys Admin searches grant hub to apply the grant to the collection.
- If relevant, Sys Admin can apply the same grant to all the whole books in the collection
Step A
Step B
Step C
Chapter-processed book level
book meta UI The same steps above apply.
- From the book metadata UI, Sys Admin searches grant hub to apply the grant to the book.
- If relevant, Sys Admin can apply the same grant to all chapters in the book.
Users can add additional grants to the chapter itself
Wholebook level
Step A and B apply.
- From the book metadata UI, Sys Admin searches grant hub to apply the grant to the book.
Sending data to NCBI
In all cases, once the grant has been applied, pass the following information to NCBI at load to PMC step:
- for book-processed packages, add it to the book record JSON file
- for chapter-processed packages, add to the chapter record JSON file
Granthub | Integration JSON |
---|---|
awards.number | number |
funding_institution.code | institution_code |
funding_institution.acronym | institution_acronym |
funding_institution.name | institution_name |
country | country |
Examples:
{
"grants": [
{
"number": "HHSN263201200074I",
"instiution_code": "OD",
"instiution_acronym": "NIH HHS",
"instiution_name": "Office of the Director",
"country": "United States"
},
{
"number": "104976",
"instiution_code": "WT_",
"instiution_acronym": "",
"instiution_name": "Wellcome Trust",
"country": "United Kingdom"
}
]
}
country
needs to be looked up in a secondary Granthub call, for example:
https://www.ncbi.nlm.nih.gov/pmc/utils/granthub/fundinginstitution/?order=&order_dir=&funding_institution.code={awards.funding_institution.code}