Skip to main content
OCLC Support

Retrieve WMS data extract files with SFTP

Retrieve WMS data extract files for all inventoried items, current patrons for an institution, and patrons that have been modified over the last week using SFTP.

Introduction

This document provides detailed information about available WMS data extract files including:

  • Naming conventions
  • Frequency
  • Data outputs
  • Date restrictions

Reconciliation reports are placed on an SFTP server as delimited text documents that can be downloaded and imported into other software as needed. Report files are retained 90 days. Report files older than 30 days are subject to zipping. For more information, see Download files with SFTP.

Row limit

All reports can be used with Microsoft Excel, regardless of size; however, depending on your version of Excel, there may be a row limit per sheet. Consequently, several sheets are generated if a report exceeds the row limit.

Field names and order

Any fields (report columns) that have been added or field names that have been updated are identified in bold formatting. The field names are listed in the order that the columns appear in the report.

Circulation Item Inventories

Description: All inventoried items.
Frequency: Weekly (every Sunday)
Time (EST): 22:00
Date restrictions (UTC): None
Other restrictions: None

Output

Institution_Symbol

Item_Holding_Location

Item_Permanent_Shelving_Location

Item_Temporary_Shelving_Location

Item_Type

Item_Call_Number

Item_Enumeration_and_Chronology

Author_Name

Title

LHR_Item_Materials_Specified

Material_Format

OCLC_Number

Title_ISBN

Publication_Date

Item_Barcode

LHR_Item_Cost

LHR_Item_Nonpublic_Note

LHR_Item_Public_Note

Item_Status_Current_Status

Item_Due_Date

Item_Issued_Count

Issued_Count_YTD

Item_Soft_Issued_Count

Item_Soft_Issued_Count_YTD

Item_Last_Issued_Date

Item_Last_Inventoried_Date

Item_Deleted_Date

LHR_Date_Entered_on_File

LHR_Item_Acquired_date

Language_Code

File name examples

<OCLC Symbol>.Circulation_Item_Inventories.yyyymmdd.txt

Additional information: As of September 30, 2018, this report replaced the Item Inventories Report.

Circulation Patron Full

Description: All current patrons for an institution.
Frequency: Weekly (every Sunday)
Time (EST): 23:00
Date restrictions (UTC): None
Other restrictions: None

Output

Inst_Symbol

Patron_Given_Name

Patron_Family_Name

Patron_Gender

Patron_Date_of_Birth

Patron_Barcode

Patron_Borrower_Category

Patron_Home_Branch_ID

Patron_Street_Address1

Patron_Street_Address2

Patron_City_or_Locality

Patron_State_or_Province

Patron_Postal_Code

Patron_Phone_Number

Patron_Email_Address

Patron_Verified_Flag

Patron_Total_Fines

Patron_Created_Date

Patron_Source_System

Patron_Expiration_Date

Patron_User_ID_At_Source

Patron_Blocked_Flag

Patron_Username

Patron_Last_Activity_Date

Patron_Last_Modified_Date

File name examples

 Note: IST = Institution Symbol

IST.Circulation_Patron_Report_Full.YYYYMMDD.txt

IST.Circulation_Patron_Report_Full.YYYYMMDD.csv

Additional information: This report replaced the Patron_Report_Full report.

Circulation Patron Week

Description: All patrons that have been modified over the last week.
Frequency: Weekly (every Sunday)
Time (EST): 22:00
Date restrictions (UTC): Only covering last week of activity (05:00-05:00)
Other restrictions: None

Output

Inst_Symbol

Patron_Given_Name

Patron_Family_Name

Patron_Gender

Patron_Date_of_Birth

Patron_Barcode

Patron_Borrower_Category

Patron_Home_Branch_Name

Patron_Street_Address1

Patron_Street_Address2

Patron_City_or_Locality

Patron_State_or_Province

Patron_Postal_Code

Patron_Phone_Number

Patron_Email_Address

Patron_Verified_Flag

Patron_Created_Date

Patron_Source_System

Patron_Expiration_Date

Patron_User_ID_At_Source

Patron_Blocked_Flag

Patron_Last_Modified_Date

File name examples

 Note: IST = Institution Symbol

IST.Circulation_Patron_Report_wk.YYYYMMDD.txt

IST.Circulation_Patron_Report_wk.YYYYMMDD.csv

Additional information: This report replaced the Patron_Report_wk report.