EPIC - Counter compliant metrics

[labradford]

Description

Goals
Repository items are linked to metrics describing views and downloads of the files, in compliance with COUNTER standards.

Requirements
A COUNTER-compliant Hyku implementation will include:

• Metrics relating to view and downloads exposed via a COUNTER/SUSHI endpoint.
• Ability for metrics including COUNTER/SUSHI and other bibliometric/altmetric services to be embedded on the public view of repository items.
• Historic metrics can be imported for items covering timeframes before the item existed in the Hyku install, which will need to be granular at least by month for COUNTER reporting.

Approach and Rationale
SoftServ will work in reference with COUNTER documentation to ensure compliance and configuration of reporting elements from Hyku, including https://cop5.projectcounter.org/ and https://www.projectcounter.org.

SoftServ has determined the following necessary steps to meet the requirements for COUNTER compliance:
Formatting of reports with headers
Determine search source (text and data mining bots vs. legitimate users)
Data mapping to COUNTER
Reports:
PR Platform Master Report, including

• Header
• Report body
• Metrics for
  -- Metrics Types
  -- Searches_Platform
  -- Total_Item_Investigations
  -- Total_Item_Requests
  -- Unique_Item_Investigations
  -- Unique_Item_Requests
  -- Unique_Title_Investigation
  -- Unique_Title_Requests

IR Item Master Report, including

• Header
• Report body
• Metrics for
  -- Total_Item_Investigations
  -- Total_Item_Requests
  -- Unique_Item_Investigations
  -- Unique_Item_Requests
  -- Limit_Exceeded (Not Necessary as they do not have limited items)
  -- No_License
  Access restrictions (Other_Free_To_Read, perhaps OA_Gold)
  Setup for restAPI & SUSHI
  Mechanism for pulling CSV reports
  Web UI
  Import and handling of historic data from before Hyku (up to 24 months)

Development will occur in allocated sprints, with alignment towards goals and budget via frequent communication between SoftServ, Pitt, and PALNI/PALCI to ensure priorities are being met and expectations are understood by all parties.

Acceptance Criteria

• Create COUNTER metrics tables in Hyrax #616
• Create an importer for historical data #617
• Understand JSON Structure for Platform and Item reports #622
• Fix Hyrax Analytics Reporting Layer #623
• Create a daily cron job to save metrics into the DB #625
• Build the Platform report #626
• Build the Item Report #627
• Build the SUSHI status endpoint #653
• Build the Platform Usage Report #654
• Build the SUSHI Report list endpoint #655
• Unique item requests & investigations on Platform & Platform Usage Report #678
• Add filters to Platform Report #686
• Add filters to Platform Usage report #687
• Filtering for Item Report #688
• Remove member list report from the reports list #694
• update the Hyrax::CounterMetric table #695
• Make COUNTER metrics test data for staging #699
• YOP report filter #720
• author report filter #721
• access_type report filter #725

Testing Instructions

should be included on the individual tickets above.

Notes

SOW: https://docs.google.com/document/d/1YsSrUDD424TRPv07DYn35yQtD-E5DVrkv5HU1oB7rs0/edit

Initial thoughts and research: https://docs.google.com/document/d/1AgzlQBtg8PofOfRP1d0GtyTKLf1V5M9tEZtMlnrtoo0/edit?pli=1