Setting up Reporting App reports

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
  • name the SQL query and JSON file (see "Naming" below)
  • 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 

• use naming conventions, e.g., LTS_ACQ_1_name_of_query
• make sure the names of the SQL query and associated JSON file match on the github repository in the reporting app directory, e.g., LTS_CAT_1_withdr_transfer.sql and LTS_CAT_1_withdr_transfer.json
• keep the query names short so they can be seen easily in the Reporting App interface
• 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)
• 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

• 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/

Troubleshooting

• If you have trouble running the report, try clearing the cache in your web browser
• Each time you make changes to the SQL for the report, you will need to re-run the report as a FUNCTION in Metadb using the z_reporting user account so that the function is updated