Skip to main content
ExLibris
  • Subscribe by RSS
  • ExLibris Dev

    Fulfillment

    Using the Fulfillment subject area, the Design Analytics user may create reports and dashboards for the Item Loan area. The following are examples of business questions that may be answered via the Fulfillment subject area:
    • How many items were loaned, returned, or lost per library?
    • How many items were loaned between specific loan dates?
    • How many items were loaned from a particular circulation desk?
    • What is the due-date policy of the loaned items?
    • How many items were loaned per classification?
    Star Diagram – Fulfillment

    Field Descriptions

    The following lists the fields available in Fulfillment.
    Fulfillment – Field Descriptions

    Loan

    The Loan fact table stores all the measures of a specific loan. The primary key is ITEM_LOAN_ID.

    Report Creation Tips

    • Filtering results using the In House Loan indicator
      In house loans are used to monitor items that were used in the library, but not actually loaned. When a return is made on an item that was not loaned, an in-house loan is created for it.
      Some industry reports require that these loans be included in the loan count and others do not; therefore, use a filter to include or exclude these results from your loan count, as necessary.
      In House Loan Indicator Filter
      The In-House Loan Indicator field is located in the Loan Details folder.
    • Distinguishing between self-check transactions and staff transactions
      Although there is no specific field that indicates the difference between self-check transactions and staff transactions, you can distinguish between the two based on the fact that the Loaned By\Returned By name for self-check machines is None.
      • Filter for returns:
        CASE WHEN "Returned By"."User Name" = 'None' THEN 'Self-Check Machines' ELSE 'Staff 'END
      • Filter for loans:
        CASE WHEN "Loaned By"."User Name" = 'None' THEN 'Self-Check Machines' ELSE 'Staff ' ENDq2

    Guidelines for Using Filters Based on Loan and Renewal Dates

    The easiest way to count the number of loans and number of renewals done in a certain time period is to create two separate reports. One report counts the number of loans based on the loan date. The other report counts the number of renewals based on the renewal date.
    In the following example, the number of loans is filtered by loan year=2013:
    Loan Filter
    The following appears:
    Loans
    In the following example, the number of renewals is filtered by renewal year=2013:
    Renewals Filter
    The following appears:
    Renewals
    It is possible to create a single report showing the number of loans and renewals in a certain time period, each based on its relevant date; however, it requires some more complex AND/OR conditions in order to find the right population.
    The following is an example of filtering all loans done in 2013 OR all renewals done in 2013. (You may need to run some tests when creating reports with slightly different filters to make sure you have the right population.)
    Loans and Renewals Filter
    The report appears as follows:
    Renewals
    Fulfillment Fields
    Field Description Additional Information
    Loans Populated with 1. This field accumulates the number of loans.  
    Returns Populated with 1 if the loan status is Complete; otherwise, it is populated with 0.  
    Recalls Stores the number of times the item was recalled  
    Renewals Stores the number of times the item was renewed  
    Lost Populated with 1 if the item is lost; otherwise, it is populated with 0.  
    Claimed Returns Populated with 1 if the patron claims that the item has been returned; otherwise, it is populated with 0.  
    Auto Renewals Stores the number of times the item was automatically renewed  
    Reading Room at Shelf Populated with 1 if the loan is a reading room loan and item is currently on the shelf; otherwise, it is populated with 0.  
    Reading Room at User Populated with 1 if the loan is a reading room loan and is currently held by the patron; otherwise, it is populated with 0.  
    WB Change Backward Stores the number of times the workbench due date was changed to an earlier date by a circulation desk operator at the circulation desk  
    WB Change Forward Stores the number of times the workbench due date was changed to an later date by a circulation desk operator at the circulation desk  
    Bulk Change Backward Stores the number of times the item was changed to an earlier date as part of a bulk change  
    Bulk Change Forward Stores the number of times the item was changed to a later date as part of a bulk change  
    Loan Days Stores the number of days between the loan date and the return date  
    Return Due Days Stores the number of days between the return date and the due date  

    Loan Details

    The Loan Details table is a dimension table that stores additional details regarding the loan. The primary key 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 note attached to the loan by the circulation desk operator  
    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 the due date policy details as defined under Fulfillment > Fulfillment Configuration > Configuration Menu > Physical Fulfillment > Advanced Policy Configuration > Policy Type = due date.
    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

    Loan Circulation Desk

    The Loan Circulation Desk table is a dimension table that stores the details about the circulation desk from which the item was loaned.
    Circulation desks are the place where items can be physically checked out or in and where circulation services are rendered. Each circulation desk is associated with a library and serves specific locations in that library
    Using this dimension table, a user is able to drill down from the campus level to the library and to the loan circulation desk. Measures (loans or returns) are accumulated to the relevant level in the hierarchy.
    Loan Circulation Desk
    Field Description Additional Information
    Campus Code Stores the code of the campus to which the circulation desk is connected.  
    Campus Description Stores the description of the campus to which the circulation desk is connected.  
    Campus Name Stores the name of the campus to which the circulation desk is connected.  
    Circ Desk Code Stores the code of the circulation desk  
    Circ Desk Desc Stores the description of the circulation desk  
    Circ Desk Name Stores the name of the circulation desk  
    Has Self Check Indicates whether the circulation desk has a self-check machine  
    Hold Shelf Indicates whether the circulation desk has the ability to hold items for patron requests  
    Hold Shelf Period Indicates the amount of time an item is held on the shelf for a patron before being returned  
    Hold Shelf Sort Stores the way items are physically stored on the shelf such as requester name, title, and date, for example.  
    Library Code Stores the library code to which the circulation desk is connected  
    Library Desc Stores the library description to which the circulation desk is connected  
    Library Name Stores the library name to which the circulation desk is connected  
    Payment Cash Indicates whether the circulation desk accepts payments in cash  
    Payment Credit Card Indicates whether the circulation desk accepts payments by credit card  
    Primary Indicator Indicates whether the circulation desk is able to send/accept items that need to be transferred out of the library  
    Print Receipt Indicates whether the circulation desk prefers payment receipts to be printed automatically  
    Reading Room Desk Indicates whether the circulation desk is a desk in a reading room where items cannot be removed from the room  
    Loan Circulation Desk Stores the is Hierarchy column that allows the user to drill down from the campus to the library to the loan circulation desk. This column provides the user with the option to view the accumulative measures in each level of the hierarchy.  

    Return Circulation Desk

    The Return Circulation Desk table is a dimension table that stores the details about the circulation desk to which the item was returned.
    The fields are the same as for Loan Circulation Desk.
    Loan Circulation Desk
    Field Description Additional Information
    Campus Code Stores the code of the campus to which the circulation desk is connected.  
    Campus Description Stores the description of the campus to which the circulation desk is connected.  
    Campus Name Stores the name of the campus to which the circulation desk is connected.  
    Circ Desk Code Stores the code of the circulation desk  
    Circ Desk Desc Stores the description of the circulation desk  
    Circ Desk Name Stores the name of the circulation desk  
    Has Self Check Indicates whether the circulation desk has a self-check machine  
    Hold Shelf Indicates whether the circulation desk has the ability to hold items for patron requests  
    Hold Shelf Period Indicates the amount of time an item is held on the shelf for a patron before being returned  
    Hold Shelf Sort Stores the way items are physically stored on the shelf such as requester name, title, and date, for example.  
    Library Code Stores the library code to which the circulation desk is connected  
    Library Desc Stores the library description to which the circulation desk is connected  
    Library Name Stores the library name to which the circulation desk is connected  
    Payment Cash Indicates whether the circulation desk accepts payments in cash  
    Payment Credit Card Indicates whether the circulation desk accepts payments by credit card  
    Primary Indicator Indicates whether the circulation desk is able to send/accept items that need to be transferred out of the library  
    Print Receipt Indicates whether the circulation desk prefers payment receipts to be printed automatically  
    Reading Room Desk Indicates whether the circulation desk is a desk in a reading room where items cannot be removed from the room  
    Loan Circulation Desk Stores the is Hierarchy column that allows the user to drill down from the campus to the library to the loan circulation desk. This column provides the user with the option to view the accumulative measures in each level of the hierarchy.  

    Loan Date

    The Loan Date table is a dimension table that stores the details about the item's loan date (month, year, and quarter). Using this dimension table, a user is able to drill down from the year to the month and to the specific date that the item was loaned. Measures (loans or returns) are accumulated to the relevant level in the hierarchy.
    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.  

    Due Date

    The Due Date table is a dimension table that stores the details about the item's due date such as month, year, or quarter. The key fields can be used when calculations are required, and the description fields can be used for formatting the display of the report.
    The fields are the same as for 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.  

    Return Date

    The Return Date table is a dimension table that stores the details about the item's return date such as month, year, and quarter. The key fields can be used when calculations are required, and the description fields can be used for formatting the report display.
    The fields are the same as for 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.  

    Renewal Date

    The Renewal Date table is a dimension table that stores all measures relating to the renewal date of loans. The primary key is DATE_KEY.
    Renewal Date
    Field Description Additional Information
    Renewal Date Month The month of the renewal date (for example: January, February).  
    Renewal Date Month Key The month of the renewal date in number format such as 2 for February.  
    Renewal Date Full Month The month and the year of the renewal date (for example: January 2014).  
    Renewal Date Quarter The quarter of the renewal date (for example: Q1, Q2).  
    Renewal Date Year The year of the renewal date (for example: 2014).  
    Renewal Date The date of the renewal.  

    LC Classifications

    Each book has a call number that consists of letters, whole numbers, and sometimes a decimal number. Each call number is arranged into, at least, two lines. The first line is referred to as the top line. The second line always begins directly after the cutter symbol. A cutter symbol is a period followed by a letter.
    Alma takes LC classification information from the holdings level.
    The field descriptions can be found in the LC Classifications shared dimension.
    LC Classifications
    Field Description Additional information
    Start Range Stores the start range of the group such as PS501  
    End Range Stores the end range of the group such as PS689  
    Classification Code Stores the letters in the beginning of the range such as PS  
    Start Range Number Stores the numbers that come after the letter in the start range  
    End Range Number Stores the numbers that come after the letter in the end range  
    Group1 Stores the name of the first level  
    Group2 Stores the name of the second level  
    Group3 Stores the name of the third level  
    Group4 Stores the name of the fourth level  
    Classifications Stores the Hierarchy column that allows the user to drill down from the first level of the classification to the fourth level. Using this column provides the user with the option to view the accumulative measures  

    Dewey Classifications

    Books can be classified with Dewey Classifications.
    In Dewey Classifications, topics are ordered in a hierarchy that is indicated by a three digit number. The highest level of the hierarchy is indicated by a number with one significant digit followed by two zeros, such as 600. The second level in the hierarchy is indicated by a number with two significant digits followed by one zero, such as 630. The third level in the hierarchy is indicated by a number with three significant digits such as 636.
    The field descriptions can be found in the Dewey Classifications shared dimension.
    Dewey Classifications
    Field Description Additional information
    Dewey Number Holds the first 3 digits of the Dewey Classification.  
    Group1 Stores the name of the first level.  
    Group2 Stores the name of the second level.  
    Group3 Stores the name of the third level.  
    Dewey Classifications Stores the Hierarchy column that allows the user to drill down from the first level of the Dewey Classification to the third level. Using this column provides the user with the option to view the accumulative measures (loans or returns) in each level of the hierarchy.  

    Item Location

    The Item Location table is a dimension table that stores the details about the shelving location of the item on loan. The primary key of the table is LIBRARYID and LOCATION_CODE.
    Location
    Field Description Additional Information
    Campus Code Stores the code of the campus where the physical item is located. This value is calculated through the library campus.
    Campus Name Stores the description of the campus. This value is calculated through the library campus.
    Campus Description Stores the name of the campus. This value is calculated through the library campus.
    Library Code Stores the library code to which the location of the physical item belongs. It is recommended to use the Library Code field of the Library Unit dimension instead of this one.
    Library Name Stores the library name to which the location of the physical item belongs. It is recommended to use the Library Name field of the Library Unit dimension instead of this one.
    Library Desc Stores the library description to which the location of the physical item belongs.  
    Location Code Stores the code of the location of the physical item.  
    Location Name Stores the name of the location of the physical item.  
    Location Type Stores the type of the location of the physical item, whether it is open stack or closed stack.  
    Call Number Type Stores the call number type used by the location of the physical item.  
    External Name Stores the name to be displayed to patrons for the location of the physical item.  
    Remote Storage Code Points to a remote storage location where the physical items are stored, if one exists.  
    Location Stores the Hierarchy column that allows the user to drill down from the campus to the library and then to the location of the physical item. This column provides the user with the option to have the user view the accumulative measures (num_of_items) in each level of the hierarchy.

    Bibliographic Details

    The Bibliographic Details table is a dimension table that stores the bibliographic details about the items at the time of the loan. 
    The field descriptions can be found in the Bibliographic Details shared dimension.
    Bibliographic Details
    Field Source in Alma (for Internal Reference) Mapping from MARC
    Title Taken from display.title in the display section of the operational record MARC 245 subfields a,b
    Author Taken from display.author in the display section of the operational record List values, delimiter is (;)
    • MARC 100 excluding Numeric subfields
    • MARC 110 excluding numeric subfields
    • MARC 111 excluding numeric subfields
    ISBN Taken from search.isbn in the search section of the operational record List values, delimiter is ;
    MARC 020 a,e,z
    ISSN Taken from search.issn in the search section of the operational record List values, delimiter is ;
    MARC 022 a,y,e,z
    Publisher Taken from display.publisher_const_b in the display section of the operational record MARC 260 b
    MARC 264 b
    Remove special characters and replace spaces.
    Publication Date Taken from display.date_of_publication in the display section of the operational record MARC 260 c
    Publication Place Taken from display.place_of_pu blication in the display section of the operational record MARC 260 a
    Place Code Taken from display.place_code in the display section of the operational record For MARC21 this is taken from 008 pos. 15-17
    Material Type Taken from search. material_type in the search section of the operational record MARC control LDR Material Type
    Begin Publication Date Taken from display.begin_pub_date in the search section of the operation For MARC21 this is taken from 008 pos. 7-10
    End Publication Date Taken from display.end_pub_date in the search section of the operation For MARC21 this is taken from 008 pos. 11-14
    Category of Material Taken from display. category_of_material in the display section of the operational record Position 0 of the 007 field of the bibliographic record
    Bibliographic Level Taken from display.bib_level in the display section of the operational record Position 7 of the LDR field of the bibliographic record
    Bibliographic ID Taken from display.bib_id in the display section in the operational record MARC 010 excluding numeric subfields
    Network Number Taken from search. other_system_number in the search section of the operational record This field is called "other system number" in Alma List values. The delimiter is ;
    MARC 035 excluding numeric subfields
    Edition Taken from display.complete_edition in the display section of the operational record MARC 250 subfields a,b
    Language Code Taken from display.language in the display section in the operational record For MARC21 this is taken from 008 pos. 35-37
    Series Taken from display.series_small in the display section in the operational record List values, delimiter is ;
    • MARC 830 subfields a,x,v
    • MARC 800 excluding numeric subfields
    • MARC 810 excluding numeric subfields
    Subjects Taken from display.subjects in the display section of the operational record List values, delimiter is ;
    MARC 6XX excluding numeric
    Type of Date Taken from display. type_of_date in the search section of the operational record For MARC21 this is taken from 008 pos. 6
    Uniform Title Taken from display.uniform_title in the display section of the operational record MARC 240 excluding numeric subfields
    MARC 130 subfields a,p
    Resource Type Constructed based on existing bibliographic fields such as the LDR and 008. For more information, see Working with the Resource Type Field.  
    The following table describes other fields in the shared dimension (taken from Alma and not MARC):
    Bibliographic Details
    Field Source in Alma (for Internal Reference)
    Active Course Code The code of an active course.
    Active Course Name The name of an active course.
    MMS ID Stores the MMS ID of the item
    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 Stores the Dewey Classification
    Dewey Classification Top Line Stores the first 3 digits of the Dewey Classification
    Local Param1 This field allows you to enrich the bibliographic information exported to Analytics with additional information stored in MARC 9XX local fields in Alma.
    In order to make use of this field, you must contact Ex Libris Support and supply them with a three-digit MARC field code (for example, 901). Following configuration of this field by Ex Libris Support, its value will be available in analytics.
    Local Param2 See the description above.
    Local Param3 See the description above.
    Local Param4 See the description above
    Local Param5 See the description above
    Creator Stores the name of the user that created the record
    Creation Date Stores the creation date
    Modified By Stores the user name that modified the record
    Modification Date Stores the modification date
    Suppressed from Discovery Indicates whether the record is suppressed from external discovery systems
    Bibliographic Lifecycle The Lifecycle of the item. Possible values are Deleted and In Repository. This allows you to filter reports by In Repository/Deleted items.
    Network ID This field is used by institutions implementing a Network Zone. It is the same as the MMS ID of the bibliographic record in the Network Zone and can be used to create reports that show the MMS ID in the member institution (using the existing MMS ID), as well as the corresponding MMS ID in the Network Zone.
    Title (Normalized) The normalized Title. This field is useful when you want to use the normalized title from one subject area to compare with a report with fields from a different subject area.
    ISSN (Normalized) The normalized ISSN. This field is useful when you want to use the normalized ISBN from one subject area to compare with a report with fields from a different subject area.
    ISBN (Normalized)
    The ISBN. Created for uniformity with Title (Normalized) and ISSN (Normalized).

    Patron Details

    The Patron Details table is a dimension table that stores the patron details at the time of the loan. The primary key of the table is ITEM_LOAN_ID.
    Patron Details
    Field Description Additional Information
    Patron Group Stores the group of the patron to whom the item is loaned.  
    Patron ID Stores the unique identifier of the patron to whom the item is loaned  
    Patron Job Title Stores the job title of the patron to whom the item is loaned. Users in the library may be given titles based on their role in the library.  
    Patron Record Type Indicates whether the patron to whom the item is loaned is a staff member  
    Patron Type Stores the type of the patron to whom the item is loaned. Users are grouped into types. Internal is a user type that has been created by the library. External is a type of user of the library supplied/created from the student information system.  

    Borrower Details

    The Borrower Details table is a dimension table that stores the details about the user to whom the item is loaned.
    For privacy reasons related to security requirements, loans may require anonymization after a defined period of time. Once anonymized, the specific user details are no longer viewable and Analytics retrieves NULL for these values.
    The following fields are not deleted when performing anonymization:
    • User Type
    • User Group
    • Campus Code
    • Job Title
    • User Statistics 1
    • User Statistics 2
    • User Statistics 3
    • User Statistics 4
    • User Statistics 5
    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.  
    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 the details about the user's preferred contact information such as preferred address, preferred phone, preferred email. and preferred SMS phone number.
    For privacy reasons related to security requirements, loans may require anonymization after a defined period of time. Once anonymized, the preferred contact information is no longer viewable and analytics retrieves NULL for these values.
    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 Operator Details

    The Loaned By table is a dimension table that stores the details about the staff user that created the loan, such as name, job title, and status.
    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 the figure Alma User Details Page – General Information, below.
    User Type Stores the values Internal, Internal with external authentication, or 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.
    • Internal with external authentication - like Internal type except that the user name and password are managed externally.
    • 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 figure Alma User Details Page – General Information, 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 figure Alma User Details Page – General Information, below.
    User Record Type Indicates if the user is a Public User or a Staff User See the field location in Alma in the figure Alma User Details Page – General Information, below.
    First Name Stores the user’s first name See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Last Name Stores the user’s last name See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Middle Name Stores the middle name of the user See the field location in Alma in the figure Alma User Details Page – General Information, 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 figure Alma User Details Page – General Information, 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 figure Alma User Details Page – General Information, below.
    Gender Stores male or female See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Birth Date Stores the birth date of the user See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Campus Code Stores the campus code of the user See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Status Date Stores the date on which the patron was registered in the university See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Status Indicates if the user is active See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Creation Date Stores the date that the user was created in the system See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Modified By Stores the name of the user that modified the user record See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Modification Date Stores the date of the modification of the user record See the field location in Alma in the figure Alma User Details Page – General Information, 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 figure Alma User Details Page – General Information, below.
    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 figure Alma User Details Page – General Information, below.
    Default Language Stores the default language of the user See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Failed Authenticati on 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 figure Alma User Details Page – General Information, 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. 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.  
    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

    Return Operator Details

    The returned By table is a dimension table that stores the details about the staff user that returned the loan, such as name, job title, and status.
    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 the figure Alma User Details Page – General Information, below.
    User Type Stores the values Internal, Internal with external authentication, or 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.
    • Internal with external authentication - like Internal type except that the user name and password are managed externally.
    • 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 figure Alma User Details Page – General Information, 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 figure Alma User Details Page – General Information, below.
    User Record Type Indicates if the user is a Public User or a Staff User See the field location in Alma in the figure Alma User Details Page – General Information, below.
    First Name Stores the user’s first name See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Last Name Stores the user’s last name See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Middle Name Stores the middle name of the user See the field location in Alma in the figure Alma User Details Page – General Information, 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 figure Alma User Details Page – General Information, 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 figure Alma User Details Page – General Information, below.
    Gender Stores male or female See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Birth Date Stores the birth date of the user See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Campus Code Stores the campus code of the user See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Status Date Stores the date on which the patron was registered in the university See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Status Indicates if the user is active See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Creation Date Stores the date that the user was created in the system See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Modified By Stores the name of the user that modified the user record See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Modification Date Stores the date of the modification of the user record See the field location in Alma in the figure Alma User Details Page – General Information, 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 figure Alma User Details Page – General Information, below.
    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 figure Alma User Details Page – General Information, below.
    Default Language Stores the default language of the user See the field location in Alma in the figure Alma User Details Page – General Information, below.
    Failed Authenticati on 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 figure Alma User Details Page – General Information, 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. 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.  
    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

    Last Renewal Date

    The Last Renewal Date table is a dimension table that stores details about the renewal date of a specific loan. This dimension was created before the Renewal Date dimension was added and is less useful now. The primary keys are Date_Key.
    The fields are the same as for Loan Date:
    Loan Date
    Field Description Additional Information
    Last Renewal Date The last renewal date in the date format 2/29/2012.  
    Last Renewal 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
    Last Renewal Month Stores the month of the date in month description format such as February  
    Last Renewal Full Month Stores the month and the year of the date in a display format such as Feb 12  
    Last Renewal Quarter Stores the quarter of the date in a display format such as Q1  
    Last Renewal Year Stores the year of the date in string format such as 2012  
    Last Renewal Fiscal Year Stores the fiscal year of the date in string format such as 2012.  
    Last Renewal 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.  

    Physical Item Details

    The Physical Item Details table is a dimension table that stores details about the physical item details. The primary key is ITEM_ID.
    .
    Physical Item Details
    Field
    Description
    Additional Information
    Modification Date
    The date that the physical item was modified.
     
    Modified By
    The user that modified the physical item.
     
    Creator
    the username of the operator that created the physical item
     
    Creation Date
    The date that the physical item was created.
     
    Alternative Call Number Type
    An alternative call number type
     
    Description
    Description of the item
     
    Barcode
    The unique identifier of the specific physical item
     
    Material Type
    Describes the nature of the material represented by the item record
     
    Item Policy
    Defines the conditions under which a request for this item can be fulfilled
     
    Provenance Code
    A code used to identify separate items that belong to different groups (but may be shelved together)
     
    Base Status
    Indicates the availability of the item in its permanent location (in place/not in place)
     
    Process Type
    When the item is being processed (acquisition/loan/bindery/etc) this indicates the type of processing
     
    Lifecycle
    Indicates whether the item is active or deleted
     
    Chron I
    The main level of chronology - usually the year
     
    Enum A
    The main level of enumeration - usually the volume
     
    Is Magnetic
    Whether the item is magnetic material or not.
     
    Expected Arrival Date
    The date when a purchased item is expected to arrive at the library
     
    Due Back Date
    Indicates the date that the item is due back at the library
     
    Inventory Date
    The last time inventory was checked (not currently in use)
     
    Last Loan Date
    The last time the item was loaned
     
    Statistics Note 1-3
    Holds statistic notes
     
    Internal Note 1-3 Holds internal notes  
    Receiving Date
    The date the material was actually received/activated for the first time
     
    Temporary Call Number Type
    A call number type provided when the item is in a temporary location
     
    Display Temporary Call Number
    A normalized temporary call number for display
     
    Display Alternative Call Number A normalized alternative call number for display  
    Originating System ID
    The ID of the item in the source system from which it has been imported
     
    Temporary Physical Location In Use
    Whether the item is in a temporary location or in a permanent location
     
    Time Loaned - not sum
    The amount of time that the physical item was loaned
     
    Permanent Call Number The permanent call number
     
     
    Fulfillment Note The fulfillment note  

    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.
    • Was this article helpful?