Scopus metrics collection for publications and researchers is handled by the process hereafter described. To have connection with Scopus properly working, following configuration properties must be set
metrics.scopus.citation-count.url = <scopus query url> metrics.scopus.citation-count.apiKey = <scopus api key> metrics.scopus.citation-count.instToken = <scopus instToken> |
If last two properties are the same used to import publications from scopus, its value can be “inherited” from ${scopus.apiKey} and ${scopus.instToken} properties already set, in this way
metrics.scopus.citation-count.apiKey = ${scopus.apiKey}
metrics.scopus.citation-count.instToken = ${scopus.instToken} |
The updating of publication and researchers metrics from Scopus service is controlled by two processes, which can be run from both processes section and Command Line Interface:
update-metrics scopus | updates metrics of type entityType=Publication |
update-metrics scopus-person | updates metrics of type entityType=Person |
where:
update-metrics - is the name of the script
scopus or scopus-person - is the name of the service, in case “-person” suffix is present, metrics regarding researchers will be collected, if no suffix is added, process will collect research output metrics
The additional parameter -l (limit) allow to set a limit of call performed to the external provider to retrieve the metrics. The item to be updated are extracted sorted by the metadata cris.lastimport.<provider>, in which is stored the date of the last metrics import.
The script applies the following steps to perform the update:
performs a global search to retrieve all entities of type Publication and have one of the following metadata set: dc.identifier.doi or dc.identifier.pmid values.
taking one item at a time - extracts the metadata values such as : (dc.identifier.doi , dc.identifier.pmid and dc.identifier.scopus) with these values it constructs the query to be sent to the external Scopus service which in turn returns the document containing the metric.
a generic answer from scopus can be:
<?xml version="1.0" encoding="UTF-8"?> <search-results xmlns="http://www.w3.org/2005/Atom" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/" xmlns:atom="http://www.w3.org/2005/Atom"> <opensearch:totalResults>1</opensearch:totalResults> <opensearch:startIndex>0</opensearch:startIndex> <opensearch:itemsPerPage>1</opensearch:itemsPerPage> <opensearch:Query role="request" searchTerms="DOI(10.1016/j.gene.2009.04.019)" startPage="0"/> <link ref="self" href="https://api.elsevier.com/content/search/scopus?start=0&count=25&query=DOI%2810.1016%2Fj.gene.2009.04.019%29" type="application/xml"/> <link ref="first" href="https://api.elsevier.com/content/search/scopus?start=0&count=25&query=DOI%2810.1016%2Fj.gene.2009.04.019%29" type="application/xml"/> <entry> <link ref="self" href="https://api.elsevier.com/content/abstract/scopus_id/67349162500"/> <link ref="author-affiliation" href="https://api.elsevier.com/content/abstract/scopus_id/67349162500?field=author,affiliation"/> <link ref="scopus" href="https://www.scopus.com/inward/record.uri?partnerID=HzOxMe3b&scp=67349162500&origin=inward"/> <link ref="scopus-citedby" href="https://www.scopus.com/inward/citedby.uri?partnerID=HzOxMe3b&scp=67349162500&origin=inward"/> <link ref="full-text" href="https://api.elsevier.com/content/article/eid/1-s2.0-S0378111909001929"/> <prism:url>https://api.elsevier.com/content/abstract/scopus_id/67349162500</prism:url> <dc:identifier>SCOPUS_ID:67349162500</dc:identifier> <eid>2-s2.0-67349162500</eid> <dc:title>Transcriptomic response of Argopecten purpuratus post-larvae to copper exposure under experimental conditions</dc:title> <dc:creator>Zapata M.</dc:creator> <prism:publicationName>Gene</prism:publicationName> <prism:issn>03781119</prism:issn> <prism:volume>442</prism:volume> <prism:issueIdentifier>1-2</prism:issueIdentifier> <prism:pageRange>37-46</prism:pageRange> <prism:coverDate>2009-08-01</prism:coverDate> <prism:coverDisplayDate>1 August 2009</prism:coverDisplayDate> <prism:doi>10.1016/j.gene.2009.04.019</prism:doi> <pii>S0378111909001929</pii> <citedby-count>44</citedby-count> <affiliation> <affilname>Institut Universitaire Européen de la Mer (IUEM)</affilname> <affiliation-city>Plouzane</affiliation-city> <affiliation-country>France</affiliation-country> </affiliation> <affiliation> <affilname>Universidad de Antofagasta</affilname> <affiliation-city>Antofagasta</affiliation-city> <affiliation-country>Chile</affiliation-country> </affiliation> <pubmed-id>19406218</pubmed-id> <prism:aggregationType>Journal</prism:aggregationType> <subtype>ar</subtype> <subtypeDescription>Article</subtypeDescription> <source-id>15636</source-id> <openaccess>0</openaccess> <openaccessFlag>false</openaccessFlag> </entry> </search-results> |
3. In the next step, a new metric is created with the data retrieved from scopus, such as:
MetricType | scopusCitation |
Last | true |
MetricCount | 44 (value contained in the tag |
AcquisitionDate | date on which the metric was recorded |
Remark | is a more complex field, which contains 4 values if there are any in the response identifier : 2-s2.0-67349162500 (value contained in the tag <eid>) link : https://www.scopus.com/inward/citedby.uri?.. (value contained in the tag <link ref="scopus-citedby" ) pmid : 19406218 (value contained in the tag <pubmed-id>) doi : 10.1016/j.gene.2009.04.019 (value contained in the tag <prism:doi>) |
In case a metric for this Publication was already on db, it is not overwritten, but its ‘Last’ flag is set to ‘false’.
In order to avoid huge load on Scopus, it is possible to limit the maximum number of objects for which metrics must be updated at each process run. This is possible by setting either -l --limit parameter (as stated in previous paragraph) as script option or by setting the metrics.update-metrics.limit in DSpace-CRIS configuration. Update process will always start importing metrics for items for which metrics from scopus have never been updated and then importing metrics for items having the earliest date for last scopus metrics update.