Skip to main content
ExLibris
  • Subscribe by RSS
  • Ex Libris Knowledge Center

    Fines and Fees

    By using the Fines and Fees area, the Design Analytics user is able to create reports/dashboards for the Fine and Fees area. The user is able to display the following information:
    • A list of all a user's cash transactions
    • A list of all the open cash transactions by patron group
    • A list of users that have fines and fees with their preferred address, phone, and email information
    • A list of all the transaction types and amounts per library
    Star Diagram – Fines and Fees

    Field Descriptions

    The following lists the fields available in Fines and Fees.
    fines_and_fees_field_descriptions.gif
    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, disputed, and transferred balance information. The primary key of the table is FINE_FEE_TRANSACTION_ID.
    Fines and Fees Transactions
    Field Description Additional Information
    Original Amount Stores the original amount of the fine or fee  
    Transaction Amount Stores the amount of money that is associated with this transaction  
    Transaction VAT Stores the tax amount associated with the transaction  
    Original VAT Stores the original tax amount of the fine or fee  
    Remaining Amount Stores the amount of money remaining after subtracting the transaction amount from the original amount.  
    Fine Fee ID Stores the unique identifier of the fine or fee  
    Fine Fee Type Stores the type of the fine or fee such as overdue loan fee or lost loan fee  
    Fine Fee Transaction ID Stores the unique identifier of the fine or fee transaction  
    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:
    1. View a patron's fines and fees.
    2. Filter by status Closed or retrieve a fine that had a partial payment.
    3. Click the Remaining Balance link (which may be 0.00 on a closed fine fee).
    4. The value of the Alma Analytics Fine Fee Additional Transaction ID is in the Transaction ID column.
    Fine Fee Transaction Type Stores the type of fine or fee transaction such as paid or waived  
    Fine Fee Status Indicates whether or not the fine or fee is active  
    Fine Comment Stores the content of the comment associated with the fine or fee  
    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  
    Status Date Stores the date that the fine or fee is created  
    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)
    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  
    External ID Stores the ID of the fine or fee in the originating system  
    Originating Loan ID Stores the Loan ID from the originating system  
    Original Currency Stores the original currency  
    Currency Stores the actual currency of the fine and fee  
    Fine Fee Creation Date Stores the date that the fine and fee was created  
    Fine Fee Created By ID Stores the user ID of the Staff Operator who created the fine or fee transaction  
    Fine Fee Creator Stores the user name of the user that created the fine and 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 Transaction Creation Date Stores the creation date of the fine and fee transaction  
    Fine Fee Transaction Created By ID Stores the user ID of the user that created the fine or fee transaction  
    Fine Fee Transaction Creator Stores the user name of the user that created the fine and 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  
    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
    Date Key Stores the fine and fee transaction date in a date format such as 2/29/2012  
    Transaction Date Stores the Hierarchy column that allows the user to drill down from the year to the month to the specific transaction date. Using this column, a user may view the accumulative measures in each level of the hierarchy.
    The rest of the fields are the same as Loan Date.
    Loan Date
    Field Description Additional Information
    Loan Date Stores the loan date in the date format 2/29/2012  
    Loan 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
    Loan Month Stores the month of the date in month description format such as February  
    Loan Full Month Stores the month and the year of the date in a display format such as Feb 12  
    Loan Quarter Stores the quarter of the date in a display format such as Q1  
    Loan Year Stores the year of the date in string format such as 2012  
    Loan Fiscal Year Stores the fiscal year of the date in string format such as 2012.  
    Loan Time Stores the time in the hours:minutes:seconds format for the loan date  
    Loan 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 Fiscal Month Key Stores the fiscal month of the date in number format such as 2 for February  
    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 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 Additional Information
    Library Code Stores the library code  
    Library Description Stores the library description  
    Library Name Stores the library name  
    Unit Type Store the type of organization unit Values can be Institution/Library

    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.
    The field descriptions can be found in the Library Unit shared dimension.
    Library Unit
    Field Description Additional Information
    Library Code Stores the library code  
    Library Description Stores the library description  
    Library Name Stores the library name  
    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.
    User Details
    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 Alma User Details Page – General Information.
    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 Alma User Details Page – General Information.
    User Group Stores the group with which the user is associated such as Faculty, Graduate, or Student See the field location in Alma in Alma User Details Page – General Information.
    User Record Type Indicates if the user is a Public User or a Staff User See the field location in Alma in Alma User Details Page – General Information.
    First Name Stores the user’s first name See the field location in Alma in Alma User Details Page – General Information.
    Last Name Stores the user’s last name See the field location in Alma in Alma User Details Page – General Information.
    Middle Name Stores the middle name of the user See the field location in Alma in Alma User Details Page – General Information.
    Job Description Stores free-form text that describes the function of the user in the library See the field location in Alma in Alma User Details Page – General Information.
    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 Alma User Details Page – General Information.
    Gender Stores male or female See the field location in Alma in Alma User Details Page – General Information.
    Birth Date Stores the birth date of the user See the field location in Alma in Alma User Details Page – General Information.
    Campus Code Stores the campus code of the user See the field location in Alma in Alma User Details Page – General Information.
    Status Date Stores the date on which the patron was registered in the university See the field location in Alma in Alma User Details Page – General Information.
    Status Indicates if the user is active See the field location in Alma in Alma User Details Page – General Information.
    Creation Date Stores the date that the user was created in the system See the field location in Alma in Alma User Details Page – General Information.
    Modified By Stores the name of the user that modified the user record See the field location in Alma in Alma User Details Page – General Information.
    Modification Date Stores the date of the modification of the user record See the field location in Alma in Alma User Details Page – General Information.
    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 Alma User Details Page – General Information.
    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 Alma User Details Page – General Information.
    Default Language Stores the default language of the user See the field location in Alma in Alma User Details Page – General Information.
    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 Alma User Details Page – General Information.
    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. Choosing 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.  
    Identifier 2 Stores identifier 2. See details in "identifier 1" above.  
    Statistical Categories 1-5 These fields allow you to map five 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.  
    Alma User Details Page – General Information
    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  
    Note Stores a note regarding the user's preferred address  

    Loan Details

    The Loan Details table is a dimension table that stores additional details of a loan when fines and fees become associated with the loan. The primary key of the table is ITEM_LOAN_ID.
    Loan Details
    Field Description Additional Information
    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  
    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 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 current status of the loan  
    Loan Note Stores the last note attached to 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  
    Original Due Date Stores the original due date given to the loan  
    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.  
    Is Booking Loan Indicates whether the loan is on an item that was booked.  
    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.  
    Publication Year For internal use only (by the migration team)  

    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.
    Fulfilment – Loan 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 Alma in Advanced Policy Configuration
    Policy Name Stores the name given to the policy See the field location in Alma in Advanced Policy Configuration
    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 Alma in Advanced Policy Configuration
    Policy Constant Stored only if the due date is a constant value  
    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 Alma in Advanced Policy Configuration
    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 Alma in Advanced Policy Configuration
    Unit of Measurement Stores the unit of measurement such as days or weeks See the field location in Alma in Advanced Policy Configuration
    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.
    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 Name The last name of the operator  
    Operator Middle Name The middle name of the operator  
    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  

    Institution

    The shared Institution dimension allows the network institution to view reports according to institution. It is available in every subject area. It contains the following fields:
    Institution
    Field Description Additional information
    Institution Code The code of the institution.  
    Institution Name The name of the institution.  
    If an analytics report is run from a member institution 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.