Skip to main content
OCLC Support

Set up integration

  1. Last updated
  2. Save as PDF
Learn how to configure integration between ZFL-Server and WorldShare Circulation.

Before you begin

  1. Verify that the ZFL-Server instance can integrate with WorldShare.
    1. For more information, refer to Information for ZFL Administrators.
  2. Verify that the WorldCat Registry has an entry for every library that you borrow from or lend to via ZFL-Server.
    • The WorldCat Registry provides the Name, ISIL, and Shipping Address of the institution.
  3. Verify that your institution's OCLC symbol is not included in the list of identifiers in your branch-level Registry records. ZFL integration will fail if your OCLC symbol is an identifier at the branch level.
  4. Obtain the ZFL-Server host and port information from your ZFL administrator.

Add pickup location identifiers to the WorldCat Registry (Optional)

WorldShare Circulation's integration with ZFL-Server supports the AusgabeOrtNumerisch field for specifying a pickup location for a patron's borrowing (PFL) request. The pickup location is usually selected by the patron in the request form provided by the ZFL gateway.

If a pickup location is not specified in the SLNPFLBestellung message, WMS will use the requesting patron's home branch as the pickup location.

At this time, WMS accepts only branch-level International Standard Identifier for Libraries (ISIL) codes in the AusgabeOrtNumerisch field.

If ZFL will provide pickup locations to WMS, then the WorldCat Registry records for your pickup branches must include your branch-level ISIL codes so that WMS can map the ISIL to the correct WMS location in the patron’s hold request in WMS. For more information, see WorldCat Registry, Relationships and WorldCat Registry, Identifiers.

Allow branch-level request brokering by adding branch-level identifiers to the WorldCat Registry (Optional)

WorldShare Circulation’s integration with ZFL-Server supports request brokering at the branch level. For example, ZFL may submit a lending (AFL) request to your law library. If your law library is modeled as a branch in WMS, then the ISIL code that ZFL uses to represent the law library must be in the WorldCat Registry branch record for the law library as well.

WMS will automatically detect if a target ISIL provided by the ZFL-Server is a WMS institution or branch and will process the request accordingly. When sending messages back to ZFL, WMS will provide the ISIL that ZFL-Server provided in the initiating message.

ZFL request processing in WMS will not change if the ISIL provided by ZFL is at the branch or institution level. For example, a ZFL request submitted to your law library branch’s ISIL may be fulfilled by any item in your institution’s collection, according to your usual hold policies; fulfillment will not be limited to items held at the law library.

If ZFL will broker requests at the WMS branch level, then the WorldCat Registry records for your branches must include your branch-level ISIL codes so that WMS can map the ISIL to the correct WMS institution. For more information, see WorldCat Registry, Relationships and WorldCat Registry, Identifiers.

Add your branch-level ISILs to the WorldCat Registry

For more information, see WorldCat Registry, Relationships and WorldCat Registry, Identifiers.

  1. In OCLC Service Configuration, go to WorldCat Registry > Relationships.
  2. Click on the link for the branch location you want to update.
  3. From the Profile Summary dialog box, click on Select this record. Your Service Configuration session is now pointed at the selected branch.
  4. In the left navigation menu, click on Identifiers.
  5. Select ISIL from the Identifier Type menu.
  6. Enter your branch's ISIL code in the Identifier entry box.
  7. Click Save.
  8. To add an ISIL to another branch, click Relationships in the left navigation menu.
  9. Click on the link for your institution's name.
  10. In the dialog box, click on  Select this record. Your Service Configuration session is now pointed at your institution.
  11. Repeat steps 2 - 10 until you have added an ISIL to all the branches that will serve as pickup options for your patrons.

Borrowing configuration

Determine the Item Holding Location and Shelving Location to be used for temporary items created in WorldShare Circulation.  This will determine which Circulation policies will be invoked for ILL requests as well as the where items must be checked in to fulfill holds and trigger the Return message to ZFL-Server at the end of the patron's loan period.  This location will be entered into the ILL Settings section of the WorldShare Circulation module of the Service Configuration in the final step of enabling integration.

 Note: Most temporary items will be created with the material format of Other.

Borrowing policy considerations

 

Policy Considerations
Circulation Notification Policy

Determine which notifications to send to patrons.

Circulation notices:

  • Bill Notification
  • Hold Pickup Notification
  • Hold Shelf Expiry Notification
  • Loan Overdue Notification
  • Recall Notifications

Loan Policy

Long Overdue Policy

Loan Policy Map

 Determine billing, loan periods, renewals, and recalls for ILL items.

Hold Limit Policy

Hold Limit Matrix

 Determine the number of items that can be placed on hold for your patrons.

Hold Request Policy

Hold Request Policy Map

Determine how long hold requests remain active and the holds forwarding policy for libraries with multiple locations or branches.

 Note: Circulation will not notify ZFL-Server if a borrowing hold expires.

Hold Fulfillment Policy

Hold Fulfillment Policy Map

 Determine pick-up notice and hold shelf expiration date for ILL items.
Hold Pickup Locations Map

ZFL integration uses the requesting patron’s home branch as the pickup location for hold requests.

Ensure that holds created by ZFL have valid pickup locations by including a row in the Hold Pickup Locations Map where the Holding Location and Shelving Location are the values used for temporary ZFL items and all patron home branches are represented in the Default Pickup Locations and/or Alternatives Pickup Locations.
Collection Type Policy Determine item availability, hold fulfillment availability, and the reshelving period for items in your Item Holding Location and Shelving Location to be used for temporary items.

 

Lending configuration

Create a patron account in order to check-out materials that will be lent to other institutions.

  1. From the Admin module, click on User Management and select New User.
  2. Enter the required information: Barcode, Patron Type, and Home Branch.
    • Patron Type can be used to impact how policies are mapped.
    • The Home Branch will be set as the pickup location for holds.  This is where items must be checked in prior to checkout to trigger the Shipped message to ZFL-Server.
  3. Optional. Enter an email address associated with a staff account to receive notifications about lending requests.

When lending materials, you will use this account to check out your items to borrowing libraries.  When viewing the item in WorldShare Circulation, the Item Details will include the AFL number and the borrowing institution for additional reference.

Configure integration with ZFL-Server to accept alternative title identifiers in lending requests 

Allow your union catalog to submit lending requests to WMS without requiring an OCLC number to identify the request by storing non-OCLC title identifiers in your WorldCat records via the 029 $ab (Other System Control Number) field.

By default, WMS will only accept lending requests from ZFL if an OCLC number is provided in the SLNPFLBestellung AFL message.

To use an alternative title identifier, ensure that title identifiers have been loaded into WorldCat bibliographic records as 029 $ab. It is highly recommended to update WorldCat frequently to add new title identifiers and to remove any duplicate or invalid identifiers from records that you no longer hold or that have been assigned to a new title identifier in your union catalog.

 Notes: 

  • If more than one WorldCat record contains a 029 that matches the title identifier specified by the ZFL request, then WMS will place the request on the WorldCat record that is currently held by your institution. Consider enabling fulfillment using variant records in your WorldShare Circulation configuration to allow any item cataloged in the same edition cluster to fulfill the request. Refer to Holds and Schedules, Settings for more information. 
  • Other system control numbers can be found in WorldCat by searching the on: index. 

When your title identifiers are loaded into WorldCat, update your ZFL-Server integration configuration in OCLC Service Configuration by selecting Other System Control Number (029 $ab) for the new Title Identifier Type option. Refer to ILL Settings. 

  • At this time, you may only specify one OCLC library identifier. WMS will only accept title identifiers from one union catalog for processing ZFL lending requests. Similarly, WMS cannot accept a mix of OCLC numbers and other system control numbers; all lending requests must use the same title identifier type.

Lending policy considerations

Policy Considerations
Circulation Notification Policy

If desired, set up notifications for overdue materials to go to the patron account setup for borrowing institutions.  

Circulation notices will be sent to the email address included on the institution patron account set up by your institution.

  • Bill Notification
  • Loan Overdue Notification
  • Recall Notification
     
Patron Type Policy

You may wish to create a new Patron Type Policy specifically for the ZFL-Server lending account.

 Note: All limits should be set to No Limit to avoid the account being blocked.
Hold Priority Determine the hold priority for the patron type created for lending to borrowing institutions.

Hold Limit Policy

Hold Limit Matrix

 Determine the number of items that can be placed on hold for your patron account created for borrowing institutions.

Hold Request Policy

Hold Request Policy Map

Determine how long hold requests remain active and the holds forwarding policy for libraries with multiple locations or branches.

 Note: Circulation will not notify ZFL-Server if a lending hold expires.
Hold Pickup Locations Map

ZFL integration uses the borrowing institution account’s home branch as the pickup location for hold requests.

Ensure that holds created by ZFL have valid pickup locations by including a row in the Hold Pickup Locations Map where the Patron Type is the type selected for borrowing institution accounts and the accounts’ home branch is included in the Default Pickup Locations or Alternatives Pickup Locations.

 

Loan Policy

Loan Policy Map

 Determine billing, loan periods, renewals, and recalls for ILL items.

Enable integration

After completing the above steps, enable ZFL-Server integration.

 Caution: Activating features on this page is the final step.  The integration will be active based on the configured settings after this page is saved.

  1. Navigate to the WMS Circulation module of the OCLC Service Configuration. 
  2. Select Integrations and then ILL Settings and locate the ZFL section.
  3. Select Yes under Enable.
  4. Enter the Borrowing Institution Patron Barcode.
  5. Enter the information for Specify accounts per Borrowing ISIL to place holds and manage loans for AFL lending requests with one WMS user account per borrowing library. It supports both institution-level and branch-level ISILS.
    • Enter the Borrowing ISIL and the Patron Barcode. 
  6. Specify the Temporary Item Holding Location and the Temporary Item Shelving Location.
  7. Enter the Hostname and Port for the ZFL-Server.
  8. Select the Title Identifier Type. Options include:
    1. OCLC Number
    2. Other System Control Number (029 $ab)
  9. Specify the OCLC Library Identifier (029 $ab) that has been stored in your WorldCat records.
    • At this time, you may only specify one OCLC library identifier. WMS will only accept title identifiers from one union catalog for processing ZFL lending requests. Similarly, WMS cannot accept a mix of OCLC numbers and other system control numbers; all lending requests must use the same title identifier type.
  10. Determine whether to automatically bill a patron who has created a new borrowing request by selecting Yes for Patron Fees. 
    1. Complete the policy mapping table to specify the bill reason and fee amount by patron type.
      • When ZFL instructs WMS to create a patron hold request, the system will evaluate the rows in the map in this order until a match is found:
        1. Top to bottom (rows)
        2. Left to right (settings in rows)
          1. Top to bottom (rows)
          2. Left to right (settings in rows)
      • When the system comes to the row that matches the requesting patron's current patron type, it will attempt to create a bill using the bill reason and amount specified in the table and will not continue to the next row.
      • The patron will not be billed for a ZFL request if patron billing is currently disabled, if no match is found in the mapping table, or the amount specified in the mapping table is 0.00. 
      • When configuring the Patron Fees map, it is recommended to:
        1. Create entries for specific patron types at the top of the map.
        2. Have a row at the bottom of the map to cover all other patron types, if needed.
      •   Note: The system will determine if a patron should be billed for a ZFL request when the ZFL-Server submits a SLNPFLBestellung PFL messages to WMS. Patrons with existing PFL requests will not be billed retroactively after your library enables the Patron Fees option. In the same way, existing bills for PFL requests will not be updated or cancelled if your library disables patron billing.
      • Patron Fees table for ZFL Integration:
        • Field Description
          Patron Policy

          Choose the Patron Type that should be billed when a new ZFL borrowing (PFL) request is created. 

          Select the All option to bill all patron types not already specified in the rows above this entry in the mapping table.
          Bill Reason

          Indicate the Bill Reason should be used when creating the ZFL request fee.

           Note:  The bill reason policy must be set to Applies to anything under the Associated With setting.  
          Fee Amount    

          Indicate the monetary amount that a patron should be charged for a ZFL request fee.

          If you do not want to assess a patron bill in certain cases, you can set the amount to 0.00. 
  11. Click Save.