What is FOLIO Reporting?
Background
The Reporting Special Interest Group (SIG) defines reporting as the tools used for data delivery
-description of reporting, including scope, features, limitations, etc.
-The PC has a couple of asks for the Reporting SIG that relate to developing a definition of reporting in FOLIO, list of in-app reports in FOLIO, and what a minimum level of reporting in FOLIO would look like.
creating a table may or may not be helpful to list the options
need to focus on the most important reporting tools
how do you query MARC?
need to consider performance in the solution chosen
need a definition for what we mean by "reporting"
useful to have a list of all the "reporting" options
ability to extract information based on a query, not business analytics
Contacts for each of the solutions for in app reports--perhaps product owner or convener, links to implementation pages. (Also reporting-general)
Where to start for new implementers?
Reporting Data Warehouse Solutions
Metadb - (open source)
LDLite - (open source) (in between API and data warehouses python scripts to extract and etl the data) (can you run FQM in LDLite) Developer improvements (after Sunflower)
Panorama - (fee-based)
Metabase (can you run Metadb on Metabase)
API-based solutions (reword--tools that use the APIs)
An API (Application Programming Interface) can be used to retrieve data from FOLIO applications directly for reporting purposes. Some examples of APIs used on the FOLIO project are Postman, CQL, Python, LDLite, BibControl, and the MARC Query Search API (this has known performance issues).
BibControl (fee-based application only available in Germany)
FQM
The token--ticket to play with FOLIO for a certain session with a time out. https://dev.folio.org/reference/api/ (channel for learning APIs in Slack) (From LS: My (small) experience with using tokens for APIs is that when you generate the token, it will say the token will be useable for the rest of the day, but in fact it times out after 30 minutes so if your query takes longer than that, it won’t work. (I don’t know if that’s a feature of the particular API or if that’s true of tokens in general))
In-App Reports
In-App reports refer to tools within the FOLIO UI. There are two types: 1) applications that support the export of selected records and 2) pre-configured reports.
Data to add: Budgets
Applications which support the export and download of selected records:
Functional Area | App | Description |
|---|---|---|
Acquisitions | Orders | allows the user to export as a CSV the results of their search |
Acquisitions | Invoices | allows the user to export as a CSV the results of their search |
Acquisitions | Receiving | allows the user to export as a CSV the results of their search |
Acquisitions/ERM | Licenses | allows the user to export as a CSV the results of their search |
Requests | Requests | allows the user to export as a CSV the results of their search |
Circulation | Circulation log | allows the user to export as a CSV the results of their search |
Metadata | Inventory/Source Record Storage | Using a list of identifiers, the user can export instances, marc bib SRS, holdings, and/or item information as MARC21 files |
Metadata | MARC authority | allows the user to export as a CSV/MARC the selected records |
Pre-configured reports:
Functional Area | App | Description |
|---|---|---|
Requests/Circulation | Requests | The Hold Shelf clearance report provides a list of items with the status of ‘awaiting pickup’ for requests with a status of ‘Closed - cancelled’ or ‘Closed - Pickup expired' for a user-defined service point. The CSV export includes the request status and basic item information. |
Metadata/Circulation | Inventory | The In transit items report exports a list of items with the status of “In transit”. The CSV export includes basic item information, checkin date, checkin service point, and destination service point. |
Metadata | MARC authority | The MARC authority headings updates report displays the authority records for which the 1XX field was updated during a user-defined date range. The CSV export includes information about the old and new heading and is available through the Export Manager app. |
Metadata | MARC authority | The Failed updates: linked bibliographic records report lists bibliographic records which failed to update when an associated MARC authority record’s 1XX or 010$a field updated. The CSV export includes information about the bibliographic record and reason for error and is available through the Export Manager app. |
Circulation | Users | The Overdue loans reports lists all users loans whose due date has past. |
Circulation | Users | The Claimed returned report lists all users with loans for items with a status of ‘claimed returned’. |
Circulation | Users | The Cash drawer reconciliation report lists all payments received during a user-defined date range. The CSV export includes information about the fee/fine owner, amount, and transaction date. |
Circulation | Users | The Financial transaction detail report lists financial transactions according to user-defined date range, fee/fine owner, and service point. |
Circulation | Users | The Refunds to process manually report lists users requiring refunds based on a user-defined date range and fee/fine owner. The CSV export includes basic user, fee/fine, and item information. |
Circulation | Users | The Lost items requiring actual cost report lists ‘Open’ loans with an item status of ‘Aged to lost’. The report does not support export and displays basic item, user, and loan information. |
FOLIO Applications
FOLIO Reporting App - The Reporting app provides a FOLIO interface for interacting with a Metadb database. There are three sections to the app, the Query builder, Saved queries, Run Reports. The Query builder allows you to build a query with the option to save it for later use. Saved queries allows you to load a previous query into the Query builder to start editing or run.
FOLIO Lists App - The Lists App in FOLIO allows users to create, manage, and export lists of information from specific record types. See the working group page for more information such as roadmap and specifications. The first release was the Lists App Beta in Poppy.
Other Tools Associated with Reporting
DBeaver - desktop application used by many FOLIO participants to write SQL queries to be used with a Metadb reporting database for FOLIO Reporting.
CloudBeaver - cloud-based web application provided by DBeaver company that users to write SQL queries to be used with a Metadb reporting database for FOLIO Reporting
PowerBI - desktop and web application used by some FOLIO users to create data dashboards and write SQL queries
Tableau - desktop application used by some FOLIO users to create data dashboards delivered through a Tableau server
Knime - a free and open-source data science platform with a graphical user interface that lets users analyze, visualize, and integrate data
BulkEdit
Google Sheets
Postman/OpenRefine
Data prep tools
Other languages? Python, etc.
Section on Automation
Redbud reporting tool (consortium--canned reports--what is the language)
Questions
-Does LDLite support reports used in the Reporting App?
No
-Does the reporting app support any data warehouse?
-Can the Lists app use metadb?