SIP2 Configuration

Policy settings

Use this section to set up additional settings for your SIP2 client.

Policy settings fields:

Supported Messages

Select an option from each drop-down menu to indicate which messages are supported by your SIP2 client.

• Some SIP2 messages can be protected by patron authentication.
  • SIP2 patron authentication is an optional configuration that requires individual library users to provide their circulation barcode and a valid password or PIN to complete specific actions via SIP2.
  • SIP2 patron authentication is only available to WMS libraries using WMS Authentication or an LDAP service. WMS will verify the user by their circulation barcode and password. For all other IdPs, please contact OCLC Support for information about loading user PINs.
  • If your institution has enabled PIN management, the Change PIN option will appear under the Profile tab in My Account allowing users to change their PIN directly. Refer to View Profile, PIN for more information. Refer to Patron PIN Settings to enable the Change PIN option.
  • The SIP2 connection must be encrypted to make use of patron authentication. If the connection is not encrypted, the WMS SIP2 Service will send back an error response.
  • SIP2 Messages that can be protected by patron authentication have three configuration options:
    • Enabled – Authentication Not Required: WMS will respond to this message.
    • Enabled – Authentication Required: WMS will respond to this message.
      • An error will be returned if the patron authentication fields are empty or fail validation. 
      • If the connection is unencrypted, WMS will respond with an error warning because of the unencrypted connection.
      • Patron authentication options vary depending on your identity provider (IdP):
        • If your library uses WMS Authentication or LDAP, your users can authenticate using their circulation barcode and either their password or WorldShare PIN.
        • If your library uses any other IdP (e.g., Shibboleth, Azure, CAS, etc.), your users may only use their circulation barcode and WorldShare PIN to authenticate.
    • Disabled: WMS will not respond to this message.
• All other SIP2 Messages are not capable of protection by patron authentication and have two configuration options:
  • Enabled: WMS will respond to this message.
  • Disabled: WMS will not respond to this message.

• Supported Messages fields:

  Field	Description	Sip2 Message Configuration
  Patron Status Request	Indicates the client can send the Patron Status Message.	Enabled – Authentication Not Required Enabled – Authentication Required Disabled
  Patron Information	Indicates the client needs the Patron Information message to request additional information regarding a patron.	Enabled – Authentication Not Required Enabled – Authentication Required Disabled
  Checkout	Indicates the client serves in checkout mode.	Enabled – Authentication Not Required Enabled – Authentication Required Disabled
  Hold	Indicates the client supports sending of the Hold message.	Enabled – Authentication Not Required Enabled – Authentication Required Disabled
  Fee Paid	Indicates the client is configured to send the Fee Paid message.	Enabled – Authentication Not Required Enabled – Authentication Required Disabled
  Renew	Indicates the client supports the Renew message.	Enabled – Authentication Not Required Enabled – Authentication Required Disabled
  Renew All	Indicates the client can send a Renew All message.	Enabled – Authentication Not Required Enabled – Authentication Required Disabled
  Item Information	Indicates the client uses the Item Information message to request additional information about an item.	Enabled Disabled
  Item Status Update Service	Not implemented. This setting should be disabled.	Enabled Disabled
  ACS Status	Required. This setting should always be enabled.	Enabled Disabled
  Request SC Resend Service	Required. This setting should always be enabled.	Enabled Disabled
  Block Patron	Indicates the client can send a Block Patron message.	Enabled Disabled
  End Patron Session	Indicates the client is configured to send the End Patron Session message.	Enabled Disabled
  Login	Required. Indicates if you want to enable the Login service. This setting should always be enabled.	Enabled Disabled
  Offline Mode	Indicates that it is possible to use the SIP2 client in offline mode and upload all recorded transactions to WMS.	Enabled Disabled
  Checkin	Indicates the client serves in checkin mode.	Enabled Disabled

Bill Reason to Fee Type

This tab allows you to map the bill reasons you created on the Bill Reasons screen to SIP2 fee types.

1. Select a Bill Reason from the list.
2. Select a Fee Type from the list.
3. To add a row, click the Add button ().
4. To delete a row, click the Remove button ().

Payment Method to Payment Type

This tab allows you to map the payment methods you created on the Payment Methods screen to SIP2 payment types.

1. Select a Payment Method from the list.
2. Select a Payment Type from the list.
3. To add a row, click the Add button ().
4. To delete a row, click the Remove button ().

Sort Bins

When Use SortBin (CL) field in Checkin response is selected, it is possible to map Routing Reasons to a value to be set in the SortBin field of the Checkin response.

At check-in, the Sort Bins table will be read from top to bottom, left to right. If no bin value is found, CL will not be sent in the response.

• When the system comes to the row where all the elements match the transaction, it applies the policy contained in that row and will not continue to the next row. If no bin value is found, then the CL field will not be sent in the response.
• Put your most restrictive rows at the top of the map.
• Include a row at the bottom of the map to cover any exceptions or unexpected items by setting all values to All and specifying a bin for exceptions.

Sort Bin map example - Image

1. Select a Routing Reason from the list. Available values include:
   • Reshelve: Item should be returned to the shelf.
   • Hold: Item is needed to fulfill a patron hold request.
   • Schedule: Item is needed to fulfill an item scheduling request.
   • ILL: Item requires further processing in your interlibrary loan system.
   • Withdrawn: Item has been withdrawn from the collection.
2. Select an Item Holding Location from the list if:
   • Routing reason is Reshelve and items need to be sorted in a specific bin for local reshelving or routing to a different branch.
   • Routing reason is Withdrawn and items from certain collections need to be sorted in specific bins for processing.
3. Select an Item Shelving Location from the list if:
   • Routing reason is Reshelve and items in certain collections need to be sorted in a specific bin for reshelving.
   • Routing reason is Withdrawn and items from certain collections need to be sorted in specific bins for processing.
4. Select an Item Destination Branch if:
   • Routing reason is Hold or Schedule and items need to be sorted in a specific bin to be routed to other branches for pickup.

      Note: You must select All to sort items that should be reserved at the current branch or to route reserved items for pickup at other institutions in your circulation group.

5. In the Sort Bin column, enter text.
6. To add a row, click the Add button ().
7. To delete a row, click the Remove button ().

Material Properties

This tab allows you to configure which material formats are magnetic and can be sensitized and/or desensitized. Values within the tab are only seen after you have saved your policy for the first time.

Material Properties fields: