Patron

Detailed View

firm_property

Each row of firm_property identifies a firm code.

Column	Data Type	Not NULL?	Comment
id	int	false	System-generated sequential ID.
code	varchar	false	Firm code.
category_code	varchar	false	Code identifying the type of firm. Each library defines its own category codes.
contact_name	varchar	false	Name of the contact representative for the firm.
contact_addr1	varchar	false	Contact address line 1.
contact_addr2	varchar	false	Contact address line 2.
contact_addr3	varchar	false	Contact address line 3.
contact_addr4	varchar	false	Contact address line 4.
telephone	varchar	false	Firm contact telephone number.
paid_thru_date	timestamptz	false	Date through which firm accounts are paid.
payment_info	varchar	false	Information regarding payments to the firm.
note1	varchar	false	Free text information related to the firm/contact.
note2	varchar	false	Free text information related to the firm/contact.

firm_property_myuser

Each row of firm_property_myuser identifies a firm, with the name presented in the language associated with the user's login account. Each library defines its own list of firm names.

Column	Data Type	Not NULL?	Comment
code	varchar	false	Firm code.
category_code	varchar	false	Code identifying the type of firm. Each library defines its own category codes.
contact_name	varchar	false	Name of the contact representative for the firm.
contact_addr1	varchar	false	Contact address line 1.
contact_addr2	varchar	false	Contact address line 2.
contact_addr3	varchar	false	Contact address line 3.
contact_addr4	varchar	false	Contact address line 4.
telephone	varchar	false	Firm contact telephone number.
paid_thru_date	timestamptz	false	Date through which firm accounts are paid.
payment_info	varchar	false	Information regarding payments to the firm.
note1	varchar	false	Free text information related to the firm/contact.
note2	varchar	false	Free text information related to the firm/contact.
name	varchar	false	Firm name.

firm_property_name

Each row of firm_property_name identifies a firm name.

Column	Data Type	Not NULL?	Comment
firm_property_id	int	false	Foreign key to firm_property.
iii_language_id	int	false	Foreign key to iii_language.
name	varchar	false	Firm name.

iii_language

Each row of iii_language identifies and describes an interface language usable by the system.

Column	Data Type	Not NULL?	Comment
id	int	false	System-generated sequential ID.
code	varchar	false	III code for the language.
description	varchar	false	Descriptive name of the language.
staff_enabled	boolean	false	Specifies whether the language is enabled for use in staff applications.
public_enabled	boolean	false	Specifies whether the language is enabled for use in public-facing applications.
display_order	int	false	Integer to manage the display order of a list.
is_right_to_left	boolean	false	Specifies whether the language is read right-to-left.

iii_language_myuser

Each row of iii_language_myuser identifies and describes an interface language usable by the system, with the name presented in the language associated with the user's login account.

Column	Data Type	Not NULL?	Comment
code	varchar	false	III code for the language.
description	varchar	false	Descriptive name of the language.
staff_enabled	boolean	false	Specifies whether the language is enabled for use in staff applications.
public_enabled	boolean	false	Specifies whether the language is enabled for use in public-facing applications.
display_order	int	false	Integer to manage the display order of a list.
is_right_to_left	boolean	false	Specifies whether the language is read right-to-left.

iii_language_name

Each row of iii_language_name associates a language with its descriptive name.

Column	Data Type	Not NULL?	Comment
iii_language_id	int	false	Foreign key to iii_language.
description	varchar	false	Description of the language.
name_iii_language_id	int	false	Foreign key to name_iii_language.

mblock_property

Each row of mblock_property identifies a manual block code.

Column	Data Type	Not NULL?	Comment
id	int	false	System-generated sequential ID.
code	varchar	false	Manual block code.
display_order	int	false	Integer to manage the display order of a list.

mblock_property_myuser

Each row of mblock_property_myuser identifies a manual patron block, with the block definition presented in the language associated with the user's login account. A value in this field prevents the patron from checking out items. Standard (English) codes and definitions include:

CODE	DEFINITION
a	INVALID ADDR
b	CHECK BOUNCED
-	NO BLOCK

Column	Data Type	Not NULL?	Comment
code	varchar	false	Manual block code.
display_order	int	false	Integer to manage the display order of a list.
name	varchar	false	Manual block name.

mblock_property_name

Each row of mblock_property_name identifies a manual block name.

Column	Data Type	Not NULL?	Comment
mblock_property_id	int	false	Foreign key to mblock_property.
iii_language_id	int	false	Foreign key to iii_language.
name	varchar	false	Manual block name.

notification_medium_property

Each row of notification_medium_property identifies a notification medium code.

Column	Data Type	Not NULL?	Comment
id	int	false	System-generated sequential ID.
code	varchar	false	Notification medium code.
display_order	int	false	Integer to manage the display order of a list.

notification_medium_property_myuser

Each row of notification_medium_property_myuser identifies a notification medium, with the media name presented in the language associated with the user's login account.

Column	Data Type	Not NULL?	Comment
code	varchar	false	Notification medium code.
display_order	int	false	Integer to manage the display order of a list.
name	varchar	false	Notification medium name.

Standard notification media include:

CODE	DEFINITION
z	EMAIL
a	PRINT
p	PHONE
m	MOBILE
-	NO LABEL

notification_medium_property_name

Each row of notification_medium_property_name identifies a notification medium name.

Column	Data Type	Not NULL?	Comment
notification_medium_property_id	int	false	Foreign key to notification_medium_property.
iii_language_id	int	false	Foreign key to iii_language.
name	varchar	false	Notification medium name.

patron_record

Each row of patron_record contains data fields for a specific patron record.

NOTE: This view might include virtual patron records associated with INN-Reach transactions.

Column

Data Type

Not NULL?

Comment

bigint

false

System-generated sequential ID.

record_id

bigint

false

Foreign key to record.

ptype_code

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.

home_library_code

varchar

false

The code for the patron's home library.

expiration_date_gmt

timestamptz

false

The expiration date of the patron's borrowing privileges.

pcode1

char

false

The library determines the name and purpose of this code and the code's definition.

pcode2

char

false

The library determines the name and purpose of this code and the code's definition.

pcode3

int2

false

The library determines the name and purpose of this code and the code's definition.

pcode4

int

false

The library determines the name and purpose of this code and the code's definition.

birth_date_gmt

date

false

Optional field containing the birth date of the patron.

mblock_code

char

false

Manual patron block. A value in this field prevents the patron from checking out items. The values of this field represent various common reasons a patron might be blocked. For example:

CODE	DEFINITION
a	INVALID ADDR
b	CHECK BOUNCED
-	NO BLOCK

firm_code

varchar

false

Code indicating the firm with which this patron is associated.

block_until_date_gmt

timestamptz

false

The date until which the patron is blocked from using library services.

patron_agency_code_num

int2

false

Code indicating the AGENCY to which the patron belongs.

iii_language_pref_code

varchar

false

Code indicating the preferred language.

checkout_total

int

false

A count of the total number of items the patron has checked out.

renewal_total

int

false

A count of the total number of items the patron has renewed.

checkout_count

int

false

A count of the total number of items the patron currently has checked out.

patron_message_code

char

false

A code corresponding to a library-defined patron message. A value in this field causes the system to display the corresponding message text when the patron attempts to check out, renew, or hold an item. Specific values are open for local definition. For example:

CODE	DEFINITION
c	CHECK CARD
a	CHECK ADDRESS
-	NO MESSAGE

highest_level_overdue_num

int

false

The highest level of overdue notice (1 = first overdue, 2 = second overdue, etc.) among all overdue notices recently sent to the patron.

claims_returned_total

int

false

Count of the number of items the patron has "claimed returned."

owed_amt

numeric

false

The amount of money the patron owes in fines and charges.

itema_count

int

false

Total number of items the patron currently has checked out from library-defined category A.

itemb_count

int

false

Total number of items the patron currently has checked out from library-defined category B.

overdue_penalty_count

int

false

Number of overdue penalty points the patron has accrued.

ill_checkout_total

int

false

Total number of inter-library loan items that have been acquired for the patron since the ILL module was installed.

debit_amt

numeric

false

OBSOLETE - Data field no longer in use.

itemc_count

int

false

Total number of items the patron currently has checked out from library-defined category C.

itemd_count

int

false

Total number of items the patron currently has checked out from library-defined category D.

activity_gmt

timestamp

false

The most recent date when one of the following circulation activities was performed for or by the patron:

checking out, checking in, or renewing an item (including ILL, INN-Reach, and Offline Circulation transactions)
placing a hold
placing a booking
photocopying materials

The system does not assign a date to this field until one of these activities occurs.

notification_medium_code

char

false

Code indicating the patron's notification medium preference.

CODE	DEFINITION
z	EMAIL
a	PRINT
p	PHONE
m	MOBILE
-	NO LABEL

registration_count

int

false

Number of seats in program sections for which the patron is currently registered.

registration_total

int

false

Total number of seats in program sections for which this patron has ever registered, including current registrations. This number excludes seats for which the patron was registered, but for which registration was cancelled.

attendance_total

int

false

Total number of program sections this patron has attended, including current programs.

waitlist_count

int

false

Number of seats in program sections for which the patron is currently waitlisted.

is_reading_history_opt_in

boolean

false

Indicates whether the patron opted to let the system retain reading history.

patron_record_address

Each row of patron_record_address contains the address data associated with a patron record.

Column	Data Type	Not NULL?	Comment
id	bigint	false	System-generated sequential ID.
patron_record_id	bigint	false	Foreign key to patron_record.
patron_record_address_type_id	bigint	false	Foreign key to patron_record_address_type.
display_order	int	false	Integer to manage the display order of a list.
addr1	varchar	false	The first line of the patron address.
addr2	varchar	false	The second line of the patron address.
addr3	varchar	false	The third line of the patron address.
village	varchar	false	The village of the patron address. (Used only at UK sites.)
city	varchar	false	The city of the patron address.
region	varchar	false	The region of the patron address. (US State or Canadian Province)
postal_code	varchar	false	The postal code of the patron address.
country	varchar	false	The country of the patron address.

patron_record_address_type

Each row of patron_record_address_type identifies a patron record address type.

Column	Data Type	Not NULL?	Comment
id	bigint	false	System-generated sequential ID.
code	char	false	Code that disambiguates the field group tag.

patron_record_fullname

Each row of patron_record_fullname contains a full patron name from a patron record.

Column	Data Type	Not NULL?	Comment
id	bigint	false	System-generated sequential ID.
patron_record_id	bigint	false	Foreign key to patron_record.
display_order	int	false	Integer to manage the display order of a list.
prefix	varchar	false	Prefix, or title. This field is populated only on systems that use MARC patron records.
first_name	varchar	false	First name. For non-MARC records, first, and middle names are parsed by searching for the first comma and second space; the string following the first comma and up to the second space is assumed to be the first name.
middle_name	varchar	false	Middle name. For non-MARC records, first, and middle names are parsed by searching for the first comma and second space; the string following the second space is assumed to be the middle name.
last_name	varchar	false	Last name. For non-MARC records, first, and middle names are parsed by searching for the first comma and second space; the string preceding the first comma is assumed to be the last name.
suffix	varchar	false	Name suffix. This field is populated only on systems that use MARC patron records.

patron_record_phone

Each row of patron_record_phone identifies a telephone number in a patron record.

Column	Data Type	Not NULL?	Comment
id	bigint	false	System-generated sequential ID.
patron_record_id	bigint	false	Foreign key to patron_record.
patron_record_phone_type_id	bigint	false	Foreign key to patron_record_phone_type.
display_order	int	false	Integer to manage the display order of a list.
phone_number	varchar	false	Telephone number text.

patron_record_phone_type

Each row of patron_record_phone_type identifies a phone type found in a patron record.

Column	Data Type	Not NULL?	Comment
id	bigint	false	System-generated sequential ID.
code	char	false	A variable-length field tag identifying a telephone number in patron records, such as 't', 'p', and 'o'.

patron_view

Each row of patron_view includes metadata and data for one patron record. The contents include identification and descriptive information, as well as data that determines how the system handles the record.

NOTE: This view does not include virtual patron records associated with INN-Reach transactions.

Column

Data Type

Not NULL?

Comment

bigint

false

System-generated sequential ID.

record_type_code

char

false

Record type code, i.e., 'p'.

record_num

int

false

Record number.

barcode

varchar

false

The patron's barcode.

ptype_code

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.

home_library_code

varchar

false

The code for the patron's home library.

expiration_date_gmt

timestamptz

false

The expiration date of the patron's borrowing privileges.

pcode1

char

false

The library determines the name and purpose of this code and the code's definition.

pcode2

char

false

The library determines the name and purpose of this code and the code's definition.

pcode3

int2

false

The library determines the name and purpose of this code and the code's definition.

pcode4

int

false

The library determines the name and purpose of this code and the code's definition.

birth_date_gmt

date

false

Patron date of birth.

mblock_code

char

false

Manual patron block. A value in this field prevents the patron from checking out items. The values of this field represent various common reasons a patron might be blocked. For example:

CODE	DEFINITION
a	INVALID ADDR
b	CHECK BOUNCED
-	NO BLOCK

firm_code

varchar

false

Code indicating the firm with which this patron is associated.

block_until_date_gmt

timestamptz

false

The date until which the patron is blocked from using library services.

patron_agency_code_num

int2

false

Code indicating the AGENCY to which the patron belongs.

iii_language_pref_code

varchar

false

Code indicating the preferred language.

checkout_total

int

false

A count of the total number of items the patron has checked out.

renewal_total

int

false

A count of the total number of items the patron has renewed.

checkout_count

int

false

A count of the total number of items the patron currently has checked out.

patron_message_code

char

false

CODE	DEFINITION
c	CHECK CARD
a	CHECK ADDRESS
-	NO MESSAGE

highest_level_overdue_num

int

false

The highest level of overdue notice (1 = first overdue, 2 = second overdue, etc.) among all overdue notices recently sent to the patron.

claims_returned_total

int

false

Count of the number of items the patron has "claimed returned."

owed_amt

numeric

false

The amount of money the patron owes in fines and charges.

itema_count

int

false

Total number of items the patron currently has checked out from library-defined category A.

itemb_count

int

false

Total number of items the patron currently has checked out from library-defined category B.

overdue_penalty_count

int

false

Number of overdue penalty points the patron has accrued.

ill_checkout_total

int

false

Total number of inter-library loan items that have been acquired for the patron since the ILL module was installed.

debit_amt

numeric

false

OBSOLETE - Data field no longer in use.

itemc_count

int

false

Total number of items the patron currently has checked out from library-defined category C.

itemd_count

int

false

Total number of items the patron currently has checked out from library-defined category D.

activity_gmt

timestamp

false

The most recent date when one of the following circulation activities was performed for or by the patron:

checking out, checking in, or renewing an item (including ILL, INN-Reach, and Offline Circulation transactions)
placing a hold
placing a booking
photocopying materials

The system does not assign a date to this field until one of these activities occurs.

notification_medium_code

char

false

Code indicating the patron's notification medium preference.

CODE	DEFINITION
z	EMAIL
a	PRINT
p	PHONE
m	MOBILE
-	NO LABEL

registration_count

int

false

Number of seats in program sections for which the patron is currently registered.

registration_total

int

false

attendance_total

int

false

Total number of program sections this patron has attended, including current programs.

waitlist_count

int

false

Number of seats in program sections for which the patron is currently waitlisted.

is_reading_history_opt_in

boolean

false

Indicates whether the patron opted to let the system retain reading history.

pblock

Each row of pblock contains automatic patron block thresholds used in preventing checkouts, renewals, and holds from taking place under certain circumstances. Each column consists of specific criteria that cause the system to block a patron of the specified type. The automatic blocks in this table can be overridden by an authorized operator.

Column	Data Type	Not NULL?	Comment
id	int	false	System-generated sequential ID.
ptype_code_num	int	false	A number, 0-255, corresponding to a patron type defined by the library. The wildcard patron type "999" means the thresholds apply to all patron types not specifically listed.
ptype_agency_code_num	int	false	A number, 0-255, corresponding to a value in the PAT AGENCY fixed-length field. The value "999" is the default and acts as a wildcard.
is_expiration_date_active	boolean	false	Specifies whether the patron's borrowing privileges have expired.
max_owed_amt	numeric	false	Maximum amount the patron can owe in fines before being blocked.
max_overdue_num	int	false	The level of overdue notice at which a patron is blocked. The valid range is 1 to the maximum number of overdue notices the library produces. The Highest Level Odues element functions on a per-item basis: if this element is set to 2 and a patron receives both a first and second overdue notice for the same item (bringing the overdue level to 2 for one item), the patron who has checked out this item is blocked. However, if a patron has two overdue items and each item receives its first overdue notice (for an overdue level of 1 for each item), the patron is not yet blocked.
max_item_num	int	false	The maximum number of items the patron can have checked out at one time (includes INN-Reach and ILL items).
max_hold_num	int	false	The maximum number of holds, excluding ILL holds, the patron can have outstanding at any given time. The patron is blocked from placing a hold if the number of HOLD fields in the patron record equals or exceeds max_hold_num.
max_ill_item_num	int	false	The maximum number of ILL items the patron can request. The default setting of 999 indicates that there is no limit to the number of ILL items that the patron can request. The value 0 means that the patron cannot request ILL items.
max_ill_item_per_period_num	int	false	Maximum number of ILL requests that a patron can place over a period of time. (The time period is determined by how often the library resets the value of the ILL REQUES fixed-length field in their patron records.) If this value is lower than the current amount in the patron record's ILL REQUES fixed-length field, the patron cannot place an ILL request. The default setting of 999 indicates that there is no limit to the number of ILL items that the patron can request. The value 0 means that the patron cannot request ILL items. NOTE: This element is ignored unless the ill_interval_max EO is set to "true." For more information, see the ill_interval_max EO doc.
max_itema_num	int	false	Maximum number of items from item category 'A' that the patron can have checked out at one time. Item category 'A' can be any library-specified set of item types and location codes, as defined by the itema_definition EO.
max_itemb_num	int	false	Maximum number of items from item category 'B' that the patron can have checked out at one time. Item category 'B' can be any library-specified set of item types and location codes, as defined by the itemb_definition EO.
max_itemc_num	int	false	Maximum number of items from item category 'C' that the patron can have checked out at one time. Item category 'C' can be any library-specified set of item types and location codes, as defined by the itemc_definition EO.
max_itemd_num	int	false	Maximum number of items from item category 'D' that the patron can have checked out at one time. Item category 'D' can be any library-specified set of item types and location codes, as defined by the itemd_definition EO.
max_registration_num	int	false	Maximum number of current programs for which a patron can register or be waitlisted. "Current programs" are those that contain sections that end at a future date and/or time. Possible values: 0-999.
max_penalty_point_num	int	false	Highest number of overdue demerits that a patron can accrue before being blocked. If set to 0, this block is ignored. For use with the optional "overdue demerits" system.
penalty_point_days	int	false	Number of days a patron is blocked when their overdue demerits reach the number specified in max_penalty_point_num.

ptype_property

Each row of ptype_property identifies a patron type code.

Column	Data Type	Not NULL?	Comment
id	int	false	System-generated sequential ID.
value	int2	false	Patron type code (0-255).
tagging_allowed	boolean	false	Specifies whether community tagging is allowed for this patron type.
display_order	int	false	Integer to manage the display order of a list.
is_force_right_result_exact_allowed	boolean	false	Specifies whether the patron type can promote RightResult relevancy for items in search results.
is_comment_auto_approved	boolean	false	Specifies whether community comments are auto-approved for this patron type.
ptype_category_id	int	false	Foreign key to ptype_category.

ptype_property_category

Each row of ptype_property_category identifies a patron type category.

Column	Data Type	Not NULL?	Comment
id	int	false	System-generated sequential ID.
display_order	int	false	Integer to manage the display order of a list.
is_default	boolean	false	Identifies the default patron type category.

ptype_property_category_myuser

Each row of ptype_property_category_myuser identifies a patron type category, with the name presented in the language associated with the user's login account. Each library maintains its own list of program types.

Column	Data Type	Not NULL?	Comment
id	int	false	System-generated sequential ID.
display_order	int	false	Integer to manage the display order of a list.
is_default	boolean	false	Identifies the default patron type category.
name	varchar	false	Patron type category name.

ptype_property_category_name

Each row of ptype_property_category_name identifies a patron type category name.

Column	Data Type	Not NULL?	Comment
ptype_category_id	int	false	Foreign key to ptype_category.
name	varchar	false	Patron type category name.
iii_language_id	int	false	Foreign key to iii_language.

ptype_property_myuser

Each row of ptype_property_myuser identifies a patron type, with the patron type name/description presented in the language associated with the user's login account. Each library determines its own patron type names.

Column	Data Type	Not NULL?	Comment
value	int2	false	Patron type code (0-255).
tagging_allowed	boolean	false	Specifies whether community tagging is allowed for this patron type.
display_order	int	false	Integer to manage the display order of a list.
is_force_right_result_exact_allowed	boolean	false	Specifies whether the patron type can promote RightResult relevancy for items in search results.
is_comment_auto_approved	boolean	false	Specifies whether community comments are auto-approved for this patron type.
ptype_category_id	int	false	Foreign key to ptype_category.
name	varchar	false	Patron type name/description.

ptype_property_name

Each row of ptype_property_name identifies a patron type name/description.

Column	Data Type	Not NULL?	Comment
ptype_id	int	false	Foreign key to ptype.
description	varchar	false	Patron type name/description.
iii_language_id	int	false	Foreign key to iii_language.

user_defined_pcode1_myuser

Each row of user_defined_pcode1_myuser identifies a user-defined fixed-length field for patron records.

Column	Data Type	Not NULL?	Comment
code	varchar	false	User-defined code to represent the user-defined field.
user_defined_category_id	int	false	Foreign key to user_defined_category.
display_order	int	false	Integer to manage the display order of a list.
name	varchar	false	The user-defined name assigned to the user-defined field.

user_defined_pcode2_myuser

Each row of user_defined_pcode2_myuser identifies a user-defined fixed-length field for patron records.

Column	Data Type	Not NULL?	Comment
code	varchar	false	User-defined code to represent the user-defined field.
user_defined_category_id	int	false	Foreign key to user_defined_category.
display_order	int	false	Integer to manage the display order of a list.
name	varchar	false	The user-defined name assigned to the user-defined field.

user_defined_pcode3_myuser

Each row of user_defined_pcode3_myuser identifies a user-defined fixed-length field for patron records.

Column	Data Type	Not NULL?	Comment
code	varchar	false	User-defined code to represent the user-defined field.
user_defined_category_id	int	false	Foreign key to user_defined_category.
display_order	int	false	Integer to manage the display order of a list.
name	varchar	false	The user-defined name assigned to the user-defined field.

user_defined_pcode4_myuser

Each row of user_defined_pcode4_myuser identifies a user-defined fixed-length field for patron records.

Column	Data Type	Not NULL?	Comment
code	varchar	false	User-defined code to represent the user-defined field.
user_defined_category_id	int	false	Foreign key to user_defined_category.
display_order	int	false	Integer to manage the display order of a list.
name	varchar	false	The user-defined name assigned to the user-defined field.