Difference between revisions of "Library Circulation"

From CollectiveAccess Documentation
Jump to: navigation, search
(Browse Tools)
(Browse Tools)
Line 58: Line 58:
  
 
# one of: available, out, reserved, overdue
 
# one of: available, out, reserved, overdue
# If set then the facet will only ever return matches for that status
+
# Limits facet to a specific type of checkout
#status = reserved,
+
# status = reserved,
 
 
 
group_mode = none,
 
group_mode = none,
Line 75: Line 75:
 
 
 
# one of: user, all
 
# one of: user, all
#user = show checkouts (type determined by 'status' below) by user
+
# user = show checkouts by user
 
mode = user,
 
mode = user,
 
 
 
# one of: available, out, reserved, overdue
 
# one of: available, out, reserved, overdue
 
# Limits facet to a specific type of checkout  
 
# Limits facet to a specific type of checkout  
#status = overdue,
+
# status = overdue,
 
 
 
group_mode = none,
 
group_mode = none,

Revision as of 19:58, 13 July 2016

--- IN PROGRESS ---

With version 1.5 CollectiveAccess includes an optional Library Circulation module that supports a simple check in/check out workflow.

Set up

The module is be enabled once directives in /app/conf/app.conf and /app/conf/library_services.conf are set.

In /app/conf/app.conf:

#
# Library-style check-out of objects
#
enable_library_services = 1
enable_object_checkout = 1

And in /app/conf/library_services.conf:

checkout_types = {
	your_object_type_here = {
		default_checkout_period = +7 days,
		allow_override_of_due_dates = 1
	}
}

Once "checkout_types" is set with a valid code from the system list object_types, the Library menu and dashboard will become visible:

LibraryModule.png

The main interface for the module is the Dashboard, which provides an overview of circulation activity. The Dashboard also includes a search box so that activity can be rendered for specific days or date ranges.

Check in and check outs contain their own menus.

There are several features outside of the module that facilitate the circulation workflow.

User Interfaces Tools

Several user interface bundles allow cataloguers to manage the circulation of items.

Checkout history.png

Browse Tools

There are several browse facets that can be configured to output circulation data in the form of search results.

The "all" facet shows types of checkout categories (available, out, reserved, overdue) and returns objects currently carrying the state of that category. When used with an optional status setting it can also limit to a specific type of checkout class. This can be useful for quickly browsing on all overdue items, for example.


		checkouts_all = {
			type = checkouts,
			restrict_to_types = [],
			
			# one of: user, all
			# all = show types of checkouts in facet 
			mode = all,

			# one of: available, out, reserved, overdue
			# Limits facet to a specific type of checkout 
			# status = reserved,
			
			group_mode = none,
			
			label_singular = _("checkout"),
			label_plural = _("checkouts")
		},

The "user" status allows for browsing on a specific user's account. The facet will return all users who have activity matching the criteria set in the status setting.

		checkouts_user = {
			type = checkouts,
			restrict_to_types = [],
			
			# one of: user, all
			# user = show checkouts by user
			mode = user,
			
			# one of: available, out, reserved, overdue
			# Limits facet to a specific type of checkout 
			# status = overdue,
			
			group_mode = none,
			
			label_singular = _("checkout by user"),
			label_plural = _("checkouts by user")
		}

Display Tools

To include circulation data in a report, simply use the bundle "Related object checkouts" (ca_objects_checkouts) within a display. The bundle will not output any data until you include a display template. The hard coded values used to output circulation data points in templates can be found below:

For Users (ca_users)

Bundle Name Description
user_name User name
fname User's first name
lname User's last name
email User's email

For Checkouts (ca_object_checkouts)

Bundle Name Description
checkout_id Unique numeric identifier used by CollectiveAccess internally to identify this object checkout entry.
group_uuid UUID for group checkout is part of.
object_id The id of the object that was checked out.
user_id The user who checked out the object.
created_on Date/time the checkout entry was created.
checkout_date Date/time the item was checked out.
due_date Date/time the item is due to be returned.
return_date Date/time the item was returned.
return_notes Notes at return of object.
checkout_notes Notes made at checkout time.
numOverdueCheckouts Number of overdue checkouts.
overdueCheckoutUserList User list for all overdue checkouts.
numCheckouts Number of checked out items.
checkoutUserList User list for all items checked out.
numCheckins Number of checked in items.
numReservations Number of reservations.
reservationUserList User list for all reservations.
last_sent_coming_due_email Date/time a coming due notice was last sent.
last_sent_overdue_email Date/time an overdue notice was last sent.
last_reservation_available_email Date/time a reservation available notice was last sent.
deleted Indicates if the order is deleted or not.
Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools