Configuring the ILLiad Web Platform

Print Friendly and PDF Follow

Many ILLiad components rely on the ILLiad Web Platform in order to function properly. The following steps must be completed in order for the ILLiad Web Platform to work.

In order for the Web Platform to work properly and to maintain security, you must have a valid SSL certificate and support HTTPS. Adding the AllowInsecureWebPlatformRequests will determine if the requests require SSL.

The ILLiad Web Platform cannot be protected by remote auth filters. These will impede with the web traffic that needs to flow freely to and from the web platform.

ILLiad Web Platform video

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.

  1. Click New Record.
  2. 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
    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.

    This should be set to the name of an ILLiad field in the Users table that can be used to uniquely identify the user in the external API consumer's system. 

    For example, if this entry in the WebPlatformConfig table will be used to integrate with Alma and users are identified by barcode in the Alma system, then the ExternalUserIDMapping column should contain the name of the field in ILLiad that holds this same barcode information (e.g., SSN). 

  3. Click Save.


WebPlatformConfig Key

Now enter a WebPlatformConfig Key value. This entry will be made in the ILLiad Customization Manager under System | Web Platform | ILLiadWebPlatformConfig.

  1. Click New Record.
  2. 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.
  3. 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. 



If this article didn’t resolve your issue, please contact Atlas Support for assistance:

Contact Support