Managing COUNTER-Compliant Usage Data
Many vendors can provide COUNTER statistics for your institution's usage in the form of COUNTER reports. These COUNTER reports can be loaded into Alma in one of two ways:
- Manually Uploaded
- Automatically Uploaded (Harvested) via the SUSHI protocol (Standardized Usage Statistics Harvesting Initiative)
Note that the ability to use the SUSHI protocol is dependent on the vendor's compliance with this protocol.
COUNTER R5 Report Types
|Report Type||Report Name||Description||Manual Upload (xlsx, xls, csv, tsv, ssv, txt formats)||SUSHI Harvest or Manual Upload (JSON format)|
|*BTR1||Book Title Report 1
|Reports on key Request metrics needed to evaluate the effectiveness of a given book.||Y||Y|
|*BTR2||Book Title Report 2||Reports on Access Denied activity for books where users were denied access because simultaneous-use licences were exceeded or their institution did not have a licence for the book.||Y||Y|
|DR||Database Master Report||A customizable report detailing activity by database that allows the user to apply filters and select other configuration options.||Y||Y|
|DR_D1||Database Search and Item Usage||Reports on key Searches, Investigations and Requests metrics needed to evaluate a database.||Y||Y|
|DR_D2||Database Access Denied||Reports on Access Denied activity for databases where users were denied access because simultaneous-use licenses were exceeded or their institution did not have a license for the database.||Y||Y|
|*DR1||Database Report 1||Reports on key Search and Request metrics needed to evaluate the effectiveness of a database or collection.||Y||Y|
|*DR2||Database Report 2||Reports on Access Denied activity for databases where users were denied access because simultaneous-use licences were exceeded or their institution did not have a licence for the database.||Y||Y|
|*DRx||Expanded Database Report||Flexible and detailed reporting on metrics captured and summarized at the database/collection level.||Y||Y|
|IR||Extended Item Report||A granular, customizable report showing activity at the level of the item (article, chapter, media object, etc.) that allows the user A person who accesses the online resourceto apply filters and select other configuration options.||Y||Y|
|IR_A1||Journal Article Requests||Reports on journal article requests at the article level. This report is limited to content with a Data_Type of Article, Parent_Data_Type of Journal, and Metric_Types of Total_Item_Requests and Unique_Item_Requests.||Y||Y|
|IR_M1||Multimedia Item Requests||Reports on multimedia requests at the item level.||Y||Y|
|*JTR1||Journal Title Report 1||Reports on key Request metrics needed to evaluate the effectiveness of a given journal.||Y||Y|
|*JTR2||Journal Title Report 2||Reports on Access Denied activity for journal articles where users were denied access because simultaneous-use licences were exceeded or their institution did not have a licence for the journal.||Y||Y|
|*PDAR1||Provider Discovery Article Report 1||Reports on requests and investigation activity by article and customer.||Y||Y|
|*PDDR1||Provider Discovery Database Report 1||Reports on requests and investigation activity by database and customer.||Y||Y|
|*PDTR1||Provider Discovery Title Report 1||Reports on requests and investigation activity by title and customer.||Y||Y|
|PR||Platform Master Report||A customizable report summarizing activity across a content provider’s platforms that allows the user to apply filters and select other configuration options.||Y||Y|
|PR_P1||Platform Usage||Platform-level usage summarized by Metric_Type.||Y||Y|
|*PR1||Platform Report 1||Provides summary usage of the most common metric types for searches, requests and access denied.||Y||Y|
|*PRx||Expanded Platform Report||Flexible and detailed reporting on metrics captured and summarized at the platform level.||Y||Y|
|TR||Title Master Report||A customizable report detailing activity at the title level (journal, book, etc.) that allows the user to apply filters and select other configuration options.||Y||Y
In case the TR report was customized Alma will not harvest it, there is a need to upload it manually
|TR_B1||Book Requests (Excluding OA_Gold)||Reports on full-text activity for books, excluding Gold Open Access content, as Total_Item_Requests and Unique_Title_Requests. The Unique_Title_Requests provides comparable usage across book platforms. The Total_Item_Requests shows overall activity; however, numbers between sites will vary significantly based on how the content is delivered (e.g. delivered as a complete book or by chapter).||Y||Y|
|TR_B2||Book Access Denied||Reports on Access Denied activity for books where users were denied access because simultaneous-use licenses were exceeded or their institution did not have a license for the book.||Y||Y|
|TR_B3||Book Usage by Access Type||Reports on book usage showing all applicable Metric_Types broken down by Access_Type.||Y||Y|
|*TRe||Expanded Title Report||Flexible and detailed reporting on metrics captured and summarized at the title level.||Y||Y|
|TR_J1||Journal Requests (Excluding OA_Gold)||Reports on usage of journal content, excluding Gold Open Access content, as Total_Item_Requests and Unique_Item_Requests. The Unique_Item_Requests provides comparable usage across journal platforms by reducing the inflationary effect that occurs when an HTML full text automatically displays and the user then accesses the PDF version. The Total_Item_Requests shows overall activity.||Y||Y|
|TR_J2||Journal Access Denied||Reports on Access Denied activity for journal content where users were denied access because simultaneous-use licenses were exceeded or their institution did not have a license for the title.||Y||Y|
|TR_J3||Journal Usage by Access Type||Reports on usage of journal content for all Metric_Types broken down by Access_Type.||Y||Y|
|TR_J4||Journal Requests by YOP (Excluding OA_Gold)||Breaks down the usage of journal content, excluding Gold Open Access content, by year of publication (YOP), providing counts for the Metric_Types Total_Item_Requests and Unique_Item_Requests. Provides the details necessary to analyze usage of content in backfiles or covered by perpetual access agreement. Note that COUNTER reports do not provide access model or perpetual access rights details.||Y||Y|
COUNTER R4 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||Y|
|BR5||Book Report: Total searches by Month and Title||R4||Y||Y|
|CR1||Consortial Report||R4||Not supported||Not supported|
|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||Y||Y|
|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||Y||Y|
|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||Y|
|PR1||Total searches, result selects, and record views by Month and Platform (previously DB3)||R4||Y||Y|
User Roles Summary
- 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
- Acquisitions Administrator
Managing SUSHI Accounts
- Vendor Manager
For information on how to define a COUNTER R5 SUSHI Account for ProQuest, ProQuest Ebook Central and Alexander Street Press in Alma, click here.
For the list of SUSHI-certified vendors for Release 5, see the SUSHI Vendors List.
For the list of SUSHI-certified vendors for Release 4, see the SUSHI Vendors List.
In the Uploaded Files section, the Report Success Rate column indicates the global success rate of the report type for that period, defined as the number of successes divided by the number of failures for the contributed accounts IDs. The statistics are calculated from two months prior to the current month and are updated roughly two days after the SUSHI report is run. The number links to the relevant SUSHI Account Details page.
- Ensure that a subscriber was defined for your institution. See Configuring COUNTER Subscribers.
- Select Add SUSHI Account.
- If Release 5 is enabled, select either Release 4 or Release 5. The SUSHI Account Details page appears.
SUSHI Account Details Page - Release 4SUSHI Account Details Page - Release 5
- Enter the vendor name in SUSHI Account. If you have selected release 5, only release 5 vendors appear in the drop-down list.
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 the SUSHI Vendors List). 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.Vendor names cannot contain a '/' (slash).A quick pick list option is available to search the vendors.Watch the Add SUSHI Account to Vendor via Search video (1:34 min).
- If you have not selected a vendor from the list, enter the URL in Vendor URL and select a subscriber in Subscriber. If needed, enter a URL in Override URL. Either the Override URL or the Vendor URL must be populated. If the Vendor URL for a SUSHI account changes in the list of SUSHI-certified vendors, the Vendor URL is updated. The Override URL is not changed by the update. When both the "Vendor URL" and "Override URL" fields are filled in Alma first attempts to connect via the "Override URL".
- Enter contact information in Contact Information. Typically, this will be a URL or email account of the vendor.
- 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. The vendor must supply the information and credentials for the API Key field. For information on special cases, see the SUSHI Vendors List.
- For Release 4 accounts, select the Report Type. For Release 5 The Accounts, select Add Report Type for each of the report types needed on this account.
- To test the connection, select Test Connection. For Release 4 accounts, if there is an error, an error message appears at the top of the page. Select 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. For Release 5 accounts, a JSON file is displayed with the connection status, and any errors, if applicable. You should also select Test Connection with Response for each report type from its respective row action menu to detect any further possible errors.
- Select Contribute to contribute a SUSHI account to the Community Zone.
- When you are done, select Save. The account is saved and appears in the Usage Data tab.
Managing SUSHI Harvesting
- Acquisitions Administrator
- Vendor Manager
- General System Administrator
For COUNTER 5, if one specific month returns an error when harvesting data, that same error will be shown for all months of that same report, even if the other months harvested successfully and have usage.
- As an Acquisitions Administrator, you can activate, deactivate, and schedule the automatic process, and you can run the job 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
- Cell 1B - Total Searches
- Cell 1C - Result Clicks and Record Views by Month and Platform
- PR1 reports should have the following data in cells 1B and 1C:
- To deactivate the SUSHI harvesting job, select Inactive or, under Schedule, select Not scheduled.
- To activate the SUSHI harvesting job, select Active and then, under Schedule, select a scheduling option (options exist for weekly or monthly job runs).
- To run the job immediately, select Run Now.
- To run the job immediately for a vendor account, select Harvest Now in the row actions list and select Confirm in the confirmation dialog box. For Release 5 accounts, you can also edit the SUSHI account, and harvest each report type separately.
- To manage reports received from the vendor, select View, Download, or Delete from the row actions list.
- To view a history of these account-specific job runs, select View History in the row actions list. The SUSHI Harvest History page appears.
Select File Details in the row actions list to see the report or response from the vendor. You can download the file by selecting 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).
Custom SUSHI Harvest
The Custom Harvest option enables users to define a specific time frame while manually harvesting SUSHI data. This is only available for SUSHI Release 5 accounts. The existing "Harvest Now" function remains and harvests usage from the past 12 months while the new "Custom Harvest" function presents users with a pop-up window allowing them to define the exact time frame for the harvest period. The "Custom Harvest" operation can run on the entire SUSHI account or on a specific report within the account. Users can define multiple harvest time frames.
If the selected date range(s) contain months previously uploaded to Alma, these will get overridden.
Watch the Harvest SUSHI Data from a Specific Time Frame video (1:18 minutes).
Manually Uploading and Deleting COUNTER Data
- Usage Data Operator
- Vendor Manager
- View information about the file and the imported data (View).
- Download the file (Download).
- Delete the file and its imported data (Delete).
- Reload the file if it did not run successfully (Reload). The action is visible only for Invalid and Partially Loaded SUSHI files.
Watch the Reload Usage Data Files That Failed to Load video (1:10 min).
- 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), select 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. The file should list counter data from the 10th Excel line onwards.
- Subscriber - Select the subscriber.
- Select Upload File. The file is uploaded and the data imported into Alma. Information about the file, including its status, appears in the table.
Viewing Usage Data
- Usage Data Operator
- In the Uploaded Files tab, select the desired report and click Download.
For more information, see Usage Data.
- 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. The green icon () indicates that the usage report file was successfully uploaded. The yellow icon () indicates that the connection to the vendor was successful, but the vendor did not send any data. While the red icon () indicates that the the vendor connection attempt was unsuccessful.