Specifications for OpenURL and
Direct Export into RefWorks from Database Service
Last updated on October 27, 2011
Direct Export is a seamless way for users of your Database Service program to easily get records into RefWorks. Currently, user have to go to your Database Service, save the records to a text file in a tagged format in the Database Service program, login to RefWorks, go to the Import page, select the filter, database and specify the text file from your program, and then finally they can start importing. This multi-step process is neither easy nor intuitive to many users. The problem areas are:
With Direct Export, we have eliminated all these problem areas and automated this process for the user. The user will be able to export records directly into RefWorks with a click of a button. Hopefully, this will lead to increase usage of both the Database Service program and RefWorks with little technical support.
Database Service Provider Implementation
There are two ways to implement passing records to RefWorks
Target window name: RefWorksMain
URL: http://www.refworks.com/express/expressimport.asp,
with the query parameters below.
Auto Login Note: If you are doing a Direct Export using an Auto Login,
use the Auto Login URL: http://www.refworks.com/refworks/autologin.asp with the query parameters below.
Shibboleth "WAYF-less URL" note: Users authenticating via Shibboleth can bypass the RefWorks WAYF
("Shibboleth-enabled Institutions" page) and be redirected to their institution's Shibboleth authentication page by
using the Auto Login URL and including a providerID parameter:
https://www.refworks.com/RWShibboleth/autologin.asp?providerID=[clientIdPShibbolethEntityID]&[DEparameters]
where [clientIdPShibbolethEntityID] is the properly escaped entityID of the authenticating Identity Provider, and [DEparameters]
are the Direct Export query parameters described below.
Note: Be sure not to set any window settings on this new browser window. We want it to look like just another browser window. Also be sure you specify the window target name, RefWorksMain, so that if the user already has RefWorks open, it will just go to that already open window rather than opening up a new window.
| Query Parameter | Description |
| vendor | (Required) Name of the Database Service, e.g. "Your Service Name" |
| filter | Name of the Import Filter that will be used to parse the records in text tagged format, e.g. "RefWorks Tagged Format". Click here for our list of filters |
| database | Name of the database source of the records as it appears in the filter. Click here for our list of filters If the records are from more than one database, omit this query string. If not specified, will use the default database specified in the filter. Contact RefWorks if you are unsure about whether to include this information. |
| url | The URL we will call that returns the records in text tagged format. E.g. "http://www.yoursite.com/yourpage.asp?RECNUM=1,2,3&SEARCH=heart" In order for RefWorks to parse the records correctly, do not include any HTML tags. |
| encoding | (Optional) If the URL page is encoded using a specific character set, specify the encoding in this parameter so the characters appear correctly when imported into RefWorks. For example if the page is in UTF-8, pass "encoding=65001" in the query string. If not specified, will use the default encoding specified in the filter. For a list of Windows character sets, click here. |
Example:
http://www.refworks.com/express/ExpressImport.asp?
vendor=<VendorName>&filter=<FilterName>&database=<DatabaseName>&encoding=<EncodingNumber>&url=<URL>
Note: Be sure to escape out spaces, ampersands, punctuation marks, accented characters, and any other non-ASCII characters in the VendorName, URL, FilterName and DatabaseName.
If you already save your records in a tagged format, check our list of filters to see if we have a filter defined for it. If we do have a filter, then save your records in that tagged format and use that filter. If you save your records in the RIS Format, use the filter, "RIS Format". Otherwise, we recommend saving your records in our own RefWorks Tagged Format (see specifications) which has a tag for each specific field in the RefWorks database and uses the filter, "RefWorks Tagged Format".
Contact RefWorks if you are unsure about which tagged format to use.
Sample code - A hyperlink and the callback returns records in RefWorks Tagged
Format encoded in
<A href="http://www.refworks.com/express/ExpressImport.asp?vendor=Your%20Service%20Name&filter=RefWorks%20Tagged%20Format&encoding=65001&url=http%3A//www.yoursite.com/yourpage.asp%3FRECNUM%3D1%2C2%2C3%26SEARCH%3Dheart" target="RefWorksMain">Export to RefWorks</A>
Target window name: RefWorksMain
URL: http://www.refworks.com/express/expressimport.asp,
with the query parameters below.
Auto Login Note: If you are doing a Direct Export using an Auto Login,
use the Auto Login URL: http://www.refworks.com/refworks/autologin.asp with the query parameters below.
Shibboleth "WAYF-less URL" note: Users authenticating via Shibboleth can bypass the RefWorks WAYF
("Shibboleth-enabled Institutions" page) and be redirected to their institution's Shibboleth authentication page by
using the Auto Login URL and including a providerID parameter:
https://www.refworks.com/RWShibboleth/autologin.asp?providerID=[clientIdPShibbolethEntityID]&[DEparameters]
where [clientIdPShibbolethEntityID] is the properly escaped entityID of the authenticating Identity Provider, and [DEparameters]
are the Direct Export query parameters described below.
Note: Be sure not to set any window settings on this new browser window. We want it to look like just another browser window. Also be sure you specify the window target name, RefWorksMain, so that if the user already has RefWorks open, it will just go to that already open window rather than opening up a new window.
| Query Parameter | Description |
| vendor | (Required) Name of the Database Service, e.g. "Your Service Name" |
| filter | Name of the Import Filter that will be used to parse the records in text tagged format, e.g. "RefWorks Tagged Format". Click here for our list of filters |
| database | Name of the database source of the records as it appears in the filter. Click here for our list of filters If the records are from more than one database, omit this query string. If not specified, will use the default database specified in the filter. Contact RefWorks if you are unsure about whether to include this information. |
| encoding | (Optional) If the URL page is encoded using a specific character set, specify the encoding in this parameter so the characters appear correctly when imported into RefWorks. For example if the page is in UTF-8, pass "encoding=65001" in the query string. If not specified, will use the default encoding specified in the filter. For a list of Windows character sets, click here. |
Example:
http://www.refworks.com/express/ExpressImport.asp?
vendor=<VendorName>&filter=<FilterName>&database=<DatabaseName>&encoding=<EncodingNumber>
Note: Be sure to escape out spaces, ampersands, punctuation marks, accented characters, and any other non-ASCII characters in the VendorName, FilterName and DatabaseName.
If you already save your records in a tagged format, check our list of filters to see if we have a filter defined for it. If we do have a filter, then save your records in that tagged format and use that filter. If you save your records in the RIS Format, use the filter, "RIS Format". Otherwise, we recommend saving your records in our own RefWorks Tagged Format (see specifications) which has a tag for each specific field in the RefWorks database and uses the filter, "RefWorks Tagged Format".
Contact RefWorks if you are unsure about which tagged format to use.
Sample code - A form with an ImportData field containing the records in RefWorks Tagged
Format encoded in
<FORM name="ExportRWForm" method="POST" target="RefWorksMain" action="http://www.refworks.com/express/ExpressImport.asp?vendor=Your%20Service%20Name&filter=RefWorks%20Tagged%20Format&encoding=65001">
<TEXTAREA name="ImportData" rows=30 cols=70>
RT Journal
ID 11579
A1 Mazzone,P. J.
A1 Arroliga,A. C.
T1 Lung cancer: Preoperative pulmonary evaluation of the lung resection candidate
JF The American Journal of Medicine
JO Am.J.Med.
YR 2005
FD Jun
VO 118
IS 6
SP 578
OP 583
AB Lung resection provides the best chance of cure for individuals with early stage non-small cell lung cancer. Naturally, lung resection will lead to a decrease in lung function. The population that develops lung cancer often has concomitant lung disease and a reduced ability to tolerate further losses in lung function. The goal of the preoperative pulmonary assessment of individuals with resectable lung cancer is to identify those individuals whose short- and long-term morbidity and mortality would be unacceptably high if surgical resection were to occur. Pulmonary function measures such as the forced expiratory volume in 1 second and the diffusing capacity for carbon monoxide are useful predictors of postoperative outcome. In situations in which lung function is not normal, the prediction of postoperative lung function from preoperative results and the assessment of exercise capacity can be performed to further clarify risks. Published guidelines help to direct the order of testing, permitting us to offer resection to as many patients as possible.
NO JID: 0267200; 2004/12/07 [received]; 2004/12/22 [revised]; 2004/12/29 [accepted]; ppublish
PP United States
SN 0002-9343
AD Department of Pulmonary, Allergy, and Critical Care Medicine, The Cleveland Clinic Foundation.
AN 15922686
LA eng
SF Journal Article; AIM; IM
DO S0002-9343(05)00147-6 [pii]; 10.1016/j.amjmed.2004.12.024 [doi]
</TEXTAREA><br>
<INPUT type="submit" name="Submit" value="Export to RefWorks">
</FORM>
The user now has their records in RefWorks!
RefWorks supports both OpenURL version 0.1 and 1.0. The format specification for the OpenURL standard version 0.1 can be found at http://www.exlibrisgroup.com/sfx_openurl_syntax.htm. The OpenURL standard version 1.0 is available free for downloading at http://library.caltech.edu/openurl/Standard.htm.
Note: If using OpenURL verion 0.1, the query string must contain the sid parameter to import properly. If using OpenURL version 1.0, the query string must contain the url_ver=Z39.88-2004 parameter to import proplerly.
Target window name: RefWorksMain
Base URL: http://www.refworks.com/express/expressimport.asp
OpenURL verion 0.1 - Query Parameters Mapping to RefWorks fields
| Meta-tag | Value | RefWorks Field |
| sid | Data Source field, Database field |
|
| id | doi | DOI field |
| pmid | Notes field | |
| bibcode | Notes field | |
| oai | Notes field | |
| pid | Notes field | |
| genre | Ref Type field | |
| journal | Journal ref type | |
| book | Book, Whole ref type | |
| conference | Conference Proceedings ref type | |
| article | Journal ref type | |
| preprint | Unpublished Material ref type | |
| proceeding | Conference Proceedings ref type | |
| bookitem | Book, Section ref type | |
| aulast | Authors, Primary field | |
| aufirst | Authors, Primary field | |
| auinit | Authors, Primary field | |
| auinit1 | Authors, Primary field | |
| auinitm | Authors, Primary field | |
| issn | ISSN/ISBN field | |
| eissn | ISSN/ISBN field | |
| coden | Notes field | |
| isbn | Notes field | |
| sici | Notes field | |
| bici | Notes field | |
| title | Periodical, Full field (article, journal) Proceedings Title (proceeding, conference) Book Title (bookitem) Title (book) |
|
| stitle | Periodical, Abbrev field (article, journal) Series Title (proceeding, bookitem, book, conference) |
|
| atitle | Title | |
| volume | Volume field | |
| part | Issue field | |
| issue | Issue field | |
| spage | Start Page field | |
| epage | End Page field | |
| pages | End Page field | |
| atrnum | Start Page field End Page field |
|
| date | Pub Year field, Pub Date Free Form field |
|
| ssn | Pub Date Free Form field | |
| quarter | Pub Date Free Form field |