Skip to main content
OCLC Support

OpenURL

Find a summary of how the values from the OpenURL are used in Relais ILL and how they populate the Relais request forms.

 

User tags

 

OpenURL tag Used by Relais
group

Used to determine what type of user is accessing the Relais Portal. 

Most typically if OpenURL is being used this will be a patron.

Valid values are:

  • staff
  • library
  • patron
UT

Used to determine what type of user is accessing the Relais Portal. 

Most typically if OpenURL is being used this will be a patron.

Valid values are:

  • S(taff)
  • L(ibrary)
  • P(atron)
aid An authorization ID, which may have been obtained from the Relais authentication service.
LS The library symbol of the patron or institution using the system.

PI

id

The patron ID.
base64PI 

Indicates whether Patron ID (in the PI tag) is encrypted and represented as base64 String.

Valid values are

  • 0
  • 1
base64id

Indicates whether Patron ID (in the id tag) is encrypted and represented as base64 String.

Valid values are

  • 0
  • 1

PS

surname

Patron surname.
base64PS 

Indicates whether the Patron Surname (in the PS tag) is encrypted and represented as base64 String.

Valid values are

  • 0
  • 1
base64surname 

Indicates whether the Patron Surname (in the surname tag) is encrypted and represented as base64 String.

Valid values are

  • 0
  • 1
UL User login.
base64UL 

Indicates whether the User Login (UL) is encrypted and represented as base64 String.

Valid values are

  • 0
  • 1
UP User password
base64UP 

Indicates whether the User password (UP) is encrypted and represented as base64 String.

Valid values are

  • 0
  • 1
RK Record key
base64RK 

Indicates whether the Record Key (RK) is encrypted and represented as base64 String.

Valid values are

  • 0
  • 1
PL

Preferred language.

Valid values are from the ISO 639-2 language code.

Navigation tags

 

OpenURL tag Used by Relais
reqno
  • reqNo

Send a query for a specific request number

FT
  • Query Form Type

Send a query.

Valid values:

  • R(equest detail)
  • Q (All requests)
  • O(pen requests)
genre
  • Request Form Type

Determines which Request template to display.

Sample values and the corresponding template: 

Article Article Request
Book Book Request
Book Chapter Book Chapter Request
Book Item Book Chapter Request
Conference Conference Request
Dissertation Thesis Request
Journal Article Request
PrePrint Article Request
Proceeding Conference Request
Thesis Thesis Request
any other values Add Request using the default template

 Note: If a genre value is received in an OpenURL and the corresponding template is not configured then Add Request using the default template displays.  

PT
  • Request Form Type

Determines which Request template to display.

Valid values and the corresponding template: 

J Article Request
B Book Request

 

Bibliographic tags

 

OpenURL tag Used by Relais
aufirst

Populate Author of Publication in format:  aulast, aufirst auinit to populate (depending on what values are provided)

aulast Populate Author of Publication in format:  aulast, aufirst auinit to populate (depending on what values are provided)
auinit     
Populate Author of Publication in format:  aulast, aufirst auinit to populate (depending on what values are provided)

aau

AA

For Article, Conference, and Book Chapter Requests, populate Author of Article/Chapter.

If no tag Article Author is provided, then the values from the Author tag(s) are used.

au

AU

Used to populate Author of Publication.

issn

IS

Populate the ISSN(s).

isbn

IB

Populate the ISSN(s).

oclcnum

rft_id

Populate System Number.  For example:

IF the value in the rft_id tag is in the format "info:oclcnum/373479620”, the number is used.

rft_id

eissn

coden

sici

bici

NL

Populate Additional Numbers.  Appropriate prefixes are added to indicate what values are provided.

If the value in the rft_id tag starts with "info:doi", then the remaining part of the tag value is used after the "/" is used along with the prefix doi.  For example, for rft_id=info:doi/F10.1038/427681, then Additional Numbers is populated with doi:F10.1038/427681

If the value in the rft_id tag starts with info:pmid/9036860, the number after the / is used along with the prefix pmid.  For example for rft_id= info:pmid/9036860, then Additional Numbers is populated with pmid:9036860

If multiple tags are included in the OpenURL then Additional Numbers is populated with all values and the appropriate prefix.  For example:

natbibid

natbibau

Populate Nat. Bib Num.

title

TI

btitle

jtitle

stitle

Populate the Journal, Book, Conference, etc Title as appropriate.

If multiple tags and corresponding values are provided, only one value is used.  The order of precedence is: title, btitle, jtitle, and then stitle.

atitle

TA

Populate Article Title

volume

VS

Populate volume

issue

part

ssn

quarter

Populate Issue.  If multiple tags and corresponding values are provided all are used.
spage Populage pages along with epage.
epage Populate Pages along with spage.

pages

tpages

PG

Populate pages.
artnum Populate pages.

pubdate

date

PD

Populate Publication Date.

The value in the pubdate tag is used only for the Book, Book Chapter, and Conference Requests.  It is not used for Article Request.

year  

place

PP

Populate Place of Publication.

pub

PU

Populate Publisher

series

SE

Populate Publisher

edition

ED

Populate Edition

rfr_id

bibsrc

verify

SI

Populate Source of Information.  If multiple tags and corresponding values are provided all are used. 

callno

CN

Populate Call Number.
needbef Not Supported.

SID

sid

Use the value provided to select the appropriate entry from the Request Source drop down. 

If no match is found, then when the request is created the default value of Relais Portal is used. 

maxcst Populate Maximum Cost.

possup

subseq

hold

strhold

avail

NO

Populate Notes.  If multiple tags and corresponding values are provided all are used.
LO Populate Suppliers.
If the supplier is not registered, the default supplier code is used when creating the request.
loc Populate Local Location.

Delivery and messaging tags

 

OpenURL tag Used by Relais

eaddr

DA

Used as the delivery address when creating the request or patron record.

DM

Used as the preferred delivery method for the request or patron record.

The value must exist in the Delivery Method table.  If it is not, the default of Mail is used.

MA Used as the messaging address for when creating the request or patron record.
MM

Used as preferred delivery method for the request or patron record.

The value must exist in the Messaging Method table.  If it does not, the default of Mail is used.

Address tags

OpenURL tag Used by Relais

buildingloc

building

street

boxid

district

line1

AO

Street 1

line2

AT

Street 2

locality

CI

City

region

PR

Province/State

country

CO

Country

postcode

PZ

Postal/Zip code

 

 

  • Was this article helpful?