JUSP Journals SUSHI Service
Total Page:16
File Type:pdf, Size:1020Kb
JUSP Journals SUSHI Service User Guide
1. Overview The JUSP Journals SUSHI Service complies with version 1.6 of the Standardized Usage Statistics Harvesting Initiative (SUSHI) protocol standard (ANSI/NISO Z39.93.2007) for obtaining electronic resource usage data. It follows the Simple Object Access Protocol (SOAP) for message exchange via the Web.
2. What do I need to collect my Journal usage statistics by SUSHI? In order to use this service, you must:
have a SUSHI client that can send and receive SOAP messages conforming to the SUSHI 1.6 standard
register for SUSHI access with JUSP (you will need to log into JUSP to do this. You will need a note of the IP address or IP range from which your SUSHI requests will come)
provide the correct Requestor ID, Customer Reference ID and other information when you use your SUSHI client to make a SUSHI request
3. Accessible Journal Reports The following reports may be obtained via the JUSP Journals SUSHI Service. These reports conform to Release 4 of the COUNTER Code of Practice for e-Resources.
Report ID Report Name Description
JR1 Journal Report 1 Number of successful full-text article requests by month and journal
JR1a Journal Report 1a Number of successful full-text article requests from an archive by month and journal
JR1GOA Journal Report 1 Number of successful Gold Open Access full-text article requests by GOA month and journal
4. Authentication To successfully access JUSP’s Journal SUSHI Service, the following credentials will be required:
IP Address
Your three letter institutional ID (RequestorID)
The authorization process entails the validation of the institutional ID provided in the SUSHI request sent to JUSP’s server. In addition, the process will verify the requestor’s IP addresses and the reports the requestor is able to access. IP Address The IP address of the requesting SUSHI client must be registered with JUSP to be granted access. JUSP should be notified prior to initiating SUSHI requests. Requestor ID The Requestor ID is a 3 letter code which identifies your institution that is generated within the JUSP system when you sign up to the JUSP service. You can find your institution’s ID on the JUSP SUSHI Admin page – follow the link from your welcome page on the portal.
Feel free to contact our SUSHI Web Service Administrator listed in Section 6 down below, send an email to [email protected], and/or visit our web site at http://jusp.jisc.ac.uk/ for more information.
5. WSDL and Service Endpoint Address/URL COUNTER Release 4 The WSDL may be retrieved from: http://jusp.jisc.ac.uk/sushiserverR4/?wsdl
The web service endpoint address for the JUSP SUSHI Web Service is: http://jusp.jisc.ac.uk/sushiserverR4/
6. Making Requests to the JUSP Journals SUSHI Server Making a call to the JUSP Journals SUSHI Service will require a third party tool that is capable of making SOAP calls.
At the very least, the following elements should be filled in: Requestor ID The ID in the Requestor element should have the unique identifier shown on your JUSP SUSHI Admin page. Customer Reference ID The Customer Reference ID is a numeric identifier that indicates which vendor’s statistics you are requesting. You can find the Identifiers for participating vendors on the JUSP SUSHI Admin page – follow the link from your welcome page on the portal. Name The Name attribute in “ReportDefinition” must reference a valid counter report (JR1, DB1, CR1, etc.). The JUSP Web Service currently supports JR1, JR1a and JR1GOA reports (release 4). Support for other reports may be made available in the future. Release The Release attribute in ReportDefinition must be a valid release for the specified counter report (1, 2, etc.). JUSP currently supports Release 4. Begin/End The Begin and End elements of “UsageDateRange” must have a valid date range of the form YYYY- MM-DD. Statistics for a given month typically become available within two-three weeks of the start of the next month.
7. Third party services You can delegate collection of your data to third-party services (e.g. USTAT by Ex Libris). Check the “Authorize 3rd party access” list on JUSP SUSHI Admin page (follow the link from your welcome page on the portal). If the agent you use is there, you can simply check the box instead of needing to know their current IP range. If your agent is not listed, either: enter their IP address in one of the IP boxes or contact our SUSHI administrator to request the addition of your agent to our list of authorized 3rd parties
8. .JUSP Contact Information SUSHI Support Email(s) [email protected]
SUSHI Administrator Paul Meehan/Paul Needham
JUSP Web Site http://jusp.jisc.ac.uk/