Database structure

From ReservesDirect: Open Source EReserves System

Home :: Features :: Screenshots :: Demo (http://www.reservesdirect.org/demo/index.html) :: Documentation :: Downloads :: Support :: Blog (http://www.reservesdirect.org/blog) :: Join Us!
ReservesDirect Documentation:   Contents | Library staff handbook | System administrator handbook | Developer handbook
Developer's Guide
edit developer toc (http://www.reservesdirect.org/wiki/index.php?title=Template:Dev_toc&action=edit)



Incomplete

Table of contents

Tables

access

This table tracks the level of access for a given user to a given course instance based on their role in the class, e.g. "proxy" (2) or "instructor" (3).

Field List

  • user_id
  • alias_id
  • permission_level

circ_rules

This table defines circ rules that are used in setting up physical items. These rules are passed directly to the Integrated Library System (ILS) to create physical reserves and correspond exactly to the loan rules for reserve items in the ILS. This table genrates the drop-down list of selectable loan rules on the Add Physical Item screen and is only meaningful if physical item integration is turned on and being used.

Field List

  • circ_rule - The ILS circ rule code used to set the loan period for a physical reserve item in the ILS
  • alt_circ_rule - Alternate circ rule to be used if certain conditions are met in the ILS For instance, in Sirsi Unicorn, the alt circ rule can used to define what loan period should be set if the transaction occurs after 10pm.
  • default_selected - Specifies the default circ rule to be used when adding physical items


course_aliases

course_instances

courses

Contains a record for every course in the system.

Field List

  • department_id - foreign key to departments table indicating what dept course is associated with
  • course_number - official course number assigned by the university registrar
  • course_name - official course name assigned by the university registrar
  • uniform_title - not used (?)
  • old_id - used during database conversion from another db to ReservesDirect to form a relationship with the matching key for course id in the old system


departments

This table contains a record for each department. Future releases should include admin screens to modify this table.

Field List

abbreviation - department abbreviation prepended to course.course_number to build Course Number as displayed

name - long department name

library_id - foreign key to library table indicating library for reserves processing

status - not used

electronic_item_audit

hidden_readings

inst_loan_periods

inst_loan_periods_libraries

instructor_attributes

item_upload_log

items

libraries

This table includes records for each libary in the system. Future releases should include admin screens to modify this table.

Field List

name - Full Name of the Library

nickname - Short name displayed most often

ils_prefix - prepended to term to create ILS course designation

reserve_desk - reserves desk that holds items placed on reserve for this library. Must match with ILS reserve_desks

url - URL of library homepage

contact_email - email address of admin for this library for various notifications

monograph_library_id - indicates library that processes non-multimedia request items

multimedia_library_id - indicates library that processes multimedia request items

mimetypes

This table contains setting for supported mimetypes. Future releases should include admin screens to modify this table.

Field List

mimetype - name

helper_app_url - url for download of needed viewing application

helper_app_name - name of helper application

helper_app_icon - icon for display with helper application link

file_extentions - file extentions which are defalted to use helper application

news

This table holds news items. The news feature is intended to provide a means to communicate scheduled maintenance or system outages to all users.

Field List

news_id - primary key

news_text - text which is displayed HTML is acceptable

font_class - css style that will be applied to text

permission_level - text is supplied to designated users NULL will display to all users

begin_time - datetime to begin message display

end_time - datetime to end message display

IF BOTH begin_time and end_time are NULL message will display forever

sort_order - order or message display DESC


not_trained

This table override the dflt_permission level found in the users table. Adding users to this table limits the access they have to the system without removing them from selection boxes. The intended purpose of this table is to allow instuctors to appear in all selection locations without giving edit permissions to the instuctor. Once an instructor has be properly trained they should be removed from the table. Future releases should include admin screens to modify this table.

Field List

user_id - foreign key to users table

permission_level - override level most often set to 0 giving student (view only permissions)

permission_levels

This table indicates the defined permission levels. Future releases should include admin screens to modify this table.

The existing levels are 0 - Student, 1 - Custodian, 2 - Proxy, 3 - Instructor, 4 - Staff, and 5 - Admin.

notes

permission_levels

physical_copies

proxies

id - Primary Key

name - Proxy Name ie ezProxy - this value is not displayed and can be blank

prefix - Proxy Prefix - this value will be perpended to the item url

proxied_hosts

id - Primary Key

proxy_id - Foreign Key to proxies table

domain - url or portion of which will be matched

partial_match - (boolean) indicating that partial_match is accepted 0 requires exact matching for entire domain

requests

reserves

reserves_old

skins

special_users

special_users_audit

staff_libraries

terms

This table contains the default begin and end dates for each term. Future releases should include admin screens to modify this table. The current term plus 2 should be included in the table for proper functionality, THIS TABLE SHOULD BE UPDATED NEAR THE END OF EACH TERM. The begin and end dates specified here are the defaults used when new class are created.


Field List

sort_order - the order in which terms appear

term_name - name displayed to users

term_year - term year may be YY or YYYY is combined with term_name for display name (eg. Fall 2005)

begin_date - YYYY-MM-DD default activation date for classes classes created in this term

end_date - YYYY-MM-DD default expiration date for classes classes created in this term

user_view_log

users