FAQ content

E-Resources Management: Add & manage SUSHI providers

In this article

In E-Resources/COUNTER 5 datasets, E-Journals/Databases (COUNTER 4) datasets, and eBooks (COUNTER 4) datasets, usage data can be fetched directly from providers using the SUSHI protocol. LibInsight allows you to centrally set up and manage your SUSHI provider settings, which you can then use when fetching usage data in your datasets.

Kindly contact providers to obtain the necessary SUSHI credentials for your institution.

  • For E-Resources/COUNTER5 datasets: you can use the SUSHI protocol to harvest usage data from any COUNTER r5-compliant vendors.
  • For E-Journals/Databases datasets and eBooks datasets: LibInsight supports a large number of COUNTER r4 SUSHI providers. However, please note that there are no plans to provide additional COUNTER 4 SUSHI providers at this time, as COUNTER 5 reporting became mandatory for data providers at the end of January 2019. 

Admin-level users can add and manage SUSHI providers by going to Admin > E-Resources Management and clicking on the SUSHI Providers tab.

the sushi providers tab

Note: If your SUSHI Service Provider has an IP restriction, make sure to designate LibInsight's IP address as authorized to access your SUSHI service on your behalf. You can find the IP address for your region on the Record Data page for any platform in your dataset, under Usage Data > Fetch SUSHI Data Now.

Add a COUNTER 5 SUSHI provider

In the steps below, enter the information as provided by your vendor. If you're unsure what the correct settings should be, please contact them directly.

  1. Under the SUSHI Providers tab, click on the Add COUNTER 5 SUSHI Provider button.

Add COUNTER 5 SUSHI Provider button

  1. In the Search for Vendor field, you can look up common vendors to auto-populate the Vendor Name and Server URL fields. Simply start typing the vendor name and click on the vendor from the list of suggestions.
  2. Otherwise, in the Vendor Name field, enter the name of this SUSHI provider.

New SUSHI Provider page for a COUNTER 5 provider

  1. Enter the Server URL for this SUSHI provider.
    • Please enter only the base URL for the SUSHI server.
    • For example, in a URL like https://sushi.provider.com/counter5/status or https://sushi.provider.com/counter5/reports, the base URL is the portion that comes before /status or /reports.
    • Some providers may have case sensitive URLs. For example, if your URL looks like https://sushi.provider.com/C5/status, enter it as-is from your provider. If you are unsure whether a URL is case sensitive, please contact your vendor.
    • If you enter more than the base URL, LibInsight will attempt to shorten it so that only the base URL remains.
  2. Enter the Requestor ID assigned by your SUSHI provider.
  3. Optionally, enter your Requestor Name if required by your SUSHI provider.
  4. Optionally, enter your Requestor Email if required by your SUSHI provider.
  5. Enter the Customer ID assigned by your SUSHI provider.
  6. Optionally, enter your Customer Name if required by your SUSHI provider.
  7. If required by your SUSHI provider, enter the Platform value.
    • For example, Oxford University Press refers to their databases as "platforms", so the platform must be specified in each SUSHI request.
    • As a result, for OUP and similar vendors, you will likely need to set up one SUSHI Provider for each of their platforms you want to fetch data from.
  8. If required by your SUSHI provider, enter your Username.
  9. If required by your SUSHI provider, enter your Password.
  10. If required by your SUSHI provider, enter your assigned API Key.
  11. Optionally, you can add some Notes about this provider for future reference.
  12. Before saving, we recommend clicking the Test Connection button to verify your settings are correct.
    1. If LibInsight was able to connect successfully, you'll see a green confirmation message at the top of the page. Otherwise, a red error message will appear with additional information. 
    2. For help troubleshooting your connection, please send that message, along with the provided API URL, to your SUSHI provider for assistance.
  13. Click the Save button.

connect test result messages

Want to validate your SUSHI provider settings? In LibInsight, you can edit a SUSHI provider at any time to test its connection. You can also use the free COUNTER r5 Validation Tool provided by Project COUNTER.

Add a COUNTER 4 SUSHI provider

In the steps below, enter the information provided by your vendor. If you're unsure whether your vendor supports SUSHI or what the correct settings should be, please contact them directly. You can view a list of providers in the SUSHI Server Registry.

  1. Click on the Add COUNTER 4 SUSHI Provider button.

Add COUNTER 4 SUSHI Provider button

  1. In the Vendor Name field, enter the name of this SUSHI provider.
  2. Enter the Server URL for this SUSHI provider.
  3. Enter the Requestor ID assigned by your SUSHI provider.
  4. Optionally, enter your Requestor Name if required by your SUSHI provider.
  5. Optionally, enter your Requestor Email if required by your SUSHI provider.
  6. Enter the Customer ID assigned by your SUSHI provider.
  7. Optionally, enter your Customer Name if required by your SUSHI provider.
  8. If required by your SUSHI provider, enter your Username.
  9. If required by your SUSHI provider, enter your Password.
  10. Optionally, you can add some Notes about this provider for future reference.
  11. Click the Save button.

Example of adding a COUNTER 4 SUSHI provider


Bulk upload SUSHI providers

In addition to adding SUSHI providers individually, you can also bulk upload providers using a CSV template. 

  1. Under the SUSHI Providers tab, click on the Upload SUSHI Providers button.

the upload providers button on the sushie providers page

  1. On the Upload SUSHI Providers page, click on the template link to download a starter CSV file. This file will include the required column headings with an example provider.
    • You can also create your own spreadsheet to use. Just make sure it has the following values in row 1:
      • Column A: version
      • Column B: name
      • Column C: url
      • Column D: requestor_id
      • Column E: requestor_name
      • Column F: requestor_email
      • Column G: customer_reference
      • Column H: customer_name
      • Column I: platform
      • Column J: username
      • Column K: password
      • Column L: api_key
      • Column M: notes
    • In the spreadsheet, enter each platform's info starting in row 2, with one provider per row.
      • For the version column, enter 5 for COUNTER 5 providers and 4 for COUNTER 4 providers.
      • COUNTER 4 providers will not have values for platform or api_key -- those are only used by COUNTER 5 providers.
    • Be sure to save the spreadsheet in CSV (Comma delimited) format. You cannot upload XLS or XLSX files.
  2. Once your CSV file is ready, return to the Upload SUSHI Providers page, click on the Choose File button, select your file, and click the Upload and Analyze Data button.

upload and analyze data button

  1. After the CSV file has been processed, a table will appear showing each provider in your spreadsheet. Select the checkbox next to each provider you want to upload to LibInsight.
    1. To select all providers at once, click on the checkbox at the top of the table.
  2. Click on the Upload SUSHI Providers button.

selecting and uploading providers


Edit or delete SUSHI providers

To manage your SUSHI providers, under the SUSHI Providers tab:

  1. Click on the edit () button in the Actions column to change the provider's information.
  2. Click on the delete () button in the Actions column to remove the provider from LibInsight. This will only delete the provider -- it will not remove any data harvested from that provider.

edit and delete options for sushi providers