Versions Compared

Old Version 36

changes.mady.by.user Irina Pokhylets

Saved on

compared with

New Version Current

changes.mady.by.user Irina Pokhylets

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

References

...

Before placing DCB request at the in Alma as a lending agency, a virtual patron needs to be found or created in Alma.

...

A virtual patron in Alma can be created by using the Create a User API.

...

  • record_type:Public

  • primary_id: The primary identifier of the user

  • first_name: User's first name.

  • last_name: User's last name.

  • account_type: External

  • user_group: Used in fulfillment policies (which one to choose or DCB should create (question))

For more details on creating a user, refer to Create user

...

  • user_primary_id: The ID of the requesting user.

  • request_type: HOLD

  • pickup_location_type: LIBRARY

  • pickup_location_library: The pickup location library code. (Note: Alma does not provide a direct API endpoint to create pickup locations dynamically. Pickup locations are defined and configured in the Alma interface by library administrators.)

  • material_type (optional): Used in fulfillment policies.

...

  • The actual record: XML string describing the record

    • suppress_from_publishing: tbd

For more details on creating a holding record, refer to Create holding record

...

Lifecycle

Given

When

Then

Dispatched by Supplying Library

Trigger: Manual action in Alma - Scan in items

  • DCB Patron Request exists in status REQUEST_PLACED_AT_BORROWING_AGENCY

DCB Patron Request Workflow matches corresponding request details at

  • Alma Supplying Library:

    • Request status: In progress (Transit item)

    • Item status: Transit

Trigger DCB HandleSupplierInTransit event to change

  • Borrowing or Pickup Library

    • transaction state = OPEN

  • DCB

    • PatronRequest.PICKUP_TRANSIT

    • HostLmsItem.ITEM_PICKUP_TRANSIT

Received at Pickup Library

  • DCB Patron Request exists

    • with corresponding HostLmsItem.ITEM_PICKUP_TRANSIT

DCB Patron Request Workflow matches corresponding request details at

  • Pickup Library

    • transaction state = AWAITING_PICKUP

Trigger HandleBorrowerItemOnHoldShelf event to change

  • Borrowing or Pickup Library

    • transaction state =AWAITING_PICKUP

  • DCB

    • PatronRequest.READY_FOR_PICKUP

    • HostLmsItem.ITEM_ON_HOLDSHELF

  • Alma Supplying Library(question) :

    • On hold shelf / Ready for pickup

Item Checked Out to Patron at Pickup Library

  • DCB Patron Request exists

    • with corresponding HostLmsItem.ITEM_ON_HOLDSHELF

DCB Patron Request Workflow matches corresponding request details at

  • Pickup Library

    • transaction state = ITEM_CHECKED_OUT

Trigger HandleBorrowerItemLoaned event to change

  • Borrowing or Supplying Library

    • transaction state = ITEM_CHECKED_OUT

  • DCB

    • PatronRequest.LOANED

    • HostLmsItem.ITEM_LOANED

  • Alma Supplying Library:

    • Request status: In progressCompleted

    • Item status: Loan

    • Loan status: Active, the item is checked out to a patron.

Item Returned by Borrowing Patron

  • DCB Patron Request exists in status

    • with corresponding HostLmsItem.ITEM_LOANED

DCB Patron Request Workflow matches corresponding request details at either

  • Pickup or Borrowing Library

    • transaction state = ITEM_CHECKED_IN

Trigger HandleBorrowerRequestReturnTransit event to change at

  • Borrowing or Pickup Library

    • transaction state = ITEM_CHECKED_IN

    • loan status = Closed

    • virtual item status = In transit

  • DCB

    • PatronRequest.RET-TRANSIT

    • HostLmsItem.ITEM_RETURNED

  • Alma Supplying Library:

    • no changes?

Received Back at Lending Agency

Trigger: Manual action in Alma - Return items

  • DCB Patron Request exists in status

    • with corresponding HostLmsItem.ITEM_RETURNED

DCB Patron Request Workflow matches corresponding request details at either

  • Alma Supplying Library

    Request status: Completed

    • Item status: Item in place /Transit for Reshelving?

    • Loan status:

      • In Transit: If the item is returned to a non-owning branch and is being sent back to its home location

      • Returned: The item has been returned to the library and is no longer checked out.

Trigger HandleBorrowerRequestReturnTransit event to change

  • Borrowing or Pickup Library

    • transaction state = CLOSED

  • DCB

    • PatronRequest.COMPLETED

    • HostLmsItem.ITEM_AVAILABLE

    • Local status on supplier request changed to AVAILABLE

Workflow diagram

...

Alma loan creation

Create Loan API allows to create a loan record for a patron.

...