Didn't find what you were looking for?

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

Resource Sharing Settings

Resource sharing settings control aspects of the ReShare system that relate to the Request and/or Supply apps.

Table of contents

Auto-responder settings

Setting

Description

Values

Setting

Description

Values

Cancellation auto-responder

Automatically responds to requests for cancellations on the supplier side.

  • On: Approves all cancellation requests as long as the request has not yet shipped. Requests that have shipped will require manual attention.

  • Off: No automatic approvals will be sent. All cancellation requests will require manual attention.

Local request auto-responder

Automatically responds to requests for items that are held locally

  • On: If the requested title is locally available the request is assigned a state of “Requires review - locally available” Staff will need to manually respond with either “fill locally” or “cannot supply”. If staff respond “cannot supply” the request will go to the next lender in the rota or if no other lenders exist to the end of rota.
    If the requested title is not locally available the system will attempt to find another lender. If no lenders can be located the request will go to end of rota.

  • Off: No automatic “cannot supply” responses will be sent, all requests will require manual attention.

Auto-responder status

The auto-responder will respond to new requests based on a real-time availability check of your local ILS.

  • Off: No auto-responses will be sent and you will need to provide a manual response to each request.

  • On - will supply only: If an item is available, ReShare will automatically send a “will supply” message on your behalf. If no item is available, you will need to provide a manual response.

  • On - will supply and cannot supply: If an item is available, ReShare will automatically send a “will supply” message on your behalf. If no item is available, ReShare will automatically send a “cannot supply” message.

Is responder stale request processing enabled or not

If enabled stale request processing will respond with a Not Supply, if the pull slip has not been print within the configured number of days

  • Yes: Stale request processing is enabled

  • No: Stale request processing is not enabled

The number of days that a request is considered as being stale

The stale request processing happens just after midnight (local time), so if a value less than 1 is entered you only have that day to process it, otherwise a value greater than 1 you will have that full number of days to process it before it will be considered stale

  • Number. The default is set to 3 days.

Do we exclude weekends when we determine if a request is stale or not

Libraries quite often do not work on weekends when supplying material to other libraries, so if we do not exclude weekends when determining if a request is stale or not the request may become stale before the supplying library has had a chance to look at the request

  • Yes: Weekends are excluded when determining if a request is stale or not

  • No: Weekends are not excluded when determining if a request is stale or not

Chat settings

Setting

Description

Values

Setting

Description

Values

Auto-mark as read

Controls the behavior messages in the chat pane.

  • On (default): Chat messages will be automatically marked as read upon being opened. Messages can be manually returned to an unread state using the action menu in the chat pane.

  • Off: Chat messages will be left in unread state until they are manually marked as read using the action menu in the chat pane.

Custom ISO 18626 settings

Setting

Description

Values

Setting

Description

Values

Loan conditions

Loan conditions can be applied to a request by the supplier using the add condition action. ReShare includes a default list of loan conditions provided by the ISO 18626 standard.

  • Use in library only

  • No reproduction

  • Signature required

  • Special collections supervision required

  • Watch over use in library only

The library can add additional custom reasons to this list. For less common situations, the “other” category can be used, along with an accompanying note.

Cannot supply reasons

A cannot supply reason can be added by the supplier when using the respond "cannot supply" action. ReShare includes a default list of reasons.

  • Incorrect item

  • Missing

  • No longer available

  • Other

The library can add additional custom reasons to this list. For less common situations, the “other” category can be used, along with an accompanying note.

Host LMS integration settings

Setting

Description

Values

Setting

Description

Values

Host LMS integration

Allows the user to specify their LMS for local integrations.

An option is available for each of the supported host LMS integrations.

Accept item

When an item is received by the requesting library, ReShare will create a temporary record in the LMS and place a hold for the requesting patron.

  • NCIP: This integration will be performed using the NCIP protocol.

  • None: This integration is disabled.

Borrower check

When a new request is placed, ReShare will look up the patron in the LMS to ensure that they have a valid account.

  • NCIP: This integration will be performed using the NCIP protocol.

  • None: This integration is disabled.

Check in item

When a request is completed, ReShare will check in the item in the LMS.

  • NCIP: This integration will be performed using the NCIP protocol.

  • None: This integration is disabled.

Check in request when returned by patron

When a request is marked returned by patron, ReShare will check in the item in the LMS.

  • On: This integration will be performed using the NCIP protocol.

  • Off: This integration is disabled.

Check out item

When a request is filled, ReShare will check out the item in the LMS to an institutional patron account.

  • NCIP: This integration will be performed using the NCIP protocol.

  • None: This integration is disabled.

Host LMS item loan policies

These settings allow the user to manually add and/or update host LMS item loan policy codes used by the auto-responder.

Note: Not all LMS return item loan policies as part of their z39.50 holdings response.

Setting

Description

Values

Setting

Description

Values

Item loan policy

A description of the name of the host LMS item loan policy as provided by a Z39.50 auto-responder response.

This field will contain the same value as the item loan policy code returned by the Z39.50 auto-responder response when a new item loan policy is added to a tenant’s list. This field is editable and the default item loan policy can be changed to a more descriptive name if desired.

Item loan policy code

The name of the host LMS item loan policy as returned by a Z39.50 auto-responder response.

This field will contain the exact value returned by the Z39.50 response when a new host LMS item loan policy is added to a tenant’s list. Once added to the list by the auto-responder, this field will be non-editable.

If a user manually adds a host LMS item loan policy to the list, the value entered in this field must exactly match what is returned in the host LMS’s Z39.50 response in order to work.

 

Lendable?

Determines if items with the item loan policy are considered lendable in ReShare

A in this field indicates that an item loan policy is considered lendable.

An in this field indicates that the item loan policy is not lendable.

Actions

A control that allows the user to toggle an item loan policy to the edit view or remove the entry from the list.

  • Edit (pencil icon): Allows the item loan policy description and lendable? fields to be edited.

  • Delete (trash can icon): Allows the item loan policy to be removed from the list. If the item loan policy is associated with a request, the item loan policy will not be deleted but hidden from display. The next time the item loan policy is returned by the Z39.50 auto-responder response it will re-display in the list with the same settings it had before it was “hidden”.

Host LMS locations

These settings allow the user to add and/or update host LMS locations, supplying priorities and related directory entries to locations used by the auto-responder.

Setting

Description

Values

Setting

Description

Values

Host LMS location

A description of the name of the host LMS location as provided by a Z39.50 auto-responder response.

This field will contain the same value as the local location code returned by the Z39.50 auto-responder response when a new location is added to a tenant’s list. This field is editable and the default location can be changed to a more descriptive name if desired.

Host LMS location code

The name of the host LMS location as returned by a Z39.50 auto-responder response.

This field will contain the exact value returned by the Z39.50 response when a new host LMS location is added to a tenant’s list. Once added to the list by the auto-responder, this field will be non-editable.

If a user manually adds a host LMS location to the list, the value entered in this field must exactly match what is returned in the host LMS’s Z39.50 response in order to work.

Supplying priority

A supplying priority assigned to the location.

The field accepts a free text value. This value must be a number. See the Host LMS locations page for an explanation of supplying priorities.

An empty field (null value) indicates that the host LMS location was newly added to the tenant’s list. The location is considered requestable until updated by a staff user to indicate otherwise.

Related directory entry

A link to a directory entry that represents the host LMS location.

This field is populated via a drop down menu that lists all managed directory entries. See the Host LMS locations page for an explanation of related directory entries.

Shelving override

Indicates whether a shelving location override has been applied to the host LMS location.

A in this field indicates that a shelving location override has been applied to the host LMS location.

Actions

A control that allows the user to toggle a location to the edit view.

  • Edit (pencil icon): Allows the priority and related directory fields to be edited.

  • Save: Saves any changes made to the location.

  • Cancel: Discards any changes made to the location.

  • Delete (trash can icon): Allows the shelving location to be removed from the list. If the shelving location is associated with a request, the shelving location will not be deleted but hidden from display. The next time the shelving location is returned by the Z39.50 auto-responder response it will re-display in the list with the same settings it had before it was “hidden”.

  • Override: (three dots): Allows a shelving location override to be added/removed from the host LMS location.

Host LMS patron profiles

These settings allow the user to manually add and update requesting privileges by patron profile / patron type as returned in the NCIP LookupUser response.

Note: In Release 1.8 the check on patron profile will only occur when staff submit a request on behalf of patron through the Request app. Release 1.9 will support the validation of a patron’s profile / blocking of placing a request when a patron attempts to place a request through discovery (e.g. VuFind).

Setting

Description

Values

Setting

Description

Values

Patron profile

A description of the name of the host LMS patron profile as provided by the NCIP LookupUser response.

This field will contain the same value as the patron profile code returned by the NCIP LookupUser response when a new patron profile is added to a tenant’s list. This field is editable and the default code can be changed to a more descriptive name if desired.

Patron profile code

The patron profile code as returned by the NCIP LookupUser response.

This field will contain the exact value returned by the NCIP LookupUser response when a new patron profile is added to a tenant’s list. Once added to the list by the NCIP LookupUser response, this field will be non-editable.

If a user manually adds a patron profile to the list, the value entered in this field must exactly match the code that exists in the host LMS / returned in the NCIP LookupUser response in order to work.

Can create requests

Indicates whether patrons with this profile are allowed to place requests in ReShare.

A in this field indicates that the patron profile is permitted to place requests in ReShare.

An in this field indicates that the patron profile is not permitted to place requests in ReShare.

An empty field (null value) indicates that the patron profile was newly added to the tenant’s list. The patron profile is permitted to place requests in ReShare until updated by a staff user to indicate otherwise.

Actions

A control that allows the user to toggle a patron profile to the edit view or remove the entry from the list.

  • Edit (pencil icon): Allows the Patron profile, and Can create requests fields to be edited.

  • Save: Saves any changes made to the patron profile.

  • Cancel: Discards any changes made to the patron profile.

  • Delete (trash can icon): Allows the patron profile to be removed from the list. If the patron profile is associated with a request, the patron profile will not be deleted but hidden from display. The next time the patron profile is returned by the NCIP LookupUser response it will re-display in the list with the same settings it had before it was “hidden”.

Host LMS shelving locations

These settings allow the user to manually add and/or update supplying priorities to shelving locations used by the auto-responder.

Setting

Description

Values

Setting

Description

Values

Shelving location

A description of the name of the host LMS shelving location as provided by a Z39.50 auto-responder response.

This field will contain the same value as the shelving location code returned by the Z39.50 auto-responder response when a new shelving location is added to a tenant’s list. This field is editable and the default code can be changed to a more descriptive name if desired.

Shelving location code

The name of the host LMS shelving location as returned by a Z39.50 auto-responder response.

This field will contain the exact value returned by the Z39.50 response when a new shelving location is added to a tenant’s list. Once added to the list by the auto-responder, this field will be non-editable.

If a user manually adds a shelving location to the list, the value entered in this field must exactly match what is returned in the host LMS’s Z39.50 response in order to work.

Supplying priority

A supplying priority assigned to the shelving location.

The field accepts a free text value. This value must be a number. See the Host LMS locations page for an explanation of supplying priorities.

An empty field (null value) indicates that the shelving location was newly added to the tenant’s list. The shelving location is considered requestable until updated by a staff user to indicate otherwise.

Actions

A control that allows the user to toggle a shelving location to the edit view or remove the entry from the list.

  • Edit (pencil icon): Allows the priority and related directory fields to be edited.

  • Save: Saves any changes made to the location.

  • Cancel: Discards any changes made to the location.

  • Delete (trash can icon): Allows the shelving location to be removed from the list. If the shelving location is associated with a request, the shelving location will not be deleted but hidden from display. The next time the shelving location is returned by the Z39.50 auto-responder response it will re-display in the list with the same settings it had before it was “hidden”.

Local NCIP settings

These settings provide the information ReShare needs to interact with the local library management system using the NCIP protocol.

Setting

Description

Values

Setting

Description

Values

NCIP app profile

The name of a profile configured within the local LMS to identify NCIP parameters specifically to be used for ReShare. The name of this profile will be defined locally and found within your local NCIP settings.

Free text

Format we expect the Due Date to be in

This field allows users to specify the format of the due date returned in the CheckoutItem response. Date formats vary by LMS.

[default] yyyy-MM-dd[ ]['T']HH:mm[:ss][.SSS][z][XXX][Z]

NCIP from agency

A code that defines the sender of an NCIP message. You must configure this within your local NCIP settings.

Free text

NCIP server address

The address of your local NCIP server. You should be able to get this information from your local NCIP settings or request it from your LMS vendor.

URL

NCIP to agency

A code that defines the receiver of an NCIP message. You must configure this within your local NCIP settings.

Free text

Use due date received from NCIP

A field that determines if the due date returned from the CheckoutItem response is used as the due date for the request in ReShare.

On

Off

Network

These settings allow users to control time variables for iso18626 messaging across tenants.

Setting

Description

Values

Setting

Description

Values

Maximum number of times we attempt to send the message before we error (0 means we just keep retrying)

 

default = 0

If we hit a network error, number of minutes before we try again

 

default = 10

Number of seconds before we give up waiting for a response, after sending a message

 

default = 30

 

Other settings

Setting

Description

Values

Setting

Description

Values

Cancellation reasons

A reason for cancellation can be added by the requester when cancelling the request. The reason for cancellation will be visible to the supplier as a note. ReShare includes a default list of reasons.

  • Duplicate request

  • Requested item is locally available

  • User account is invalid

  • User requested cancellation

The library can add additional custom reasons to this list.

Pull slip notifications

These settings allow the user to create one or more delivery profiles for notifications of new pull slips available for printing. Each delivery profile includes the following fields:

Setting

Description

Values

Setting

Description

Values

Name

A human-readable label for the profile. Profiles will be sorted alphabetically by name.

Free text

Active status

This status determines whether or not notifications will be sent for a particular profile. Profiles can be disabled temporarily as needed.

  • Active

  • Inactive

Days

One or more days of the week on which the notification will be sent.

M, Tu, W, Th, F, Sa, Su

Times

One or more times of day at which the notification will be sent.

Time

Locations

One or more item locations for the pull slip notification. This setting enables notifications to be grouped and delivered to the correct location.

A dropdown menu will be provided and populated with any locations that have been associated with a filled request.

Email addresses

The email recipient(s) of the pull slip notification.

Email address

Request defaults

Setting

Description

Values

Setting

Description

Values

Default requester symbol

Libraries can store one or more symbols on their directory entries. This field tells the ReShare system which symbol should be sent by default as part of the messaging between requester and supplier.

ReShare defaults to using the ISIL symbol. Libraries using this symbol do not need to populate this field.

NAMESPACE:SYMBOL

Ex: OCLC:STH

Lenders of last resort

Defines one or more lenders of last resort that will be appended to the end of all lending strings.

Comma separated list of symbols

Request ID prefix

A prefix that will be added to the beginning of each request ID for which the library is the requester. Common practice is to use the default lending symbol followed by a dash.

Ex: PMILS-

Request routing

These settings allow the user to select and configure the way that the suppliers are selected and ordered when a rota is created.

Setting

Description

Values

Setting

Description

Values

Routing adapter

Each routing adapter uses a different source to gain access to a set of possible suppliers and determine their inclusion and order in the rota.

  • FOLIOSharedIndex: This adapter uses the FOLIO-based Shared Inventory application that has been developed for ReShare. When the shared inventory integration is used, ReShare will select suppliers based on lendable holdings, then order them using the ratio-based load balancing process. Note that to use the Shared Inventory integration, you must also configure the shared index setting as described below.

  • Static: This adapter uses a static rota that is defined using the “static rota” setting described below.

Static rota

This field allows the user to define an ordered list of suppliers that will be used to create a static rota.

This field accepts a comma-separated list of symbols in the format: SYMBOL:authority:symbol.

Example:

SYMBOL:ISIL:US-RST3,SYMBOL:ISIL:US-RST2,SYMBOL:ISIL:US-RST1

Shared index settings

These settings provide the information needed for ReShare to connect to the shared index used by your library to provide consortial availability information. These settings will be provided to you by your consortial administrator or ReShare service provider.

Setting

Description

Values

Setting

Description

Values

Shared index base URL

The location of your shared index

 

Shared index username

The user name of an admin account that can be used to access your shared index

 

Shared index password

The user password of an admin account that can be used to access your shared index

 

Shared index tenant

The tenant name for your shared index

 

State/action configuration

These settings allow users to combine two state changes/actions in one step.

Setting

Description

Values

Setting

Description

Values

Combine supplier actions 'fill request' and 'mark shipped'

Allows users to fill a request and mark it shipped in one step.

  • Yes: Enables combining of the two actions in one step

  • No (default): Fill request and marked shipped remain separate actions

Combine requester actions 'mark returned by patron' and 'mark return shipped'

Allows users to mark a request returned by patron and marked return shipped in one step.

  • Yes: Enables combining of the two actions in one step

  • No (default): Mark returned by patron and mark returned shipped remain separate actions.

WMS settings

OCLC’s WMS has several unique settings not used by other systems. These settings are grouped here. They can be ignored by non-WMS users.

Setting

Description

Values

Setting

Description

Values

API key

WMS users must request an API key (or WSKey, in OCLC parlance) to grant ReShare access to its APIs. The API key is stored in this field.

 

API secret

OCLC’s API keys are accompanied by API secrets. The API secret functions like a password, so ReShare will hide the text for this value. Please store this information somewhere safe.

 

Lookup patron endpoint

WMS does not support an NCIP-based patron lookup and instead relies on a proprietary Identity Management API. The endpoint for this API is stored here.

 

Registry ID

Calls to OCLC’s Identity Management and NCIP APIs require a registry ID. This ID will be provided to you when you request an API key for one or more OCLC APIs.

 

Z39.50 settings

Setting

Description

Values

Setting

Description

Values

Z39.50 server address

This is the address of the Z39.50 server associated with your local library management system. Your LMS vendor should be able to provide this information for you.

 

 

 

 

 

 

 

 

Operated as a Community Resource by the Open Library Foundation