Information for Librarians

Librarians: Technical Details

How to register your resolver

You can register your resolver here. When you submit the configuration details to openurl.ac.uk, they will be checked and entered into the database.

Any UK institution involved in tertiary education or research can register a resolver. An "institution" in this context refers to a group of users who share the use of an OpenURL Resolver, and can be identified by UK federation scope and/or a shared IP address or range. In some circumstances this could be a subset of a University or research body, and it does not need to correspond to a UK federation "scope".

If you need to amend information about a resolver that has already been registered, just email the changes you would like to make to helpdesk@openurl.ac.uk, or re-register your resolver by re-submitting the configuration request form.

Configuration information required

To register your Resolver at openurl.ac.uk you will need to provide the information detailed below:

Resolver URL
The base URL for OpenURL requests that are directed to your resolver.
Button image URL
Optional. The URL of the button or icon image that you would prefer to be used for OpenURL links.
Button alt text
Optional. The "alt" text you would prefer to be used with the button image. This is important for accessibility.
UK federation scope
The UK federation scope that identifies your institution, e.g. bath.ac.uk is identified as University of Bath.
Note that although this resembles an internet domain, it is, strictly speaking, distinct from an institution's domain. Nevertheless, for many institutions the UK federation scope happens to be the same as one of its internet domains.
IP address or range
This should be the IP address or range associated exclusively with your institution. The conventions indicated below should be used to specify the IP range.
A wildcard * or missing value matches a whole subnet:
. 2 . 3 . *
. 2 . 3
Hyphenated values can specify a range, and lists of comma separated values can be used:
. 2 . 3 . 4-8
. 2 . 3-5
. 2 . 3 . 4,5,6
. 2 . 3,4,5 . 0-128
Minimum acceptable precision:
. 2 
Multiple values can be provided.
Domain name
This should be the domain name associated exclusively with your institution. Multiple values can be provided.
Institution name
This allows the OpenURL resolver to be identified (for human readers)
Administrator name
Your name and email address will be used to resolve queries connected with this configuration and to alert you, when necessary, about any changes to the service. The Router service will not make these details available to a third party.
Administrator email
See "Administrator name" above.

Linking via the OpenURL Router

You will need to set up links via the OpenURL Router for services that do not use the Router automatically or as their default setting. This may currently apply to most of your services. It is, nevertheless, worthwhile configuring links to use the Router because if you change your resolver URL in the future (software updates, firewall/proxy server changes, domain name changes, switching port numbers, etc.) you need alter only the configuration at the OpenURL Router to effect this change immediately for all of your services.

URL for OpenURL links

Use this as the base URL for links

http://openurl.ac.uk/ukfed:SCOPE

In place of SCOPE use your UK federation scope (the string resembling a domain that you used when you registered your resolver; if you registered more than one UK federation scope, you can use any one of them here).

URL for button/link image

Where a service allows you to specify a button/link image, use this

http://openurl.ac.uk/button/ukfed:SCOPE

In place of SCOPE use your UK federation scope (the string resembling a domain that you used when you registered your resolver; if you registered more than one UK federation scope, you can use any one of them here).

Backwards compatibility for Athens

Old links using the 'athens' parameter (in place of the 'ukfed' parameter above) will continue to work, so no changes to existing links made in this manner will be necessary.

jiscedina

OpenURL is a Jisc-sponsored service, and is administered jointly by EDINA.