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

    Analytics Usage Tracking

    The Analytics Usage Tracking subject area allows you to create reports concerning the usage of Alma Analytics and is able to answer the following types of business questions:

    • Which Alma user ran Analytics reports/dashboards? When were the reports/dashboards run? Which reports/dashboards were run (including a path to the reports)?
    • How long did the reports take to run (total time in seconds)? How many times were the reports run (number of queries)?
    • Which percent of reports ended successfully or failed?
    • Which subject areas are used the most? How many times were the subject areas used? How many users use the subject areas? How long were queries run on each subject area?
    • Which users use which specific subject areas?
    • What is the analytics usage for a day of the week? an hour of the day? a week of the year? a month of the year?
    analytics_usage_tracking_star.png
    Analytics Usage Tracking
    • To use the Usage Tracking subject area, you must set the enable_usage_tracking parameter (see Analytics Configuration - Other Settings) to true
    • Additionally, the Analytics Usage Tracking job must be enabled.
    • This subject area becomes available a week after the parameter is set and the data included is from one week prior to the parameter's activation. For example, if the parameter was set to true on November 13th, the Usage Tracking subject area will be available by November 20th and will include data as of November 6th.
    • Analytics Usage Tracking data is updated once a week. The nightly job which is run Monday night will extract to analytics all data from the previous week up to and including the previous Saturday. Thus, for example, the job run Monday January 21 will include all data up to and including Saturday January 19.

    Field Descriptions

    analytics_usage_tracking_field_descriptions.png
    Analytics Usage Tracking - Field Descriptions

    Usage Tracking Measures

    The Usage Tracking Measures table is a measures table that stores details on usage tracking.
    Usage Tracking Measures
    Field Description Additional Information
    Number of Queries The number of standalone reports that ran, as well as the number of reports in dashboards and DV sections in workbooks that ran when the dashboard or workbook opened. Count is per report path, meaning for example, that accessing a canvas in a DV will count all the sections that appear on the canvas.

    Note that the usage tracking measure "Number of Queries" does not distinguish between reports run from a link within Alma (an analytics object) and reports created manually in the Oracle analytics interface. Therefore, you cannot create reports that display usage from just one of those sources.

    Total Time in Seconds The total time the queries took in seconds  
    Average Time in Secs The average time to run the report  

    Total Rows Retrieved

    The total number of rows retrieved by the report  
    Average Rows Retrieved The average number of rows retrieved by the report  

    Query Details

    The Query Details table is a dimension table that stores details on queries.
    Query Details
    Field Description Additional Information
    Data updated as of The last date the usage data was updated  
    Dashboard Tab/Workbook Canvas Name The name of the individual dashboard tab or workbook canvas accessed. If there is no name given to the tab/canvas in the dashboard, the tabs/ canvases are given numbers.
    Dashboard/Workbook Path The path of the dashboard or DV Workbook  
    New for August!
    DV Section
    The specific section within the DV workbook (single visualization) If there is no title given to the section in the dashboard, the sections are given numbers.
    In DV workbooks, DV sections are similar to reports in a dashboard, except that DV sections cannot be accessed as a standalone the way that reports in a dashboard can.
    Start Hour Min The start hour  
    Start Time The start time  
    Error Code The code of the error  
    Error Text The text of the error message  
    End Hour Min The end hour  
    End Time The end time  
    Number of Rows per Report The number of rows in the report When a large amount of data is returned from a query, this column is not populated until the user displays all of the data.
    Report Path The path to a specific report within the catalog The path to a specific report usually beginning with shared/.
    The report cannot be accessed directly from a browser, only within the OAS. If the report is a DV section, it has an internal path, as it cannot be accessed as a standalone.
    Report URL The URL of the report that ran This field displays the URL of specific reports. If the analysis type is dashboard, the URL to a report within the dashboard tab is displayed.
    Object Type The Alma/Primo/Esploro object type.

    Not available for analyses that do not have an Alma/Primo/Esploro object. 

    Possible Values:
    • Dashboard
    • Report
    • Data Visualization workbook
    • Product Embedded Reports (reports that are embedded in the Alma product)
    • None (no object assigned)
    Query Type Group Indicates whether the query runs in classic analytics or DV.  Possible values:
    • Classic Reports and Dashboards
    • DV Projects
    • None (for ad hoc queries or unsaved analyses) 
    Report Duration The time the report took to run  
    Query Status The query status  
    Subject Area The subject area  

    Query Date

    The Query Date table is a dimension table that stores details on the query date.
    Query Date
    Field Description Additional Information
    Query Date The date that the query was run  
    Query Day Name The query day name  
    Query Day of Week The query day of the week  
    Query Week Number The query week number  
    Query Month Key The query month (for example 2 for February)  
    Query Month The query month  
    Query Quarter The query quarter  
    Query Year The query year  
    Query Year Month The query year and month  
    Query Year Month Key The query year and month in format 2023-02  
    Query Fullmonth Stores the month and the year of the date in a display format such as Feb 12 This field is useful when comparing data on a month basis between years.
    Query Date Filter Used to filter reports by date  
    Query Year-Month The year and the month in a format such as 2023-1  

    User Details

    The User Details table is a dimension table that stores details on users.
    User Details
    Field Description Additional Information
    External Id The external ID of the user  
    First Name The first name of the user  
    Full Name The full name of the user If the report is system generated, Scheduled Reports is displayed for the user name.
    Gender The gender of the user  
    Job Description The  job description of the user  
    Job Title The job title of the user  
    Last Activity Date The last date that a patron made a request or borrowed or returned an item  
    Last Name The last name of the user  
    Middle Name The middle name of the user  
    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.
    Primary Identifier The primary identifier of the user  
    Status The status of the user  
    Expiry Date Stores the date on which the user is to expire and no longer be able to get service from the system 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.
    Birth Date Stores the birth date of the user  
    User Group The user group of the user  
    User Id The user ID of the user  
    IdP Service in Use Indicates if an identity provider service is in use  
    User Record Type The record type of the user  
    User Title The user title of the user  
    User Type The user type of the user  

    Institution

    The shared Institution dimension allows the Network Zone to view reports according to institution. 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.

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