Skip to main content
OCLC Support

Modernized interface: Download and use the offline client

Learn how to download and use the offline circulation client to perform circulation transactions while the WorldShare Circulation system is unavailable.

The offline client is a downloadable desktop application that allows you to track items that you check out and items that patrons return to the library while WorldShare Circulation is not available or while your library is unable to connect to WMS. These offline transactions can be uploaded when you connect to WMS again.

It is highly recommended that your library download the modernized offline client no later than June 2024.

 Caution:  The legacy offline client will continue to be supported through June 2024. However, after Circulation's April 2024 release, you will no longer be able to download the legacy client to fix issues with an expired WSKey, an invalid user-to-act-as, etc. If those problems occur, you will be unable to upload transactions that are pending in the legacy client.

Download and run the modernized Offline Circulation client

Download the new offline client from the OCLC Community Center before 30 June 2024:

The new client will run with Windows 10 or 11.  At this time, there is no version of the client for macOS or other operating systems.

After the download, a desktop shortcut will be created automatically. Pin the client to your taskbar to make it easier to run in a future session.

Important:  Uninstall the legacy offline client

Once you've downloaded and adopted the client, you may safely uninstall the legacy client from all workstations. This process will allow you to make sure no private data remains on your workstation.

 Caution:  Upload any pending transactions in the legacy client before 21 April 2024.  Do not delete the legacy client until you are sure that all pending transactions have been successfully uploaded or are no longer relevant.

To fully uninstall the legacy client, find and delete the following folders and files:

  • wms-offline-circulation.jnlp
    • File that you execute to run the legacy client
  • derby.log
    • Database for the legacy client
  • All program files in the wms-offline-circ folder
    • Default location is usually C:\Users\jsmith\wms-offline-circ

After completing the steps above, Java can be removed from the workstation if it is not needed for any other applications.

 Note:  Assistance from your IT department may be required for some of the uninstall procedures.

Customize the offline client interface

Within the offline client, customize your screen using the following features:

  1. Change the size of the font and other elements by zooming in or out. Click View in the top toolbar and select either Zoom In or Zoom Out.  Youcan also zoom in or out by using Ctrl ++ or Ctrl --.
  2. The OCLC footer can be hidden to make more room on the screen to see transactions.  Click on the down arrow to hide the footer and click on the up arrow to bring it back again.
  3. The list of transactions can be filtered by upload status and columns can be hidden and then reset by using the three buttons on the right side of the Checkout and Check In screens.

worldshare_circulation_offline_client.png 

Check out items

To check out items to a patron, follow the directions below:

  1. Open the offline client.
  2. Click the Checkout tab in the upper left corner of the screen.
  3. Enter the Patron barcode and Item barcode
  4. Use the calendar widget or manually type the due date and time in the Set due date field.  

     Note:  The system remembers the first due date chosen and retains that for all subsequent checkouts.  It will clear once you change tasks or tabs.

  5. Click the blue Check out button. Items will be added to the table with a status of Upload pending.
  6. Once you connect to WorldShare, Upload transactions

The transactions will remain on the Checkout and Check In screens until you clear them or uninstall the client.  Refer to Clear transactions

Check in items

To check in items, follow the directions below:

  1. Open the offline client.
  2. Click the Check In in the upper left corner of the screen.
  3. Enter the Item barcode

     Note: This capability is for items that were previously on loan.  It cannot be used for checking in items from the Pull List and processing Holds, nor can it be used to check in items that are in transit to your location.  The items must have the status of On Loan, Claimed, or Missing. 

  4. Click the blue Check in button. Items will be added to the table with a status of Upload pending.
  5. Once you connect to WorldShare, Upload transactions

The transactions will remain on the Checkout and Check In screens until you clear them or uninstall the client.  Refer to Clear transactions

Upload transactions

When you connect to WMS and you are ready to upload your transactions:

  1. Select your institution and log in.
  2. Click on Upload transactions in the upper left corner of the screen after you have checked out or checked in some items.
  3. Next, click the  Log in button to open the Select an Institution dialog box:
  4. In the Select an Institution dialog box, identify the institution with which you are affiliated by typing your institution's OCLC symbol, name, or zip code in the Search Query box. 
  5. Once your institution shows up in the box, click Continue.
    • After identifying your institution, the client will remember this and each subsequent time you upload transactions, you will be able to choose to stay with this same institution or change institutions if you are affiliated with more than one.
  6. Follow the prompts to sign in using the staff account you use for WorldShare Circulation. 
  7. After successful authentication, you will be returned to the offline client. 
    • The client supports logging in with any of the authentication methods your library uses for the WorldShare staff interface. If your library has more than one identity provider (IdP), you will be asked to select your authentication method first. 
  8. After logging in, select the branch where the transactions were processed from the pull-down list and click Start upload.  The upload action will process everything in date/time order.
  9. As transactions are processed, a progress screen will appear, indicating the number of successful, and any unsuccessful, transactions. 
    • If a transaction has failed, the reason will be indicated under the Upload status column.  You may choose to investigate your failed transactions further once you are connected to WorldShare Circulation.
    • Only unsuccessful transactions will be visible in the table. 
  10. Once upload progress has reached 100%, the client will display summary information about all the transactions processed.  
    • The client will provide a count of the transactions successfully processed out of the total number of transactions attempted.
    • The client will provide a count of failed transactions that can be retried later out of the total number of failed transactions.
    • The client will only retry failed transactions if there was a problem connecting to WMS when the upload was attempted.  
  11. When processing is complete, you may click the Start Over button in the bottom left corner of the screen if there were any failed transactions that can be retried, or, if you have processed additional loans. 
  12. When finished processing transactions, close the client or log off without losing any pending transactions or the status of uploaded transactions.  Even transactions that have been successfully uploaded will remain on your Checkout and Check In screens until you clear them.  

View the status of each transaction by reviewing the list in the  Checkout or Check In  screens, including all successfully uploaded transactions. 

Clear transactions

Transactions can be cleared from either the Check In or the Checkout screen.  You may want to clear transactions after a successful upload to ensure that sensitive patron information is no longer visible in the client after it is no longer needed for processing.

To clear transactions:

  1. Click on Clear transactions at the top of the table.
  2. Choose one of the following:
    •  Clear all: To clear all transactions listed.
    • Clear successful: To only clear those that were uploaded successfully.
    • Clear failed: To clear those transactions that failed to upload. 

      You will be asked to confirm your choice before the transactions will be cleared.

Log out

When you are finished processing transactions, close the client or log off without losing any pending transactions or the status of uploaded transactions.  Even transactions that have been successfully uploaded will remain on your Checkout and Check In screens until you clear them or uninstall the client.  

OCLC recommends deciding your library's procedure in advance for logging out or closing the client to adhere to any local guidelines for managing patron data.