A Web Service Key is required for OLIB to allow the automatic addition and deletion of copy records in WorldCat. Web service keys, commonly referred to as WSKeys, are the primary method used for authenticating and authorising interactions with web services available on the OCLC WorldShare Platform.
You request the WSKey from OCLC. Having obtained it, the values need to be added to fields in OLIB Defaults and Locations:
- OLIB Defaults - WorldCat API Licence Key on the External Integration tab
- Locations - wskey on the Main tab
(If these fields are not included on the OLIB Defaults layout and/or the Locations layout, they should be added to OLIB using Layout Manager).
Visit this information about requesting Web Service Keys from OCLC. This provides information for accessing the WSKey Management form on the WorldShare platform.
When completing this form, enter the following details for OLIB:
Select the WorldCat Metadat API service.
What is the reason for this request?
Include as much relevant information as possible in this box, e.g:
Institution Name: Application: OLIB This WSKey will be used for adding and removing WorldCat basic holdings for the Registry ID and Symbol below. This is a sub-ordinate of the parent Registry ID/Symbol: XXX
OLIB Defaults: External Integration
Within OLIB Web, there are other fields to complete. Go to System Administration> OLIB Defaults and complete the External Integration sheet:
|OCLC Symbol||The OCLC Symbol for your library. If you have multiple libraries each with its own symbol, these are entered in the respective location record's OCLC Symbol field, and the OLIB Defaults OCLC Symbol should contain the group symbol.|
|Institution ID||This is the institution ID, sometimes referred to as the WorldCat Registry ID, for your institution.|
|Secret||The authentication token that you will be given once your WSKey application is completed. Where WSKey is your user ID, Secret is your password.|
|Principal ID||The identifier for the WorldShare user associated with the WSKey. As with Secret, you will be given the Principal ID once your WSKey application is completed.|
|Namespace||A string that indicates that your WorldShare identity is managed by WorldShare's IDM rather than an external IDM. As with Secret, you will be given the Namespace once your WSKey application is completed.|
|Holding Codes Retrieval URL||
|Holdings Maintenance URL||
|Suspend Data Push Job||Set to No once you are ready to start synchronizing your holdings additions and deletions with WorldCat via the OLIB-WorldCat Metadata API Link.|
The above URLs are critical as they point to the production WorldCat metadata API, not a test instance. If these URLs are not present, you will not get any response when you click the Get Holdings Codes button below.
Go to User Management> Locations and complete the Main sheet:
|OCLC Symbol||the OCLC Symbol for your library. The same OCLC Symbol can be shared by several locations. The wskey, Secret, Principal ID and Namespace fields only need to be completed for one of those locations.|
|WorldCat Registry ID||This is the institution ID, sometimes referred to as the WorldCat Registry ID, for your institution.|
|WorldCat Metadata API||Set to Yes when you are ready to start synchronising your holdings additions and deletions with WorldCat via the OLIB-WorldCat Metadata API Link.|
|Secret||The authentication token that you will be given once your WSKey application is completed.|
|Principal ID||The identifier for the WorldShare user associated with the WSKey.|
|Namespace||A string that indicates that your WorldShare identity is managed by WorldShare's IDM rather than an external IDM.|
Test the link
You can now test the link by clicking the Get Holding Codes button on the Locations Main sheet:
This sends a test message to the WorldCat Metadata API and validates the information you have entered. OLIB provides the following responses:
Retrieved Holdings Code(s): MAIN
ORA-06502: PLSQL: numeric or value error
ORA-06512: at "SYS.XMLTYPE", line 272
ORA-06512: at line 1
The above occurs when any information is incorrect.