Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The table below contains a description of different ProQuest integration's configuration settings:

ParameterMandatoryDefaultDescription
Data source nameYesProQuestThe name of the Circulation Manager's data source used to store information about ProQuest books
BooksCatalog Service's URL Yes
The URL of BooksCatalog service used to download the ProQuest OPDS 2.0 feed and described on ProQuest API page
PartnerAuthToken Service's URLYes
The URL of PartnerAuthToken service used to create a ProQuest JWT bearer token required to authenticate in other ProQuest services and described on ProQuest API page
DownloadLink Service's URLYes
The URL of DownloadLink service used to download ProQuest books and described on ProQuest API page
ProQuest JWT token's expiration timeoutNo3600Determines how long in seconds can a ProQuest JWT token be valid
List of SAML attributes containing an affiliation IDNoeduPersonPrincipalName,
eduPersonScopedAffiliation
ProQuest integration assumes that the SAML provider is used for authentication. ProQuest JWT bearer tokens required by the most ProQuest API services are created based on the affiliation ID - SAML attribute uniquely identifying the patron.This setting determines what attributes the ProQuest integration will use to look for affiliation IDs. The ProQuest integration will investigate the specified attributes sequentially and will take the first non-empty value.
Test SAML affiliation IDNo1

This configuration setting is really useful for testing ProQuest API without the need to set up a SAML authentication provider.
If this configuration setting is set, then the ProQuest integration will be using in the case when it cannot find a SAML affiliation ID.

Warning

Please contact ProQuest before using it


Default audienceNo
If ProQuest does not specify the target audience for their books, assume the books have this target audience
Feed page's sizeNo5,000

This value determines how many publications will be on a single page fetched from the BooksCatalog service

{

HTTP proxy's URLNo
URL of the proxy handling HTTP traffic. Proxies can be used for testing when trying to access ProQuest API from machines having non-whitelisted IP addresses. Please find more information below
HTTPS proxy's URLNo
URL of the proxy handling HTTPS traffic. Proxies can be used for testing when trying to access ProQuest API from machines having non-whitelisted IP addresses. Please find more information below

Proxies

As it was mentioned above it might be useful to use a proxy to test the SAML integration from the local machine which has an IP address non whitelisted by ProQuest. To do so you need to use a SOCKS proxy:

...

Code Block
npm install -g http-proxy-to-socks
hpts -s 127.0.0.1:8888 -p 8080

After this, you can set use the following values for proxy settings:

  • HTTP proxy's URL

...

...

...


Warning

Depending on your system configuration you might face a weird SSL: WRONG_VERSION_NUMBER error. In this case you can try to use a SOCKS proxy:

...

...


Configuration a ProQuest collection in Circulation Manager

...