Configuration:MySQL config
From ReservesDirect: Open Source EReserves System
| Table of contents |
Overview
Certain tables in the ReservesDirect database contain field values that are unique to each local implementation of the system. Example data is provided when you create the initial database from the source code tarball. Most of these tables must be edited during implementation with values proper to your own library.
Tables to be pre-populated with localization values
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
libraries
This table includes records for each libary in the system. Future releases should include admin screens to modify this table. If you are going to use the physical item ILS integration features, and especially if you are implementing RD for a multi-library environment, every staff user must be assigned a library. Currently this can only be done in the database, not through the interface.
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 - valid RFC 2046 media type
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
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.
skins
This table designates which skin (presentation style) to use with ReservesDirect. A default skin is supplied with the source code, controlled by css/ReservesStyles.css.
Field List
id - skin id
skin_name - friendly name for the skin
skin_stylesheet - css file that controls the skin
default_selected - whether this is the default skin
terms / semesters
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
Terms Add/Edit was added with v2.3 - This feature is linked from the Admin Tab
AutoProxy
With v2.3 support was added for automatic proxy of selected materials. It is no longer necessary for users to add proxy information when adding a linked resource. To implement autoproxy you will need to edit 2 database tables proxies and proxied_hosts.
Start by adding your proxy to the proxies table. Then add domains which should be proxied to the proxied_host table. The reservesViewer.php script will now automatically perpend the proxies.prefix field to item urls which match the domains specified in the proxied_hosts table. This feature was developed specifically for use with EZproxy (http://www.usefulutilities.com/) to extend web-based licensed databases to remote users additional development will be required to work with another proxy utility
An example will help clarify things.
Assume your proxy server is located at https://my_ezproxy.my_domain.edu. You would insert this url into the proxies table.
Now assume the we need to pass links to http://licensed_content.copyright_holder.com thur EZproxy to ensure access is restricted. This can be do by inserting either of the following records into the proxied_hosts table.
proxy_id => 1 (value for the record in your proxies table) domain => 'licensed_content.copyright_holder.com' partial_match => 0
this would proxy links to http://licensed_content.copyright_holder.com?QUERY_STRING but not http://QUERY_STRING.licensed_content.copyright_holder.com
For this we would need to add
proxy_id => 1 (value for the record in your proxies table) domain => 'licensed_content.copyright_holder.com' partial_match => 1
