DCB Circulation Lifecycle Events
References
Original Writeup: Slack
Workflow Diagram: Miro
Parking Lot: Discussion and Questions
Main Success Flow
Preconditions and Assumptions
The request workflow event triggers and actions that DCB listens for and reacts to are described below in a given. when, then
style. The given
is the same basic setup for each:
GIVEN that a patron request has been placed in DCB
AND already been through some transitions.
Assumed as a final when
for each is that actions occur also:
WHEN DCB finds out about the event
DCB Circulation Workflow Principles
DCB cares about the circulation status of items over the status of the request
1. Dispatched by Lending Agency
WHEN a librarian at the lending agency *checks in* a DCB paged item
(which also fulfils the request at the lending agency)
AND which changes the item status at the lending agency to
Sierra: IN-TRANSIT
Polaris: TRANSFERRED
FOLIO: ??
THEN the status of the patron request (DCB) should change
to PICKUP_TRANSIT
AND the status of the request at the borrowing agency should change
to (the local equivalent of) IN TRANSIT, ie,
Sierra: IN-TRANSIT
Polaris: TRANSFERRED
FOLIO: ??
Technical Notes
Triggering Event: item request at the lending library has been “checked in” and the item is put in a state of “in-transit”.
The ILS status for “in-transit”:
ILS | item has been put “in-transit” | Reference |
---|---|---|
Sierra | item status: staff message: | API calls or, for a group of items: User documentation: |
Polaris | Item status: | API calls User documentation: Polaris Patron Services Admin Guide v7.4 pp203-205 Note: |
FOLIO | Item status: |
Updating DCB Status changes:
DCB | field(s) | value(s) |
---|---|---|
request status |
|
|
??? |
|
|
Updating borrowing agency request
ILS | “in transit” | Reference |
---|---|---|
Sierra | Item status: message: string barcode: string | API calls User Documentation: |
Polaris | Item status: | Polaris Patron Services Admin Guide v7.4 pp203-205 |
FOLIO | Request status: |
locally equivalent of “in transit”
??? barcode
ILS specific fields
Sierra: ???
Polaris: ???
FOLIO:
destination (service point) on item
this is additional pickup location to the destination initially set when placing the request
status of request and item (TBD)
???
Variations / Exceptions to Consider
What happens if the status is wrong?
What is the exceptional (unrecognised) state and response?
2. Received at Borrowing Agency
Out of scope for initial implementation of Sierra and Polaris circulation flow
DCB cares more specifically that the item is received at the pickup location at the borrowing agency, ie, the hold shelf, rather than internal transit locations.
Technical Notes
Triggering Event: “has been received at the pickup location” at the borrowing agency
pickup location should be the same as destination location set when updating request status to IN TRANSIT
the pickup location is assumed rather than verified by DCB when the status is reacted
being received at the pickup location is a reliable proxy for being placed on the hold shelf and ready to be collected by a borrowing patron
The ILS status for “item has been on hold shelf pickup location” is:
ILS | “item has been put on hold shelf” | Reference |
---|---|---|
Sierra | item status field:
| API calls or, for a group of items: User documentation: |
Polaris | item status field: | Polaris Patron Services Admin Guide v7.4 pp203-205 |
FOLIO | request status: |
Updating DCB Status changes:
DCB | field(s) | value(s) |
---|---|---|
request status |
|
|
??? |
|
|
Updating request at lending agency
ILS | “item has been put on hold shelf” at borrowing agency | Reference |
---|---|---|
Sierra | item status: Delete m-tagged varfield(s) of “In-Transit” type | API User documentation: |
Polaris | item status: | Polaris Patron Services Admin Guide v7.4 pp203-205 |
FOLIO | request status: |
|
Other Notes
When setting the borrowing agency request status to
IN TRANSIT
, the destination location may not be different to the pickup location set at this transition
3. Item Checked Out to Patron at Borrowing Agency
Technical Notes
Triggering Event:
The ILS status for “item has been checked out at borrowing agency” is:
ILS | “has been checked out at borrowing agency” | Reference |
---|---|---|
Sierra | item status: AND
| API calls or, for a group of checkouts: User documentation: |
Polaris | Item status field: | Polaris Patron Services Admin Guide v7.4 pp203-205 |
FOLIO | Item status: |
Updating DCB Patron Request Status:
DCB | field(s) | value(s) |
---|---|---|
request status |
|
|
??? |
|
|
Updating request at lending agency
ILS | “has been checked out at lending agency” | Reference |
---|---|---|
Sierra | assign the value of date due in ISO 8601 format from the borrowing agency AND item status: AND Delete corresponding item-level hold | API calls User documentation: |
Polaris | Item status: | Polaris Patron Services Admin Guide v7.4 pp203-205 |
FOLIO | Item status: |
4. Item Returned by Borrowing Patron
Technical Notes
Triggering Event: “item has been checked back in” at the borrowing agency
item status being changed to available is the proxy for being checked back in
The ILS status for “item has been checked back in” is:
ILS | “has been checked back in at the borrowing agency” | Reference |
---|---|---|
Sierra | item status: message: string | API calls or, for a group of items: User documentation: |
Polaris | item status: |
|
FOLIO | Clears due date and puts into transit to lending agency. |
Updating DCB patron request
DCB | field(s) | value(s) |
---|---|---|
request status |
|
|
??? |
|
|
Updating request at lending agency
ILS | “in transit” | Reference |
---|---|---|
Sierra |
| API calls or, for a group of checkouts: |
Polaris | Item status: |
|
FOLIO |
|
Other Notes
5. Received Back at Lending Agency
Clean up and removal of requests and virtual records is out of scope for initial implementation of Sierra and Polaris
Technical Notes
Triggering Event: “item has been received back at lending agency”
the item at the lending agency being in the
available
status is a reliable proxy for being received back at the lending agency
The ILS status for “item has been received back at lending agency” is
ILS | “item has been received back at lending agency” | Reference |
---|---|---|
Sierra |
in transit message is removed
| API or, for a group of items |
Polaris | Polaris sets item status field to Item status: | triggers the removal of virtual records |
FOLIO |
|
Updating DCB patron request
DCB | field(s) | value(s) |
---|---|---|
request status |
|
|
Updating request and virtual records at lending agency
ILS | clean up | Reference |
---|---|---|
Sierra | virtual patron is removed IFF no other open DCB transactions for that virtual patron exist. |
|
Polaris | virtual patron is removed IFF no other open DCB transactions for that virtual patron exist. |
|
FOLIO | virtual patron is removed IFF no other open DCB transactions for that virtual patron exist. |
|
Updating request and virtual records at borrowing agency
ILS | clean up | Reference |
---|---|---|
Sierra | virtual item and bib are removed IFF no other open DCB transactions for a different patron from the same borrowing agency exists. |
|
Polaris | virtual item and bib are removed IFF no other open DCB transactions for a different patron from the same borrowing agency exists. |
|
FOLIO | virtual item and bib are removed IFF no other open DCB transactions for a different patron from the same borrowing agency exists. |
|
Other Notes
Workflow Diagram
Operated as a Community Resource by the Open Library Foundation