Library Data Platform
In order for LDP software to connect to FOLIO, it needs read-only access to Okapi and the FOLIO database. The LDP can be hosted and administered locally by an institution’s own staff or by contracting hosting services out to a third party. You can find specific system requirements in the LDP documentation.
Installing and configuring the LDP
For detailed information about how to set up and configure the LDP, please review any of the guides linked below that are available in the LDP repository. There you also will find the latest versions and fixes of the LDP.
- Overview: brief introduction and summary
- System requirements: software and hardware requirements
- Installation: installing prerequisites and building LDP
- Database configuration: setting up and configuring the database
- Server configuration: setting up, configuring, starting and upgrading the LDP
- Direct extraction: setting up direct extraction from FOLIO’s database
- Data privacy: options to anonymize personal data
- Optional columns: specifying optional FOLIO columns that should always appear in LDP tables
- Historical data: description of historical data feature and instructions for disabling
- Reference: reference for the configuration file: ldpconf.json
- Foreign keys: enabling capability to infer foreign keys
- Reference: reference for the configuration file: dbconfig.general
Setting up derived tables
To let report users take full advantage of the community-developed report queries as well as having a good starting point for ad hoc querying, it is strongly recommended to set up a nightly update on derived tables. Note that the use of views and materialized views is not supported in LDP databases and may cause the LDP software to be unable to perform data updates.
You can find instructions in Github on how to set up FOLIO Reporting Derived Tables.
The LDP is designed to support GDPR and other data privacy requirements. Administrators can exclude a predefined set of tables.
See the Anonymization Guide for information on how to activate and configure these features.
The pages linked below list attributes that contain potential personal data:
- Users module: tables that will not loaded in LDP when anonymization is turned on
- Organizations module: potential personal data in organizations module
Adding local data
As documented in the user guide, it is also possible to load and create local data into your LDP. Besides using the local schema, you might consider setting up separate schemas for different user groups or purposes.
The concept of schemas allows you to organize tables and permissions within one database. In LDP we have initially four relevant schemas:
- public: contains all extracted tables and its current data from the bound FOLIO tenant
- history: stores data that have been updated in the past or may no longer exist
- folio_reporting: contains all derived tables created and supported by the community
- local: common area for report users to create or import own data
Beside existing schemas, you are free to create more schemas for your local needs (e.g., to provide data for different departments, to separate and protect sensitive data).
Learn more about the schema concept and how to configure schemas using Postgres’s Schema Documentation.
Moving and loading data
Loading and moving data into LDP is as simple as it is for databases in general.
For Postgres there are two common approaches:
- COPY: SQL command for moving table data via csv files
- pg_dump / pg_restore: Postgres command line tools for importing and exporting data
FOLIO Data Coverage in the LDP
The LDP utilizes the FOLIO APIs to get most of its content. To see more details about the APIs can be found at FOLIO Developers API documentation.
As of version 1.3.0, the LDP pulls data from the following FOLIO modules:
* - The LDP supports direct extraction for these tables, rather than using the module APIs.