FAQ content

Harvesting SUSHI (COUNTER r4) usage data for eBook datasets

In this article

Getting there

Via the command bar

To record data to a dataset, click on  Record Data in the command bar. This will take you to the default dataset selected in your account's settings. If you are currently viewing the Analyze page for a dataset, however, it will take you to that same dataset's Record Data page instead.

Navigating to the Record Data page from the command bar

Via the homepage

In the Shortcuts box, select a dataset from the  Record Data To dropdown.

Navigating to the Record Data page via the homepage shortcuts

Via the Datasets page

Click on a dataset's Record Data () button in the Actions column.

Navigating to the Record Data page via the Datasets page

Selecting a platform

All of the data for your e-resources are managed at the platform level.

  1. To begin adding or managing your usage and cost data, click on the platform's Add Records () button in the Actions column.
  2. If you would like to clear out all of the data for a platform, click on its Empty this Platform () button in the Actions column. This will completely delete all data from the platform, so be careful!

Options for adding data or empty a platform

Manually harvesting SUSHI usage data

If your platform's vendor is a SUSHI service provider, you can harvest your usage data directly without having to generate and upload COUNTER files. LibInsight supports a growing list of SUSHI service providers. If your provider is not currently supported, contact Springy Support and we'll work with the vendor to add support.

Before you can harvest SUSHI data, an admin must first add your SUSHI providers to LibInsight.

Harvesting data

  1. Under the Usage Data tab, click on the Fetch SUSHI Data Now panel to expand it.
  2. Select from one of the available SUSHI providers in your system.
  3. From the Report Type dropdown, select the type of COUNTER report to harvest.
    • Keep in mind that not all service providers support all of the available COUNTER reports listed in the dropdown.
    • If you're unsure, please contact your SUSHI provider for more info on which reports are supported.
  4. For the Usage Date Range, use the Begin Date and End Date fields to select the time period to harvest.
    • Important: because providers only allow harvesting of usage data for a maximum of a one-year date range, you will not be able to submit your request if you select a date range greater than 12 months.
    • For harvesting BR2 (r4) reports: these tend to generate very large XML files when a platform contains a large number of journal titles. Unfortunately, this can cause your import to fail. To prevent this, please try importing smaller 1-3 month periods at a time.
  5. For the Update Type, you can choose how to handle situations where your dataset already contains data for a date in your import file.
    • ​Select Add to Existing Values if Date Exists to simply add the value from the import file to the value already recorded in your dataset.
    • Select Overwrite Values if Date Exists to overwrite the value recorded in your dataset with the value in your import file.
  6. Click the Get Report button. 
    • A confirmation message will appear if the file was uploaded successfully. Especially large files may take several minutes before the data is fully added to your dataset (don't worry -- our server will work on this behind the scenes!). Once the data is ready, you'll receive an email confirmation.
    • Please note: LibInsight has a maximum file size of 18 MB for fetched data files. If the data you requested exceeds that limit, you will receive an email notification that it could not be processed. Please resubmit your fetch request with a shorter date range.
    • If there were any issues with your upload, an error message will appear indicating the specific issues. Once you've addressed the issues, you can try the import again. If you continue to have issues or need any help, contact the Springy Support team.

Example of harvesting SUSHI data 

Schedule future SUSHI retrievals

In addition to manually fetching SUSHI data on demand, you can also schedule regular retrievals. This allows you to automatically harvest data for a platform at either monthly, quarterly, semi-annual, or yearly intervals. You can create schedules for each platform and report type; for example, you could retrieve BR2 data monthly and BR5 data quarterly. For each schedule option, data is fetched on a different day of the month:

  • Monthly: retrieved starting on the 10th day of the following month (i.e. May's data would be fetched starting June 10)
  • Quarterly: retrieved starting the 12th of April, July, October, and January
  • Semi-annual: retrieved starting the 13th of July and January
  • Yearly: retrieved starting on January 15th of the following year (i.e. 2018 data would be fetched starting January 15, 2019)

Just as with manually fetching data, an admin must first add your SUSHI providers to LibInsight before you can create retrieval schedules.

Creating a schedule

  1. Under the Usage Data tab, click on the Schedule Future SUSHI Harvesting panel to expand it.
  2. Click on the Add New button.
  3. In the Add New Schedule window, use the Select Provider dropdown to select which provider to harvest from.
    • If you selected a default provider in your platform's SUSHI Credentials settings, then that provider will be selected by default.
  4. From the Report Type dropdown, select which COUNTER report you want to fetch.
  5. From the Fetch Frequency dropdown, select how often you want to harvest that report.
  6. Once you select a frequency, the Recurring Until field will appear. Click in the field to select an end date for this schedule.
  7. Optionally, you can select up to 3 users to receive email notifications once a report has been fetched.
    • Click on a name to select it.
    • To select multiple users, hold down the CTRL key and click on additional names.
  8. By default, you new schedule will be enabled. However, if you would like to delay starting this schedule, select the Disabled radio button (you can edit the schedule later to enable it).
  9. Click the Save button.

Managing schedules

  1. To modify a schedule, click on its Edit () button in the Actions column.
  2. To cancel a schedule, click on its Delete () button in the Actions column.

Options to add, edit, and delete a schedule

The Add New Schedule window

Managing harvested data

  1. Click on the Uploads List​ tab to view a list of all successfully uploaded files.

    1. Click on the Download File () button in the Action​ column to download a copy of the file.
    2. Click on the Delete​ () button in the Action​ column to delete the file and its data. Only dataset admins have the ability to delete uploaded data.
      • If the file's Update Type​ is "Add to Existing", the values from the file will be deducted from the totals in your dataset.
      • If the file's​ Update Type​ is "Overwrite if Existing", then the corresponding records from the dataset will be deleted.

Example of viewing and managing uploads