*** This version of Confluence is for testing only and contains a copy of content from June 29th 2026. No changes will be preserved. ***
-
Created by
Sharon Helen Markus, last updated on Aug 12, 2025
1 minute read
Basics
Reports that are delivered through the FOLIO Reporting App require some setup and configuration before they can be published for users. Here are some of the first steps.
- write the query as a FUNCTION
- in addition to the SQL query, set up a JSON file to configure the report display and parameters
- use naming conventions, e.g., LTS_ACQ_1_name_of_query
- make sure the report does not include sensitive data, such as patron identifiers (e.g., user_id, requester_id)
Publishing the report
- test the report by running it as a FUNCTION in Metadb
- save working version of the query and its companion JSON file to reporting_app_dev
- to publish, post the query and its companion JSON file to the reporting_app directory
- test the report in the FOLIO Reporting App
Naming Conventions
- Add a prefix appropriate for the work area or function of your report, as well as a number
Reporting App Naming Conventions
- LAW_ACQ
- LAW_CAT
- LAW_CIRC
- LTS_ACQ
- LTS_CAT
- CIRC
- ADC
- FBO
- CUCD
Additionally, we will need to number the reports sequentially. How does this look to everyone as a template?
- LTS_ACQ_1_sopo
- LTS_ACQ_2_orders
- FBO_1_daily_appr_inv_exported_yesterday
- FBO_2_daily_appr_inv_vendor_yesterday
Documentation Links:
- There are more specific instructions for creating Reporting App reports here:
https://github.com/folio-org/ui-ldp/blob/master/doc/reports.md - Stefan created a nice set of information on the folio-analytics wiki on UDFs, which includes information on writing functions for the Reporting App here:
https://github.com/folio-org/folio-analytics/wiki/Cookbook:-User-Defined-Function - We also have the FOLIO documentation info, which is helpful for Settings and Permissions, here:
https://sunflower.docs.folio.org/docs/reporting/reporting-app/