Functional requirements
Functional requirement sources:
- "Circulation log of all actions filtered by a patron and/or an item with additional filters" user story
- Circulation Log Ideas spreadsheet
- Circ log templates
- Circ log examples (thin thread)
- Open questions
Non-functional requirements
Availability
Assumption: It should be 99.5%
Scalability
There are about 55 million items in the Shanghai library.
Annual book circulation volume exceeded 60 million copies in 2015 (http://www.shanghai.gov.cn/nw2/nw2314/nw2315/nw5827/u21aw1103363.html). Taking into account 8% annual growth, the circulation volume by the end to 2020 should be about 84 million copies.
It means that there will be 84 million records in the Audit log for Loan "Check in" events only and approximately the same amount for "Check out" events.
In total, for these 2 events, there will be 168 million records. Taking into account the other events tracked in Audit logs, there will be 100s of millions of records in the logs.
Security
Access should be granted either to all audit records or none of them.
Usability
UI should satisfy Accessibility guide:
https://github.com/folio-org/stripes-components/blob/master/docs/AccessibilityDevPrimer.md
Assumption:
Supported devices:
Desktop only.
Supported browsers:
Google Chrome only (latest version).
Other Assumptions
Target module (Circulation, Fees Fines) requests/responses contain all Audit data that should be added to Circulation Audit logs.