Installing the GIST API Widgets
GIST has utilized the WorldCat, Google Books, Amazon, and other APIs to provide your users with a customized interface and your staff with a more powerful workflow. These various elements can all be turned on or off depending upon your preferences, and more options will be made available as other APIs are integrated into GIST. Note: Prior to installation, we strongly recommend saving a copy of all your ILLiad web files.
| We want your feedback! |
|---|
| Problems? Send us your troubleshooting comments. |
| Something you want to see in the next version of GIST? Let us know your ideas about what to add and improve. |
| GIST-L Subscription |
| Please sign up for the GIST-L listserv so that you will get notification of any updates. http://mail.geneseo.edu/mailman/listinfo/gist-l . |
| Optional Registration |
| We are interested in getting some basic information from everyone that downloads GIST. This is completely optional but if you don't mind, please go to GIST Registration and register. Thank you! |
Installing the GIST Programs
- Back up your current ILLiad Web Directory
- Extract the Zip file to your ILLiad Web Directory (or the NVTGC directory if you have multiple sites).
- If you get a warning about overwriting your web.config file, then click NO
- You will need to open the web.config file and modify the <appSettings> line to <appSettings file=“GIST.config”/>
- Obtain an Amazon Web Services key, an Amazon Secret Key (same page) and a WorldCat API key before continuing. Also review the Google Book Search API branding guidelines.
- Open up the GIST.config file located in your ILLiad Web Directory. Enter the keys along with your library information into the GIST.config file.
- After you make any changes to GIST.config you will need to update web.config so that it has a newer Modified Date. (just open it, add a space to a blank line and resave it.)
|
|---|
About the GIST API Widgets
GIST utilizes several components to provide users with discovery and delivery information at the point of request. These same components also work behind the scenes to greatly improve and automate the workflows for acquisitions and ILL staff. By incorporating several APIs, which you can enable or disable based upon your preferences, you can customize the GIST experience for your users and staff. Below you will find an explanation of each widget (Note: this is the layout used by SUNY Geneseo, but yours may differ based upon your own local web page designs).
|
|---|
Feedback
We want your feedback about these widgets! To comment on a specific widget, please follow the links below to our development blog:
Customizing GIST: How to Use the GIST.Config File
Below you will find a description of each section of the GIST.config file, which allows you to customize the GIST API widgets. Note: If you make any changes to GIST.config, you will need to update web.config so that it has a newer Modified Date (just open it, add a space to a blank line and resave it).
Location of GIST files
This specifies the location of the GIST folder you installed. For the value, enter the URL to this folder on your ILLiad web server.
<!--Location of GIST Files--> <add key="File_Location" value="Enter URL here" /> <!--For Example: http://ids.geneseo.edu/gist-->
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--> <add key="Library_Name" value="Your Library" /> <!-- 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: this value should be your local OCLC symbol and is used to determine your local holdings.
- Group1Label: enter the text displayed when local holdings are found.
- Group2: this value should contain the comma separated OCLC symbols for your primary resource sharing or coordinated collection development (CCD) group.
- Group2Label: enter the text displayed when holdings are found for your primary resource sharing or CCD group.
- Group3: this value should contain the comma separated OCLC symbols for your secondary resource sharing or CCD group.
- Group3Label: enter the text displayed when holdings are found for your secondary resource sharing or CCD group.
<!-- Group members and labels--> <add key="Group1" value="XXX" /> <!--Local OCLC Symbol--> <add key="Group2" value="AAA,BBB,CCC,DDD,EEE" /> <!--Comma Delineated OCLC Symbols --> <add key="Group3" value="FFF,GGG,HHH,III,JJJ,KKK" /> <!--Comma Delineated OCLC Symbols --> <add key="Group1Label" value="Locally Held" /> <!-- Displayed for Locally Held items. Could also have Owned by, etc. --> <add key="Group2Label" value="Local Consortium" /> <!-- Title of main group you borrow from --> <add key="Group3Label" value="State/Other" /> <!-- 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: this value should be the number of days it typically takes to receive items from your primary resource sharing or CCD group (Group1 above)
- Group3Time: this value should be the number of days it typically takes to receive items from your secondary resource sharing or CCD group (Group2 above)
<!--Estimated delivery time in days--> <add key="Group2Time" value="3" /> <add key="Group3Time" value="7" />
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 '&' with '&' in your parameters or it won't work.
<!-- Local Catalog ISBN Search - You must replace all '&' with '&' in your parameters or the config will fail--> <add key="localCatalogISBN" value="Enter URL here" /> <!--http://saranac.sunyconnect.suny.edu:4420/F?func=find-b&find_code=020&request=-->
Local Catalog OCLC 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 not present, but there is an OCLC number. For the value, enter the URL for your OPAC's OCLC search. Note: you must replace all '&' with '&' in your parameters or it won't work.
<!-- Local Catalog OCLC Search - You must replace all '&' with '&' in your parameters or the config will fail--> <add key="localCatalogOCLC" value="Enter URL here" /> <!--http://saranac.sunyconnect.suny.edu:4420/F?func=find-b&find_code=035&request=-->
WorldCatKey and Amazon.com 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 Amazon.com ID Key--> <add key="AWSAccessKeyId" value="Enter Value here" /> <add key="AWSSecretKey" value="Enter Value here"/> <add key="WorldCatKey" value="Enter Value here" />
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'--> <add key="googleOn" value="on" /> <add key="amazonOn" value="on" /> <add key="purchaseboxOn" value="on" /> <add key="freeOn" value="on" /> <add key="worldcatOn" value="on" />
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'--> <add key="googleNoData" value="on" /> <add key="amazonNoData" value="on" /> <add key="purchaseboxNoData" value="on" /> <add key="freeNoData" value="on" /> <add key="worldcatNoData" value="on" />

