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)
- give users permissions to view the reporting app report
Naming
- 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
- Number the reports sequentially. For example:
- LTS_ACQ_1_sopo
- LTS_ACQ_2_orders
- FBO_1_daily_appr_inv_exported_yesterday
- FBO_2_daily_appr_inv_vendor_yesterday
Publishing
- Make sure the metadb comment that points to the function is included at the top of the SQL file (e.g., --metadb:function LTS_Holdings_Admin_Notes)
- Make sure the JSON and SQL files have the same file name on the github repository in the reporting app directory
- save working version of the query and its companion JSON file to reporting_app_dev directory
- to publish, post the query and its companion JSON file to the reporting_app directory
- run the report as a FUNCTION in Metadb using the z_reporting user account
- verify that the saved function is in the Functions directory in the z_reporting user account schema
- test the report in the FOLIO Reporting App
Permissions
- Make sure CUL FOLIO users have permissions to see and run the new report in the Reporting App
Documentation