Analytics Objects

Field Descriptions

The following lists the fields available in Analytics Objects.

Analytics Objects – Field Descriptions

Analytics Objects Measures

The Analytics Objects Measures table is a fact table that stores all measures relating to analytics objects.

Analytics Objects Measures
Field	Description	Additional Information
Num of Objects	The number of analytics objects created by the institution.
Num of Objects for Source Alma	The number of objects Alma created by the institution from Alma analytics.
Num of Objects for Source Primo	The number of objects created by the institution from Primo analytics.
Num of Objects of Type Dashboard	The number of analytics objects of type dashboard
Num of Objects of Type DV	The number of analytics objects of type data visualization
Num of Objects of Type Dashboard - Active (to be deprecated)	The number of active objects of type dashboard	This field will be deprecated in a future release and should not be used.
Num of Objects of Type Dashboard - Not Active (to be deprecated)	The number of non-active objects of type dashboard	This field will be deprecated in a future release and should not be used.
Num of Objects of Type Report	The number of analytics objects of type report
Num of DV Objects Marked for Homepage	The number of analytics objects of type Data Visualization that are marked as being available to be used as an Alma homepage.
Num of Scheduled Objects	The number of scheduled analytics objects
Num of Objects of Type Scheduled Report - Active (to be deprecated)	The number of active objects of type scheduled report	This field will be deprecated in a future release and should not be used.
Num of Objects of Type Scheduled Report - Not Active (to be deprecated)	The number of non-active objects of type scheduled report	This field will be deprecated in a future release and should not be used.
Num of Objects Added as Widget	The number of analytics objects that were added as a widget
Num of Subscribed Users	The number of users who subscribed to a scheduled report.
Number of Widget Instances Displayed	The number widgets displayed by all users	The same widget is counted separately for each user that uses the widget
Num of Objects Delivered by Attachment	The number of analytics objects marked to be sent as an attachment
Num of Objects Delivered by Link	The number of analytics objects marked to be sent as a link
Num of Objects Delivered by FTP	The number of analytics objects marked to be delivered by FTP
Num of Users Who Pinned Object	The number of users that pinned an object
Num of Shared Internal Users	The number of internal users with whom the analytics object is shared
Num of Shared Users by Role	The number of roles with which the analytics object is shared

Analytics Object Details

The Analytics Object Details table is a dimension table that stores all measures relating to analytics object details.

Analytics Object Details
Field	Description	Additional Information
Object ID	The object ID
Object Report URL	The report URL of the analytics object.	This field only supports Alma Analytics Objects.
Object Type	The object type
Report Name	The object name
Object Title	The object title
Object Description	The object description
Report Location	The report location
Scheduled Report Delivery Format	The scheduled report format
Scheduled Frequency	The scheduled frequency
Scheduled Status	The scheduled status
Scheduled FTP	The scheduled FTP
Source System	The source system
Subject Area	The subject area of the report of the analytics object
Is Out of Box	Indicates if the report or dashboard of the analytics object is "out-of-the-box" - created by Ex Libris
Is Widget	Indicates if the analytics object is added as a widget that can be added to the Alma homepage
Is DV Homepage	Indicates of the analytics object of type data visualization is marked as being available to be used as the Alma homepage
Is Scheduled	Indicates if the analytics object is scheduled
Scheduled by Link/ Attachment	Indicates if the scheduled analytics object is marked to be sent as a link or as an attachment
Shared Internal Users	The names of the internal users with whom the analytics object is shared
Shared Roles	The roles with which the analytics object is shared

Created By

The Created By table is a dimension table that stores all measures relating to the analytics objects creator.

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.
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.
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.
Statistical Categories 01-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 accessed Primo/Alma for services in another institution. Note that this does not necessarily indicate that the services were actually supplied or that a linked account was created.	Possible values: yes no
User Group Code	The user group code

Alma User Details Page – General Information

Creation Date

The table is a dimension table that stores all measures relating to the analytics objects creation date.

Creation Date
Field	Description	Additional Information
Creation Date	Stores the creation date in the date format 2/29/2012
Creation Start of Week	The date of the first business day of the week
Creation Week Number	The number of the week of the year
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 Month	Stores the month of the date in month description format such as February
Creation Full Month	Stores the month and the year of the date in a display format such as Feb 12
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 Fiscal Month Key	Stores the fiscal year 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 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.

Modification Date

The table is a dimension table that stores all measures relating to Analytics Objects modification date.

Representation Modification Date
Field	Description	Additional Information
Modification Date	Stores the modification date in the date format 2/29/2012
Modification Start of Week	The date of the first business day of the week
Modification Week Number	The number of the week of the year
Modification 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
Modification Month	Stores the month of the date in month description format such as February
Modification Full Month	Stores the month and the year of the date in a display format such as Feb 12
Modification Quarter	Stores the quarter of the date in a display format such as Q1
Modification Year	Stores the year of the date in string format such as 2012
Modification Fiscal Month Key	Stores the fiscal year of the date in number format such as 2 for February.
Modification Fiscal Year	Stores the year of the date in string format such as 2012
Modification Date Filter	Used to filter report results by date
Modification Year-Month	The year and the month in a format such as 2023-1
Modification 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.

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