Skip to content
BAlter edited this page Apr 29, 2021 · 4 revisions

ILLiad is divided into four main components: the client, the user manager, the customization manager, and the web interface.

NYU's ILLiad uses the RemoteAuth authentication method via https://github.com/nyulibraries/illiad_proxy

Staff Client

The ILL staff uses this to process requests once they've come in. It is a Windows desktop application installed on staff workstations.

User Manager

ILL admins will use this to grant permission to the other ILLiad components. A super admin can create a user account for themselves from the database manager.

The Customization Manager

This controls various aspects of the application. Web Services is primarily concerned with the "Web Interface" section:

  • Web Interface > Authentication - See ILLiadProxy page

  • Web Interface > Labels > WebFormValues - Map web form buttons to forms. It isn't clear that this is essential for making new web forms.
  • Web Interface > OpenURL > OpenURLMapping - Maps OpenURL fields to ILLiad web forms.
  • Web Interface > Validation > WebValidation - Create regular expressions for validating fields in web forms.

Web Interface

The Web Interface consists of a number of proprietary web forms with fields that correspond to input in the ILLiad client and rules in the customization manager.

Creating new web forms

Read up on the ILLiad wiki:

Note: In the documentation pay close attention to X and Y variable placeholders and make sure you replace them with appropriate values.

Some tips for making new forms:

  • The custom created forms are named in the form GenericRequest[RequestType].html where GenericRequest is a controlled term.
  • When updating any forms you must also update the Edit version of that form, which are all named in the form Edit[FormName].html
  • Customization Manager admins should handle making certain fields required and mapping the fields you create into the correct field in the client.
  • When creating a new form, OpenURL parameters need to be mapped to the correct form in the Customization Manager table "OpenURLMapping."

Redirect root URL to the ILLiad application

In the Website root folder (/inetpub/wwwroot) create a file called index.htm redirecting to the illiad.dll.

Use the following code or similar:

<html> <head> <meta http-equiv="refresh" content="0;url=http://ill.library.nyu.edu/illiad/illiad.dll"> <script type="text/javascript"> <!-- window.location = "http://ill.library.nyu.edu/illiad/illiad.dll" //--> </script>  </head> <body> <noscript> If you are not automatically redirected, <a href="http://ill.library.nyu.edu/illiad/illiad.dll">click here</a>. </noscript> </body> </html>

Since this runs on an IIS server you could also make a Default.aspx page in these places with a server redirect if you so choose.

Adding custom status error messages

First you have to enable/install Classic ASP as an IIS component. See the Microsoft docs

We just add custom errors to the illiad site level (i.e. Default Web Site). The error script must live within that site directory, so at least under /illiad.

In IIS Manager under the custom errors screen the following lines were added to the associated status errors:

/illiad/error.asp?error=500
/illiad/error.asp?error=404
/illiad/error.asp?error=403