WEB OF SCIENCE USAGE REPORTING

Size: px

Start display at page:

Download "WEB OF SCIENCE USAGE REPORTING"

Sherman Jefferson
6 years ago
Views:

1 WEB OF SCIENCE USAGE REPORTING COUNTER - SUSHI WEB SERVICE October 30, 2013

2 Table of Contents Web of Science Usage Reporting Web Service 2 Reports Returned by the Service 2 Service Endpoint Address and WSDL 2 Authentication 2 Request Parameters 3 Sample Request 5 Support 6 Helpful Links Thomson Reuters 1

3 Web of Science Usage Reporting Web Service Web of Science Usage Reporting Web Service complies with the Standardized Usage Statistics Harvesting Initiative (SUSHI) Protocol (ANSI/NISO Z ) for obtaining electronic resource usage data. It follows the Simple Object Access Protocol (SOAP) for message exchange via the Web. To use this service, you must have a Web services client that can send and receive SOAP messages conforming to the SUSHI standard. Reports Returned by the Service The following reports may be obtained via the Web of Science Usage Reporting Web Service. These conform to the COUNTER Code of Practice for Journals and Databases Release 4. Report DB1 DB2 CR2 Description Database Report 1: Total Searches, Result Clicks and Record Views by Month and Database Database Report 2: Access Denied by Month, Database and Category Consortium Report 2: Total searches by month and database The SUSHI Reports Registry at provides more information about COUNTER-SUSHI reports as well as a link to the COUNTER-SUSHI schema. Service Endpoint Address and WSDL The Web service endpoint address for Web of Science Usage Reporting Web Service is: The WSDL may be retrieved from: Authentication Web of Science Web Service is an authenticated Web service. It requires successful validation of your authentication credentials prior to data retrieval. In addition, access to the service itself is IP authenticated. Two credentials are required: a Requestor ID, which is a 6-digit number, and a CustomerReference ID, which is a 32-alphanumeric string. You should have received these credential via from Thomson Reuters Web Products Entitlements. If you did not receive this , or if you have questions about your entitlements, please contact the Thomson Reuters Technical Help Desk at Thomson Reuters 2

4 Request Parameters ReportRequest Attributes Attribute Type Example Description Required? Created datetime T21:12:15.630Z GregorianCalendar timestamp ID string jfreemanitservices User-defined ID. Use this element to track or document your own requests. Requestor No Element Type Example Description Required? ID string The ID that entitles you to use the service. This ID is provided by Thomson Reuters Web Products Entitlements. Name string Judith Freeman The name of the requestor. The requestor name may change from request to request. This information is helpful for support and troubleshooting. string The of the requestor. The requestor may change from request to request.this information is helpful for support and troubleshooting. CustomerReference No No Element Type Example Description Required? ID string 9f05a4715d f3f70cdb98291 An ID provided by Thomson Reuters that uniquely identifies the requesting institution. Name string University of Buffalo Name of the requesting institution. ReportDefinition Attributes No Attribute Type Example Description Required? 2013 Thomson Reuters 3

5 Name string DB2 The usage report you are requesting. This attribute can take one of the following values: DB1 DB2 CR2 Release string 4 This identifies the release version of the COUNTER Code of Practice. The only valid value for this attribute is 4. Filters Filters has one subelement, UsageDate Range, which his used to specify the date range of the report. Element Type Example Description Required? UsageDateRange complex Begin date End date Thomson Reuters 4

6 Sample Request <soapenv:envelope xmlns:soapenv=" xmlns:coun=" xmlns:sus=" <soapenv:header/> <soapenv:body> <coun:reportrequest Created=" T21:12:15.630Z" ID=""> <sus:requestor> <sus:id>24570</sus:id> <sus:name></sus:name> <sus: ></sus: > </sus:requestor> <sus:customerreference> <sus:id>9f05a4715d f3f70cdb98291</sus:id>  <sus:name></sus:name> </sus:customerreference> <sus:reportdefinition Name="CR2" Release="4"> <sus:filters> <sus:usagedaterange> <sus:begin> </sus:begin> <sus:end> </sus:end> </sus:usagedaterange> </sus:filters> </sus:reportdefinition> </coun:reportrequest> </soapenv:body> </soapenv:envelope> 2013 Thomson Reuters 5

7 Support If you have questions about using our products or about your access to them, please visit our support page at This page has links to our support Knowledgebase, the local telephone numbers, and hours of operation. When you click on the Open eticket tab, your issue will be immediately routed to your local support team. Questions about network connections and/or the use of your Web browser should be directed to your network administrator Thomson Reuters 6

8 Helpful Links URL Title Project COUNTER Codes of Practice Schemas for the Standardized Usage Statistics Harvesting Initiative (SUSHI) SUSHI Reports Registry and link to the SUSHI schema COUNTER Schema Data Element Values Code of Practice Release Thomson Reuters 7

Lab 3: Simple Integration Use Case

Lab 3: Simple Integration Use Case Exercise 1 : Create the web service...2 Exercise 2 : Deploy the web service...4 Exercise 3 : Test the service...8 1/16 In this exercise, you will learn how to activate a Maximo inbound web service. This