Circulation

id

bigint

false

System-generated sequential ID.

item_record_id

bigint

false

Foreign key to item_record

patron_record_id

bigint

false

Foreign key to patron_record.

created_gmt

timestamptz

false

Date and time the booking was created.

start_gmt

timestamptz

false

Booking start date and time.

end_gmt

timestamptz

false

Booking end date and time.

type_code

char

false

Code identifying the method used to place the booking,

prep_period

int

false

The date and time at which the booked item becomes unavailable.

location_code

varchar

false

Location code associated with the booking.

delivery_code

int2

false

The delivery method selected when the booking was placed. Possible values are:

If the prep_booking EO is set to "true|on", the value in this field is always '0'.

location_note

varchar

false

Location descriptive note.

note

varchar

false

Free text note field.

event_name

varchar

false

Event name associated with the booking.

id

bigint

false

System-generated sequential ID.

patron_record_id

bigint

false

Foreign key to patron_record.

item_record_id

bigint

false

Foreign key to item_record.

items_display_order

int

false

Integer to manage the display order of an item list.

due_gmt

timestamp

false

Due date of the item.

loanrule_code_num

int

false

The loan rule number (from the Loan Rule Determiner table) under which an item is currently checked out. '0' if the item is not checked out.

checkout_gmt

timestamp

false

Checkout date and time of the item.

renewal_count

int

false

Total number of times the item has been renewed.

overdue_count

int

false

The level of the last overdue letter sent to the patron who has the item checked out (for example, 1 = first overdue, 2 = second overdue, etc.)

overdue_gmt

timestamp

false

The date of the last overdue letter sent to the patron.

recall_gmt

timestamp

false

The date the item was recalled (blank if the item has not been recalled).

ptype

int2

false

The type of patron. Used to define groups of patrons that may have different borrowing privileges. The library defines ptype codes and definitions.

loan_rule_num

int

false

The loan rule number.

period_uom

int

false

A code indicating the time unit used to measure the loan period. Possible values are:

loan_period

int

false

The length of time (in units specified in the period_uom element) that the item is loaned when there are no special conditions for the checkout.

first_renewal_period

int

false

The duration of the first renewal period that follows the normal loan period.

additional_renewal_period

int

false

The duration of each subsequent renewal after the first renewal period.

is_holdable

boolean

false

Specifies whether holds can be placed on items covered by this loan rule. Possible values are:

• y - The item is holdable
• n - The item is not holdable.

is_shippable

boolean

false

Specifies whether requesting patrons can elect to have their held items mailed. Possible values are:

• y - Requesting patrons can have their held items mailed.
• n - Requesting patrons cannot have their held items mailed.

ship_days

int

false

Specifies the number of days to extend the due date for shipped items.

pickup_days

int

false

The number of days a held item remains on the holdshelf. After the item remains on the holdshelf for the number of days specified in this element, the hold becomes defunct.

max_renewal

int

false

The total number of renewals allowed, including automatic renewals.

grace_period

int

false

The number of days or minutes after an item is due when overdue fines begin accruing.

replacement_processing_fee

numeric

false

The processing fee portion of the replacement bill to assess for an unreturned item. This amount represents the library's expenses in acquiring and cataloging a replacement copy.

Specifies whether patrons can select a pickup location when placing a hold. This element applies to standard circulation (non-ILL, non-INN-Reach) holds only.

Possible values are:

• y - For item-level holds, the system automatically sets the pickup location to match the item LOCATION fixed-length field. For title-level holds, the system changes the pickup location to match the item LOCATION when an item fills the hold.
• n - The system allows users to select a pickup location.

id

int

false

System-generated sequential ID.

transaction_gmt

timestamptz

false

Transaction date in UNIX format.

application_name

varchar

false

The name of the program that generated the transaction. Valid program names are:

• circ (includes transactions made using PC Circ)
• circa (for transactions written by selfcheckwebserver and in-house use [transaction codes 'u' and 's'], which use webpac to execute transactions.)
• milcirc
• milmyselfcheck
• readreq
• selfcheck

source_code

varchar

false

The transaction source. Possible values are:

• local
• INN-Reach
• ILL

op_code

varchar

false

Type of transaction.

• o = checkout
• n = hold
  
• nb = bib hold
  
• ni = item hold
  
• nv = volume hold
• f = filled hold
• b = booking
• i = checkin
• h = hold with recall
  
• hb = hold recall bib
  
• hi = hold recall item
  
• hv = hold recall volume
• r = renewal
• u = use count

patron_record_id

bigint

false

Foreign key to patron_record.

item_record_id

bigint

false

Foreign key to item_record.

volume_record_id

bigint

false

Foreign key to volume_record.

bib_record_id

bigint

false

Foreign key to bib_record.

stat_group_code_num

int

false

The number of the terminal at which the transaction occurred or the user-specified statistics group number for PC-Circ transactions.

Also stores the login's statistics group number for circulation transactions performed with the following Circa applications:

• checkout
• checkin
• count internal use

due_date_gmt

timestamptz

false

Due date in UNIX format. The application of this date depends on the op_code for the transaction. The due date is not included for bookings (op_code b) or filled holds (op_code f).

For op_code 'i' (checkin), this is the original due date.

For op_code 'r' (renewal), this is the renewal due date.

For op_code 'o' (checkouts), this is the item due date.

For op_codes 'n' (holds) and 'h' (holds with recall), a non-zero entry indicates that the hold is for a checked-out item that is due on the specified date.

count_type_code_num

int

false

Indicates the type of use count (for op_code 'u'):

itype_code_num

int

false

Item type code. (Defined by the library.)

icode1

int

false

Item code 1. (Defined by the library.)

icode2

varchar

false

Item code 2. (Defined by the library.)

item_location_code

varchar

false

A five-character location code, right-padded with spaces, from the associated item record.

item_agency_code_num

int

false

A one-character AGENCY code from the associated item record.

ptype_code

varchar

false

Patron type code. (Defined by the library.)

pcode1

char

false

Patron code 1. (Defined by the library.)

pcode2

char

false

Patron code 2. (Defined by the library.)

pcode3

int

false

Patron code 3. (Defined by the library.)

pcode4

int

false

Patron code 4. (Defined by the library.)

patron_home_library_code

varchar

false

A five-character location code, right-padded with spaces, from the associated patron record.

patron_agency_code_num

int

false

A one-character AGENCY code from the associated patron record.

id

bigint

false

System-generated sequential ID.

name

varchar

false

Name to identify entry.

minimum_owed_amt

numeric

false

Minimum amount that a patron must owe to be eligible for inclusion in the Collection Agency Report.

start_date_gmt

timestamptz

false

The first assessment of a fine must be on or after the date in the start date element for a patron to be eligible for inclusion in the Collection Agency Report.

If this element is not defined, the system goes as far back as the data allows (i.e., it evaluates all fines that were generated before the date specified in the end date element).

end_date_gmt

timestamptz

false

The first assessment of a fine must be before the date in the End date element for a patron to be eligible for inclusion in the Collection Agency Report.

If this element is not defined, the system uses the current date as the end date.

grace_period

int

false

Number of days that a patron must owe money before being eligible for inclusion in the Collection Agency Report. This period is applied to the start date and the first fine assessment date.

If the sum of the first fine assessment date plus the days in the Grace Period element brings a fine's eligibility for inclusion in the report to a date after the End Date (or to a date before the sum of the Start Date plus the Grace Period), that fine is not included in the Collection Agency report. In other words, the Start Date + Grace Period must be earlier than or the same as the first fine assessment date + Grace Period, which must be earlier than or the same as the End Date.

minimum_days_overdue

int

false

Minimum number of days past the due date of a checked-out item (the number of days overdue) before a patron is eligible for inclusion in the Collection Agency Report. This value only applies to days the library is open and does not count days closed.

This value is ignored for patrons that are already included in the Collection Agency Report.

Setting this element ensures that only fines that are associated with overdue items can be included in the Collection Agency Report (i.e., manual fines will not be added to the report).

remove_if_less_than_amt

numeric

false

Minimum amount that a patron must owe to remain in the Collection Agency Report.

agency_fee_amt

numeric

false

Amount of the Collection Agency Report Charge, which is a fee that patrons are automatically assessed for being included in the Collection Agency Report.

email_source

varchar

false

Email account from which the Collection Agency Report is sent.

email_to

varchar

false

Comma-delimited list of email addresses to which the Collection Agency Report should be sent.

email_cc

varchar

false

Comma-delimited list of email addresses to which the Collection Agency Report should be copied.

email_subject

varchar

false

Subject line used for the Collection Agency Report.

auto_new_submission

boolean

false

Specifies whether the New Submissions Report is automatically created and sent. Possible values: y = yes ,n = no.

auto_update_submission

varchar

false

Comma or dash-delimited list of days the Updated Patrons Report is sent. 1=Sunday, 2=Monday, and so on through 7=Saturday.

id

bigint

false

System-generated sequential ID.

colagency_id

bigint

false

Foreign key to colagency.

home_library

varchar

false

Location(s) to which patrons must belong to be eligible for inclusion in the Collection Agency report. A blank entry represents all locations.

id

bigint

false

System-generated sequential ID.

colagency_id

bigint

false

Foreign key to colagency.

ptype

int2

false

The P TYPE number(s) that are eligible for inclusion in the Collection Agency Report. Only P TYPE numbers that are listed in the col_ptypes option can be specified. A blank entry represents all of the P TYPE numbers specified in the col_ptypes option.

id

bigint

false

System-generated sequential ID.

patron_record_metadata_id

bigint

false

Foreign key to patron_record_metadata.

status

varchar

false

The status of the patron's inclusion in the Collection Agency reports. Possible values are:

0 = unknown
1 = new
2 = update
3 = unchanged
4 = removed

Multiple occurrences of a given value are allowed.

time_removed_gmt

timestamptz

false

Date the patron was removed from the Collection Agency report.

time_report_last_run_gmt

timestamptz

false

Date of the last report run including the current patron.

colagency_criteria_metadata_id

bigint

false

Foreign key to colagency_criteria_metadata.

id

bigint

false

System-generated sequential ID.

patron_record_id

bigint

false

Foreign key to patron_record.

assessed_gmt

timestamptz

false

The date the fine was assessed. Note that if the fine is a reinstated fine, this column reflects the date the fine was reinstated and not the original date the fine was assessed.

invoice_num

int

false

The fine's invoice number. For fine adjustment entries (charge type = 4), this column contains the invoice number of the original fine.

item_charge_amt

numeric

false

processing_fee_amt

numeric

false

billing_fee_amt

numeric

false

charge_code

char

false

The code for the fine type.

charge_location_code

varchar

false

paid_gmt

timestamptz

false

The date the fine was paid or, if the action was an adjustment, the current date.

terminal_num

int

false

The terminal number at which the fine was paid or adjusted.

paid_amt

numeric

false

If partial payment is accepted as full payment, the amount of the partial payment appears here.

initials

varchar

false

The staff initials used to authorize the fine payment or adjustment.

created_code

char

false

The method used to create the fine.

is_print_bill

boolean

false

Specifies whether the finespaid file adds fine-payment entries to the bills2print file.

description

varchar

false

item_record_metadata_id

bigint

false

Foreign key to record_metadata (for the item record).

checkout_gmt

timestamptz

false

The checkout date of the item for which a fine was assessed.

due_gmt

timestamptz

false

The due date of the item for which a fine was assessed.

returned_gmt

timestamptz

false

The date the item for which a fine was assessed was returned.

loanrule_code_num

int

false

The code number of the loan rule under which the item was checked out.

title

varchar

false

Title of the item associated with the charge.

original_patron_record_metadata_id

bigint

false

Foreign key to record_metadata (for the original patron record).

original_transfer_gmt

timestamptz

false

Date of the original transfer.

previous_invoice_num

int

false

The previous invoice number. If no previous invoice number is present, the field displays "0".

display_order

int

false

Integer to manage the display order of a list.

id

bigint

false

System-generated sequential ID.

fine_assessed_date_gmt

timestamptz

false

The date the fine was assessed. Note that if the fine is a reinstated fine, this column reflects the date the fine was reinstated and not the original date the fine was assessed.

patron_record_metadata_id

bigint

false

Foreign key to record_metadata (for the patron record).

item_charge_amt

numeric

false

processing_fee_amt

numeric

false

billing_fee_amt

numeric

false

charge_type_code

char

false

The code for the fine type.

charge_location_code

varchar

false

paid_date_gmt

timestamptz

false

The date the fine was paid or, if the action was an adjustment, the current date.

tty_num

int

false

The terminal number at which the fine was paid or adjusted.

last_paid_amt

numeric

false

If partial payment is accepted as full payment, the amount of the partial payment appears here.

iii_user_name

varchar

false

The staff user name used to authorize the fine payment or adjustment.

fine_creation_mode_code

char

false

The method used to create the fine.

print_bill_code

char

false

Specifies whether the finespaid file adds fine-payment entries to the bills2print file. (0 = false, 1 = true)

item_record_metadata_id

bigint

false

Foreign key to record_metadata (for the item record).

checked_out_date_gmt

timestamptz

false

The checkout date of the item for which a fine was assessed.

due_date_gmt

timestamptz

false

The due date of the item for which a fine was assessed.

returned_date_gmt

timestamptz

false

The date the item for which a fine was assessed was returned.

loan_rule_code_num

int

false

The code number of the loan rule under which the item was checked out.

description

varchar

false

paid_now_amt

numeric

false

The amount of the payment being made toward the fine in this transaction, or, if action is an adjustment, the amount of the original charge.

payment_status_code

char

false

The status of the fine payment.

payment_type_code

char

false

The one-character code associated with the payment method. If staff do not assign a payment method at the time of payment (e.g., a fine is automatically waived), this field is "NULL". Each library specifies its own payment type codes, except for code 'e', which is assigned by the system for Ecommerce transactions in WebPAC and (in Sierra 6.3 and later) Vega Discover.

payment_note

varchar

false

Free text of up to 150 characters.

transaction_id

int

false

A number that identifies the entry. The transaction ID consists of the last four digits of the process id that creates the entry, followed by a revolving five-digit counter. The first four digits of the transaction ID (the last four digits of the process id) correlate with the last four digits of the process ID in syserr messages.

invoice_num

int

false

The fine's invoice number. For fine adjustment entries (charge type = 4), this column contains the invoice number of the original fine.

old_invoice_num

int

false

The previous invoice number. If no previous invoice number is present, the field displays '0'.

id

bigint

false

System-generated sequential ID.

patron_record_id

bigint

false

Foreign key to patron_record.

record_id

bigint

false

Foreign key to record.

placed_gmt

timestamp

false

Date the hold was placed.

is_frozen

boolean

false

Specifies whether the hold is frozen (suspended).

delay_days

int

false

Stores the "not wanted before" date as a number of days after the date the hold was placed. The maximum value is "180". If a "not wanted before" date was not specified, the value is '0'.

location_code

varchar

false

For bib or volume-level holds, the branch location from which to fill the hold, if the hold is set for 'Limit to Location'. Does not apply to item-level holds (blank).

expires_gmt

timestamp

false

"Not needed after" date.

status

char

false

Hold status.

is_ir

boolean

false

Specifies whether the hold is an INN-Reach hold.

pickup_location_code

varchar

false

Pickup location code.

is_ill

boolean

false

Specifies whether the hold is an ILL hold.

note

varchar

false

Free text note field.

ir_pickup_location_code

varchar

false

INN-Reach pickup location code.

ir_print_name

varchar

false

INN-Reach print name.

ir_delivery_stop_name

varchar

false

INN-Reach delivery stop name.

is_ir_converted_request

boolean

false

Specifies whether the hold is a converted INN-Reach request.

Item and patron belong to the same Local Server. Converted to standard circulation transaction at Remote Site Check-Out.

patron_records_display_order

int

false

Integer to manage the display order of a list. (8 field order in the 'i', 'j', or 'b' record.)

records_display_order

int

false

Integer to manage the display order of a list. (8 field order in the 'p' record.)

id

bigint

false

System-generated sequential ID.

patron_record_id

bigint

false

Foreign key to patron_record.

record_id

bigint

false

Foreign key to record.

placed_gmt

timestamptz

false

Date the hold was placed.

is_frozen

boolean

false

Specifies whether the hold is frozen (suspended).

delay_days

int

false

Stores the "not wanted before" date as a number of days after the date the hold was placed. The maximum value is "180". If a "not wanted before" date was not specified, the value is '0'.

location_code

varchar

false

For bib or volume-level holds, the branch location from which to fill the hold, if the hold is set for 'Limit to Location'. Does not apply to item-level holds (blank).

expires_gmt

timestamptz

false

The "Not Needed After" date.

status

char

false

Hold status.

is_ir

boolean

false

Specifies whether the hold is an INN-Reach hold.

pickup_location_code

varchar

false

Pickup location code.

is_ill

boolean

false

Specifies whether the hold is an ILL hold.

note

varchar

false

Free text note field.

ir_pickup_location_code

varchar

false

INN-Reach pickup location code.

ir_print_name

varchar

false

INN-Reach print name.

ir_delivery_stop_name

varchar

false

INN-Reach delivery stop name.

is_ir_converted_request

boolean

false

Specifies whether the hold is a converted INN-Reach request.

Item and patron belong to the same Local Server. Converted to standard circulation transaction at Remote Site Check-Out.

patron_records_display_order

int

false

Integer to manage the display order of a list. (8 field order in the 'i', 'j', or 'b' record.)

records_display_order

int

false

Integer to manage the display order of a list. (8 field order in the 'p' record.)

The holdshelf status of the hold. Possible values are:

• '!' (ON HOLDSHELF)
• 'm' (MISSING)
• '-' (AVAILABLE)
• 'p' (PICKED UP)
• 'c' (CANCELLED)

id

bigint

false

System-generated sequential ID.

item_record_metadata_id

bigint

false

Foreign key to item_record_metadata.

patron_record_metadata_id

bigint

false

Foreign key to patron_record_metadata.

checkout_gmt

timestamptz

false

Date the item was checked out.

checkin_gmt

timestamptz

false

Date the item was checked in.

id

bigint

false

System-generated sequential ID.

patron_record_metadata_id

bigint

false

Foreign key to patron_record_metadata.

time_added_to_table_gmt

timestamptz

false

The time and date the patron was marked for exclusion from the New Submissions report.

id

bigint

false

System-generated sequential ID.

pmt_date_gmt

timestamp

false

Payment date.

amt_paid

numeric

false

Amount paid.

pmt_type_code

varchar

false

A one-character alphabetic code that uniquely identifies the type of payment. Each library maintains its own list of payment types and codes.

pmt_note

varchar

false

Free text note accompanying the payment.

patron_record_metadata_id

bigint

false

Foreign key to record_metadata (for the patron record).

id

bigint

false

System-generated sequential ID.

bib_record_metadata_id

bigint

false

Foreign key to record_metadata (for the bib record).

item_record_metadata_id

bigint

false

Foreign key to record_metadata (for the item record).

patron_record_metadata_id

bigint

false

Foreign key to record_metadata (for the patron record).

checkout_gmt

timestamp

false

Date the item was checked out by the patron.

id

bigint

false

System-generated sequential ID.

patron_record_id

bigint

false

Foreign key to patron_record.

item_record_id

bigint

false

Foreign key to item_record.

items_display_order

int

false

Integer to manage the display order of a list of items.

ptype

int2

false

Patron type associated with the request. The library defines ptype codes and definitions.

patrons_display_order

int

false

Integer to manage the display order of a patron list.

request_gmt

timestamptz

false

Time the request was made.

pickup_anywhere_location_code

varchar

false

Location code of the Pickup Anywhere location.

central_location_code

varchar

false

Location code of the Central server.

transaction_num

int

false

Unique transaction number.

remote_patron_record_key

varchar

false

ID of the remote patron record.

dl_pickup_location_code_num

int

false

Location code corresponding to the distance learning pickup location.

id

bigint

false

System-generated sequential ID.

patron_record_metadata_id

bigint

false

Foreign key to patron_record_metadata.

item_cost_amt

numeric

false

The cost of the returned item.

checked_in_time_gmt

timestamptz

false

The date and time the billed item was checked in.

invoice_number

int

false

The invoice number of the fine.

id

bigint

false

System-generated sequential ID.

prepared_date_gmt

timestamp

false

Date on which the title paging report was prepared.

location_type

int

false

Location type.

location_code

varchar

false

Location code.

location_group_code_num

int

false

Location group code number.

longname

varchar

false

Full name of the title paging report.

id

bigint

false

System-generated sequential ID.

title_paging_report_id

bigint

false

Foreign key to title_paging_report.

record_metadata_id

bigint

false

Foreign key to record_metadata.

display_order

int

false

Integer to manage the display order of a list.

title

varchar

false

Paged title appearing in the report entry.

call_number

varchar

false

Call number of the paged title.

is_processed

boolean

false

Specifies whether the page has been processed.

id

bigint

false

System-generated sequential ID.

title_paging_report_entry_id

bigint

false

Foreign key to title_paging_report_entry.

record_metadata_id

bigint

false

Foreign key to record_metadata.

scanned_date_gmt

timestamp

false

Date the item was scanned to satisfy the page.

id

bigint

false

System-generated sequential ID.

title_paging_report_entry_id

bigint

false

Foreign key to title_paging_report_entry.

record_metadata_id

bigint

false

Foreign key to record_metadata.