Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The original “WMS” adapter supported integrations for three of the four NCIP services used by ReShare: Check Out Item, Check In Item, and borrower check. The “WMS2” adapter, with support for Accept Item, and a true Lookup User service, was added in ReShare 1.11 (May 2023).

To configure NCIP for use with the original WMS adapter, complete the following steps.

...

To configure NCIP for use with the updated WMS2 adapter, complete the following steps.

...

  1. Configuration changes are required in your WMS application in order to support the creation of temporary item records. Please consult the OCLC support document, https://help.oclc.org/Library_Management/WorldShare_Circulation/Configuration/Integration_with_ReShare, in particular the “Set up integration” instructions. You should complete the WMS changes before making the changes described in steps 2-4 below in ReShare.

  2. Go to Directory and find the directory entry for your institution.

    1. Edit the directory entries that represent pickup location(s) associated with patron requests.

    2. Be sure the LMS Location Code field contains the 6-digit branch registry ID for that location. This code will be used by the NCIP Accept Item service to communicate the correct pick-up location when a hold is placed for your patron.

    3. For your main branch, this is the same 6-digit code you enter for the NCIP from agency, and the NCIP to agency in step #4 below.

    4. Other branch

      Branch registry IDs can be found in OCLC Service Configuration > WorldCat Discovery and WorldCat Local > Holding Codes & Shelving Location Messages > Holding Codes Translation Table.

  3. Go to Settings>Resource sharing>Host LMS integration settings.

    1. Set each of the services you wish to use – Accept Item, Borrower Check, Check Out Item, Check In Item – to “NCIP.”

    2. Decide whether you want to enable the option “Check in request when returned by patron”. (To use this option, you must also have Check In Item method = “NCIP”)

    3. Choose “WMS2” for the “Host LMS integration” field.

  4. Go to Settings>Resource sharing>Local NCIP settings.

    1. Populate each of the fields that appear on this page.

      1. NCIP app profile: This value is not used by WMS. You may enter a blank value or leave the system default.

      2. NCIP from agency: For WMS, this value will always be the branch registry ID of your main branch. Each institution can obtain this information by going to Service Configuration > WorldCat Discovery and WorldCat Local > Holding Codes & Shelving Location Messages > Holding Codes Translation Tableyour institution's registry ID.

      3. NCIP to agency: This is the same value as the from agency value described abovevalue will also be your institution's registry ID.

      4. NCIP server address: This value is specific for each WMS user, be sure to substitute your institution’s Registry ID: https://<registryId>.worldcat.org/ncip/circ-staff.

...

  1. Go to Settings>Resource sharing>WMS settings.

  2. Populate the following information.

    1. API key: This is a long alphanumeric string. It can be located in the OCLC developer portal for the service provider organization.

    2. API Secret: his is a short alphanumeric string. It can be located in the OCLC developer portal for the service provider organization.

    3. Connector address, username, and password: Connectors are a proprietary technology owned by Index Data that supports searching an OCLC catalog and returning Z39.50-like results. Index Data may provide this service directly to its customers or to other service providers. Index Data will supply these details when the service is in use.

    4. Lookup patron endpoint: The original WMS NCIP service did not support a true NCIP Lookup User service, so ReShare uses the WMS Identity Management API to return NCIP-like results when doing the borrower check. This value is specific for each WMS user, so substitute your institution’s Registry ID in the following URL: https://<registryId>.share.worldcat.org/idaas/scim/v2/Users/.search> .

    5. Registry ID: This value can be located in the OCLC developer portal for the service provider organizationis your institution’s registry ID.