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

    Digital Usage

    Using the Digital Usage subject area, you can create reports and dashboards relating to digital usage and answer the following types of business questions:
    • How many times was the digital representation viewed?
    • How many times was the digital representation shared?
    • How many times was the digital representation access denied?
    • How many and which of the digital files were downloaded?
    • How many and which of the digital files were viewed?
    Star Diagram – Digital Usage

    Field Descriptions

    The following fields are available in Licenses.
    digital_usage_field_descriptions.png
    Digital Usage – Field Descriptions

    Digital Usage Measures

    The Digital Usage Measures table is a fact table that stores all measures relating to digital usage, such as number of digital representation views and number of digital file views.
    The number of digital representation views may be greater than the number of digital file views if the representation has an access rights policy that requires the patron to acknowledge a copyright statement. If the patron does not accept the copyright statement, it counts as a representation view but not as a file view.
    Digital Usage Measures
    Field Description Additional Information
    Number of digital representation views The number of digital representation views  
    Number of digital representation shares The number of digital representation shares  
    Number of digital representation access denied The number of digital representation access denied The number of times access to the digital representation has been denied due to the access rights policy blocking the user.
    Number of digital file views The number of digital file views In the Universal viewer and the Internet Archive Book Reader Viewer, there is no support for counting the number of files viewed (no event is triggered when moving between files), as there is for the Alma Viewer.
    Number of digital file downloads The number of digital file downloads  

    Digital Usage Details

    The Digital Usage Details table is a dimension table that stores additional details about digital usage.
    Digital Usage Details
    Field Description Additional Information
    Request ID The request ID  
    Delivery Type The delivery type of the representation Possible Values:
    • ALMA – Alma Viewer
    • IIIF – manifest request
    • JSON – representation json request
    • UV – Universal Viewer
    • IABR – Internet Archive Book Reader Viewer
    Representation ID The representation ID  
    File ID The file ID  
    Usage level The usage level  
    Creator The creator  

    Representation Details

    The Representation Details table is a dimension table that stores information about digital representations.
    Representation Details
    Field Description Additional Information
    Rep Create Date The date that the representation was created  
    Rep Creator The creator of the representation  
    Rep Delivery URL The delivery URL of the representation  
    Rep Deposit ID The deposit ID of the representation  
    Rep Digitization ID The digitization ID of the representation  
    Rep Entity Author The Author value of the representation entity type   
    Rep Entity Creator The Creator value of the representation entity type  
    Rep Entity Date The Date value of the representation entity type  
    Rep Entity Day in Month The Day in Month value of the representation entity type  
    Rep Entity End Page The End Page value of the representation entity type  
    Rep Entity End Time The End Time value of the representation entity type  
    Rep Entity Issue The Issue value of the representation entity type  
    Rep Entity Number The Number value of the representation entity type  
    Rep Entity Season Month The Season/Month value of the representation entity type  
    Rep Entity Start Page The Start Page value of the representation entity type  
    Rep Entity Start Time The Start Time value of the representation entity type  
    Rep Entity Title The Title value of the representation entity type  
    Rep Entity Track The Track value of the representation entity type  
    Rep Entity Type The entity type of the representation  
    Rep Entity Volume The Volume value of the representation entity type  
    Rep Entity Year The Year value of the representation entity type  
    Rep Label The label of the representation  
    Rep Last View Date The last date that the representation was viewed  
    Rep Library ID The library ID of the representation  
    Rep Lifecycle The lifecycle of the representation  
    Rep Link Param 1-5 The representation link parameters 1-5  
    Rep Modification Date The modification date of the representation  
    Rep Modified By The user who modified the representation  
    Rep Originating System ID The origination system ID of the representation  
    Rep Public Note The public note of the representation  
    Rep Remote Code The remote code of the representation  
    Rep Type Code The code of the type of the representation  
    Rep Usage Type The usage type of the representation  
    Is Deposit Indicates if the representation entered the repository as a deposit  
    Is Digitization Indicates if the representation entered the repository from a digitization request  

    File Details

    The File Details table is a dimension table that stores information about the digital file details.
    File Details
    Field Description Additional Information
    File Create Date The creation date of the file  
    File Creator The creator of the file  
    File Deleted Type The type of the deleted file  
    File Extension The extension of the file  
    File Internal Path The internal path of the file  
    File Label The label of the file  
    File Last View Date The last date the file was viewed  
    File Lifecycle The lifecycle of the file  
    File Mime Type The Mime type of the file  
    File Modification Date The modification date of the file  
    File Modified By The user who modified the file  
    File Name The name of the file  
    File Original ID The original ID of the file  
    File Original Name The original name of the file  
    File Original Path The original path of the file  
    File Size in Bytes The size of the file in bytes  

    Request Date

    The Request Date table is a dimension table that stores information about the digital request date.
    Request Date
    Field Description Additional Information
    Request Date Stores the request date in a date format such as 2/29/2014.  
    Request Start of Week The date of the first business day of the week  
    Request Week Number The number of the week of the year  
    Request Month Key Stores the month of the date in number format such as 2 for February  
    Request Month Stores the month of the date in month description format such as February  
    Request Full Month Stores the month and the year of the date in a display format such as Feb 12  
    Request Quarter Stores the quarter of the date in a display format such as Q1  
    Request Year Stores the year of the date in number format such as 2012  
    Request Fiscal year Stores the fiscal year of the date in a string format such as 2012.  
    Request Date Filter (Under Construction) Used to filter the request date.
    The functionality of this field may change in the future, so this field should not be used for saved reports.
     

    Bibliographic Details

    The Bibliographic Details table is a dimension table that stores the bibliographic details of the digital usage. The primary key of the table is MMS_ID.
    The field descriptions can be found in the Bibliographic Details shared dimension.
    Bibliographic Details
    Field Source in Alma (for Internal Reference) Mapping from MARC21 Mapping from UNIMARC
    Title Taken from display.title in the display section of the operational record MARC 245 subfields a,b 249 a,b,c,v 200 a,c,d,e,h,i
    Title (Filing) The title with common words such as "The" and "An" removed to help with sorting the title.
    For a video describing the use of this field, see Sort Analytics Reports by Filing Title - Ignoring "The", "A", and "An".
    240 245   200 a,e 500
    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. This field is built in the following manner:
    Alma does the following to the 245 field (except subfields c,h,6 and 8) in the following order:
    1. Removes non filing text.
    2. Removes <<>> and anything between them.
    3. Removes these characters: []|,.;:"
    4. Changes these characters to a space: !@#$%^&*()_+-={}\<>?/~'
    5. Changes characters to lowercase.
    6. Packs spaces (replace all sequences of more than one space with a single space).

    245 a,b

    249 a,b,c,v

    200 a,c,d,e,h,i
    Title Author Combined and Normalized 100 characters of the normalized title and the first four letters of the author in lowercase letters, with spaces removed See Author and Title Fields See Author and Title Fields
    Title (Complete) The information from MARC field 245, subfields $p, $n, $s, $k, $f, $g. 245 a,n,p,h,b,c,f,g,k,s 200 a-i
    Author Taken from display.author in the display section of the operational record 100,110,111 700,701,710,711
    Author (Contributor) An additional Author field

    711 a,c-e,i,j,n,q,u and its 880

    700 a-e,j,q,u and its 880

    710 a-e,i,n,u and its 880

    700 a-d,f,p

    701 a-d,f,p 

    710 a-h,p

    711 a-h,p

    720 a,f"

    721 a,f

    702 a-d,f,g 

    712 a-h,p

    722 a,f

    Collection Name The name of the collection    
    Bibliographic Source of Acquisition Note The name of the people or organization that is the source of the material (from MARC field 541 $a) 541 a  
    Bibliographic Acquisition Accession Number Note The identification code assigned to materials acquired in a single and separate transfer of custody (from MARC field 541 $e). 541 e  
    Collection ID The ID of the collection    
    ISBN Taken from search.isbn in the search section of the operational record MARC 020 a MARC 776 z 010 a
    ISSN Taken from the MMS Display Table in the search section of the operational record 022 l,a 776 x 011 a f
    Original Cataloging Agency The MARC code or the name of the organization that created the original record 040 a 081 b
    Publisher Taken from display.publisher_const_b in the display section of the operational record

    260 b

    264 b

    210 c

    214 c

    Publication Date Taken from display.date_of_publication in the display section of the operational record
    The publication date is determined as follows:
    • the bibliographic details publication date comes from 264 subfield c
    • if there is no 264 subfield c, then the publication date comes from 260 subfield c
    • if there is no 264 subfield c and also no 260 subfield c, then the publication date comes from 008 pos. 7-10
    The publication date is determined as follows:
    • the bibliographic details publication date comes from 210 subfield d
    • If there is no 210 subfield d, then the publication date comes from field 214 subfield d.
    • if both fields do not exist, then the publication date comes from field 100 subfield a pos. 9-12 
    Publication Place Taken from display.place_of_pu blication in the display section of the operational record 260 a 264 a 210 a 214 a
    Place Code Taken from display.place_code in the display section of the operational record 008 pos. 15-17  
    Place of Publication - Country The country of publication    
    Place of Publication - State The state of publication    
    Place of Publication - City The city of publication    
    Material Type See the table, Fields that Identify the Bibliographic Material Type, in the Material Types in Search Results section for a description of material type. MARC control LDR Material Type  
    Material Type Code Code of the material type described above (in Material Type). MARC control LDR Material Type  
    Begin Publication Date Taken from display.begin_pub_date in the search section of the operation 008 pos. 07-10 100.Date1
    End Publication Date Taken from display.end_pub_date in the search section of the operation 008 pos. 11-14 100.Date2
    Category of Material Taken from display. category_of_material in the display section of the operational record Position 0 of the 007 field  200 b
    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 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 010 excluding numeric subfields 020 a
    Network Number Taken from search. other_system_number in the search section of the operational record 035 a z 053 a z
    OCLC Control Number (019) The OCLC control number 019 a  
    OCLC Control Number (035a) The OCLC control number 035 a 035 a
    OCLC Control Number (035a+z) The OCLC control number 035a+z 035a+z
    OCLC Control Number (035z) The OCLC control number 035 z 035 z
    BIB 008 MARC The contents of the MARC 008 bibliographic field 008  
    BIB LDR MARC The contents of the MARC LDR bibliographic field LDR  
    Open Access Indicates if the article is open access Based on 506 f 506 2  
    Edition Taken from display.complete_edition in the display section of the operational record MARC 250 subfields a,b 205 a,b,f,g
    Form of Item The form of the item MARC 008 pos. 23  
    Government Publication The government publication type MARC 008 pos. 28  
    Language Code Taken from display.language in the display section in the operational record 008 pos. 35-37 101 a
    Series Taken from display.series_small in the display section in the operational record

    800 t

    801 t

    811 t

    830 a,n,p,v

    410 a,h,i,o,t,x
    Subjects Taken from display.subjects in the display section of the operational record 69X,630,689 600 a,b 602 603-8 610 616 617
    Type of Date Taken from display. type_of_date in the search section of the operational record 008 pos. 6 100 pos 8
    Uniform Title Taken from display.uniform_title in the display section of the operational record 240 130 500
    Uniform Resource Identifier The uniform resource identifier 856 u 856 u
    Resource Type Constructed based on existing bibliographic fields such as the LDR and 008. For more information, see 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. This is the MMS ID of the portfolios associated with the electronic collection. It is not the MMS ID of the electronic collection or of the MMS ID of the descriptive bibliographic record added in the Additional tab of the electronic collection editor. If there are no portfolios, the value of this field is empty.
    LC Classification Top Line Stores the combined LC code and classification numbers until the first period which is followed by a letter. If there are no periods then the entire string is taken until there is a space. The length is limited to 50 characters.
    For example:
    • if the LC Classification is | a HB3821.I8 |b R3 then the LC Classification Top Line will be HB3821
    • if the LC Classification is | a DF506.5 |b .G27 then the LC Classification Top Line will be DF506.5
    • if the LC Classification is | a N 7353 |b .K513 1965 then the LC Classification Top Line will be N
    • if the LC Classification is | a NOT YET ORDERED then the LC Classification Top Line will be NOT
    The LC Classification Top Line will contain one value. For MARC21, if the bibliographic record has:
    • both 090 and 050 then the LC Classification Top Line will come from 090
    • 050 and not 090 then the LC Classification Top Line will come from 050
    • 090 and not 050 then the LC Classification Top Line will come from 090
    Dewey Classification Stores the Dewey Classification
    Dewey Classification Top Line Stores the first 3 digits of the Dewey Classification
    Chinese Classifications Stores the Chinese Classification
    Local Param 1-10 This field allows you to enrich the bibliographic and holdings information exported to Analytics with additional information from MARC 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). (The field does not need to include a 9.)
    The fields can be number and code fields but not control fields. Therefore, the field must be greater than or equal to 010, because 00X are Control Fields and 01X-09X are Numbers and Code Fields.
    Following configuration of this field by Ex Libris Support, its value will be available in analytics.
    Subfields can be maintained in the Analytics fields identified for Local Param. When this capability is implemented, fields/subfields appear in Alma Analytics with the Alma subfield delimiter (either $$ or ‡) used to delineate the subfield content. Contact Support to enable this feature. Note that reindexing is required to fully implement this capability.
    Note that the local param fields are not related to the MARC type of the record. For example, if field 913 is defined to be in local param 1 then field 913 will always be in local param 1. This is the case if the record is of the type KORMARC, CNMARC, UNIMARC, MARC21, and so forth. It is not possible to have different sets of Local Param 1-10 for different types of MARC.
    Link ID The link ID
    Linked to CZ Indicates if the record is linked to the Community Zone
    Linked to NZ Indicates if the record is linked to the Network Zone
    Creator Stores the name of the user that created the record
    Creation Date Stores the creation date
    Managed by Provider Indicates if the electronic resource is managed by the provider
    Modified By Stores the user name that modified the record
    Modification Date Stores the modification date
    Peer Reviewed Indicates if the article was peer reviewed
    Provider Name The name of the provider
    Record Format The format of the bibliographic record. Possible values:
    • MARC 21
    • DC
    • KORMARC
    • CNMARK
    • UNIMARC
    • None
    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.
    ISSN (Normalized) The normalized ISSN. This field is useful when you want to use the normalized ISSN 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).
    Brief Level The level of the brief record
    Originating System The system where the bibliographic record originated
    Originating System ID The ID of the system where the bibliographic record originated
    Originating System Version The version of the originating system

    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.
    Note that the Dewey number is taken from the 852 subfield h of the holdings record and not from the 082 of the bibliographic record.
    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.
    The Dewey Number comes from the bibliographic record, except for in the Physical Items subject area where it comes from the holdings record.
    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.  

    LC Classification

    Using this dimension, the user can drill down from Group1 to Group4. In each level, the user may see measures accumulated to the relevant group and see the number of items grouped by classification.
    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
    • In the Fulfillment subject area, if there is more than one classification code, the last one appears.
    • The Classification Code comes from the bibliographic record, except for in the Physical Items subject area where it comes from the holdings record.
    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  
    Group5 Stores the name of the fifth 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. Note that the fifth level is not included in this field.  

    Other Classifications

    The Other Classifications table is a dimension table that contains fields for classification systems other than LC and Dewey.
    Other Classifications
    Field Description Additional Information
    Chinese Classifications
    Classification Code The Chinese Classification code with which to find a match to the Chinese Classification code from the bibliographic record.  
    Group 1-7 (Chinese) Stores the Chinese Classification Code, which comes from the bibliographic record.  
    Group 1-7 (English) Stores the name of the levels of classification  
    Chinese Classifications (Taiwan)
    Classification Code The Chinese Classification code with which to find a match to the Chinese Classification code from the bibliographic record.  
    Group 1-3 (Chinese) Stores the Chinese Classification Code, which comes from the bibliographic record.  
    Group 1-3 (English) Stores the name of the levels of classification  

    Institution

    The shared Institution dimension allows the Network Zone to view reports according to institution. It is available in every subject area. It contains the following fields:
    Institution
    Field Description Additional information
    Institution Code The code of the institution.  
    Institution Name The name of the institution.  
    Institution Timezone The timezone of the institution  
    Data Available As Of When the data became available to analytics  
    Data Updated As Of When the data was taken from Alma  
    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.