Didn't find what you were looking for?

Email questions or documentation suggestions to info@projectreshare.org.

WorldShare Management Services (WMS) integrations

Owned by Kristen Wilson
Last updated: Aug 09, 2023 by Julie Nye
3 min read

Note that OCLC’s WMS product uses a fundamentally different model for integration than other LMSes that work with ReShare. WMS requires the use of an API key and secret for access. Due to this difference, WMS has its own settings page that is used in conjunction with some of ReShare’s standard settings.

NCIP

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, was added in ReShare 1.11 (May 2023).

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

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

    1. Set each of the services you wish to use to “NCIP.”

    2. Set the Accept Item method to “none.”

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

  2. 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 Table.

      3. NCIP to agency: This is the same value as the from agency value described above.

      4. NCIP server address: This value is the same for all WMS users: https://circ.sd00.worldcat.org/ncip.

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. 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 your institution's registry ID.

      3. NCIP to agency: This value 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.

Z39.50

WMS does not support catalog searching via Z39.50. Some service providers may be able to provide you with an alternate method of cataloging searching to support the auto-responder.

WMS users do not need to populate the Z39.50 settings in ReShare. All information will be part of the WMS settings page.

WMS settings

WMS requires unique settings not shared with any other LMS. The information needed to populate these settings is typically provided directly to your ReShare service provider by OCLC.

Service providers can configure the WMS settings by completing the following steps:

  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: 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 is your institution’s registry ID.

 

Operated as a Community Resource by the Open Library Foundation