Installation and Configuration

With a plan in place, you are now ready to begin installing and configuring the various components of GIST for ILLiad Webpages. Please follow these directions carefully to help ensure a smooth implementation. If you need any help, please post your questions to our Help Forum.

Upgrading from the original GIST for ILLiad Webpages

If you are upgrading your existing GIST implementation, please proceed to Step 2.

System Requirements

  • ILLiad server version 8.1 or above
  • ILLiad client version 8.1 or above

Step 1. Obtain the required API keys

GIST utilizes the WorldCat Search API and Amazon Web Services API, both of which require you to register for keys in order to use them. (Keep these keys in a safe place: you may even find it helpful to print them out or write them down.)

Upgrading from the original GIST for ILLiad Webpages

You can use your existing API keys found in your GIST.config file.

WorldCat Search API

The WorldCat Search API is free to all institutions that currently contribute their holdings to OCLC WorldCat. To access the API and obtain your institution’s key, all you need is a free account. (This process is not automated so it could take a day or two to receive your key via email.)

Amazon Web Services API

The Amazon Web Services API requires two keys:

  • Access Key ID
  • Secret Access Key

Once you register for an AWS account, you will be provided with these keys.

Amazon Affiliate Program Associate Tag

Use of the Amazon Web Services API now requires an Associate Tag from the Amazon Affiliate Program. You can apply for an Associate Tag by using your account and creating an Affiliate profile that describes your website. We recommend using your ILLiad webpage URL and ILL department or library in your description.

Step 2. Install the GIST SQL tables

Using the Acquisitions Manager requires the installation of several new ILLiad database tables.

OCLC-Hosted Sites

Contact OCLC support to have the tables installed on your hosted server.

Self-Hosted Sites

The following steps need to be performed by your SQL Server administrator.

  1. Download: (1198).
  2. Extract to the C Drive.
  3. Open SQL Server Management Studio and log into the SQL Server.
  4. Select ILLData Database.
  5. Go to File | Open | File and select GIST_SQL_Tables.sql.
  6. Execute Script.

Step 3. Install the GIST files to your ILLiad web directory

Before you begin

  • This step should be performed by (or in consultation with) the person responsible for maintaining your ILLiad webpages.
  • Before beginning, it is highly recommended that you create a backup of your ILLiad web directory. This will allow you to roll back your changes should you encounter any problems during implementation.

Installation instructions

  1. New Installations: GIST for Web 2.0.3 Full Installer (1204)  |  Upgrade Installations: GIST for Web 2.0.3 Upgrade Installer (952)
  2. Extract the zip file to the ILLiad Web directory on your ILLiad server (or the NVTGC directory if you have multiple sites).
    • If prompted to overwrite your existing web.config file, click No.
  3. For new installations: open the web.config file. Replace the existing <appSettings> tag with:
<appSettings file="GIST.config"/>

Step 4. Configure your GIST settings

Now you are ready to customize the GIST for ILLiad Webpages settings. To get started, open the GIST.config file, located in the new GIST folder of your ILLiad Web directory. Then edit the settings as explained below.

Upgrading from the original GIST for ILLiad Webpages

Users upgrading from the original GIST for ILLiad Webpages can use their original GIST.config file.

Location of GIST Files

This setting species the location of the installed GIST files. Specify the full URL to the folder on your ILLiad Web directory.

<!--Location of GIST Files-->
 <!--For Example:>

Library Name

GIST uses this whenever it needs to display the name of your library. For the value, enter your library’s name.

<!--Library Name-->
 <!-- i.e. Milne Library -->

Group Members and Labels

These settings are used by the WorldCat API in determining your local and group holdings, estimate ILL delivery times, and trigger routing rules based upon your coordinated collection development policies.

  • Group1: your OCLC symbol, used for determining local holdings
  • Group2: the OCLC symbols (separated by commas) of your primary consortium or other preferred libraries
  • Group3: the OCLC symbols (separated by commas) of your secondary consortium, state, or other group
  • Group1Label: the text you’d like displayed when local holdings are found
  • Group2Label: the name of your primary group
  • Group3Label: the name of your secondary group
<!-- Group members and labels-->
 <!--Local OCLC Symbol-->
 <!--Comma Delineated OCLC Symbols -->
 <!--Comma Delineated OCLC Symbols -->
 <!-- Displayed for Locally Held items. Could also have Owned by, etc. -->
 <!-- Title of main group you borrow from -->
 <!-- Title of second group you borrow from -->

Estimated Delivery Time in Days

These settings are used to calculate the estimated delivery time for items borrowed from your primary and secondary groups. When holdings are found for the primary group, that delivery estimate is displayed. If there are no holdings in that group, then the secondary group’s delivery estimate is displayed.

  • Group2Time: the number of days it typically takes to receive ILL loans from your primary group.
  • Group3Time: the number of days it typically takes to receive ILL loans from your secondary group.
<!--Estimated delivery time in days-->

Local Catalog ISBN Search

When local holdings are found at your library, this setting allows GIST to link to the item in your catalog when an ISBN is present in the request. For the value, enter the URL for your OPAC’s ISBN search. Note: you must replace all ampersands (&) with ‘&amp;’ in your parameters or it won’t work.

<!-- Local Catalog OCLC Search - You must replace all '&#038;' with '&#038;' in your parameters or the config will fail-->

WorldCat Key and ID Key

These are required to use the WorldCat and Amazon APIs. For the value, enter the keys you obtained while installing GIST.

<!--WorldCatKey and ID Key-->

Switches to Determine If Requests and Data Will Be Shown

These settings turn the various API widgets on and off. If you do not want to use a certain widget, then set the value to off. Otherwise, set the values to on (the default setting).

<!-- Switches to determine if requests and data will be shown. Values for Google, Amazon, etc. are 'on' or 'off'-->

Switches to Determine If Widgets Will Be Hidden or If “No Data Found” Will Be Displayed

These settings determine the behavior of the widgets if the APIs cannot find any data for the requested item. To hide the widgets, set the value to on (default setting). To instead show the widget and have it display the text “No data found”, set the value to off.

<!-- Switches to determine widget will be hidden or 'No data found' will be displayed. Values for Google, Amazon, etc. are 'on' or 'off'-->

When finished, open the web.config file, add a blank space after the last tag, and save your changes. (You simply need to make sure the Date Modified is later than the GIST.config file’s.)

Step 5. Customize your webpages

Before you begin

  • This step should be performed by (or in consultation with) the person responsible for maintaining your ILLiad webpages.

During installation, the following HTML files were extracted to your ILLiad web directory:

  • GenericRequestGIST-GIST_Tester
  • EditGenericRequestGIST-GIST_Tester
  • ILLiadMainMenu-GIST_Tester
  • include_menu-GIST_Tester

These pages already contain the required HTML code and will allow you to test GIST without affecting your production webpages. If you have customized the style of your ILLiad webpages, then you will need to modify these pages accordingly. The installation package includes a style sheet (GIST.css) that applies to all of the GIST widgets. This will allow you to adjust the dimensions, text, and colors to fit with your other stylesheets. To learn more about editing HTML and CSS, take a look at the W3Schools HTML Tutorial. For more information about customizing ILLiad request forms, visit the ILLiad 8.2 documentation for Customizing the Web Interface.

Step 6. Install the GIST Web addon

In order to access the data being stored in the GISTWeb ILLiad table, you need to download and install the GIST Web addon. This will give you a simple view of the available data, such as local holdings, group holdings, online full text, user preferences, and vendor prices.

Upgrading your existing GIST for ILLiad Webpages implementation?

Since the latest version of GIST for ILLiad Webpages no longer repurposes the Citation fields in ILLiad, you no longer need to use the customized request layouts provided in the previous version. Now is a good time to restore your default client layouts to revert back to the original layouts.

Leave a Reply

XHTML: You can use these tags: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>