Once you have received a WSKey and secret from OCLC, you will need to make some configurations for Article Exchange to work properly. You will do this in the ILLiad Customization Manager.
To watch a demonstration of this, go to the Web Platform Configuration video in the Video Training Library.
You need to have a working SSL certificate on your ILLiad web server in order for this to work. If you are hosted by Atlas or OCLC you have one. If you are self-hosted, check with your system administrator.
These customizations affect both Borrowing and Lending.
- Under System | Integration | WebPlatformConfig click New Record.
-
Input the following key values:
ID This will be assigned automatically. NVTGC This is a global setting that is already populated. (shared servers: use ILL. You only need to make one entry in the table.) APIKey Click on the ellipsis in the field to have this auto-populate. BaseWebserviceUrl This is the location where your ILLiad web platform lives on your web server. This path will be https://your.illiad.server/illiadwebplatform/. Description Fill in a description. This is a required field. - Under System | Web Platform | ILLiadWebPlatformConfig enter the Key Value and save changes. This will be the ID assigned to you in WebPlatformConfig (it will most likely be 1).
- Under System | OCLC | OCLCWebServiceV2APIKey enter the WSKey you received from OCLC.
-
Under System | OCLC | OCLCWebServiceV2APISecret enter the secret you received from OCLC that is associated with your WSKey.
If you have a shared server installation, you will need to enter the WSKey and Secret in the Customization Manager for each individual site (NVTGC). If you only have one OCLC symbol, these values will be the same for all NVTGCs. If you have multiple OCLC symbols, each symbol requires a unique WSKey and secret and should be entered in the Customization Manager in the corresponding NVTGC fields.
WebPlatformConfig Table
First, make an entry in the WebPlatformConfig table. This is found in the ILLiad Customization Manager under System | Integration | WebPlatformConfig.
If you have a shared server installation, you only need to create one WebPlatformConfig record, but it needs to be created on the ILL NVTGC site.
- Click New Record.
-
Create an entry for the ILLiad Web Platform by filling in the following values:
ID This field is auto-generated. NVTGC This field is auto-generated (ILL). API Key Click on the API Key field, then click the ellipses to generate this. Base Webservice URL This URL should point to your ILLiad Web Platform. This will look like https://your.ILLiad.server.name/ILLiadWebPlatform/.
The URL must contain https and you must have an SSL certificate installed.Description Fill in a description that helps you identify that this entry points to the ILLiad Web Platform.
WebPlatformConfig
Now enter a WebPlatformConfig Key value. This entry will be made in the ILLiad Customization Manager under System | Web Platform | ILLiadWebPlatformConfig.
- Click New Record.
- Enter the Key Value. This value will be the ID number for the WebPlatformConfig table entry that identifies the ILLiad Web Platform. In the example we have been using, the value will be set to 1.
- Click Save.
Restart Services
The final step is to restart the IIS and Odyssey Manager services on the ILLiad server. OCLC-hosted sites will need to contact OCLC support for this restart. Locally hosted sites will need to ask their local server administrator to do this.