Fines and Fees

Field Descriptions

The following lists the fields available in Fines and Fees.

Fines and Fees – Field Descriptions

Fines and Fees Transactions

The Fines and Fees Transactions table is a fact table that stores all amount related to Fines and Fees Transactions. It also stores details of fines and fees including active balance, disputed balance, and transferred balance information. The primary key of the table is FINE_FEE_TRANSACTION_ID.

Fines and Fees Transactions
Field	Description	Additional Information
Associated Course Code	The code of a course that was active during the time the item was loaned. The item belonged to a citation that was part of the reading list of the course.
Associated Course Name	The name of a course that was active during the time the item was loaned. The item belonged to a citation that was part of the reading list of the course.
Additional Fine Fee Transaction ID	Stores an additional identifier of the fine or fee transaction	To view the Fine Fee Additional Transaction ID in Alma: View a patron's fines and fees. Filter by status Closed or retrieve a fine that had a partial payment. Select the Remaining Balance link (which may be 0.00 on a closed fine fee). The value of the Alma Analytics Fine Fee Additional Transaction ID is in the Transaction ID column.
Currency	Stores the actual currency of the fine and fee
Dewey Classification Top Line	Stores the first 3 digits of the Dewey classification
External ID	Stores the ID of the fine or fee in the originating system
Fine Comment	Stores the content of the comment associated with the fine or fee
Fine Fee Created By ID	Stores the user ID of the Staff Operator who created the fine or fee transaction
Fine Fee Creation Date	Stores the date that the fine and fee was created
Fine Fee Creator	Stores the user name of the user that created the fine and fee
Fine Fee ID	Stores the unique identifier of the fine or fee
Fine Fee Modification Date	Stores the modification date of the fine and fee
Fine Fee Modified By	Stores the user name of the user that modified the fine and fee
Fine Fee Status	Indicates whether or not the fine or fee is active
Fine Fee Transaction Created By ID	Stores the user ID of the user that created the fine or fee transaction
Fine Fee Transaction Creation Date	Stores the creation date of the fine and fee transaction
Fine Fee Transaction Creator	Stores the user name of the user that created the fine and fee transaction
Fine Fee Transaction ID	Stores the unique identifier of the fine or fee transaction
Fine Fee Transaction Modification Date	Stores the modification date of the fine and fee transaction
Fine Fee Transaction Modified By	Stores the user name of the user that modified a previously existing fine and fee transaction
Fine Fee Transaction Type	Stores the type of fine or fee transaction such as paid or waived
Fine Fee Type	Stores the type of the fine or fee such as overdue loan fee or lost loan fee
In House Loan Indicator	Y/N field that indicates if the loan is an in-house or a regular loan. Null means that it is not an in-house loan.
In Temp Location at Time of Loan	Y/N field that indicates if the loan is a temporary location at the time of the loan
Is Hold Request Loan	Indicates if the loan was initiated by a hold request
Item Loan ID	Indicates the associated item loan ID when the fine or fee is associated with a loan
Item Title	Indicates the title of the loan when the fine or fee is associated with an item
Loaned at Another Institution	Indicates if the item was loaned at an institution different than the one that owns the item
Loaned at Institution Name	The name of the institution at which the item was loaned
Original Amount	Stores the original amount of the fine or fee
Original Currency	Stores the original currency
Original VAT	Stores the original tax amount of the fine or fee
Originating Loan ID	Stores the Loan ID from the originating system
Payment Method	Indicates whether the payment was made online or by cash or credit	A null value indicates that the transaction is not a payment transaction (waive, for example)
Remaining Amount	Stores the amount of money remaining after subtracting the transaction amount from the original amount.
Status Date	Stores the date that the status of the fine or fee was changed
Transaction Amount	Stores the amount of money that is associated with this transaction
Transaction Note	Stores the content of notes associated with fine or fee transactions
Transaction Reference Number	Stores the reference number of the fine or fee transaction
Transaction VAT	Stores the tax amount associated with the transaction
User ID Encryption	The Encryption ID of the User	This ID is used to get counts by user ID after the anonymization job is run, which deletes the Primary ID
Waiving Reason Description	A description of the waiving reason

Transaction Date

The Transaction Date table is a dimension table that stores details about the dates of fine and fee transactions such as month, year or quarter. Key fields may be used whenever calculations are required. Description fields may be used for formatting the display of the report. Alma stores the following types of fields:

Calendar Fields – These are date fields as they display in the calendar.
Fiscal Date Fields – These are date fields that match the institution's fiscal period. For the examples below, the fiscal period of the institution is for fiscal year 2012 that starts June 1, 2011 and ends May 31, 2012.

Using this dimension, the user is able to drill down from year to month to the specific date on which the fine and fee transaction occurred. Measures such as transaction amount, original amount, etc., are accumulated to the relevant level in the hierarchy.

Transaction Date
Field	Description	Additional Information
Transaction Date	Stores the transaction date in the date format 2/29/2012
Transaction Date Start of Week	The date of the first business day of the week
Transaction Date Week Number	The number of the week of the year
Transaction Fiscal Month Key	Stores the fiscal month of the date in number format such as 2 for February	This field is useful when you want to sort by month
Transaction Fiscal Year	Stores the fiscal year of the date in string format such as 2012.
Transaction Full Month	Stores the month and the year of the date in a display format such as Feb 12
Transaction Month	Stores the month of the date in month description format such as February
Transaction Month Key	Stores the month of the date in number format such as 2 for February	This field is useful when you want to sort by month
Transaction Quarter	Stores the quarter of the date in a display format such as Q1
Transaction Year	Stores the year of the date in string format such as 2012
Transaction Date Filter	Used to filter report results by date.
Transaction Year-Month	The year and the month in a format such as 2023-1
Transaction Date	Stores the Hierarchy column that allows the user to drill down from the year to the month to the specific loan date. Using this column provides the user with the option to view the accumulative measures in each level of the hierarchy.

Creation Date

The Creation Date table is a dimension table that stores the date that the fine and fee was created. It contains the date fields that exist in all date dimensions in Analytics.

Creation Date
Field	Description	Additional Information
Creation Date	Stores the creation date in the date format 2/29/2012
Creation Date Start of Week	The date of the first business day of the week
Creation Date Week Number	The number of the week of the year
Creation Fiscal Month Key	Stores the fiscal month of the date in number format such as 2 for February	This field is useful when you want to sort by month
Creation Fiscal Year	Stores the fiscal year of the date in string format such as 2012.
Creation Full Month	Stores the month and the year of the date in a display format such as Feb 12
Creation Month	Stores the month of the date in month description format such as February
Creation Month Key	Stores the month of the date in number format such as 2 for February	This field is useful when you want to sort by month
Creation Quarter	Stores the quarter of the date in a display format such as Q1
Creation Year	Stores the year of the date in string format such as 2012
Creation Date Filter	Used to filter report results by date.
Creation Year-Month	The year and the month in a format such as 2023-1
Creation Date	Stores the Hierarchy column that allows the user to drill down from the year to the month to the specific loan date. Using this column provides the user with the option to view the accumulative measures in each level of the hierarchy.

Owning Library

The Owning Library table is a dimension table that stores details about the library/institution that created the fine and fee. The primary key of the table is ORGANIZATION_ID.

The field descriptions can be found in the Library Unit shared dimension.

Library Unit
Field	Description	Field Location in Alma	Additional Information	Data Type	Data Size
Library Address Line 1	The first line of the address of the institution. It usually includes the building number and the street name.	Configuration > General > Add a Library or Edit Library Information > Contact Information tab. This is taken from the address configured as the Preferred address. The label in Alma is Address Line 1.		VARCHAR	1000
Library City	The city of the library.	Configuration > General > Add a Library or Edit Library Information > Contact Information tab. This is taken from the address configured as the Preferred address. The label in Alma is City.		VARCHAR	255
Library Code	The library code	Configuration > General > Libraries > Add a Library or Edit Library Information > Libraries tab > Path [the text after the period]		VARCHAR	50
Library Code (Active)	The code of active (not deleted) libraries	Configuration > General > Libraries > Add a Library or Edit Library Information > Libraries tab > Path [the text after the period]	The same as Library Code without deleted libraries.	VARCHAR	50
Library Country	The country of the library.	Configuration > General > Add a Library or Edit Library Information > Contact Information tab. This is taken from the address configured as the Preferred address. The label in Alma is Country.		VARCHAR	320
Library Description	The library description	Configuration > General > Libraries > Add a Library or Edit Library Information > Libraries tab The label in Alma is Description.		VARCHAR	100
Library Name	The library name	Configuration > General > Libraries > Add a Library or Edit Library Information > Libraries tab The label in Alma is Organization Unit Name.		VARCHAR	255
Library Name (Active)	The library name of active (not deleted) libraries	Configuration > General > Libraries > Add a Library or Edit Library Information > Libraries tab The label in Alma is Organization Unit Name.	The same as Library Name without deleted libraries.	VARCHAR	255
Library Postal Code	The postal code of the library.	Configuration > General > Add a Library or Edit Library Information > Contact Information tab. This is taken from the address configured as the Preferred address. The label in Alma is Postal code.		VARCHAR	200
Library State Province	The state or province of the library.	Configuration > General > Add a Library or Edit Library Information > Contact Information tab. This is taken from the address configured as the Preferred address. The label in Alma is State/Province.		VARCHAR	320
Unit Type	The type of organization unit	Configuration > General > Libraries > Add a Library or Edit Library Information > Libraries tab The label in Alma is Organization Unit Type.	Values can be Institution/Library	VARCHAR	20

Executed by Unit

The Executed by Unit table is a dimension table that stores details about the library/institution that executed the transaction. The primary key of the table is LIBRARYID.

Executed by Unit
Field	Description	Additional Information
Unit Code	Stores the library unit code
Unit Code (Active)	Stores the code of active (not deleted) library units
Unit Name	Stores the library unit name
Unit Name (Active)	Stores the library name of active (not deleted) library units
Unit Description	Stores the library unit description
Unit Type	Store the type of organization unit	Values can be Institution/Library

User Details

The User Details table is a dimension table that stores details about users with fines and fees. The primary key of the table is USER_ID.

The field descriptions can be found in the User Details shared dimension.

Many institutions store information about individuals, including personal details and information about their activities. Due to privacy concerns, some institutions are required to anonymize the data on a regular basis.
Alma offers the option to delete such user information for fulfillment and resource sharing activities. The information is deleted for activities that have been completed, such as completed loans, closed fines and fees, or resource sharing borrowing requests.
You can configure Alma to delete the more specific information (for example, User ID) and retain the more general user information (for example, User Group and Job Title).
The information that is not anonymized can be included in Analytics reports.
For more information concerning anonymization, see Security and Data Privacy.

Field	Description	Additional information
User ID	Stores the unique ID of the user
Primary identifier	Stores the primary identifier that the user uses in order to log on to Alma	See the field location in Alma in the image below.
User Title	The title of the user
User Type	Stores the values Internal and External.	Internal - An internal user is one whose core user details are managed within the system such as user name, password, contact information, and so forth. External - An external user is one whose core user details are managed by a student information system. See the field location in Alma in the image below.
User Group	Stores the group with which the user is associated such as Faculty, Graduate, or Student	See the field location in Alma in the image below.
User Record Type	Indicates if the user is a Public User or a Staff User	See the field location in Alma in the image below.
First Name	Stores the user’s first name	See the field location in Alma in the image below.
Full Name	The user's first and last name	There is no option to include the middle name.
Last Name	Stores the user’s last name	See the field location in Alma in the image below.
Middle Name	Stores the middle name of the user	See the field location in Alma in the image below.
Preferred First Name	Stores the user’s preferred first name	See the field location in Alma in the image below.
Preferred Last Name	Stores the user’s preferred last name	See the field location in Alma in the image below.
Preferred Middle Name	Stores the user's preferred middle name	See the field location in Alma in the image below.
Job Description	Stores free-form text that describes the function of the user in the library	See the field location in Alma in the image below.
Job Title	Stores the job category definition to which the user belongs based on the Job Categories code table	See the field location in Alma in the image below.
Gender	Possible values are taken from the Genders code table (Configuration > User Management > User Details > Genders)	See the field location in Alma in the image below.
Birth Date	Stores the birth date of the user	See the field location in Alma in the image below.
Campus Code	Stores the campus code of the user	See the field location in Alma in the image below.
Status Date	Stores the date on which the patron was registered in the institution	See the field location in Alma in the image below.
Status	Indicates if the user is active	See the field location in Alma in the image below.
Creation Date	Stores the date that the user was created in the system	See the field location in Alma in the image below.
Last Activity Date	The last date that a patron made a request or borrowed or returned an item
Modified By	Stores the name of the user that modified the user record	See the field location in Alma in the image below.
Modification Date	Stores the date of the modification of the user record	See the field location in Alma in the image below.
Expiry Date	Stores the date on which the user is to expire and no longer be able to get service from the system	See the field location in Alma in the image below. Changing the user expiry date is one way to control item due dates that extend beyond the end of a semester and must be shortened to the end of the semester. For more information, see How to Make Items Have Due Dates at the End of the Semester.
Locked Out Date	Indicates the date on which the user is locked out. A user is locked out if he tries to access the Alma system several times with incorrect credentials.
Purge Date	Stores the date on which the user record is to be deleted from Alma	See the field location in Alma in the image below.
Default Language	Stores the default language of the user	See the field location in Alma in the image below.
Failed Authentication	Stores the number of times that the user tried to access Alma with an incorrect password
Creator	Stores the user name of the user that created the user in the system	See the field location in Alma in the image below.
External ID	Stores the ID of the user in the originating system
Identifier 1	Stores identifier 1.	The identifier field allows you to enrich the user details exported to Analytics with additional identifiers. Selecting a specific identifier to be included in the user details is done in Alma (in a table that is currently restricted to Ex Libris staff). For assistance in defining this field, contact Ex Libris Support. Only one value per identifier is supported.
Identifier 2	Stores identifier 2. See details for the Identifier 1 field above.
IdP Service in Use	Indicates if an identity provider service is in use
Statistical Categories 1-10	These fields allow you to map ten statistical categories. This allows you to filter reports based on advanced user information typically stored in the statistical category fields. For more information, see Configuring Statistical Categories for Analytics.
Resource Sharing Library Code	The code of the resource sharing library assigned to the user.
Resource Sharing Library	The resource sharing library assigned to the user.
Cataloger Level	The cataloger level of the user
Has Role Other Than Patron	indicates if the patron has a role other than Patron
Has Role Other Than Patron and Instructor	Indicates if the patron has a role other than Patron and Instructor
Is Blocked	Indicates if the patron is blocked
Patron Letters Opt In	The letters for which the patron has opted in
Patron Letters Opt Out	The letters for which the patron has opted out
User – Linked From Other Institution	Indicates if the user is linked from another institution	Possible values: yes no
User – Linked From Institution Code	The code of the institution from which the user is linked
User – Linked From Institution Name	The name of the institution from which the user is linked
Linked To Other Institution	Indicates if the user is linked to another institution
User Group Code	The user group code

Alma User Details Page – General Information

Preferred Contact Information

The Preferred Contact Information table is a dimension table that stores details about preferred contact information for users such as preferred address, phone, and email. The primary key of the table is USER_ID.

Preferred Contact Information
Field	Description	Additional Information
Line1	Stores the first line of the user's preferred address
Line2	Stores the second line of the user's preferred address
Line3	Stores the third line of the user's preferred address
Line4	Stores the fourth line of the user's preferred address
Line5	Stores the fifth line of the user's preferred address
City	Stores the city of the user's preferred address
Postal Code	Stores the postal code of the user's preferred address
Country	Stores the country of the user's preferred address
State Province	Stores the state or province of the user's preferred address
Address Type	Stores the type of the preferred address such as home or work
Preferred Phone Number	Stores the user's preferred phone number
Preferred SMS	Stores the user's preferred phone number for SMS
Preferred Email	Stores the user's preferred email for correspondence
Preferred Contact Note	Stores a note regarding the user's preferred address

Loan Details

Loan Details
Field	Description	Additional Information
Author	The author of the loan
Description	A description of the loan
Item ID	Stores the ID of the item that was loaned
Barcode	Stores the barcode of the item that was loaned
Call Number	Stores the call number of the item that was loaned
LC Classification Code	Stores the letters of the LC class number of the item that was loaned such as BF or QA	In the Fulfillment subject area, if there is more than one classification code in the bibliographic record, the last one appears.
LC Classification Number	Stores the numbers that follow the classification letters until the first period that is followed by a letter
LC Classification Top Line	Stores the combined LC code and classification numbers until the first period followed by a letter such as NB933 when the lc_class_number is NB933.F44
Dewey Classification Top Line	Stores the first 3 digits of the Dewey classification
Loan Date	The date of the loan
Loan Status	Indicates if the loan is active or has already been returned; also known as historical loan	Possible values: Active – On loan Complete – Returned Inactive – Deleted
Process Status	Indicates the workflow status of the loan, based on the last activity of the loan	Possible values: Lost Claimed return Normal Recall Renew
Loan Time	The time of the loan
Loan Note	Stores the last note attached to the loan
Location Code	The location code of the loan
Material Type	The material type of the loan
Recall Date	Stores the date on which the item was recalled
Recall Time	Stores the time in the hours:minutes:seconds format for the recall date
Return Date	The return date of the loan
Return Time	The return time of the loan
Original Due Date	Stores the original due date given to the loan	This field is populated only when the loan is "Recall"
Original Due Time	Stores the time in the hours:minutes:seconds format for the original due date
Due Date	Stores the current due date as displayed in Alma	The new due date can differ from the original due date due to a recall or renewal
Due Time	Stores the time in the hours:minutes:seconds format of the new due date
Item Loan ID	Stores the unique ID of the loan for the item	This is useful to find a specific loan of an item
In House Loan Indicator	Y/N field that indicates if the loan is an in-house or a regular loan. Null means that it is not an in-house loan.
In Temp Location at Time of Loan	Y/N field that indicates if the loan is a temporary location at the time of the loan
Is Booking Loan	Indicates whether the loan was initiated by a booking request
Publication Year	For internal use only (by the migration team)
Courtesy Notification Sent	Indicates if a courtesy letter was sent to the patron concerning an overdue loan.	This field only contains data beginning from July 2018.
MMS ID	The MMS ID of the loan
New Due Date	The new due date of the loan
New Due Time	The new due time of the loan
Title	The title of the loan
User ID Encryption	The Encryption ID of the User	This ID is used to get counts by user ID after the anonymization job is run, which deletes the Primary ID

Loan Policy

The Loan Policy table is a dimension table that stores due-date policy details associated with fines and fees. The primary key is ITEM_LOAN_ID.

Fulfillment Policy
Field	Description	Additional Information
Measurement Value	Stores the number of days or weeks that are used to calculate the due date.	Use this with the unit of measurement field. See the field location in the Advanced Policy Configuration screenshot below
Policy Name	Stores the name given to the policy	See the field location in the Advanced Policy Configuration screenshot below
Is Active	Indicates if the policy is currently active
Definition Level	Indicates what level of the organization was used to define the policy, Library or Institution	See the field location in the Advanced Policy Configuration screenshot below
Policy Constant	Stored only if the due date is a constant value	See the field location in the Advanced Policy Configuration screenshot below
Policy Description	Stores the description given to the policy
Policy Is Default Value	Indicates if this is the default policy used by the organization	See the field location in the Advanced Policy Configuration screenshot below
Policy Type	Since this dimension is only for policy with type "due date", this is the value for this field.	See the field location in the Advanced Policy Configuration screenshot below
Unit of Measurement	Stores the unit of measurement such as days or weeks	See the field location in the Advanced Policy Configuration screenshot below

Loan Policy Report

Advanced Policy Configuration

Staff Operator Details

The Staff Operator Details table is a dimension table that stores information about the staff operator.

The Staff Operator fields include information only about users in Alma and are empty if the transaction is paid by an external system.


Field	Description	Additional Information
Operator Primary Identifier	The primary identifier of the operator
Operator Type	The type of the operator
Operator Group	The operator group
Operator Record Type	The record type of the operator
Operator Title	The title of the operator
Operator First Name	The first name of the operator
Operator Last Activity Date	The last date that a patron made a request or borrowed or returned an item
Operator Last Name	The last name of the operator
Operator Middle Name	The middle name of the operator
Operator Preferred First Name	Stores the user’s preferred first name	See the field location in Alma in the image below.
Operator Preferred Last Name	Stores the user’s preferred last name	See the field location in Alma in the image below.
Operator Preferred Middle Name	Stores the user's preferred middle name	See the field location in Alma in the image below.
Operator Job Title	The job title of the operator
Operator Description	The description of the operator
Operator Campus Code	The campus code of the operator
Operator Gender	The gender of the operator
Operator Status	The status of the operator
Operator External ID	The external ID of the operator
Operator IdP Service in Use	Indicates if an identity provider service is in use
Identifier 1	Stores identifier 1.	The identifier field allows you to enrich the user details exported to Analytics with additional identifiers. Selecting a specific identifier to be included in the user details is done in Alma (in a table that is currently restricted to Ex Libris staff). For assistance in defining this field, contact Ex Libris Support. Only one value per identifier is supported.
Identifier 2	Stores identifier 2. See details for the Identifier 1 field above.

Institution

The shared Institution dimension allows the Network Zone to view reports according to institution. It is available in every subject area. It contains the following fields:

Institution
Field	Description	Additional information	Data Type	Data Size
Institution Code	The code of the institution.	Configured from: Configuration > General > Add a Library or Edit Library Information > Summary tab. The label in Alma is Code located on the right pane.	VARCHAR	50
Institution Name	The name of the institution.	Configured from: Configuration > General > Add a Library or Edit Library Information > Summary tab. The label in Alma is Organization unit name.	VARCHAR	255
Institution Address Line 1	The first line of the address of the institution. It usually includes the building number and the street name.	Configured from: Configuration > General > Add a Library or Edit Library Information > Contact Information tab. This is taken from the address configured as the Preferred address. The label in Alma is Address Line 1.	VARCHAR	1000
Institution City	The city of the institution.	Configured from: Configuration > General > Add a Library or Edit Library Information > Contact Information tab. This is taken from the address configured as the Preferred address. The label in Alma is City.	VARCHAR	255
Institution State Province	The state or province of the institution.	Configured from: Configuration > General > Add a Library or Edit Library Information > Contact Information tab. This is taken from the address configured as the Preferred address. The label in Alma is State/Province.	VARCHAR	320
Institution Country	The country of the institution.	Configured from: Configuration > General > Add a Library or Edit Library Information > Contact Information tab. This is taken from the address configured as the Preferred address. The label in Alma is Country.	VARCHAR	320
Institution Postal Code	The postal code of the institution.	Configured from: Configuration > General > Add a Library or Edit Library Information > Contact Information tab. This is taken from the address configured as the Preferred address. The label in Alma is Postal code.	VARCHAR	200
Institution Timezone	The timezone of the institution.	The timezone is set during implementation.	VARCHAR	255
Data Available As Of	When the institution data became available in analytics.	Displayed at the bottom of the main Analytics menu.	VARCHAR	255
Data Updated As Of	When the institution data was taken from the Alma database.	Displayed at the bottom of the main Analytics menu.	VARCHAR	255

If an analytics report is run from the Network Zone in a collaborative network implementing a Network Zone, all member institutions are included in the report for Institution Code and Institution Name.

If an analytics report is run from an institution that is not part of a collaborative network implementing a Network Zone, only the single institution from which the report is run is included in the report for Institution Code and Institution Name.

Reports involving data across a collaborative network implementing a Network Zone may take longer to run than reports within one institution.

Shared Dimensions with Other Subject Areas

For information concerning shared dimensions with other subject areas, see Shared Dimensions.