| Schema name | Name | Number of columns | Primary key columns | Comment | Note |
| action | aged_circulation | 33 | id | Circulation records with information that identifies an individual patron removed. | |
| asset | asset.copy | 28 | id | This is an individual item attached to a bibliographic record and assigned a barcode, call number, and copy location. | |
| config | audience_map | 3 | code | Identifies the codes an descriptions used for audience level. Examples of audience are Preschool, Primary, Adolescent, and Adult. | |
| vandelay | authority_attr_definition | 6 | id | | |
| vandelay | authority_match | 4 | id | | |
| vandelay | authority_queue | 1 | | | |
| metabib | author_field_entry | 4 | id | Definitions for the author search index | |
| container | biblio_record_entry_bucket | 6 | id | | |
| container | biblio_record_entry_bucket_item | 5 | id | | |
| container | biblio_record_entry_bucket_item_note | 3 | id | | |
| container | biblio_record_entry_bucket_note | 3 | id | | |
| container | biblio_record_entry_bucket_type | 2 | code | | |
| vandelay | bib_attr_definition | 6 | id | | |
| config | bib_level_map | 2 | code | The bibliographic level as defined in the MARC leader byte 7. | |
| vandelay | bib_match | 5 | id | | |
| vandelay | bib_queue | 2 | | | |
| config | bib_source | 4 | id | Valid sources of MARC records
This is table is used to set up the relative "quality" of each MARC source, such as OCLC.
indicates whether a bib record is transcendant - bibs will appear in the catalog if there are no attached items. | |
| serial | bib_summary | 4 | id | | |
| money | billable_xact | 5 | id | A billable transaction - this includes circulation, bills, fines, and payment | Maintained by interaction with Unique Management. |
| money | billing | 10 | id | | |
| config | billing_type | 4 | id | Indicates whether the billing is for overdue items, damaged materials, lost materials, or processing fee, or some other purpose. | |
| serial | binding_unit | 3 | id | | |
| money | bnm_desk_payment | 9 | id, xact | | |
| money | bnm_payment | 8 | id, xact | | |
| asset | call_number | 8 | id | The call number that is used to locate the item on the shelf and is printed on the spine label. | |
| container | call_number_bucket | 6 | id | | |
| container | call_number_bucket_item | 5 | id | | |
| container | call_number_bucket_item_note | 3 | id | | |
| container | call_number_bucket_note | 3 | id | | |
| container | call_number_bucket_type | 2 | code | | |
| asset | call_number_note | 7 | id | | |
| actor | card | 4 | id | Library Cards: Each User has one or more library cards. The current "main" card is linked to here from the actor.usr table, and it is up to the consortium policy whether more than one card can be active for any one user at a given time. | |
| money | cash_payment | 9 | id, xact | | |
| money | check_payment | 10 | id, xact | | |
| action | circulation | 26 | | The record of a circulation transaction. A circulation transaction starts when the item is checked out and ends when the item is checked in, or when any outstanding fines for the item are paid. | |
| config | circ_matrix_circ_mod_test | 3 | id | Tests for max items out by circ_modifier | |
| config | circ_matrix_circ_mod_test_map | 3 | id | Tests for max items out by circ_modifier | |
| config | circ_matrix_matchpoint | 19 | id | Determine the the circulation policy that applices to a specific user and copy to be circulated.
Conditions that will cause the matchpoint to fail
- the user is BARRED
- we couldn't find the user
- we couldn't find the item
- we couldn't find a matchpoint
- the item can't circulate
- the item isn't in a circulateable status on a non-renewal
- the item can't circulate because of the shelving location
- the test is set to hard non-circulating
- the user has too many items with specific circ_modifiers checked out
The following penalties are also checked
- Max file balance
- Max items overdue
- Number of items out
- collections level fine balance | -- ****** Which ruleset and tests to use *******
--
-- * Most specific range for org_unit and grp wins.
--
-- * circ_modifier match takes precidence over marc_type match, if circ_modifier is set here
--
-- * marc_type is first checked against the circ_as_type from the copy, then the item type from the marc record
--
-- * If neither circ_modifier nor marc_type is set (both are NULLABLE) then the entry defines the default
-- ruleset and tests for the OU + group (like BOOK in PINES)
-- |
| config | circ_modifier | 5 | code | Indicates the description of the attributes that determine circulation policy. Circulation policy rules govering maximum fines, loan duration, number of renewals, and recurring fines can be set for different circulation modifiers. | |
| action_trigger | cleanup | 2 | module | After an event is reacted to (either succes or failure) a cleanup module is run against the resulting environment | |
| money | collections_tracker | 5 | id | | |
| action_trigger | collector | 2 | module | | |
| container | copy_bucket | 6 | id | | |
| container | copy_bucket_item | 5 | id | | |
| container | copy_bucket_item_note | 3 | id | | |
| container | copy_bucket_note | 3 | id | | |
| container | copy_bucket_type | 2 | code | | |
| asset | copy_location | 7 | id | The shelving location for the item. An entire location can be set as non holdable, non circulating, or not OPAC visible. | |
| asset | copy_note | 6 | id | | |
| config | copy_status | 4 | id | Copy Statuses
The available copy statuses, and whether a copy in that status is available for hold request capture. 0 (zero) is the only special number in this set, meaning that the item is available for immediate checkout, and is counted as available in the OPAC.
Statuses with an ID below 100 are not removable, and have special meaning in the code. Do not change them except to translate the textual name.
You may add and remove statuses above 100, and these can be used to remove items from normal circulation without affecting the rest of the copy's values or its location. | |
| asset | copy_transparency | 14 | id | | |
| asset | copy_transparency_map | 2 | id | | |
| money | credit_card_payment | 14 | id, xact | | |
| money | credit_payment | 8 | id, xact | | |
| acq | currency_type | 2 | code | The type of currency used for currency conversions. | |
| acq | distribution_formula | 4 | id | A preset list of owning libraries, locations and quantities that can be used to enter a purchase order. For example a distribution formala can be used to order copies for all the library branches at once. | |
| acq | distribution_formula_entry | 6 | id | | |
| action_trigger | environment | 6 | id | | |
| action_trigger | event | 12 | id | An event can be defined which tells Evergreen to run certain processes in response to the event. An example of an event might be a checkout, or an item is marked missing. | |
| action_trigger | event_definition | 16 | id | | |
| action_trigger | event_output | 4 | id | | |
| action_trigger | event_params | 4 | id | | |
| acq | exchange_rate | 4 | id | | |
| money | forgive_payment | 8 | id, xact | | |
| authority | full_rec | 8 | id | | The full MARC record, with one row for each MARC tag. |
| acq | fund | 6 | id | | |
| acq | funding_source | 5 | id | | |
| acq | funding_source_credit | 4 | id | | |
| acq | fund_allocation | 8 | id | | |
| acq | fund_debit | 10 | id | | |
| acq | fund_tag | 3 | id | | |
| acq | fund_tag_map | 3 | id | | |
| money | goods_payment | 8 | id, xact | | |
| money | grocery | 7 | id | Manually entered fines. Catchall table for local billing. Inherits from the billable_xact table. | |
| permission | grp_penalty_threshold | 5 | | Set limits for max fees, overdues, checkouts. Based on the user profile. | |
| permission | grp_perm_map | 5 | id | | |
| permission | grp_tree | 7 | id | | |
| action | hold_copy_map | 3 | id | A list of copies that statisfy a hold. | |
| config | hold_matrix_matchpoint | 23 | id | ****** Which ruleset and tests to use *******
Most specific range for org_unit and grp wins. Circ_modifier match takes precidence over marc_type match, if circ_modifier is set here marc_type is first checked against the circ_as_type from the copy, then the item type from the marc record. If neither circ_modifier nor marc_type is set (both are NULLABLE) then the entry defines the default ruleset and tests for the OU + group (like BOOK in PINES)
for each potential matchpoint for this ou and group ...
calculate the rule match weight
set the matchpoint if we found the best one
Things that will cause a failure
- we couldn't find a user
- we couldn't find a copy
- user is barred
- we couldn't find any matchpoint (requires a default) | Proc |
| action | hold_notification | 6 | id | A record of the date and time, notification method and staff involved in notifying patron that a hold is ready to pick up. | |
| action | hold_request | 27 | id | Capture information about the hold and the requestor as well as the time the hold takes to be filled. | |
| action | hold_request_cancel_cause | 2 | id | | INSERT INTO action.hold_request_cancel_cause (id, label) VALUES (1, 'Untargeted expiration');
INSERT INTO action.hold_request_cancel_cause (id, label) VALUES (2, 'Hold Shelf expiration');
INSERT INTO action.hold_request_cancel_cause (id, label) VALUES (3, 'Patron via phone');
INSERT INTO action.hold_request_cancel_cause (id, label) VALUES (4, 'Patron in person');
INSERT INTO action.hold_request_cancel_cause (id, label) VALUES (5, 'Staff forced');
INSERT INTO action.hold_request_cancel_cause (id, label) VALUES (6, 'Patron via OPAC'); |
| action | hold_transit_copy | 10 | id | A copy in transit to fill a hold. | |
| action_trigger | hook | 4 | key | The conditions that indicate that a particular event has occurred | |
| actor | hours_of_operation | 15 | | The hours of operation for an organization unit. | |
| config | i18n_core | 5 | id | Internationalization. See http://www.debian.org/doc/manuals/intro-i18n/ for details. | |
| config | i18n_locale | 4 | code | Internationalization. See http://www.debian.org/doc/manuals/intro-i18n/ for details. | |
| config | identification_type | 2 | id | Types of valid patron identification.
Each patron must display at least one valid form of identification in order to get a library card. This table lists those forms. | |
| config | idl_field_doc | 5 | id | | |
| vandelay | import_bib_trash_fields | 3 | id | | |
| vandelay | import_item | 22 | id | | |
| vandelay | import_item_attr_definition | 26 | id | Each TEXT field (other than 'name') should hold an XPath predicate for pulling the data needed. | |
| serial | index_summary | 4 | id | | |
| action | in_house_use | 5 | id | | |
| serial | issuance | 6 | id | | |
| config | item_form_map | 2 | code | | |
| config | item_type_map | 2 | code | MARC Leader 006 | |
| metabib | keyword_field_entry | 4 | id | Definitions for the keyword search index | |
| config | language_map | 2 | code | | |
| acq | lineitem | 15 | id | A line item on a purchase order that indicates a specific title to be ordered. | |
| acq | lineitem_attr | 6 | id | The line item attributes describe the line items on a picklist or purchase order. The attributes may be defined differently or different providers or users. | |
| acq | lineitem_attr_definition | 5 | id | | |
| acq | lineitem_detail | 14 | id | | |
| acq | lineitem_generated_attr_definition | 7 | id | | |
| acq | lineitem_local_attr_definition | 6 | id | | |
| acq | lineitem_marc_attr_definition | 7 | id | | |
| acq | lineitem_note | 7 | id | | |
| acq | lineitem_provider_attr_definition | 8 | id | | |
| acq | lineitem_usr_attr_definition | 7 | id | | |
| config | lit_form_map | 3 | code | | MARC 008 byte 33 |
| config | metabib_field | 8 | id | XPath used for record indexing ingest
This table contains the XPath used to chop up MODS into its indexable parts. Each XPath entry is named and assigned to a "class" of either title, subject, author, keyword or series | See http://evergreen-ils.org/dokuwiki/doku.php?id=documentation:indexing for more information |
| metabib | metarecord | 3 | id | | |
| metabib | metarecord_source_map | 2 | id | | |
| config | net_access_level | 2 | id | Patron Network Access level
This will be used to inform the in-library firewall of how much internet access the using patron should be allowed. | |
| action | non_cataloged_circulation | 6 | id | Circulation to a user that does not have a bib record in the catalog. Only an itype type is specified, no specific title. | |
| config | non_cataloged_type | 5 | id | Types of valid non-cataloged items, depending on the library policy. Examples are pamphlet and paperback | |
| action | non_cat_in_house_use | 5 | id | In house circulation that does not have a bib record in the catalog. Only an itype type is specified, no specific title. | |
| actor | org_address | 11 | id | An organization address. An organization may have more than one address for different purposes - mailing, physical. | |
| actor | org_lasso | 2 | id | An org lasso is a grouping of organizational units. | |
| actor | org_lasso_map | 3 | id | The org lasso map relates and org unit to one or more org lassos (groups). | |
| actor | org_unit | 12 | id | An organizational unit could be at any level in the hierarchy - a department, branch, library system, or consortium. | |
| actor | org_unit_closed | 5 | id | Indcates when a unit is closed. Affects fine calculations, due dates, and holds targeting. | |
| actor | org_unit_proximity | 4 | id | Indicates physical distances between org units for holds targeting based on proximity. | |
| actor | org_unit_setting | 4 | id | This table contains any arbitrary settings that a client program would like to save for an org unit. Miscellaneous settings i.e. Allow credit card payments, rehelving item status interval. Watch for new things added to this list after upgrades. | |
| actor | org_unit_type | 7 | id | Type of org unit - i.e. department, branch, library system. This also indicates the position of this type of org unit in the hierarchy. | |
| money | payment | 6 | id | | |
| permission | perm_list | 3 | id | | |
| acq | picklist | 8 | id | This is the selection list, the first step in the order process. Purchase Orders can be created directly from items approved on selection lists. | |
| acq | po_note | 7 | id | | |
| acq | provider | 6 | id | A vendor or service provider of items on a purchase order. | |
| acq | provider_address | 11 | id | | |
| acq | provider_contact | 6 | id | | |
| acq | provider_contact_address | 11 | id | | |
| acq | provider_holding_subfield_map | 4 | id | | |
| acq | purchase_order | 9 | id | | |
| vandelay | queue | 5 | id | | |
| vandelay | queued_authority_record | 3 | | | |
| vandelay | queued_authority_record_attr | 4 | id | | |
| vandelay | queued_bib_record | 4 | | | |
| vandelay | queued_bib_record_attr | 4 | id | | |
| vandelay | queued_record | 5 | id | | |
| action_trigger | reactor | 2 | module | After an event passes validation (action_trigger.validator), the reactor processes it. | |
| metabib | real_full_rec | 7 | id | | |
| authority | record_entry | 12 | id | The record entry that uniquely identifies an authority record. | |
| serial | record_entry | 11 | id | | |
| biblio | record_entry | 14 | | The record entry that uniquely identifies an authority record. | |
| authority | record_note | 7 | id | | |
| biblio | record_note | 8 | id | | |
| metabib | rec_descriptor | 16 | id | MARC leader information | |
| authority | rec_descriptor | 4 | id | | |
| search | relevance_adjustment | 5 | id | | |
| config | rule_age_hold_protect | 4 | id | Hold Item Age Protection rules
A hold request can only capture new(ish) items when they are within a particular proximity of the home_ou of the requesting user. The proximity ('prox' column) is calculated by counting the number of tree edges between the user's home_ou and the owning_lib of the copy that could fulfill the hold. | |
| config | rule_circ_duration | 6 | id | Circulation Duration rules
Each circulation is given a duration based on one of these rules. | Circulation duration load rules |
| config | rule_max_fine | 4 | id | Circulation Max Fine rules
Each circulation is given a maximum fine based on one of these rules. | Maximum fine loan rules. |
| config | rule_recuring_fine | 6 | id | Circulation Recurring Fine rules
Each circulation is given a recurring fine amount based on one of these rules. The recurance_interval should not be any shorter than the interval between runs of the fine_processor.pl script (which is run from CRON), or you could miss fines. | Fine loan rule |
| offline | script | 8 | id | | |
| metabib | series_field_entry | 5 | | Definitions for the series search index | |
| offline | session | 8 | | | |
| config | standing | 2 | id | Patron Standings
This table contains the values that can be applied to a patron by a staff member. These values should not be changed, other than for translation, as the ID column is currently a "magic number" in the source. :( | |
| config | standing_penalty | 4 | id | Defines the types of standing penalties. For example, block renewals or block placing holds. | Functions that are blocked (i.e. CIRC, RENEW, HOLD) if a patron is subject to a standing penalty.
INSERT INTO config.standing_penalty (id, name, label, block_list)
VALUES (1, 'PATRON_EXCEEDS_FINES', 'Patron exceeds fine threshold', 'CIRC|HOLD|RENEW');
INSERT INTO config.standing_penalty (id, name, label, block_list)
VALUES (2, 'PATRON_EXCEEDS_OVERDUE_COUNT', 'Patron exceeds max overdue item threshold', 'CIRC|HOLD|RENEW');
INSERT INTO config.standing_penalty (id, name, label, block_list)
VALUES (3, 'PATRON_EXCEEDS_CHECKOUT_COUNT', 'Patron exceeds max checked out item threshold', 'CIRC');
INSERT INTO config.standing_penalty (id, name, label, block_list)
VALUES (4, 'PATRON_EXCEEDS_COLLECTIONS_WARNING', 'Patron exceeds pre-collections warning fine threshold', 'CIRC|HOLD|RENEW');
INSERT INTO config.standing_penalty (id, name, label) VALUES (20, 'ALERT_NOTE', 'Alerting Note, no blocks');
INSERT INTO config.standing_penalty (id, name, label) VALUES (21, 'SILENT_NOTE', 'Note, no blocks');
INSERT INTO config.standing_penalty (id, name, label, block_list) VALUES (22, 'STAFF_C', 'Alerting block on Circ', 'CIRC');
INSERT INTO config.standing_penalty (id, name, label, block_list) VALUES (23, 'STAFF_CH', 'Alerting block on Circ and Hold', 'CIRC|HOLD');
INSERT INTO config.standing_penalty (id, name, label, block_list) VALUES (24, 'STAFF_CR', 'Alerting block on Circ and Renew', 'CIRC|RENEW');
INSERT INTO config.standing_penalty (id, name, label, block_list) VALUES (25, 'STAFF_CHR', 'Alerting block on Circ, Hold and Renew', 'CIRC|HOLD|RENEW');
INSERT INTO config.standing_penalty (id, name, label, block_list) VALUES (26, 'STAFF_HR', 'Alerting block on Hold and Renew', 'HOLD|RENEW');
INSERT INTO config.standing_penalty (id, name, label, block_list) VALUES (27, 'STAFF_H', 'Alerting block on Hold', 'HOLD');
INSERT INTO config.standing_penalty (id, name, label, block_list) VALUES (28, 'STAFF_R', 'Alerting block on Renew', 'RENEW'); |
| asset | stat_cat | 4 | id | Defines user defined statistical categories for copies. | Controlled vocabulary for user defined patron related fields. |
| actor | stat_cat | 4 | id | User Statistical Catagories: Local data collected about Users is placed into a Statistical Catagory. Here's where those catagories are defined. | |
| actor | stat_cat_entry | 3 | id | User Statistical Catagory Entries: Local data collected about Users is placed into a Statistical Catagory. Each library can create entries into any of its own stat_cats, its ancestors' stat_cats, or its descendants' stat_cats. | |
| asset | stat_cat_entry | 4 | id | The statistical category entry for a particular copy. | The list of valid values for a statistical category. |
| asset | stat_cat_entry_copy_map | 4 | id | | |
| asset | stat_cat_entry_transparency_map | 4 | id | | |
| actor | stat_cat_entry_usr_map | 4 | id | Statistical Catagory Entry to User map: Records the stat_cat entries for each user. The values for a stat cat assigned to a particular user (patron). For example, this will indicate that a particular patron. Application will let the user enter a value that is not on the list of valid values. | |
| metabib | subject_field_entry | 4 | id | Definitions for the subject search index | |
| serial | subscription | 5 | id | | |
| serial | sup_summary | 4 | id | | |
| action | survey | 10 | id | Summary information about a user survey. The details of the survey are in the survey response, survey_question and survey_answer tables. Also indicates if a survey is required. | |
| action | survey_answer | 3 | id | | |
| action | survey_question | 3 | id | | |
| action | survey_response | 8 | id | | |
| metabib | title_field_entry | 4 | id | Definitions for the title search index | |
| action | transit_copy | 9 | id | | |
| action | unfulfilled_hold_list | 5 | id | A hold that trapped for a specific copy and was not fulfilled. Records the date and time the fulfillment failed This facilitiates the retargeting of holds. | |
| config | upgrade_log | 2 | version | Records the date each version of the application was installed. | |
| asset | uri | 5 | id | Uniform Resource Indicator for an asset. | |
| asset | uri_call_number_map | 3 | id | | |
| container | user_bucket | 6 | id | | |
| container | user_bucket_item | 5 | id | | |
| container | user_bucket_item_note | 3 | id | | |
| container | user_bucket_note | 3 | id | | |
| container | user_bucket_type | 2 | code | | |
| actor | usr | 39 | id | This table contains the core User objects that describe both staff members and patrons. The difference between the two types of users is based on the user's permissions. | |
| actor | usr_address | 14 | id | A user's address. A user may have more than one address for different purposes - physical, mailing, temporary, etc. | |
| permission | usr_grp_map | 3 | | | |
| actor | usr_note | 7 | id | Free text notes for a user, also indicates whether the note is OPAC visible. | |
| permission | usr_object_perm_map | 6 | | | |
| actor | usr_org_unit_opt_in | 6 | id | | |
| permission | usr_perm_map | 5 | | | |
| actor | usr_setting | 4 | id | This table contains any arbitrary settings that a client program would like to save for a user. | |
| actor | usr_standing_penalty | 8 | | A standing penalty is a circulation policy that is not specific to a particular copy. Examples of standing penalties are to block circulation if a user owes more than a certain dollar amount or if they have too many overdue items. | |
| permission | usr_work_ou_map | 3 | id | The function permission.usr_has_perm_at_nd returns a set of all the org units for which a given user has a given
permission, granted directly (not through inheritance from a parent org unit). The permissions apply to a minimum depth of the org unit hierarchy, for the org unit(s) to which the user is assigned. (They also apply to the subordinates of those org units, but we don't report the subordinates here.)
The function useses this table to define which users belong to which org units. I.e. we ignore the home_ou column of actor.usr. | |
| action_trigger | validator | 2 | module | | |
| config | videorecording_format_map | 2 | code | Codes and descriptions for videorecording formats. | |
| actor | workstation | 4 | id | Workstation registration. This associates a PC with an organization unit. This is used to determine the location for checkin, checkout, and holds operations. | |
| money | work_payment | 8 | id, xact | | |
| config | xml_transform | 4 | name | Identifies the xslt template for display. | |
| config | z3950_attr | 7 | id | | |
| config | z3950_source | 8 | name | | |