- Send due date changed notice when moving recall request CIRC-316
- Can override renewals with request related failures (CIRC-311, CIRC-319)
- Introduces experimental move request API (CIRC-315, CIRC-316, CIRC-333, CIRC-395)
- Decides upon item for title level requests based upon due date (CIRC-361)
- Provides template context for staff slips during check in (CIRC-378)
- Adds
Closed - Unfilled
andClosed - Pickup expired
request states (CIRC-350) - Includes additional location information for requests (CIRC-331)
- Includes outstanding fees and fines amount to pay for loans (CIRC-323)
- Assorted bug fixes (CIRC-305, CIRC-350, CIRC-353, CIRC-356, CIRC-357, CIRC-371, CIRC-390)
- Provides
circulation 7.10
(CIRC-323, CIRC-350, CIRC-315, CIRC-331) - Provides
requests-move 0.2
(CIRC-350) - Provides
requests-reports 0.2
(CIRC-350) - Requires
calendar 3.0
(CIRC-363, MODCAL-45) - Requires
feesfines 15.0
(CIRC-232) - Requires
loan-storage 5.3 or 6.0
(CIRC-380) - Requires
instance-storage 4.0, 5.0, 6.0 or 7.0
(CIRC-396)
- Use sets for module permissions to reduce size when included in headers (CIRC-352)
- Only fetch single record by ID when ID is not null (CIRC-359)
- Only update request queue when loan is closed (CIRC-351)
- Uses correct request type for instance level requests (CIRC-344)
- Processes scheduled patron notices (CIRC-337)
- Includes location related tokens for patron notices (CIRC-332)
- Handles missing request expiration date for instance level requests (CIRC-345)
- Does not attempt to store extended requester patron group information (CIRC-342)
- Introduces creation of requests based upon an instance (CIRC-245, CIRC-264, CIRC-265, CIRC-267)
- Includes borrower personal information for loans (CIRC-290, CIRC-335, CIRC-336)
- Notifies requester for all recall requests, not only those which change due date (CIRC-295)
- Include additional tokens in patron notices (CIRC-296, CIRC-297)
- Schedule time based patron notices on check out (CIRC-322)
- Send scheduled patron notices (CIRC-310)
- Provides custom hold shelf clearance report (CIRC-320)
- Corrects issues with incorrect request JSON schema documentation (CIRC-321)
- Includes technical metadata in module descriptor (FOLIO-2003)
- Can only use drools 7.0.0 due to compatibility with Alpine Linux (CIRC-309)
- Provides
circulation 7.6
(CIRC-245, CIRC-265, CIRC-267) - Provides
requests-reports 0.1
(CIRC-320) - Provides
_timer 1.0 interface for sending scheduled patron notices
(CIRC-310) - Requires
request-storage 3.1
(CIRC-320) - Requires
cancellation-reason-storage 1.1
(CIRC-296, CIRC-297) - Requires
loan-types 2.2
(CIRC-296, CIRC-297) - Requires
scheduled-notice-storage 0.1
(CIRC-310)
- Block loan renewal when item is recalled (CIRC-202)
- Can override loan policy when checking out an item (CIRC-211)
- Replacing a loan ignores the derived service point properties (CIRC-237)
- Better validation error message when trying to create a request for an item that does not exist (CIRC-241)
- Pickup service point is required for requests fulfilled to the hold shelf (CIRC-243)
- Can override renewal for items which are not loanable (CIRC-249)
- Do not attempt to fetch related records when no requests are found (CIRC-250)
- Clear loan action after overriding renewal (CIRC-251)
- Stop a patron having more than a single open request for an item (CIRC-255)
- Stop a patron from requesting an item they have on loan (CIRC-258)
- Send request related patron notices (CIRC-256, CIRC-262)
- Truncate loan due date when item is recalled (CIRC-259)
- Paged items can only be checked out by the requester (CIRC-260)
- Disallow overridden renewal if due date would not change (CIRC-261)
- Can check out an item with a barcode containing whitespace (CIRC-284)
- Allow requests for items on order or in process (CIRC-275)
- Provides
circulation 7.5
- Introduces endpoints to determine request and patron notice policies (CIRC-187, CIRC-196, CIRC-197)
- Due date calculation includes closed due date management (CIRC-158, CIRC-159, CIRC-160, CIRC-180, CIRC-186, CIRC-217, CIRC-206, CIRC-226)
- Respect chosen timezone when calculating due date during check out and renewal (CIRC-224, CIRC-238)
- Provides override mechanism for renewals (CIRC-174, CIRC-180, CIRC-212, CIRC-221)
- Send patron notices when item is checked out or checked in to return loan (CIRC-222)
- Introduces support for page requests (CIRC-189)
- Populates
hold shelf expiration date
when request beginsawaiting pickup
(CIRC-194) - Requests only begin
awaiting pickup
when checked in to selected service point (CIRC-172, CIRC-193) - Restricts when requests can be created based upon policy and item status whitelist (CIRC-207, CIRC-208, CIRC-230)
- Changes loan due date when recall request is created depending upon policy (CIRC-203)
- Prevents check out of missing items (CIRC-231)
- Improves validation of loans (CIRC-173)
- Adds
tags
to requests (CIRC-188, CIRC-232) - Improves RAML documentation (CIRC-142, CIRC-220, CIRC-244)
- Increases HTTP client connection pool size from 5 to 100 connections (CIRC-225)
- Includes
copy number
from item in requests (CIRC-175) - Uses Alpine docker image (CIRC-185)
- Provides
circulation 7.4
- Requires
loan-storage 5.3
- Requires
circulation-rules-storage 1.0
- Requires
request-storage 3.0
- Requires
loan-policy-storage 1.2 or 2.0
- Requires
request-policy-storage 1.0
- Requires
calendar 2.0
- Requires
patron-notice-policy-storage 0.7
- Requires
patron-notice 1.0
- Requires
configuration 2.0
- Include item ID in check in API response when no loan is present (CIRC-176)
- Provides support for basic in transit to home process during check in (CIRC-146)
- Includes extended check in and check out point properties in loans (CIRC-150)
- Includes extended destination service point properties in items when checking in (CIRC-146)
- Using PUT to a loan for check in is no longer supported (CIRC-146)
- Provides
circulation
interface version 5.2 (CIRC-146, CIRC-150) - Requires only
item-storage
interface version6.1
or7.0
(CIRC-146) - Requires only
location
interface version3.0
(CIRC-146)
- Initial check in by barcode API for checking in an item at a service point (CIRC-154)
- Removes additional delivery address properties before storage (CIRC-171)
- Provides
circulation
interface version 5.1 (CIRC-154) - Requires
item-storage
interface version5.3
,6.0
or7.0
(CIRC-170) - Requires
instance-storage
interface version4.0
,5.0
, or6.0
(CIRC-168) - Requires
holdings-storage
interface version1.3
,2.0
or3.0
(CIRC-169)
- Stores the service point where checking out or in occurred (CIRC-104)
- Uses RAML 1.0 for API documentation (CIRC-157)
- Include extended
patronGroup
properties for requestinguser
for (CIRC-156) - Validate pickup service point for a request (CIRC-152)
- Bug fixes for fetching related records (CIRC-153, CIRC-161, CIRC-164, CIRC-165)
- Provides
circulation
5.0 interface (CIRC-104) - Requires
loan-storage
5.2 interface (CIRC-104) - Requires
request-storage
2.3 interface (CIRC-147) - Requires
service-points
3.0 interface (CIRC-152)
- Introduce request
pickupServicePointId
(CIRC-147) - Include
contributorNames
,enumeration
,callNumber
andstatus
of theitem
for requests (CIRC-140) - Include
deliveryAddress
andpatronGroupId
of theuser
for requests (CIRC-140) - Include
dueDate
of thecurrent loan
for requests (CIRC-140) - Requires version 2.0 or 3.0 of
locations
(CIRC-143) - Requires version 5.3 or 6.0 of
item-storage
(CIRC-141) - Requires version 4.0 or 5.0 of
instance-storage
(CIRC-141) - Requires version 1.3 or 2.0 of
holdings-storage
(CIRC-141) - Provides
circulation
4.2 interface (CIRC-141, CIRC-140)
- Only requires
userId
for open loans (CIRC-136)- Although it is not possible to create already closed loans
- Provides
circulation
4.0 interface (CIRC-136) - Requires
loan-storage
interface 5.0 (CIRC-136)
- Fix module permissions for request collection endpoint (CIRC-134)
- No longer sets item status to variants of
Checked out
(CIRC-126) - Introduce request
position
property (CIRC-83) - Introduce endpoint for fetching request queue for an item (CIRC-83)
- Request queue positions are allocated upon creation, closure, cancellation or deletion (CIRC-83)
- Closed requests cannot be replaced via PUT (CIRC-122)
- Fixes response code discrepancy between implementation and description of renewal API in
circulation
interface (CIRC-130) - Provides
circulation
interface 3.5 (CIRC-83) - Requires
request-storage
interface 2.2 (CIRC-83)
- Provide different error messages when item not found in different circumstances (CIRC-123)
- Determine location using permanent and temporary locations from both the holdings and item (CIRC-121)
- Includes
location
forrequests
(CIRC-121) - Provides
circulation
interface 3.4 (CIRC-121) - Requires
item-storage
interface 5.3 (CIRC-121) - Requires
holdings-storage
interface 1.3 (CIRC-121)
- Initial renewal API for renewing an item to a loanee using IDs (CIRC-117)
- Provides
circulation
interface 3.4 (CIRC-117)
- Add support for 'Cancelled - Closed' request status (CIRC-118)
- Add support for 'cancellationReason' and 'cancellationDate' request fields (CIRC-90)
- Changes validation message when attempting to check out to user other than requester to include more information (CIRC-114)
- Provides
circulation
interface 3.3 (CIRC-90) - Requires
request-storage
interface 2.1 (CIRC-90, CIRC-118)
- Initial renewal API for renewing an item to a loanee using their barcodes (CIRC-100)
- Provides
circulation
interface 3.2 (CIRC-100)
- Support
users
interface 15.0 which removesmeta
property from proxy relationships (CIRC-113)
- Fixed due date schedule limits are applied for rolling loan policies during check out (CIRC-106)
- Check out requests using a rolling loan policy with missing policy definition respond with an error message (CIRC-108)
- Proxy validation uses properties from either root or meta object whilst transitioning between models (CIRC-107)
- Reports an error if the loan rules match to a non-existent policy (CIRC-111)
- Initial check out API for checking out an item to a loanee using their barcodes (CIRC-74)
- Rename
metaData
property tometadata
(CIRC-98) - Add shelving location to loan rule parser (CIRC-16)
- Add required priority keyword to loan rule engine (CIRC-17)
- Add "all" keyword to loan rule engine (CIRC-18)
- Add ! (negation) operator to loan rule engine (CIRC-19)
- Implement applyAll API endpoint of loan rules engine (CIRC-33)
- applyAll API endpoint returns loan policy ID rather than loan policy itself (CIRC-33)
- Implement /circulation/loan-rules/apply-all endpoint (fix 500 status) (CIRC-63)
- Implement antlr parser; wire loan rules against UUIDs of controlled vocabularies (CIRC-35)
- Fix "Loan rule is not processed when no space after colon between rule and policy" (CIRC-73)
- Fix for multiple value headers in storage module responses (CIRC-103)
- Adds missing location permission for getting loans in module descriptor (CIRC-105)
- Forward on X-Okapi-Request-Id header if present (CIRC-99)
- Provides
circulation
interface 3.1 (CIRC-98, CIRC-33, CIRC-74) - Requires
loan-storage
interface 4.0 (CIRC-98) - Requires
request-storage
interface 2.0 (CIRC-98) - Requires
loan-policy-storage
interface 1.2 (CIRC-74) - Requires
fixed-due-date-schedules-storage
interface 2.0 (CIRC-74)
- Loan rules
apply
endpoint missing or malformed reports query parameters (CIRC-95) - Provides
circulation
interface 2.13 (CIRC-95) - Requires
locations
interface 1.1 or 2.0 (CIRC-91) - No longer requires
shelf-locations
interface (CIRC-91)
- Includes proxy user's name for requests (CIRC-88)
- Stores proxy user's name for requests (so it can be used for sorting, CIRC-88)
- Defaults request
status
toOpen - Not yet filled
(CIRC-53) - Updates request
status
for hold shelf delivery toOpen - Awaiting pickup
on check in (CIRC-53) - Updates request
status
for hold shelf delivery toClosed - Filled
on check out to the requester (CIRC-53) - Disallow checking out item to other patrons when request is awaiting pickup (CIRC-53)
- Refuse loan creation for already checked out items (CIRC-53)
- Refuse loan creation when item or holding does not exist (CIRC-53)
- Only allow
Open
andClosed
loan status (may become interface constraint in future, CIRC-53) - Item status is determined by the oldest request in the request queue (CIRC-52)
- Allows un-expiring relationships when validating proxy (CIRC-92)
- Reuse Vert.x HTTP client within the circulation verticle (to allow for connection pooling, CIRC-86)
- Use == relation when finding related records (CIRC-87)
- Validation messages are structurally similar to schema (CIRC-93)
- Provides circulation interface 2.12 (CIRC-88)
- Requires request-storage interface 1.5 (CIRC-88)
- Adds
status
property torequests
(CIRC-53) - Adds
proxyUserId
torequests
(CIRC-77) - Adds
systemReturnDate
property toloans
(CIRC-81) - Adds
status
property torequests
(CIRC-53) - Adds
materialType
property to theitem
forloans
(CIRC-80) - Adds
callNumber
property to theitem
forloans
(CIRC-80) - Adds
contributors
array to theitem
forloans
(CIRC-80) - Validates proxy relationship when creating or updating
loans
andrequests
(CIRC-79) - Provides circulation interface 2.11 (CIRC-53, CIRC-81, CIRC-80, CIRC-77, CIRC-79)
- Requires request-storage interface 1.4 (CIRC-53, CIRC-77, CIRC-79)
- Requires users interface version 14.2 (CIRC-79)
- Requires loan-storage interface 3.5 (CIRC-81)
- Requires material-types interface 2.0 (CIRC-80)
- Adds
holdingsRecordId
andinstanceId
properties to the item for a loan (CIRC-61) - Adds
holdingsRecordId
andinstanceId
properties to the item for a request (CIRC-70) - Request to PUT loan rules will respond with 422 when invalid (CIRC-68)
- Accept comments in loan rules without a space (CIRC-69)
- Adds missing
deliveryAddressTypeId
into the request schema definition (CIRC-71) - Provides circulation interface 2.7 (CIRC-61, CIRC-70)
- Applies loan rules to determine the policy to use whilst handling loan requests (CIRC-51)
- Adds
loanPolicyId
property to a loan, to keep the last policy that was applied to the loan (CIRC-51) - Clear cache of loan rules engine when changing loan rules (CIRC-59)
- Default loan status to
Open
(and action tocheckedout
) if not provided (CIRC-60) - Provides circulation interface 2.6 (CIRC-51)
- Requires loan-storage interface version 3.4 (CIRC-51)
- Requires item-storage interface version 4.0 or 5.0 (CIRC-57)
- Requires instance-storage interface version 3.3 or 4.0 (CIRC-57)
- Requires holdings-storage interface version 1.0 (CIRC-57)
- Allow multiple requests for the same item (CIRC-54)
- Use permanent location from holding or item (CIRC-49)
- Use title from instance or item (CIRC-50)
- Use item permanent and temporary locations for
location
property in loans (CIRC-36) - Item status
Checked Out
is nowChecked out
(CIRC-39) - Creating or changing a loan updates the
itemStatus
snapshot (similar toaction
) in loan storage (CIRC-38) - Creating a hold or recall request changes the associated item's
status
(CIRC-39) - Creating a hold or recall request updates the
action
anditemStatus
snapshots for an open loan for the same item in storage, in order to create a loan history entry (CIRC-40, CIRC-38) - A hold or recall request will be rejected when associated item's
status
is not checked out (CIRC-39) - A request for an item that does not exist will be rejected (CIRC-39)
- The
itemStatus
snapshot is not included in loan representation, as the current status is included from the item, and having both may be confusing (CIRC-38) - Requires loan-storage interface version 3.3 (CIRC-38)
- Requires item-storage interface version 4.0 (CIRC-36)
- Requires holdings-storage interface version 1.0 (CIRC-49, CIRC-50)
- Requires shelf-locations interface version 1.0 (CIRC-36)
- Introduces
circulation/requests
for making requests for items (CIRC-27) - Stores item and requesting user metadata with request, in order to aid searching / sorting (CIRC-28, CIRC-29)
- Put loan rules validation error message into JSON (CIRC-34)
- Provides circulation interface version 2.5
- Requires request-storage interface version 1.1
- Requires users interface version 14.0
- Adds mod- prefix to names of the built artifacts (FOLIO-813)
- Introduces
/circulation/loan-rules
for getting and replacing loan rules (CIRC-11) - Introduces
/circulation/loan-rules/apply
for loan rules engine (CIRC-26) - Provides circulation interface version 2.4
- Requires loan-rules-storage interface version 1.0 (new dependency)
- Remove
module.scan.enabled
, storage and configuration permissions from circulation.all set, as part of moving permissions to UI modules (CIRC-32) - Generates Descriptors at build time from templates in ./descriptors (FOLIO-701)
- Introduces proxy user ID for a loan (CIRC-23)
- Adds
metaData
property to loan (for created and updated information, CIRC-24) - Requires loan-storage interface version 3.2
- Provides circulation interface version 2.3
- Include item status and location in loans
- Provides circulation interface version 2.2
- Adds property
dueDate
to loan - Adds
renewalCount
property to loan - Provides circulation interface version 2.1
- Requires loan-storage interface version 3.1
- Include implementation version in
id
in Module Descriptor - Includes missing
action
property definition in loan schema
- Adds required property
action
to loan - Provides circulation interface version 2.0
- Requires loan-storage interface version 3.0
- Removes item representation from requests forwarded to storage
- Circulation.all permission set includes permissions for related UI tasks
- Requires loan-storage interface version 2.0
- Requires item-storage interface version 3.0
- Makes the all circulation permissions set visible (requires Okapi 1.3.0)
- Includes permission definition for enabling the scan UI module (included in all permissions set)
- Requires item-storage interface version 2.0 (no incompatible changes)
- Required permissions for requests
- Initial release