Download

Open

Release Notes

• v1.0.1:

  • Removed the requirement for inputting a trailing slash in the SharedIndexUrl setting value. This setting can now be configured with or without the trailing slash in the URL

  • Fixed an issue where any leading and trailing spaces present in addon setting values would break addon functionality. The addon will now handle these spaces if present to avoid errors

  • The addon will now check to ensure the SharedIndexUrl setting has been configured with a value and will display a configuration error message if this setting has been left blank

• v1.0.0:

  • Initial release

Configuration - Addon Settings

Addon settings are configured in the Manage Addons form in the ILLiad Client.

ReShare Configuration & Testing

Please contact your consortium for help acquiring the initial configurations and credentials listed below. If you have any questions concerning troubleshooting for installation, please contact Atlas Support (support@atlas-sys.com):

• SharedIndexUrl

Configuring Multiple Copies of the ReShare Client Addon

Users who are members of multiple consortia should configure a separate copy of the ReShare Client Addon for each consortium. For example, members of both PALCI and IPLC should configure two copies of the addon: one with the SharedIndexUrl setting configured to search the PALCI index and one with the SharedIndexUrl setting configured to search the IPLC index. To configure two copies of the ReShare Client Addon:

1. Download and install as many copies as needed of the ReShare Client Addon files according to the usual client addon installation process.

2. Open the Config.xml file for the first copy of the addon and modify the <Name>ReShare Client Addon</Name> element at the top of the file (line 2) to differentiate the copy by the consortium it will be configured to search (e.g., <Name>ReShare Client Addon - PALCI</Name>).

3. Save and close the Config.xml file.

4. Repeat steps 2-3 for each copy of the addon you have installed.

5. Open the ILLiad Client and use the System ribbon to navigate to the Manage Addons form. You should see multiple copies of the ReShare Client Addon (differentiated by the names configured in step 2) in the list of your installed addons.

6. Change the Name setting for each copy of the ReShare Client Addon to differentiate each copy of the addon you have installed by consortium (e.g., ReShare - PALCI).

7. Configure the SearchingMonitorQueue setting for each addon copy so that it matches the SearchingMonitorQueue setting that has been configured in the corresponding ReShare Server Addon copy installed for that consortium.

8. Configure the SharedIndexUrl setting so that each addon copy points to the proper consortium Shared Index URL.

9. Click Save Settings when you have finished configuring the settings for each addon copy.

Addon Workflow

To use the ReShare Client Addon, click the ReShare tab on the request form.

1. If the ReShare addon has been set to search automatically, it will search the ReShare Index using bibliographic data on the ILLiad request with the following precedence according to the SearchPriorityList setting. By default, the search order will be:

   1. By OCLC number if the ILLiad request has a value in the ESPNumber field (note that this field is displayed by default as OCLC Number on the ILLiad request form).

   2. If no results are found or if the OCLC number is not present on the ILLiad request, then it will search by ISBN/ISSN if the ILLiad request has a value in ISxN.

   3. If no results are found or if the ISBN is not present on the ILLiad request, then it will perform a Bib Search by title, author, and date using the LoanTitle, LoanAuthor, and LoanDate fields on the ILLiad request if the request type is Loan or using the PhotoArticleTitle, PhotoArticleAuthor, PhotoJournalYear fields if the request type is Article.
      Note that the Bib Search will only be performed if at least two of the three Title, Author, and Date fields contain information.

2. If the search is not set to start automatically or if none of the search types above return results during an auto search, you will see a blank page instead of a list of ReShare search results. In the case that an auto search returns no results, the label on the search results grid will display “No Auto Search Results”

3. If necessary, a manual search can be performed by clicking the OCLC Search, ISxN Search or Bib Search button on the ReShare ribbon. The criteria used for the search can be adjusted in the corresponding text box fields for each search type.

4. When a search is successful, the search results for the ReShare records found will display in the addon grid. Citation information for each ReShare record as well as the total number of holdings and the number of those holdings that are loanable will display for each record. The detailed record information in the ReShare public interface can be accessed by clicking the hyperlink in the ReShare Record URL column if more information is needed.

5. Once a record is selected in the grid, the Import Only button will be enabled for Borrowing, Lending, and Document Delivery requests. The Select and Select and Import buttons will be enabled for Borrowing requests only if the selected record is loanable (as indicated in the Lending Status column of the grid):

   1. Click the Import Only button to import the citation details from the ReShare record into the ILLiad request. The addon will switch the request form to the Details tab where the imported information must be reviewed and manually saved.

      1. The citation information imported will be the information present in the search results grid. The ReShare field used to populate the data in the columns in the grid and the ILLiad field to which each column will be imported is modifiable in the DataMapping.lua file.

   2. Click the Select button to send the request to the SearchingMonitorQueue from where the ReShare Server addon will pick up the request and submit it to ReShare for fulfillment using the record ID (GUID) from the ReShare record you selected.

      1. A history entry will be added to the ILLiad request noting which ReShare record was selected and used to submit the request to ReShare for fulfillment

   3. Click the Select and Import button to import the citation details into the ILLiad request and submit the request to ReShare for fulfillment according to the process for the Select button documented above. Note that when the Select and Import button is used to import citation details, the imported information will be automatically saved to the ILLiad request and cannot be reviewed before saving.

Data Mappings

Below are the default configurations for the ReShare addon. 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 search of the ReShare Shared Index and the fields used to import citation information into the ILLiad request from the selected ReShare record.

Source Fields

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.

Default Configuration

Citation Information Import

The information within this data mapping is used to configure which ReShare field is used to populate the citation data columns in the search results grid and which ILLiad field the information will be imported into when the addon is used to perform a citation data import. To modify the ReShare field used, the field name in the brackets as shown in the ReShare Field column should be changed to the name of the new field as it appears in the Shared Index API. To modify the ILLiad field used, the field name in the ILLiad Field column should be changed to the database name for the new field.

Default Configuration - Loan

Default Configuration - Article