Settings > Reporting
The Reporting section of the Settings app is where you can configure FOLIO’s connection to an LDP or Metadb database instance, set limitations on running queries and establish connections to GitHub repositories for the sake of running parameterized SQL queries.
Permissions and Capabilities
The following are the capabilities and permissions for Reporting in the Settings app:
| Permission Display Name (OKAPI) | Resource (EUREKA) | Type | Action | Description |
|---|---|---|---|---|
| Settings (Reporting): browse and load Reporting saved queries | Ui-Ldp Saved Queries | Settings | View | This capability allows a user to browse and load queries that they or other users have saved using the Reporting app’s |
| Settings (Reporting): Can modify default record limits | UI-Ldp Settings Record-Limits | Settings | View | This capability allows a user to set the amount of records/rows that can be returned and exported to a CSV (can be different values) when running a query in the Reporting app. |
| Settings (Reporting): Can modify reporting database connection details | UI-Ldp Settings Dbinfo | Settings | View | This capability allows a user to configure the Reporting app’s connection to an LDP/Metadb instance including the username and password used to query the LDP/Metadb reporting database. |
| Settings (Reporting): Can modify templated-query repos configuration | UI-Ldp Settings Tqrepos | Settings | View | This capability allows a user to create new or modify existing connections to GitHub repositories for the purpose of accessing parameterized SQL queries via the Reporting app. |
| Settings (Reporting): Can select which tables are available to search | UI-Ldp Settings Table-Availability | Settings | View | This capability allows a user to select/remove which tables will appear in the “Table” dropdown while using the Reporting app’s “Build query” feature. |
| Settings (Reporting): create and update Reporting saved queries | Mod-Settings Global Write Ui-Ldp Queries | Settings | Manage | This capability allows a user to save queries they’ve created using the Reporting app’s “Build query” feature as well as edit and overwrite existing queries (whether they are the report’s creator or not). |
Settings > Reporting > Record limits
The Record limits setting allows you to set the default and maximum numbers of records to show in a user’s query results. You may also restrict the number of records a user can export using the Maximum number to export setting.
- Default number to show
- Maximum number to show
- Maximum number of export
Settings > Reporting > Table availability
The Table availability setting
- Shows the schema and tables in the connected database and allows tables to be “turned off” from being able to query against them so that users cannot include them in queries. This is useful for tables that may contain restricted data, such as PII (Personally Identifiable Information).
Currently recommended to disable
It is currently recommended to disable tables: srs_marc, srs_marctab, srs_records. Currently the app does not support indexing of certain columns. Keeping them enabled can cause performance issues and extra stress on the database.Settings > Reporting > Database configuration
The Configure database connection URL & credentials setting is used to set the connection from the FOLIO application instance to the LDP/Metadb reporting database instance. This is also used to set the username and password to be used by the Reporting app to query the LDP/Metadb reporting database.
Settings > Reporting > Report repositories
The Report repositories setting allows you to configure connections to GitHub repositories for the purpose of accessing SQL queries created by individual institutions or the wider FOLIO reporting community. Queries saved in these repositories can be run using the Reporting app’s “Run report” option and can be configured to display parameters to filter the data output. The GitHub user, repository name, repository branch, and directory within the repository must be specified here.
For information on how to set up SQL queries compatible with the Reporting app in GitHub, please refer to [Authoring reports for the FOLIO Reporting App] (https://github.com/folio-org/ui-ldp/blob/master/doc/reports.md).
Last modified May 13, 2025