Guide to Reporting Documentation

Owned by Sharon Markus
Last updated: Sep 19, 2022 by Nassib Nassar


  • Introduction; what you can expect of the reporting tool
    • Description
    • Limitations
    • Benefits
      • Can ingest non-folio data
    • Folio app; graphical user interface to generate reports
    • Data Flow Diagram
  •  Getting started for report users (Sharon)
    • Report repository
      The FOLIO reporting community is developing an FOLIO-Analytics report repository on GitHub. It contains SQL reports and other analytics developed for FOLIO and designed to run on the Library Data Platform. The reports are based on the requirements of FOLIO partner libraries, covering functional areas such as circulation, cataloging, and acquisitions. In creating these report queries, the goal is to provide sample reports that are as useful as possible to participating libraries for their own implementations of the FOLIO system and its accompanying Metadb reporting database.
    • Reporting tools
      FOLIO reports can be run against an institution's LDP (Library Data Platform) reporting database using a variety of third-party reporting applications, such as Tableau Desktop and DBeaver. See the Database Tools page in the LDP Community wiki for more information on configuring these tools.
    • Data Model Diagrams
      Report writers often ask if there is an ERD (Entity Relationship Diagram) for the FOLIO reporting database. An ERD of the FOLIO LDP Reference reporting database has been implemented via SchemaSpy.
    • Data Dictionary
      To understand where to find data elements and what their names are in the reporting database, report writers our data dictionary, the FOLIO Schema Parser. 
  •  Setting up your reporting database (Getting started for reporting database administrators) (Axel)
  • How to get involved in the FOLIO reporting community (Linda)
    • Thinking about joining the FOLIO Reporting SIG and want to know more?
    • FOLIO reporting communication channels
      • The Reporting SIG has created a wiki page to help you get started.  It outlines the SIG's various modes of communication, and how you are either added to them, or which steps you need to take to join them. 
        • Simultaneously signup up for edit access to the FOLIO wiki and the Reporting JIRA project .  The SIG uses the Reporting JIRA project to track all FOLIO reporting requirements and development.   
        • FOLIO uses a Slack team called "folio-project" for real-time chat communication.  Request to join here.  Please join the #reporting-general channel, and consider joining these additional channels: #reporting-announce (announcements about reporting software); #reporting-users (querying and general usage of reporting software); and #reporting-sysadmin (system administration of reporting software).
        • The Convener will add you to the reporting-sig Mailing List which is used for agendas, general announcements.
  • Contributing to the FOLIO-Analytics Report Repository
    • Training resources (SQL training resources page)
      Creating reports for the FOLIO-Analytics report repository requires a basic knowledge of SQL (Structured Query Language) and the ability to use Git (source code storage system). Links to helpful training resources on both topics are available on the Reporting SIG wiki.
    • Reporting Requirements
      Reports to be developed and added to the FOLIO-Analytics report repository are identified and prioritized by FOLIO project participants. To see current plans for development, see the current list of report clusters in the FOLIO JIRA system (used to track tasks). To see JIRA tickets, you need to join the FOLIO JIRA system. Each report cluster requirement defines a query that can be used to generate one or more related reports.