Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

Start here:  Ex Libris Product Documentation Managing COUNTER-Compliant Usage Data


SUSHI Logins (request access through site)

Additional Guidance | Tips and Tricks for Specific Vendors

QuestionAnswer
What information do I need to set up a SUSHI account and where do I get it?

It is best to contact the vendor to obtain the credentials that you need to set up a SUSHI account. SUSHI credentials will always include a rest URL. Vendors use one or more of a requestor ID, a customer ID and an API key. Ex Libris provides a SUSHI Vendor Lists and this information is available in Alma but I recommend verifying the information with the vendor. 

How many SUSHI accounts do I need to set up for each vendor?In most cases, only 1 SUSHI account is needed to get COUNTER 5 reports for each vendor but multiple SUSHI accounts are needed for vendors that have different SUSHI credentials for different platforms. For COUNTER 4 reports, you need one SUSHI account for each type of report you need to harvest.
Do SUSHI account names  need to be unique for each report?

I recommend having unique SUSHI account names if you have multiple SUSHI accounts under the same vendor. You can use the search feature in the SUSHI Account box to find a pre-configured SUSHI account information. If needed, edit the name before saving because you cannot change the SUSHI account name after you've created the account. (For COUNTER 4 reports, it is okay if the account names are not unique since each account is set up to collect only 1 type of report.)

What if I need to harvest many different reports for the same vendor?  Do I have to configure each one separately?

No.  You can use the duplicate feature.  Then you only need to change the report type (you will get an error message if you do not change the report type).


How do I test the connection?  What do the different test buttons do?

  • Test Connection is the one you will use most often.  It sends a test message to the SUSHI service and returns a response of Connection Succeeded or Connection Failed. 
  • Connection Succeeded means that Alma successfully contacted the server and requested the designated report.  There could still be a failed harvest even with a successful connection (e.g. if the usage report isn't yet available when the harvest job runs).
  • Connection Failed will include an error message. Examples:
    • Connection failed:Report Not Supported means the report you selected is not available from that vendor's SUSHI service
    • Connection failed:Requestor is Not Authorized to Access Usage for Institution means there is a problem with authentication, most likely something wrong with Requester ID or Customer ID.  See the Ex Libris documentation or tips/tricks below for help with difficult set-ups.
    • Connection failed:null is an all-purpose error message.  It most commonly means there is a problem with the Vendor URL. Be alert to changes to these URLs in particular if a vendor has recently changed platforms or transitioned from HTTP to HTTPS.
  • Test Connection with Response is only useful for troubleshooting.  It will perform the same connection test, but will deliver back to you a folder containing two XML documents.  The first one is a copy of the test message so you can verify what metadata was sent to the server. The second document contains the response back from the server; it may have useful error messages.
  • Note that when either Test Connection button results in Connection Failed response, an invalid report will appear in the usage file list.  You can safely delete these invalid files.
What happens the first time the SUSHI harvest job runs after I set up an account?

The first time the SUSHI harvest job runs after you set up the account, it will harvest the most recent 12 months of usage reports, if available.  This is the same whether you choose the "harvest now" option or wait for the scheduled job to run.

Tips and Tricks for Specific Vendors

More information is available in the Ex Libris Knowledge Center

Are there usage statistics available for this resource?

Here is a non-comprehensive list of resources to tell if usage stats are available:

How do I set up SUSHI for Elsevier (Science Direct, Scopus, Engineering Village)?

You have to fill out an Elsevier request form before you can use SUSHI:https://www.elsevier.com/__data/assets/word_doc/0003/184791/Elsevier-SUSHI-application-form.docx 
Here's a guide that explains in more detail: https://www.elsevier.com/__data/assets/pdf_file/0006/184776/how_to_use_elsevier_sushi.pdf 

Send the completed form to Elsevier (click the email link at https://service.elsevier.com/app/home/supporthub/admin-tool/ or https://www.elsevier.com/solutions/sciencedirect/support)

Here are the IP addresses you'll need to fill in:

The following IPs/IP ranges must be allowed access to/from your institution. (Note that the IP ranges below are in CIDR notation.) 
In the U.S.A. (refers to the Ex Libris Chicago data center): 
66.151.7.40/29 [66.151.7.40-47] 
66.151.7.128/26 [66.151.7.128-191] 
66.151.7.192/28 [66.151.7.192-207] 
66.151.7.224/30 [66.151.7.224-227] 
66.151.7.236 
66.151.14.129 
74.217.12.128/27 [74.217.12.128-159] 
64.74.237.221 
64.74.237.229 
64.74.237.232/31 [64.74.237.232-233] 

Here is further documentation in the Ex Libris Knowledge Center:

https://knowledge.exlibrisgroup.com/Alma/Implementation_and_Migration/Implementation_Guides/03Technical_Requirements_for_Alma_and_Discovery_Implementation#Alma_IP_Range

How do I set up SUSHI for Engineering Village if I already did it for ScienceDirect?

Open a support ticket with Elsevier.  Let them know you've already set up other services and need to add Engineering Village.  They will do the set-up on the back end and give you the correct URL and account number to set up SUSHI harvesting for Alma.

Click on the email link at https://service.elsevier.com/app/home/supporthub/admin-tool/ or https://www.elsevier.com/solutions/sciencedirect/support

How do I set up SUSHI for American Mathematical Society?

Use the following values:

  • SUSHI Account: American Mathematical Society
  • Vendor URL (Books & Journals): http://<username>:<password>@www.ams.org/SushiService/BookAndJournalStats
    • Important: Replace the hyphen in your username with an asterisk (e.g. "CAPOSU-934" needs to be entered as "CAPOSU*934")
  • Vendor URL (MathSciNet): https://<username>:<password>@www.ams.org/SushiService/MathSciNetStats  ← URL updated 2/6/2019
    • Important: Replace the hyphen in your username with an asterisk (e.g. "CAPOSU-934" needs to be entered as "CAPOSU*934")
    • Also important: Note that the URL for MathSciNet stats is secure (HTTPS). The non-secure (HTTP) version will not work.
  • Requester ID: Put your password here
  • Customer ID: Put your username here, again replacing the hyphen with an asterisk
  • User Name: Put your username here, again replacing the hyphen with an asterisk
  • Password: Put your password here
  • Report Type: Choose JR1 for AMS journals and DB1 for MathSciNet
  • Counter Release: R4
  • All other fields may be left blank

How do I set up SUSHI for Silverchair-hosted vendors (e.g. AMA, ASME, Duke, GeoScienceWorld)

Log into the Sitemaster admin page and select the COUNTER reports tab.  Scroll to the bottom and click on the "How do I use SUSHI to generate COUNTER reports?" link.  Enter your Requestor ID, Customer ID, and password as indicated (note that the password you used to log into Sitemaster goes in the Requester Email field).

  • Note 1:  Your Sitemaster password can apparently change or expire without notice, and you must contact support in order to reset it.  If your password is no longer valid, your SUSHI harvests will fail.
  • Note 2:  Alma sometimes "sticks" when updating SUSHI account information.  You may need to try more than once and/or log out and back into Alma to retain the changes.  If SUSHI harvests still give an error after updating account information, use Test Connection with Response to see what information Alma is actually sending to the vendor.



  • No labels