Examples of data model changes and exchanges with developers
- Angela Zoss (Old)
- Jennifer Eustis
- Stefan Dombek
Owned by Angela Zoss (Old)
- RA/UM (problematic): have discovered deprecated fields by surprise, just looking at API documentation (examples: createdDate and updatedDate fields in users table, patronGroup from requests)
- RA/UM (positive): extensive discussion with stakeholders on CIRC-1112 - Getting issue details... STATUS , including reporting
- change in SRS fields: instance_id → external_id, instance_hrid → external_hrid
- https://github.com/folio-org/mod-source-record-storage/commit/7170f6d403c1e1e27b9a451e85aa6b7996b56ec5#diff-46f7d07b43a783d11e8d1982e2c78e9f87de5280f0a5947c18d9e9f15f74327f
- https://github.com/folio-org/mod-source-record-storage/commit/7170f6d403c1e1e27b9a451e85aa6b7996b56ec5#diff-9e09a71a256c4524b15a6b0082120f1e98995f106deb1df4f51251ed722fc40e
- Note that the LDP pulls these data straight from the database, and Metadb will pull all data from the database, so it's important to be notified of changes that occur in the database; for other parts of LDP and other groups, changes to APIs are important
- PO Line change in Kiwi: we did request a direct linkage to holdings, but when it was implemented, it didn't do anything retroactive, so there is old data that each institution will have to deal with separately
- Changes to property name:
- mod-inventory: Rename holdingsId to holdingId - being reviewed in code commit for pull request 453. This is linked to the work on duplicate identifiers in the holdings, instance, and item records. See this Jira for reference. MODINV-589 - Getting issue details... STATUS
- RM/ERM:
- new or deprecated fields (example: transactions encumbrance,
amountAwaitingPayment) - FOLIO processes, such as fy rollover, that affect calculations in reports
- new or deprecated fields (example: transactions encumbrance,
- MM
- Inconsistency with property name. UI = resource type. JSON = instanceType
- Inconsistency with property name for holdings records id → sometimes holdingsRecordsIds or holdingsId
Reasons why Release Notes and Sprint Reviews are not sufficient:
- note: we're not really interested in UI changes, which is what the sprint review focuses on. We really want to know the changes that affect the database. Those seem to show up more in GitHub PRs, not even in release notes. For example, Data Import will say, "we have better logging capability, you can click on...". That's very high level and focused on UI, not the API or the database.
- See also: MM SIG Release Note & Other Highlights