istex

Fetches istex (opens new window) data from their API (opens new window). This middleware enriches the ECs that come from the ISTEX API and those that come from the publisher Elsevier.

This middleware is activated by default.

Enriched fields

Name	Type	Description
mime	String	format of resource. (HTML, PDF, VIDEO, etc)
rtype	String	type of consultation.
publication_title	String	Name of publication.
publisher_name	String	Name of publisher.
istex_genre	String	type of resource. (article, book, conference, thesis, report etc.)
language	String	Lang of resource.
subject	String	subject, thematic of resource.
print_identifier	Number	ISBN or ISSN.
online_identifier	Number	EISBN or EISSN.
doi	String	DOI of resource.
ark	String	ARK of resource.
access_type	String	The OA status, or color, of this resource.
oa_status	String	open access status

Prerequisites

The ISTEX middleware uses the istex-identifier found in the access events to request metadata using the node-istex (opens new window).

You must use istex after filter, parser, deduplicator middleware.

Headers

• istex-enrich : Set to true to enable ISTEX enrichment. Disabled by default.
• istex-cache : Enable/Disable cache.
• istex-ttl : Lifetime of cached documents, in seconds. Defaults to 7 days (3600 * 24 * 7).
• istex-throttle : Minimum time to wait between queries, in milliseconds. Defaults to 500.
• istex-paquet-size : Maximum number of identifiers to send for query in a single request. Defaults to 50.
• istex-buffer-size : Maximum number of memorized access events before sending a request. Defaults to 1000.
• istex-max-attempts : Maximum number of trials before passing the EC in error. Defaults to 5.

How to use

ezPAARSE admin page

On the /admin/middlewares page, you can choose to move the middleware from “Available Middleware” to “Active Middleware for Processing.”

ezPAARSE process page

On the /process page, under the “2 Settings” tab, in the ‘Settings’ menu, you can choose to move the middleware from “Available Middleware” to “Active Middleware for Processing.”

ezp

# enrich with one file
ezp process <path of your file> \
  --host <host of your ezPAARSE instance> \
  --settings <settings-id> \
  --header "ezPAARSE-Middlewares: istex" \
  --out ./result.csv

# enrich with multiples files
ezp bulk <path of your directory> \
  --host <host of your ezPAARSE instance> \
  --settings <settings-id> \
  --header "ezPAARSE-Middlewares: istex"

curl

You can use istex for an enrichment process with curl like this:

curl -X POST -v http://localhost:59599 \
  -H "ezPAARSE-Middlewares: istex" \
  -H "Log-Format-Ezproxy: <line format>" \
  -F "file=@<log file path>"