Skip to main content

Relais Search Client Addon

PALCI requires a client addon to perform searches on Relais Discovery 3.0.

General​

  • The addon will be available on the ILLiad Request Form.
  • The addon will log into Relais D2D in order for processing staff to place a D2D request on the patron's behalf.
  • An option to auto-search will be present that will use the SearchPrioritylist setting.
  • In addition to auto-search, staff may initiate a manual search by clicking on Search buttons in the addon ribbon. Buttons will be available for a general Search (which will use the same type of search as an auto-search).
  • The addon will navigate to the search results after a manual or auto search is performed. The addon will not perform any importing of data from the search results page into ILLiad.
  • If a search cannot be performed due to missing data in the ILLiad request, a message dialog will appear to alert staff that the search could not be performed.

Search Types​

The following search types will be supported using the LoanTitle and LoanAuthor or PhotoArticleTitle and PhotoArticleAuthor depending on the ILLiad RequestType:

  • Title
  • Using the LoanTitle or PhotoArticleTitle depending on the ILLiad RequestType.
  • ISxN
  • Using the ISxN field.
  • Keyword

Settings​

The configuration fields can be modified in the Addon Manager after the addon has been properly installed.

ApiKey

  • The API Key to use to authenticate with the DWS.
  • Default value: blank.

AutoSearch

  • Should the search be automatically performed when the form opens?

BaseURL

Patronldentifier

  • The mapping to the patron identifier for authenticating to Relais. This will support either a constant value or a tag for a field from the User or Transactions table in ILLiad.
  • Examples: '29089123456789' or '{TableMapping:User.Number}' or '{TableMapping:Transaction.Itemlnfol}'.

LibraryCode

  • The library code assigned by Relais for authenticating to Relais.
  • Example: 'UCHICAGO'.

SearchPrioritylist

  • The fields that should be searched on, in order of search priority. Each field in the string will be checked for a valid corresponding search value in the request, and the first search type with a valid corresponding value will be used.
  • Default: ISBN, Keyword.

EncryptionKey

  • The public encryption key used for encrypting the patron login during the initial login. Leave blank if encryption should not be used.
  • Due to encryption processes, this may change from a setting with the key to be the filename of the PEM file provided by Relais that the site adds to the addon directory.

RelaisReturnsProxyUrls

  • Boolean value that specifies whether the URL returned by the Relais Find Item service includes a proxy URL. This should be changed to true for anyone using EZProxy.
  • Default value: “false”.

AvailableLocallyButtonLabelText

  • Defines the Button Label that the Find Item DWS sends back if the item is available locally.
  • Example: “Available at the UCHICAGO library”.

LibrarySymbol

  • The Library Symbol to use when making calls to the DWS.
  • Default value: blank.

UserBarcodeMapping

  • The mapping to indicate where to find the user’s barcode. This is used for authentication to the DWS.
  • Example: {TableField:User.UserInfo1}.

UserPasswordMapping

  • The mapping to indicate where to find the user’s password to use to authenticate to the DWS. This value can be blank if password authentication is not required.
  • Example: {TableField:User.UserInfo1}.

In addition to the basic configuration settings, there are six settings that "must be set for each specific library:

  • RelaisReturnsProxyUrls
  • AvailableLocallyButtonLabelText
  • LibrarySymbol
  • UserBarcodeMapping
  • UserPasswordMapping
  • ApiKey

There are UserBarcodeExternalLookupURL and UserBarcodeExternalMatch keys that could be used instead of the barcode and password mapping if applicable to your setup.