FOLIO is a new open source, cloud hostable, app-store based library platform, designed to facilitate collaboration between disparate development teams.
This glossary defines some terms to assist developers.
The FOLIO middleware and API gateway. Okapi serves as the foundation layer for managing FOLIO apps and services. For more information, see the Okapi Guide and Reference.
The FOLIO UI toolkit. The Stripes toolkit provides a means of building web applications that expose the functionality of underlying Okapi modules. For more information, see the Stripes GitHub repository.
The document Stripes entities: packages, modules, apps and more is a summary of terms used in that context, e.g. component, package, module, app, plugin.
Okapi-Stripes Platform, LSP Base, LSP Extended
The “Okapi-Stripes Platform” and the “FOLIO LSP Base” and the “FOLIO LSP Extended Apps” are defined.
FOLIO Special Interest Groups (SIGs)
For further information about SIGs and how to participate, refer to Special Interest Groups.
Some abbreviations are provided below. Note that there are other SIGs besides these.
Library Data Platform - Reporting
FOLIO Technologies and Concepts
Application programming interfaces (APIs) are well-defined interfaces through which interactions happen.
An online portal for obtaining and installing software. FOLIO is designed to support the installation of both free and commercial modules and applications through an App Store.
Bibliographic Framework Initiative (BIBFRAME).
Some starting points are:
- A Gentle Introduction to CQL (incomplete, outdated, explains features not supported by FOLIO).
- FOLIO CQL to PostgreSQL JSON converter (CQL2PgJSON).
- FOLIO FAQ Explain CQL string matching
- The CQL-1.2 specification and context sets.
- As SRU 2.0 is OASIS searchRetrieve Version 1.0, then CQL is its Part 5.
- The CQL parser in YAZ.
A CQL example:
(username=="ab*" or personal.firstName=="ab*" or personal.lastName=="ab*") and active=="true" sortby personal.lastName personal.firstName barcode
For other relevant CQL examples see the FOLIO items above, and the API docs, and the debug output for tests in each backend module.
The basic functions of persistent storage: Create, Read, Update, Delete (CRUD).
Combining software development and information technology operations: DevOps.
Docker is a platform for managing software containers. FOLIO is well-suited for deployment in a Docker environment.
Definition of Done (DoD). Criteria to decide when a feature is deemed finished, and its issue tracker tickets are closed. Refer to the management notes for each FOLIO Development Team.
Definition of Ready (DoR). Criteria to decide when a feature is well-described and is deemed ready to be scheduled to undertake the work. Refer to the management notes for each FOLIO Development Team.
Don’t repeat yourself (DRY).
Amazon Elastic Kubernetes Service (Amazon EKS).
Electronic resource management (ERM).
Functional Requirements for Bibliographic Records (FRBR).
“Higher-order components” are a pattern for re-use of component logic with React.
Human-readable identifier (HRID) is an additional unique identifier available on some records. Also known as eye-readble identifier. Not to be confused with the UUID of a holdings record (which may also have a HRID).
Integrated Library System (ILS).
Vocabularies that define the format of JSON instances.
JSON Web Token is a JSON-based open standard for creating tokens that assert some number of claims. JWTs are authenticated and encrypted, and used by Okapi.
Apache Kafka is a distributed event streaming platform.
Kubernetes (k8s) is a “platform for automating deployment, scaling, and operations of application containers across clusters of hosts”.
Library Data Platform (LDP) is an open source platform for reporting and analytics in libraries.
Library Services Platform (LSP).
Learning Tools Interoperability (LTI).
MARC (Machine-Readable Cataloging) standards.
Markdown is a simple plain text formatting syntax, used for documentation throughout the FOLIO code.
MARC 21 Format for Holdings Data (MFHD).
MongoDB is an open source, schemaless document database.
A pattern for building loosely-coupled, highly available, modular applications. Each component of a microservices-based application is a self-contained service, which communicates with other components over the network using a lightweight protocol. The FOLIO LSP is built using a microservices architecture.
A pattern of software architecture in which a single instance of the software is designed to serve multiple tenants, with appropriate security provisions and data separation. FOLIO is designed from the ground up to operate in a multitenant environment.
Market-Viable Platform (MVP). Refer to the FOLIO Implementation Group.
NISO Circulation Interchange Protocol (NCIP).
The OpenAPI Specification (OAS) for describing RESTful web services. (Originally part of Swagger.)
See Okapi explained above.
The Open Library Foundation is an independent not-for-profit organization to ensure the availability, accessibility and sustainability of open source and open access projects for and by libraries. See Newsroom. OLF has joined the FOLIO community to help with the development of FOLIO.
Each FOLIO Product Owner (PO) represents the business or user community, and is responsible for working with this group to determine what features will be in the product release. Refer to the overview of Product Owners including explanation of “What is a Product Owner”, getting involved and getting started, and the Directory of Product Owners by Area of Focus.
PostgreSQL (often called “Postgres”) is an open source enterprise-level relational database.
Resource Description and Access (RDA).
Continuously built FOLIO systems to exhibit the state of development. These are linked and their automation is explained at Software build pipeline.
Representational State Transfer architectural style, and RESTful web services, enable interaction between systems using a well-known set of stateless operations and responses.
The RAML Module Builder (RMB) framework, is a special FOLIO module that abstracts much functionality and enables the developer to focus on implementing business functions.
Software Development Life Cycle (SDLC) Software development process. Also abbreviated as DLC.
The FOLIO Security Team is the group is charged with overseeing the process related to identification and resolution of security vulnerabilities reported against FOLIO.
A human-readable identifier with keywords and alpha-numeric characters. Whitespace is replaced by a hyphen or an underscore character. Punctuation and accented characters are removed, thereby avoiding the need for special encoding.
Used for friendly URLs and reliable identifiers.
To “slugify” is to translate a string into a slug by replacing such characters.
FOLIO is a single-page application (SPA).
Spring is an application framework for the Java platform.
Some FOLIO modules are developed using the folio-spring-base library and the Spring Way.
FOLIO Source Record Storage (SRS).
System operators, systems administrators of multi-user computer systems: Sysop.
User experience (UX).
Vert.x is a toolkit for building scalable, reactive applications on the JVM. Vert.x is particularly suitable for developing applications using the microservices architectural pattern.
Some FOLIO modules are developed using the lightweight folio-vertx-lib library.
Web Content Accessibility Guidelines (WCAG).
The Node.js module bundler, used to deploy Stripes modules.
The World Open Library Foundation Conference (WOLFcon).
A generic term for Web Services Application Programming Interface (see API above).
Apache ZooKeeper is a service for highly reliable distributed coordination.
Z39.50 refers to ANSI/NISO standard Z39.50, and ISO standard 23950 “Information Retrieval (Z39.50): Application Service Definition and Protocol Specification”.
The Library of Congress is the Z39.50 Maintenance Agency.