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

    Managing COUNTER-Compliant Usage Data

    Translatable
    Alma can collect and report on electronic resource usage statistics information supplied by content providers in COUNTER format. With access to these reports, librarians have more options for analyzing and understanding usage within their institutions. COUNTER reports may be presented in a variety of formats in Alma Analytics, as well as in specific cases in the Alma user interface.
    COUNTER (Counting Online Usage of NeTworked Electronic Resources) compliant usage statistics is explained here: https://www.projectcounter.org/.
    Many vendors can provide COUNTER statistics for your institution's users' usage. In some cases, you receive this information in a file and upload the information to Alma manually. In some cases your vendor supports the SUSHI protocol (Standardized Usage Statistics Harvesting Initiative), which allows Alma to automatically retrieve (harvest) and upload the data automatically. For more information about SUSHI, see http://www.niso.org/workrooms/sushi/.

    COUNTER Report Types

    COUNTER usage data is provided in many different prepackaged types (reports). Alma supports the following types (as of May 2017), depending on the COUNTER release version and method of entering the data. In the description, platform refers to the vendor interface.
    Supported COUNTER Report Types
    Report Type Description COUNTER Release Manual Upload (xlsx, xls, csv, txt, tsv formats) SUSHI Harvest or Manual Upload (xml format)
    BR1 Book Report: Successful Title Requests by Month and Title R4 Y Y
    BR2 Book Report: Successful Section Requests by Month and Title R4 Y Y
    BR3 Book Report: Access Denied to Content Items by Month, Title, and Category R4 Y
    Y
    BR4 Book Report: Access Denied to Content Items by Month, Platform, and Category R4
    Y
    Planned
    BR5 Book Report: Total searches by Month and Title R4
    Y
    Planned
    CR1 Consortial Report R4 Planned Planned
    DB1 Database Report: Searches, Result Clicks, and Record Views by Month and Platform R3 Y Y
    DB1 Database Report: Searches, Result Clicks, and Record Views by Month and Platform R4 Y Y
    DB2 Database Report: Access Denied by Month, Database, and Category R4 Planned Planned
    JR1 Journal Report: Successful Full-Text Article Requests by Month and Journal R3/R4 Y Y
    JR1 GOA Journal Report: Successful Gold Open Access Full-Text Article Requests by Month and Journal R4 Y Y
    JR1a Journal Report: Successful Full-Time Article Requests from an Archive by Month and Journal R3/R4 Y Y
    JR2 Journal Report: Access Denied to Full-Text Articles by Month, Journal, and Category R4 Planned Planned
    JR5 Journal Report: Successful Full-Text Article Requests by Year-of-Publication (YOP) and Journal R4 Y Y
    MR1 Multimedia Report: Successful Full Multimedia Content Unit Requests by Month and Collection R4
    Y
    Planned
    PR1 Total searches, result clicks, and record views by Month and Platform (previously DB3) R4 Y Y

    User Roles Summary

    Users with the following roles can perform tasks related to COUNTER compliant user statistics:
    • Acquisitions Administrator - Configure COUNTER subscribers and activate, deactivate, or manually run the automatic harvesting job.
    • Vendor Manager - View usage data related to a particular vendor, manually harvest data for the vendor, manually upload data for the vendor, and manage any uploaded data files.
    • Usage Data Operator - Manually upload or delete data for any vendor, manage the uploaded data files, and view missing COUNTER data.
    • General System Administrator - Activate, deactivate, schedule, or monitor the automatic harvesting job, view the job's history, report, and events, and configure email notifications for the job.

    Configuring COUNTER Subscribers

    To configure COUNTER subscribers, you must have the following role:
    • Acquisitions Administrator
    Subscribers are used to maintain multiple accounts with a vendor. For an institution, subscribers can be used to separate the usage data by campus or library (when the vendor can distinguish access to its resources by the IP addresses of each entity). Alma requires you to define at least one subscriber. Subscriber information is provided by, or agreed upon with, the vendor.
    When you manually upload a data file, the file is considered new data if several key fields are different (vendor, dates, etc), including subscriber. Uploading the same data file a second time overwrites the data from the first upload. If you change the subscriber in the data to a different, valid subscriber, the data is uploaded as new data.
    With multiple subscribers you can use the subscriber as a filter field in Alma Analytics.
    You configure subscribers on the Subscribers code table (Acquisitions > Acquisitions Configuration > Configuration Menu > Acquisitions > General > Subscribers). For more information about code tables, see Code TablesCode Tables.
    Subscribers Code Table
    As noted above, you must configure at least one subscriber.

    Managing SUSHI Accounts

    To configure SUSHI accounts, you must have the following role:
    • Vendor Manager
    SUSHI accounts enable Alma to automatically retrieve COUNTER reports from vendors. You create a SUSHI account for each vendor and for each report type; a single vendor may require multiple SUSHI accounts, one for each report type.
    You do not have to create a SUSHI account to retrieve COUNTER data from a a vendor. Whether or not you configure a SUSHI account for a vendor, a vendor can provide you COUNTER data by some other means for you to upload manually to Alma.
    You manage SUSHI accounts on the Usage Data tab of the Vendor Details page (Acquisitions > Acquisitions Infrastructure > Vendors, select Actions > Edit in the row actions list for the vendor and select the Usage Data tab).
    Vendor Details - Usage Data Tab
    To add a SUSHI account:
    While the procedure below indicates that you should add the account for a vendor on the Usage Data tab of that vendor, in fact you can add an account for any vendor on the Usage Data tab of any vendor. The vendor that is contacted by the SUSHI job is determined solely by the URL and other information you add when configuring the account, not the tab on which you enter the information. Nevertheless, Ex Libris recommends that you add the account for each vendor on the Usage Data tab of that vendor, for organizational purposes.
    For vendors that are actually subscription agents for other vendors (access providers or publications), each report type from each access provider or publication requires an additional SUSHI account for each access provider or publication; multiple reports from the same vendor require multiple SUSHI accounts.
    1. Ensure that a subscriber was defined for your institution. See Configuring COUNTER Subscribers.
    2. On the Usage Data tab, if the vendor is not yet noted as SUSHI-enabled, select SUSHI Vendor. The Add button and an area of the page to list this vendor's SUSHI accounts appears.
    3. Click Add. The SUSHI Account Details page appears.
      SUSHI Account Details Page
    4. Enter the vendor name in SUSHI Account.
      After you enter three letters in this field, a drop-down list of SUSHI-certified vendors appears (this list is predefined by Ex Libris; see SUSHI-Certified Vendors). If you select any of the vendors from this list, Vendor URL is prefilled with the correct URL for the vendor (other information may also be prefilled). However, you do not have to select a predefined certified vendor; you can enter any value you like.
    5. Enter the URL in Vendor URL and select a subscriber in Subscriber.
    6. Enter the required credentials in the Request Details area. Some information may already be prefilled; your vendor will supply you with the required information for this area.
      • For ProQuest, enter the customer ID, username, and password that ProQuest sent you for your institution. Enter <username/password> as the Requester ID. For example, if your username is "orange" and your password is "apple", enter orange/apple for Requester ID, orange for User Name, and apple for Password.
      • For Elsevier, the Requester ID is SUSHI-ALMA. If you previously used UStat, this ID is different from the one your institution used in UStat, which was SUSHI-Exlibris. Ex Libris changed the ID for all existing customers for the May, 2017 release. For institutions currently setting up Alma SUSHI accounts while still working in UStat (customers still implementing Alma), contact Elsevier customer support to ensure that your SUSHI-ALMA account is active. For these customers, Test Connection does not work for Elsevier, because Elsevier supports only one active account per institution and the UStat account is still active.
    7. Select the Report Type.
    8. To test the connection, click Test Connection. If there is an error, an error message appears at the top of the page. In this case, you may want to click Test Connection with Response to view a Zip file containing both the SUSHI request and response packages (in XML) sent to/from the vendor. These packages may help you debug the connection.
    9. When you are done, click Save. The account is saved and appears in the Usage Data tab.
    You can delete the account by selecting Actions > Delete in the account row on the Usage Data tab.
    On the Search Vendors page (Acquisitions > Acquisitions Infrastructure > Vendors), you can filter the table to display only SUSHI-enabled vendors by selecting SUSHI Vendor in the Vendor Type filter. Note that a vendor may be SUSHI-enabled even if it does not have a SUSHI account.
    search_vendors_with_sushi_vendors_highlighted.png
    search_vendors_with_sushi_vendors_highlighted.png
    Search Vendors Page

    SUSHI-Certified Vendors

    • AACC International
    • Accessible Archives
    • ACM Digital Library R4
    • AIP Scitation R4
    • Alexander Street Press
    • Allen Press
    • American Academy of Periodontology
    • American Chemical Society
    • American College of Chest Physicians
    • American College of Physicians
    • American Economic Association
    • American Fisheries
    • American Geophysical Union R3
    • American Geophysical Union R4
    • American Institute of Aeronautics and Astronautics
    • American Medical Association
    • American Mental Health Counselors Association
    • American Meteorological Society
    • American Physical Society R4
    • American Phytopathological Society
    • American Public Health Association
    • American Roentgen Ray Society
    • American Statistical Association
    • American Thoracic Society
    • American Veterinary Medical Association
    • Ammons Scientific
    • Annual Reviews
    • APA PsycNET R4
    • ASA platform – all publishers R4
    • Ascelibrary.org
    • BioMed Central
    • BioOne
    • Brepols
    • Brill Online Books and Journals
    • British Institute of Radiology
    • Caliber
    • Cambridge University Press
    • CFA Publications
    • Duncker & Humblot
    • EBSCO Publishing R4
    • Ecological Society of America
    • Edinburgh University Press
    • Edward Elgar Publishing
    • Elsevier
    • Emerald Insight
    • Endocrine Society Journals
    • Families in Society
    • Future Medicine
    • Future Science
    • Guilford Press
    • HighWire Press
    • Hogrefe
    • IEEE Xplore R4
    • Informa Healthcare
    • INFORMS
    • Ingentaconnect
    • Institution of Civil Engineers
    • IOP Publishing R4
    • IOP Science R4
    • Irish Newspaper Archives
    • Journal of Coastal research
    • Journal of Marketing Research
    • Journal of Neurosurgery
    • Journal of Oral Implantology
    • Journal of Orthopedic & Sports Physical Therapy
    • Journal of Parasitology
    • Journal of Studies on Alcohol and Drugs R4
    • Journal of the Physical Society of Japan
    • Journal Usage Statistics Portal R4
    • JSTOR
    • Maney
    • Mary Ann Liebert, Inc
    • MetaPress
    • MIT Press
    • Modern Language Association
    • Morgan and Claypool Publishers
    • Multi-Sciences Publishing
    • Nature R4
    • New England Journal of Medicine
    • NRC Press
    • OECD library
    • Oldenbourg
    • Optical Society of America R4
    • OvidSP
    • Oxford Journals R4
    • Palgrave R4
    • Physicians Postgraduate Press R3
    • Project Euclid
    • ProQuest
    • ProQuest Ebook Central
    • Psychiatry Online
    • Radiation Research
    • Radiological Society of North America
    • Royal Society of Chemistry R4
    • Scholars Portal (OCUL)
    • ScienceSocieties R4
    • SIAM R4
    • Society of Exploration Geophysicists
    • Springer
    • Taylor & Francis
    • The Cleft Palate - Craniofacial Journal
    • University of Chicago Press
    • University of Toronto Press
    • Vandenhoeck & Ruprecht
    • Walter de Gruyter Reference Global Journals
    • Wiley Online Library
    • World Scientific

    Managing SUSHI Harvesting

    To manage the SUSHI harvesting job, you must have one of the following roles (see below for details):
    • Acquisitions Administrator
    • Vendor Manager
    • General System Administrator
    By default, the SUSHI harvesting job harvests all COUNTER data from all active SUSHI accounts. The job runs some time between Friday evening and Saturday morning, depending on your time zone.
    The actions you can perform depend on your role.
    • As an Acquisitions Administrator, you can activate, deactivate, or schedule this job, or run it manually.
    • As a Vendor Manager, you can run the job manually for a single vendor account and view a history of how often this was performed.
    • As a General System Administrator, you can activate, deactivate, schedule, or monitor the job, view a job's history, report, and events, and configure email notifications for the job on the Monitor Jobs page. For more information, see Viewing Scheduled Jobs. Viewing Running Jobs, Viewing Completed Jobs.
      PR1 reports should have the following data in cells 1B and 1C:
      • Cell 1B - Total Searches, Result Clicks and Record Views by Month and Platform
      • Cell 1C - empty
      In some cases, vendors have sent PR1 reports with the following (incorrect) data in cells 1B and 1C:
      • Cell 1B - Total Searches
      • Cell 1C - Result Clicks and Record Views by Month and Platform
      The SUSHI harvesting job reports an error in this case. If you see an error is the job report, check the report sent from the vendor. In the above case, correct the data and then manually upload the report; see Manually Uploading and Deleting COUNTER Data.
    To manage the SUSHI Harvesting job as an Acquisitions Administrator or General System Administrator:
    On the Acquisitions Jobs Configuration Page (Acquisitions > Acquisitions Configuration > Configuration Menu > Acquisitions > General > Acquisition Jobs Configuration), perform one of the following actions in the SUSHI Harvesting Job area:
    Acquisition Jobs Configuration
    • To deactivate the SUSHI harvesting job, select Inactive or select Not scheduled for SUSHI harvesting job schedule.
    • To activate the SUSHI harvesting job, select Active and select a valid scheduling option in SUSHI harvesting job (currently the only valid option is Every Saturday at 03:00).
    • To run the job immediately, click Run Now.
    To manage the SUSHI Harvesting job as a Vendor Manager:
    On the Usage Data tab of the Vendor Details page (Acquisitions > Acquisitions Infrastructure > Vendors, select Actions > Edit in the row actions list for the vendor and select the Usage Data tab), perform one of the following actions:
    • To run the job immediately for a vendor account, select Actions > Harvest Now in the row actions list and click Confirm in the confirmation dialog box.
    • To manage reports received from the vendor, select View, Download, or Delete from the Actions menu in the report rowrow actions list.
    • To view a history of these account-specific job runs, select Actions > View History in the row actions list. The SUSHI Harvest History page appears.
      SUSHI Harvest History
      Click File Details in the row actions list to see the report or response from the vendor. You can download the file by clicking Download. You can download the file even if it was deleted (on the Usage Data tab of the Vendor Details page or the Uploaded Files tab of the Usage Data Loader page).
      SUSHI File Details

    Manually Uploading and Deleting COUNTER Data

    To manually upload COUNTER data or manage this data after it was uploaded, you must have one of the following roles (see below for details):
    • Usage Data Operator
    • Vendor Manager
    A vendor can send you COUNTER data to upload manually to Alma. The data that you upload must be in one of the following formats: xslx, xls, csv, txt, or tsv. For some report types, you can also manually upload data in xml format (see COUNTER Report Types).
    A Usage Data Operator can upload data for any vendor and manage all uploads on the Uploaded Files tab of the Usage Data Loader page (Acquisitions > Import > Load Usage Data).
    Usage Data Loader, Uploaded Files Tab
    A Vendor Manager can upload data and manage uploads for a single vendor at a time on the Usage Data tab of the Vendor Details page (Acquisitions > Acquisitions Infrastructure > Vendors, select Actions > Edit in the row actions list for the vendor and select the Usage Data tab).
    After uploading the data, the operator/manager can perform the following actions:
    • View information about the file and the imported data (select Actions > View).
    • Download the file (select Actions > Download).
    • Delete the file and its imported data (select Actions > Delete).
    New for September! A Usage Data Operator can also delete data according to its file ID on the Delete Usage Data page (Acquisitions > Import > Delete Usage Data). This is helpful when usage data was migrated to Alma and appears (with its file ID) in Analytics.
    Delete Usage Data Page
    To manually upload COUNTER data:
    See the note about errors in PR1 reports from some vendors in Managing SUSHI Harvesting. If you see this error in a PR1 report, manually correct the report before uploading it.
    1. On the Uploaded Files tab of the Usage Data Loader page (as a Usage Data Operator), or on the Usage Data tab of the Vendor Details page (as a Vendor Manager), enter the following information into the Quick Add areaclick Upload File and enter the following.
      • Vendor (Usage Data Loader page, only) - The vendor associated with the uploaded data. Note that the vendor does not have to be a SUSHI vendor.
      • Upload File - Browse for the file to upload.
      • Subscriber - Select the subscriber.
    2. Click Upload File. The file is uploaded and the data imported into Alma. Information about the file, including its status, appears in the table.
    To manually delete COUNTER data according to its file ID:
    On the Delete Usage Data page, enter the file ID and click Delete File and click Confirm in the confirmation dialog box.
    A Delete Usage Data job runs. See Viewing Completed Jobs for information on monitoring the job and viewing the report.

    Viewing Missing COUNTER Data

    To view missing COUNTER data you must have the following role:
    • Usage Data Operator
    You can view missing COUNTER data by subscriber, platform (vendor interface), report type and measurement, and month on the Missing Data tab of the Usage Data Loader page (Acquisitions > Import > Load Usage Data; select the Missing Data tab). Contact your vendor for any missing information.
    Usage Data Loader, Missing Data Tab
    Select a year or report type and measurement using the filter drop-down lists (Year or Measured By, respectively). Any year for which you have at least some COUNTER data appears in the Year filter.
    The columns on this page include:
    • Subscriber
    • Platform
    • Measured By - Report type and measurement. If you do not select anything in the Measured By filter, all report types and measurements appear.
    • Jan .. Dec - Only the months of the year selected in the Year filter appear. A green checkmark indicates that there is data, a red exclamation point indicates missing data.