ILLiad WorldCat Local Addon (WebView2 & Chromium)

Minimum Version Requirement

You must be on ILLiad version 9.2 to use this addon. Note that if you are on ILLiad Client v9.2.4, the addon will use the WebView2 browser. If you are on a previous version of the ILLiad 9.2 Client, the addon will use the Chromium browser.

WorldCat will perform a security check based on your machine's IP address when using this addon to access individual records. You may experience issues accessing these records if your IP address fails the security check.

Name

WorldCat Local

Version

1.5.3

Author

Atlas Systems, Inc.

Description

The WorldCat Local Search Addon allows you to search Articles and Loans using a variety of criteria (title, ISSN, OCLC, etc.) and automatically shows search results.

This addon is available for developers to modify and extend. Developers are encouraged to submit changes to this addon by forking the git repository from GitHub and creating a pull request.

Download

Download zip file: WorldCatLocalSearch_v1.5.3.zip

Release Notes

  • v1.5.3:

    • Added support for importing bibliographic information from the WorldCat record into ILLiad. For more information, see Using this Addon below.

Configuration

Addon settings are configured in the Manage Addons form. WorldCat Local Search performs a WorldCat search using the request title, ISxN or OCLC number.

WorldCat Local Search is Not Active by default. To hide the tab on your Request form, select No and Save Settings.

Name

Default

Type

Description

Name

Default

Type

Description

AutoSearch

True

Boolean

Defines whether the search should be automatically performed when the form opens.

WorldCatURL

https://worldcat.org

String

The URL for WorldCat Local. Do not include a trailing slash.

SearchPriority

Title,ISxN,OCLC

String

Defines what order priority should be used when attempting to find a field to search by when using the auto search feature. Allowed fields are title, isxn and oclc.

Using this Addon

  1. To use the WorldCat Local Search Addon, click the WorldCat Local Search tab on the request form.

  2. If WorldCat Local has been set to search automatically, it will search using the available fields, and open to a list of search results.

  3. Click on the item in WorldCat Local you want to select to bring up that item page.

  4. If the search is not set to start automatically, you will see a blank page instead of a list of WorldCat Local Search results.

  5. Start the search by clicking the Search Title, Search ISxN or Search OCLC button on the WorldCat Local ribbon.

  6. When on a record page, click the Import button to import bibliographic information from WorldCat. The fields this information is imported to are configurable in the DataMapping.lua file.

  7. Use the BackForwardStop and Refresh buttons in the WorldCat Local ribbon to move between pages, refresh pages and stop loading a page.

Data Mappings

Below are the default configurations for the WorldCat Local addon when used with ILLiad. The mappings within DataMappings.lua are settings that typically do not have to be modified from site to site. However, these data mappings can be changed to customize the fields used to perform the WorldCat search and the fields used to import citation information into the ILLiad request from the WorldCat record.

Source Fields for Searching

The SourceFields mappings control the ILLiad fields that are read by the addon and used to perform the auto search. To modify the ILLiad field that is read and used for each search type, the field name in the Source Field column should be changed to the database name for the new field. Note that the source fields used for Loan requests are configured separately from the source fields used for Article requests.

Default Configuration

Search Type

Source Field - Loans

Source Field - Articles

Search Type

Source Field - Loans

Source Field - Articles

DataMapping.SourceFields["Title"]

“LoanTitle”

“PhotoJournalTitle”

DataMapping.SourceFields["Isxn"]

“ISSN”

“ISSN”

DataMapping.SourceFields["OclcNumber"]

“ESPNumber”

“ESPNumber”

Bibliographic Import Fields

The ImportFields mappings control the ILLiad fields into which the WorldCat record information will be imported when the addon is used to perform a citation data import. To modify the ILLiad field used, the field name in the Import Field column should be changed to the database name for the new field. Note that the import fields used for Loan requests are configured separately from the source fields used for Article requests.

Default Configuration

Citation Data

Import Field - Loans

Import Field - Articles

Citation Data

Import Field - Loans

Import Field - Articles

DataMapping.ImportFields["Title"]

“LoanTitle”

“PhotoJournalTitle”

DataMapping.ImportFields["Isxn"]

“ISSN”

“ISSN”

DataMapping.ImportFields["Author"]

“LoanAuthor”

“ItemAuthor”

DataMapping.ImportFields["Publisher"]

“LoanPublisher”

“PhotoItemPublisher”

DataMapping.ImportFields["PublicationPlace"]

“LoanPlace”

“PhotoItemPlace”

DataMapping.ImportFields["PublicationDate"]

“LoanDate”

“PhotoJournalYear”

DataMapping.ImportFields["OclcNumber"]

“ESPNumber”

“ESPNumber”