Circulation Event Types
Find available values and definitions for all Circulation Event types in WorldShare Reports in Power BI.
Billing and Suspension
| Value | Description |
|---|---|
| Cancel-Bill | A bill has had its total original amount outstanding cancelled by library staff or policy. |
| Create-Bill | A bill has been created against a user's account by library staff or policy. |
| Edit-Bill | A bill note has been updated by library staff. |
| Pay-Bill | A bill has been partially or fully paid by a user. |
| Pay-Bill-Pending | A user has consented to WMS sharing billing data with a third-party online bill payment processing service. Online payment may be pending. |
| Refund-Bill | A previously paid amount has been partially or fully refunded to a user. |
| Waive-Bill | A bill has had part or all of its total original amount outstanding waived by library staff. |
| Suspend-Patron | A user's suspension status has been updated by library staff or policy. |
Holds
| Value | Description |
|---|---|
| Approve-Hold | An item has been approved by library staff to fulfill a hold request. |
| Cancel-Hold | A hold request has been deleted by the user or library staff. |
| Complete-Hold | A hold request has been marked complete by library staff. |
| Consult-Hold-Item | A hold request has been updated to In Use status by library staff when the item is issued to the patron for in-house use. |
| Decline-Hold | A hold has been declined to be fulfilled by a specific branch after an item appears on its pull list. |
| Edit-Hold | A hold's pickup location, notes, hold shelf expiration date/time, approval status, etc., have been updated. |
| Expire-Hold | A hold has been deleted because its expiration date has passed, any expiration notifications have been sent to the user, and (for fulfilled holds only) the reserved item has been checked in off the Clear Hold Shelf report. |
| Expired-In-Transit-Hold | Sent when an on-hold, in transit/dispatched item is checked in and the related hold has expired. |
| Forward-Hold | Library staff have manually forwarded a title-level hold for potential fulfillment at other branches of the same institution or at all relevant locations within a circulation group. |
| Fulfill-Hold | A hold has transitioned to Ready for Use status after the item arrives at the pickup location and any required processing constraints (e.g., item approval) are completed. |
| Fulfill-Constrained-Hold | An item is checked in to fulfill a hold at the pickup location, but the hold requires library staff action before it can transition to Ready for Use status (e.g., it needs approval or preparation). |
| Pickup-Hold | A user has checked out an item that has fulfilled that user's hold request. |
| Place-Hold | A hold request has been created by a user, library staff, or third-party integration. |
| Prepare-Hold | A hold request has been marked prepared by library staff. |
| Requeue-Hold | Sent when a hold that was in the GETTING_READY or READY_FOR_USE states moves back to the PENDING state. |
| Return-Hold-Item | Library staff have updated a hold request back to Ready for Use status after it was issued to the patron for in-house use. This indicates that the patron plans to come back to consult the item again. |
| Unfulfill-Hold | Sent when a hold that was in the READY_FOR_USE state moves back to the GETTING_READY state. |
Item Management
| Value | Description |
|---|---|
| Create-Item | A temporary or container item has been created. |
| Dispatch-Item | An item has been routed to a different branch after an even number of check-ins at the origin branch. |
| Edit-item | The bibliographic or item details of a temporary or container item have been edited. The event is not written when an item is added to or removed from a container. |
| Find-item | An item that was previously in Missing, Lost, Claimed Never Had, or Claimed Already Returned status has been checked in. |
| Soft-Check-Out | An item has been checked in using non-loan return mode or using Digby's reshelving function. |
| Receive-Item | An item that was previously in In Transit or Dispatched status has been checked in at its destination branch. |
| Report-Missing | An item has been updated to Missing status. |
| Route-Item | An item has been routed to a different branch after an odd number of check-ins at the origin branch. |
| Transition-to-Long-Overdue | An item transitions to long overdue status. |
| Update-Item-Location | An item's last-seen location has been manually updated by library staff. |
| Withdraw-Item | A temporary or container item has been withdrawn from the collection. |
Item and Room Schedules
| Value | Description |
|---|---|
| Cancel-Schedule | An item schedule has been deleted. |
| Edit-Schedule | The start date/time, end date/time, note, pickup location, etc., of an item schedule have been updated. |
| Fulfill-Schedule | An item schedule is ready for pickup. |
| Fulfill-Schedule-item | An item schedule is ready for pickup. |
| Pickup-Schedule | A user has checked out an item that has fulfilled that user's item scheduling request |
| Place-Schedule | An item schedule has been created. |
| Cancel-Room-Schedule | A room schedule has been deleted. |
| Place-Room-Schedule | A room schedule has been created. |
Loans
| Value | Description |
|---|---|
| Auto-Renew-Failure | An item failed to be automatically renewed. For institutions that support auto renewal retries, this is written when the system will no longer try to renew the loan. |
| Change-Due-Date | An item on loan has its due date manually updated by library staff. |
| Check-In | An item that was previously on loan to a user has been returned. |
| Check-Out | An item has been loaned to a user. |
| Recall-Item | An item on loan has been manually recalled for use by another user. If automatic renewal fails, an event is not written. |
| Release-Loan | An item transitioned out of restricted loan or recalled status. |
| Renew | An item on loan has been renewed successfully. |
| Report-Already-Returned | An item on loan has been claimed already returned by the user. |
| Report-Lost | An item on loan has been claimed lost by the user. |
| Report-Never-Had | An item on loan has been reported as never having been used by the user. |
| Transition-to-Long-Overdue | An item transitions to long overdue status. |
Patron Account
| Value | Description |
|---|---|
| Patron-Delete | A user record has been deleted. |
| SIP2-Patron-Authentication | A user has been verified by the WMS SIP2 Service. |
| Start-Membership | A user's membership has been activated by the full payment and/or waiving of the associated membership bill. |