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 data extract files are placed on an SFTP server as delimited text documents that can be downloaded and imported into other software as needed. Data extract files are retained 90 days. Data extract files older than 30 days are subject to zipping.
WMS data extract files can be found under the /xfer/wms/reports file exchange directory and can be downloaded using an open-source SFTP client.
Row limit
All data extract files 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 data extract file exceeds the row limit.
Field names and order
Any fields (data extract file 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 data extract file.
Available data extract files
Circulation Item Inventories
Description: All inventoried items.
Caution: After an item is deleted, its status in WMS is Withdrawn. The item may still appear in the Circulation Item Inventories file for a period of time, depending on the time configured in your library's Deleted Items policy. For a withdrawn item, the following fields will be empty:
- LHR_Item_Materials_Specified
- LHR_Item_Nonpublic_Note
- LHR_Item_Public_Note
- LHR_Date_Entered_on_File
- LHR_Item_Acquired_date
- LHR_Item_Call_Number_Normalized
|
| 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
標題
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
LHR_Item_Call_Number_Normalized
|
|
|
File name examples
<OCLC Symbol>.Circulation_Item_Inventories.yyyymmdd.txt
|
Additional information:
- As of September 30, 2018, this report replaced the Item Inventories Report.
- No data will appear in the LHR_Item_Call_Number_Normalized when the circulation item does not have an associated LHR item, e.g. a temporary item (Item Type = TEMPORARY or CIRC_MANAGED) or a withdrawn item.
|
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
Patron_Custom_Category_1
Patron_Custom_Category_2
Patron_Custom_Category_3
Patron_Custom_Category_4
Patron_Country
Patron_Public_Notes
Patron_Staff_Notes
User_Account_Roles
|
|
|
File name examples
Note: IST = Institution Symbol
IST.Circulation_Patron_Report_Full.YYYYMMDD.txt
IST.Circulation_Patron_Report_Full.YYYYMMDD.csv
|
Additional information:
- The User_Account_Roles feature is available in files produced on and after March 20, 2022.
- The User_Account_Roles column displays system role names.
- Users that are a member of a group and have cross-institution roles will have @<institution symbol> appended to their cross-institution role name in the User_Account_Roles column (e.g., a user who has the ACQUISITIONS_ADMIN role at their institution as well as at another institution in their group (institution symbol XYZ) will have ACQUISITIONS_ADMIN^ACQUISITIONS_ADMIN@XYZ).
- Apply a filter to the User_Account_Roles column in Microsoft Excel to search and view specific account roles.
|
Circulation Patron Week
| Description: All patrons that have been added 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
Patron_Custom_Category_1
Patron_Custom_Category_2
Patron_Custom_Category_3
Patron_Custom_Category_4
Patron_Country
Patron_Public_Notes
Patron_Staff_Notes
User_Account_Roles
|
|
|
File name examples
Note: IST = Institution Symbol
IST.Circulation_Patron_Report_wk.YYYYMMDD.txt
IST.Circulation_Patron_Report_wk.YYYYMMDD.csv
|
Additional information:
- The User_Account_Roles feature is available in files produced on and after March 20, 2022.
- The User_Account_Roles column displays system role names.
- Users that are a member of a group and have cross-institution roles will have @<institution symbol> appended to their cross-institution role name in the User_Account_Roles column (e.g., a user who has the ACQUISITIONS_ADMIN role at their institution as well as at another institution in their group (institution symbol XYZ) will have ACQUISITIONS_ADMIN^ACQUISITIONS_ADMIN@XYZ).
- Apply a filter to the User_Account_Roles column in Microsoft Excel to search and view specific account roles.
|
Circulation patron files - Display and system role names
The display name that you see when assigning roles in the WorldShare Admin module differs from the role's system name that appears when you hover over a display name. The Circulation Patron Full and Circulation Patron Week files use the system name in the User_Account_Roles column. The following table maps the display to the system name for all available roles.
- Display and system role names - Table
-
| Display role name |
System role name |
| 採購管理員 |
收購_管理員 |
| 採購預算管理員 |
採購預算管理員 |
| 採購預算工作人員 |
採購預算工作人員 |
| 採購編目工作人員 |
採購編目工作人員 |
| 採購匯率管理員 |
採購匯率管理員 |
| Acquisitions Legal Deposit Receipts Admin |
ACQ_LEGAL_DEPOSIT_RECEIPTS_ADMIN |
| 採購訂單工作人員 |
ACQ_ORDER_STAFF |
| 採購唯讀使用者 |
ACQ_READ_ONLY_USER |
| 採購接收工作人員 |
ACQ_RECEIVE_STAFF |
| 採購報告檢視器 |
ACQUISITIONS_REPORTS_VIEWER |
| 採購請求建立者 |
ACQ_REQUEST_CREATOR |
| 採購請求管理員 |
ACQ_REQUEST_MANAGER |
| 採購請求審查人員 |
ACQ_REQUEST_REVIEWER |
| 採購資深訂單工作人員 |
ACQ_SENIOR_ORDER_STAFF |
| 採購資深工作人員 |
ACQ_SENIOR_STAFF |
| 採購設定工作人員 |
採購設定工作人員 |
| 警示管理員 |
ALERT_ADMIN |
| 警示傳送者 |
ALERT_SENDER |
| 警示使用者 |
ALERT_USER |
| 分析報告管理員 |
ANALYTICS_REPORT_ADMIN |
| 分析報告作者 |
ANALYTICS_REPORT_AUTHOR |
| 分析報告作者管理員 |
ANALYTICS_REPORT_AUTHOR_ADMIN |
| 分析報告排程員 |
ANALYTICS_REPORT_SCHEDULER |
| 分析報告工作人員 |
ANALYTICS_REPORT_STAFF |
| 分析使用者 |
ANALYTICS_USER |
| 應用程式審查人員 |
APP_REVIEWER |
| 應用程式工作人員 |
APP_STAFF |
| 加拿大書目法式名稱管理機構 |
AUTHORITIES_CANADIANA_NAMES_FRENCH |
| 加拿大書目法式名稱刪除管理機構 |
AUTHORITIES_CANADIANA_NAMES_FRENCH_DELETES |
| 加拿大書目主題管理機構 |
AUTHORITIES_CANADIANA_SUBJECTS |
| 加拿大書目主題刪除管理機構 |
AUTHORITIES_CANADIANA_SUBJECTS_DELETES |
| LC NACO名稱權威檔案管理機構 |
AUTHORITIES_LC_NACO_NAME_AUTHORITY_FILE |
| 權威搜尋匯出 |
AUTHORITIES_SEARCH_EXPORT |
| 加拿大書目搜尋匯出管理機構 |
AUTHORITIES_SEARCH_EXPORT_CANADIANA |
| 編目管理員 |
Cataloging INST Admin |
| 編目專員 |
Cataloging_Agent |
| 編目 BIBCO |
編目 BIBCO |
| 編目批次修改 |
CATALOGING_BULK_EDIT |
| 編目 CONSER |
編目 CONSER |
| Cataloging Evaluation |
Cataloging Evaluation |
| 編目匯出 |
CATALOGING_EXPORT |
| 完整編目 |
完整編目 |
| 有限編目 |
有限編目 |
| 全國性編目 |
CATALOGING_NATIONAL |
| 編目報告檢視器 |
CATALOGING_REPORTS_VIEWER |
| 編目已簡化 |
編目已簡化 |
| 流通管理員 |
CIRCULATION_ADMIN |
| 流通櫃檯 |
CIRCULATION_DESK |
| 流通櫃檯隱私權 |
CIRCULATION_DESK_PRIVACY |
| 流通報告檢視器 |
CIRCULATION_REPORTS_VIEWER |
| 館藏評估管理員 |
COLLECTION_MANAGEMENT_ADMIN |
| 館藏評估分析管理員 |
ANALYTICS_COLLECTION_MANAGEMENT_ADMIN |
| 館藏評估群組管理員 |
GROUP_COLLECTION_MANAGEMENT_ADMIN |
| 館藏評估群組使用者 |
GROUP_COLLECTION_MANAGEMENT_USER |
| 館藏評估公共使用者 |
PUBLIC_COLLECTION_MANAGEMENT_USER |
| 館藏評估使用者 |
COLLECTION_MANAGEMENT_USER |
| 館藏管理員管理員 |
KB_ADMIN |
| 館藏管理員報告檢視器 |
KB_REPORTS_VIEWER |
| 館藏管理員工作人員 |
KB_STAFF |
| 館藏管理員主管 |
KB_SUPERVISOR |
| 課程儲備維護人員 |
COURSE_RESERVES_MAINTAINER |
| 課程儲備經理 |
COURSE_RESERVES_MANAGER |
| 每個人 |
每個人 |
| 授權管理員管理員 |
ERM_ADMIN |
| 授權管理員報告檢視器 |
LMAN_REPORTS_VIEWER |
| 授權管理工作人員 |
ERM_STAFF |
| 授權管理員主管 |
ERM_SUPERVISOR |
| 付款管理員 |
付款管理員 |
| 付款經理 |
付款經理 |
| 付款測試者 |
付款測試者 |
| Selector |
SELECTOR |
| 期刊管理員 |
SERIALS_ADMIN |
| 期刊裝訂人員 |
期刊裝訂人員 |
| 期刊索取 |
SERIALS_CLAIM |
| 接收期刊 |
SERIALS_RECEIVE |
| 服務設定使用者 |
CONFIG USER |
| 學生勞工 |
STUDENT_WORKER |
| 學生勞工流通 |
STUDENT_WORKER_CIRCULATION |
| 已限制學生勞工 |
STUDENT_WORKER_RESTRICTED |
| Superuser |
SUPERUSER |
| 使用者管理員 |
USER_ADMIN |
| 使用者管理員 |
USER_MANAGER |
| 供應商管理員 |
VIC Vendor Administrator |
| 供應商管理員 |
VIC Vendor Manager |
| WMS Group Acquisitions Admin |
WMS_GROUP_ACQUISITIONS_ADMIN |
| WMS Group Cataloging Admin |
WMS_GROUP_CATALOGING_ADMIN |
| WMS Group Circulation Admin |
WMS_GROUP_CIRCULATION_ADMIN |
| WMS Group EResources Admin |
WMS_GROUP_ERESOURCES_ADMIN |
| WorldCat Discovery 管理員 |
WC Discovery Admin |
| WorldCat Discovery 工作人員 |
WorldCat Discovery 工作人員 |
| WorldShare IL管理 |
WORLDSHARE_ILL_ADMIN |
| WorldShare IL使用者 |
WORLDSHARE_ILL_USER |
| WSKey Admin |
WSKEY_ADMIN |
Download a WMS data extract file with SFTP
OCLC supports secure SFTP for institutions to retrieve data extract files from OCLC. You may retrieve your files using an open source SFTP client. FileZilla is recommended, as it works consistently with multiple operating systems. FileZilla is freely available from the web and can be found here.
Quick connect to the server
- Open Filezilla.
- Enter your Host, Username, Password, and Port in the quick connect bar.
- Click Quickconnect. If this is your first time connecting to the server, the Unknown host key dialog will appear.
- (Optional) From the Unknown host key dialog, select the Always trust this host, add this key to the cache checkbox to bypass this dialog in the future.
- Click OK to finish connecting to the server.
Download data extract files
- In the Remote pane, click / > xfer to open the xfer directory.
- From the xfer directory, double-click wms > reports.
- Select the file(s) to download and drag-and-drop them from the Remote pane to the Local pane. The files will be added to the transfer queue at the bottom of the window. See Available data extract files above for file name examples.
Import a text file into Excel
You can import your Circulation Item Inventories data file into an Excel worksheet.
- Open a new Excel file and navigate to File > Open > Browse.
- From the Open dialog window, navigate to the data extract file and click Open. The Text Import Wizard dialog window opens.
Note: Select Text Files from the file type drop-down list to help locate the file.
- From the Text Import Wizard dialog window:
- Select Delimited as the file type that best describes your data and then click Next.
- Under Delimiters:
- Deselect Tab.
- Select Other and enter a pipe character ( | ) in the text field.
- Click Next.
- Click Finish.
- In the Excel worksheet, sort, filter, format, and save the file as needed.
