Circulation Documentation - Needs
Don't worry about
whether documentation already exists
whether a function is built out in FOLIO
duplicating a documentation need if it overlaps in different categories
We can figure that out as we go from the list. Just put down what comes to mind where you think it might fit!
- 1 App-Specific Documentation
- 1.1 Users
- 1.2 Users - RA SIG will write
- 1.3 Inventory (sent list to Jesse Lambertson 3-16-2021)
- 1.4 Courses
- 1.5 Requests
- 1.6 Check-In
- 1.7 Check-Out
- 1.8 Circulation Log
- 2 Cross-App Workflows
- 3 Settings and Circulation Rules
- 4 Behind The Scenes Stuff To Know / Tips for Implementation
- 5 Workarounds for not-yet-completed workflows
- 6 Reporting
App-Specific Documentation
Users - RA SIG will write
Workflow Name | Existing Documentation or link to FOLIO DOCS | Needs a writer | Apps | Could this be a flowchart? |
|---|---|---|---|---|
Viewing a patron's fee/fine history | ||||
Waiving a fee/fine - full waive, partial waive | ||||
Refunding a fee/fine - full waive, partial waive | ||||
Accepting payment for a fee/fine - full/partial |
Courses
Workflow | Existing documentation or DOCS Jira link | Apps Involved | Could this be a flowchart? |
|---|---|---|---|
Intro to Courses
| Courses | ||
How to create a course | https://docs.folio.org/docs/access/courses/courses/#creating-a-course | Courses | |
Create a course with cross-listings | https://docs.folio.org/docs/access/courses/courses/#adding-a-cross-listed-course | ||
Find a list of items on reserve for a course | https://iris.docs.folio.org/docs/access/courses/courses/#searching-for-reserves | ||
How do temporary locations work on courses items | https://docs.folio.org/docs/access/courses/courses/#adding-a-reserve-item-to-a-course | Courses, Inventory | |
How do temporary loan types work on courses items | |||
Integrations with outside systems - LTI | |||
Integrations with outside systems - ARES | |||
Reserve items - using processing statuses
| |||
Copyright information in Courses
| |||
In-app reports: what's available, when you might run them, what's required to do so | There are no in-app reports for Courses and none are planned. |
Requests
Check-In
Workflow | Existing documentation or DOCS jira | Apps | Could this be a flowchart? |
|---|---|---|---|
How anonymizing loans works if you do it in check in | |||
How checking in works for items with multiple pieces | |||
How to backdate a check-in | https://docs.folio.org/docs/access/check-in/checkin/#checking-in-and-backdating-an-item | ||
In-App reports - what's available, when you might run them, what's required | There are no in-app reports for the Check-in app and none are planned. |
Check-Out
Workflow | Existing Documentation or DOCS jira | Apps | Could this be a flowchart? |
|---|---|---|---|
How to loan to someone who is borrowing as a proxy for another patron | https://docs.folio.org/docs/access/check-out/checkout/#checking-out-to-a-proxy-borrower | Checkout, Users | |
How checkout works for items with multiple pieces | |||
How to change a loan due date | https://docs.folio.org/docs/access/check-out/checkout/#changing-the-due-date-of-an-item | ||
How to override patron blocks | |||
How to override item blocks | |||
In-App reports - what's available, when you might run them, what's required |
Circulation Log
Workflow | Existing Documentation or DOCS Jira | Apps | Could this be a flowchart? |
|---|---|---|---|
Why you would use the circulation log vs. other FOLIO features
| https://docs.folio.org/docs/access/circulation-log/circ_log/ Could maybe add these two extra things to the top under overview | ||
How to look up item histories (and what you might find here that isn't in Inventory) | |||
How to interpret circ log records that have proxy relationships | |||
How anonymized data looks in the circ log | |||
How to look for notice information | |||
How to look at fee/fine information |
Cross-App Workflows
Workflow name | Existing Documentation or DOCS Jira? | Apps | Could this be a flowchart? |
|---|---|---|---|
Handling items that have been in transit for too long | Inventory, Requests | ||
Patron claims that they returned an item but it's still on their account (claim returned) | Users, Inventory | ||
On-the-fly / Fast Add record creation, loaning items, considerations for use (Inventory vs. Courses vs. Check Out) | Inventory, Courses, Check Out | ||
Handling fines - declared lost, aged to lost | Users, Export Manager, Inventory | ||
Handling lost and paid items | Users, Inventory | ||
Managing Patron Blocks - how to set them up on users, how to override | Users, Check Out | ||
Remote Storage | Settings, Inventory, Check In, Check Out |
Settings and Circulation Rules
Workflow name/description | Existing documentation or DOCS Jira | Needs a writer? | Apps | Could this be represented graphically / through flowchart? |
|---|---|---|---|---|
Tags - how they work, plans for future development, suggestions for scenarios where they would be helpful | Settings, any app that has installed tags (many) | |||
How to create permission sets | Done - on docs.folio.org site | Settings | ||
Calendars - how to set up dates / times, how exceptions work | Google Doc - Settings > Calendar | Settings | ||
Configuring Settings for Remote Storage | Settings |