Library Data Platform (LDP) Beta
(UXPROD-1128)
|
|
| Status: | Closed |
| Project: | UX Product |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None | Parent: | Library Data Platform (LDP) Beta |
| Type: | New Feature | Priority: | P2 |
| Reporter: | Nassib Nassar | Assignee: | Unassigned |
| Resolution: | Won't Do | Votes: | 0 |
| Labels: | ldp-platform, mandatory, po-mvp, reporting | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original estimate: | Not Specified | ||
| Issue links: |
|
||||||||||||||||||||||||||||||||||||
| Epic Link: | Library Data Platform (LDP) Beta | ||||||||||||||||||||||||||||||||||||
| Development Team: | Prokopovych | ||||||||||||||||||||||||||||||||||||
| PO Rank: | 120.1 | ||||||||||||||||||||||||||||||||||||
| Rank: Chalmers (Impl Aut 2019): | R2 | ||||||||||||||||||||||||||||||||||||
| Rank: Chicago (MVP Sum 2020): | R1 | ||||||||||||||||||||||||||||||||||||
| Rank: Duke (Full Sum 2021): | R1 | ||||||||||||||||||||||||||||||||||||
| Rank: 5Colleges (Full Jul 2021): | R2 | ||||||||||||||||||||||||||||||||||||
| Rank: GBV (MVP Sum 2020): | R1 | ||||||||||||||||||||||||||||||||||||
| Rank: hbz (TBD): | R1 | ||||||||||||||||||||||||||||||||||||
| Rank: Lehigh (MVP Summer 2020): | R2 | ||||||||||||||||||||||||||||||||||||
| Rank: Leipzig (Full TBD): | R1 | ||||||||||||||||||||||||||||||||||||
| Rank: Leipzig (ERM Aut 2019): | R1 | ||||||||||||||||||||||||||||||||||||
| Rank: TAMU (MVP Jan 2021): | R1 | ||||||||||||||||||||||||||||||||||||
| Rank: U of AL (MVP Oct 2020): | R1 | ||||||||||||||||||||||||||||||||||||
| Description |
|
Complete documentation of data attributes in Folio module APIs is needed to enable data modeling work as part of building reporting functionality. In particular, this is needed to ensure data quality for reporting. The specific documentation requirements being requested are described in: https://folio-org.atlassian.net/browse/FOLIO-1551 This issue is a blocker for the entire Library Data Platform reference implementation epic ( https://folio-org.atlassian.net/browse/UXPROD-1128 ) . We may be able to develop somewhat in parallel; however, most of the documentation will be needed early in the reporting development because data models, ETL, and report queries all depend on it. |
| Comments |
| Comment by Nassib Nassar [ 09/Jan/19 ] |
|
Please recommend a developer to estimate the BE. |
| Comment by Marc Johnson [ 19/Feb/19 ] |
|
Nassib Nassar given this is an active issue, I thought I’d comment here rather than
Where are you hoping this degree of information will be documented? Some can be explicit in the interface JSON schema, e.g. required in all circumstances or basic domain information. Others, e.g. references, most constraints and additional domain information are not. These policies may well be specific to an implementation of an interface, or be provided by collaborators. |
| Comment by Nassib Nassar [ 19/Feb/19 ] |
|
I think it would be wherever the developers have decided to document the interface definitions and the module implementations. If a constraint doesn't apply to an interface definition or a module implementation, then it seems out of scope of their documentation. |
| Comment by Holly Mistlebauer [ 09/Sep/19 ] |
|
Nassib Nassar, were you going to come up with a prioritized list for Jakub? We are trying to remember... |