Doorgaan naar de website
OCLC Support

SIP2 IP Address

  1. Laatst bijgewerkt
  2. Opslaan als pdf
Use this screen to register the IP addresses of your SIP2 clients for communication with the server.

To access this screen, sign in Service Configuration, open the WMS Circulation left navigation, select Integrations, and then select the SIP2 IP Addresses link.

Use this screen to register the IP addresses of your SIP2 clients for communication with the server.

  • To create a new policy, you must first configure your SIP client's settings on the SIP2 Configuration screen.
  • The IP addresses that you enter on this screen must be static, routable, and have access to the Internet.

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)

Add a new IP address

  1. Click  Create New to add a new IP address.
  2. Fill in the fields in the order below:
    1. IP Address: The IP address that is granted access to the SIP2 service.
      • The IP address must be static, routable, and have access to the Internet.
      • This value cannot be changed once it has been entered.
      • To change an IP address, you need to delete the row and enter the new value into a new row.
      • You can use the same IP address for multiple branches or institutions, but you also need to enter a Login ID and Password. If you do not enter a Login ID and Password, then you cannot use the IP address more than once.
    2. Username/Password: A username and password are used to identify each SIP2 terminal if you have multiple SIP2 terminals at the same branch using the same IP Address. The username and password entered here must be the same as the username and password configured on the SIP2 terminal. The username and password will be used to confirm the initial Login Message (93).
      • Username:
        • The username (login user id) that will be sent from this SIP2 terminal as part of the initial Login Message (93).
        • If you do not enter a Login Id, then the IP address can only be used for one SIP2 terminal. You only need to enter a Login ID if you are using the same IP address for more than one SIP2 terminal.
      • New Password/Confirm Password: This option is shown when you create a new SIP2 IP Address record and should be populated with the password as configured on the SIP2 terminal.
      • Reset Password: Use this check box to display the New Password/Confirm Password fields for an existing SIP2 IP Address record if you need to enter a change to the password.
    3. Description: Optional text field to add a description of the IP address/SIP2 terminal.
    4. Branch: Indicates to which branch the policy applies. 
      • This should be the home location of the SIP2 terminal and will be used to decide if an item needs to be set In Transit to another branch.
    5. Vendor: The vendor of your SIP2 client.
      • Bibliotheca and Envisionware are supported vendors and can be selected from the list.
      • If your SIP2 client is not from a supported vendor, select default.
    6. Character Encoding: Select the character encoding to use when displaying characters on SIP2 enabled devices. Reset your device's connection to WMS for configuration changes to take effect. The SIP2 Client must send a valid Login message to WMS and may require that you reboot the client to start a new session.
      1. IBM850 (Default): Character encoding required by the SIP2 standard. Supports most characters used by western European languages.
      2. UTF-8: Enhanced encoding that supports all Unicode characters.
        • Contact your vendor(s) for assistance configuring your machine if UTF-8 is supported.  Additional character sets may need to be enabled for your SIP2 client.  
    7. Group Resolution: The level at which Patron and Item data is resolved when using the SIP2 Client.
      1. Select this option to enable group functionality for your applications using SIP2 to communicate with WMS.  If selected:
        • Patrons of any member of your group can access and use your SIP2-enabled services
        • Items owned by any member of your group can be viewed, checked out, and checked in
        • Patrons can checkout temporary items created via interlibrary loan (ILL) integration
      2. If not selected (default):
        • Allows only patrons and items associated with the SIP2 client's institution to be recognized. All other transactions will fail with an appropriate screen message.  See SIP2 Custom Messages for message configuration information.  
    8. Receive Shelf-Ready Order Items: Select this option to automatically receive new, shelf-ready monographs that were ordered in WorldShare Acquisitions. When this setting is enabled and an item is checked in and not found in the catalog, the system will search for a shelf-ready order item in WorldShare Acquisitions. To use this feature, your library will need:
      1. MARC or EDIFACT shelf-ready data which provides the item's holding location, shelving location, call number and piece designation to WorldShare Acquisitions.  See Import invoice and shelf-ready data from MARC file and Import shelf-ready data from EDIFACT file for more information.
      2. A SIP2 client capable of submitting a Check In message to WMS, a RFID- enabled bookdrop, or a self-service kiosk that accepts returns.

        If the order is found:
        1. The item is received in WorldShare Acquisitions.
        2. The item record is added to WorldCat.
        3. A hold is created if any patron is selected as the Requestor of the ordered item.
        4. The item is checked into WorldShare Circulation.
        5. A check-in response is provided to the SIP2 client with directions for how to proceed with the item. See SIP2 Configuration, supported messages.
    9. Due Dates with Timestamps: Select this option to allow library users to see the exact due date and time of their loans when interacting with your services that are integrated with the SIP2 protocol. When enabled, WMS will provide a formatted date and time in the AH field in the following messages:
      • Checkout Response (12)
      • Item Information Response (18)
      • Renew Response (30)

        Due date information provided in the AH field is formatted to reflect the language and locale specified by the client in the relevant Patron Status Request (23) or Patron Information Request (63). If no language has been specified, WMS will format the date and time using your library's language and locale set in the Currency and Locale setting of the WorldCat Registry. 
    10. Block checkout if holds are pending: The setting is selected by default. Select this setting to prevent library users from checking out an item from the collection that is needed to fulfill a pending hold request from a different patron.  This setting only applies to checkouts attempted via SIP2 from the specified IP address.

      • The setting also does not apply in the following scenarios:

        1. The item is needed to fulfill a hold for the patron attempting the checkout. The patron will be able to check out the item and the hold will be fulfilled and removed from the queue. 
        2. The item is needed to fulfill an upcoming item schedule. Library staff must assist the patron with the checkout.
        3. The item is already reserved for a different patron. Library staff must assist the patron with the checkout.
        4. The patron attempts to renew an item that they already have on loan when that item is needed to fulfill a hold or item schedule for another patron. Library staff must assist the patron with the renewal.
    11. Click Save.