Skip to main content
OCLC Support

SIP2 Configuration

Use this screen to specify the settings for your SIP2 client (such as a self checkout machine).

  • Settings can be configured for each library branch in your institution.
  • It is recommended to have a good understanding of your SIP2 client before configuration.

You need to contact OCLC Support if:

  • You are setting up SIP2 for WMS for the first time
  • You are establishing a SIP2 connection via the open internet (through an unencrypted (http) protocol)

Create or edit a SIP2 Configuration

  1. On the SIP2 Configuration screen, click Create New, or click the Policy Name you want to edit.
  2. On the Create New or Edit Policy screen, fill in the fields.
    • Policy settings: Use this section to set up additional settings for your SIP2 client.
      • Policy settings fields:
        Setting Description
        Send Personal Data in Patron Information Service

        When selected, the Patron Information Service will send:

        • Email address
        • Home address
        • Telephone number
        • Items on hold
        • Items unavailable
        • Items recalled
        • Items overdue
        • Outstanding fee

        Even if you do not select to send this personal data, patron name, barcode, number of items on hold, number of items unavailable, number of recalled items, and number of overdue items will always be sent.

        Available Hold Allowed

        Indicates if the client allows a hold to be placed on an item that is available.

        • Yes: Hold can be placed on an item that is available (not on loan). Hold can be placed on an item that is unavailable (checked out)
        • No: Hold cannot be placed on an item that is available. Hold can be placed on items that are unavailable.
        Use SortBin (CL) field in Checkin response

        Indicate if you want the value of the SortBin field to be set according to the Routing Reason of the Checkin transactions:

        • Yes: The Routing Reason to Sort Bin tab appears in Mapping section. The value of the SortBin field will be set according to the Routing Reason of the Checkin transactions.
        • No: SortBin field (CL) in the Checkin response will not be sent.
        Number of Retries Allowed

        The maximum number of retries before the connection is closed.

        • This number should be the same as the number specified in the client's configuration.
        Timeout Periods in Seconds

        Number of second the client should wait before the connection is determined to be unresponsive.

        • This setting may be ignored by some clients, as they prefer to use the value configured within the client settings.
        Terminal Location Optional text field to add a description of where the client is located.
    • Supported messages: Select an option from each drop-down menu to indicate which messages are supported by your SIP2 client.
      • Supported Messages fields:
        Field Description Required?
        Patron Status Request Indicates the client can send the Patron Status Message.  
        Patron Information Indicates the client needs the Patron Information message to request additional information regarding a patron.  
        Checkout Indicates the client serves in checkout mode.  
        Hold Indicates the client supports sending of the Hold message.  
        Fee Paid Indicates the client is configured to send the Fee Paid message.  
        Renew Indicates the client supports the Renew message.  
        Renew All Indicates the client can send a Renew All message.  
        Checkin Indicates the client serves in checkin mode.  
        Item Information Indicates the client uses the Item Information message to request additional information about an item.  
        Item Status Update Service Not implemented. This setting should be disabled.  
        ACS Status This setting should always be enabled. Yes
        Request SC Resend Service This setting should always be enabled. Yes
        Block Patron Indicates the client can send a Block Patron message.  
        End Patron Session Indicates the client is configured to send the End Patron Session message.  
        Login

        Indicates if you want to enable the Login service.

        • This setting should always be enabled.
        Yes
        Offline Mode Indicates that it is possible to use the SIP2 client in offline mode and upload all recorded transactions to WMS.  
    • Mappings: Use these tabs for connecting WMS categories to SIP fixed categories.
      • 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:
          Column Description
          Material Format As defined in the item's master record. For more information, see Material Type Names and Codes to determine how the master record provides material format.
          Magnetic Indicates if the material format is magnetic.
          Sensitize Indicates if the material will be sensitized when it is checked in.
          Desensitize Indicates if the material will be desensitized when it is checked out.
      • Routing Reason to Sort Bin: 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.
        1. Select a Routing Reason from the list.
        2. In the Sort Bin column, enter text.
        3. To add a row, click the Add button (Add button).
        4. To delete a row, click the Remove button (Remove button).
      • Payment Method to Payment Type: This tab allows you to map the payment methods you created on the Payment Method 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 (Add button).
        4. To delete a row, click the Remove button (Remove button).
      • Bill Reason to Fee Type: This tab allows you to map the bill reasons you created on the Bill Reason 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 (Add button).
        4. To delete a row, click the Remove button (Remove button).
  3. Click Save.
  • Was this article helpful?