The ui-acquisition-units repo is used for the management of Acquisition unit records in FOLIO. It includes summary information and details regarding the Acquisition unit interaction and preferences.

The Agreements UI Module, or ui-agreements, is a Stripes UI module used for management of various E-resource tasks including handling agreements and viewing available E-resources.

Stripes UI module- Audit app visually conveys the idea of examining past activity, organized by different points of view: user; resource; circulation etc

This is a Stripes UI module for institutional calendar functions.

This is a Stripes UI module for checking items in with simulated scans of barcodes

This is a Stripes UI module for checking items out with simulated scans of patron card and item barcode.

This is a Stripes UI module for Circulation management.

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-circulation-log and start your development.

The Course Reserves UI Module, or ui-courses, is a Stripes UI module used for maintaining information about courses, and associated course reserves with them. (A 'Stripes UI module' is an NPM module that adheres to certain conventions that allow it to function within the Stripes UI framework that is part of FOLIO.)

Application for data export functionality.

Application for Data Import functionality

This is a Stripes UI module for managing developer settings. This will not be included in production deployments.

The ui-eholdings module adds the ability to manage electronic holdings in FOLIO. The first supported knowledge base is from EBSCO.

The ERM comparisons module, or ui-erm-comparisons, is a Stripes UI module used for comparison of 'Agreement' and/or 'Package' objects defined by the ui-agreements (Agreements) module.

The ERM-Usage UI Module, or ui-erm-usage, is a Stripes UI module for managing usage statistics. It allows to enter credentials for accessing usage data providers. These credentials are used by the backend module mod-erm-usage to harvest usage statistics periodically.

The ui-finance allows for the management of ledgers, funds, and budgets in FOLIO. It includes a dashboard that provides a snapshot of your account totals for the current fiscal year across ledgers and funds.

This is a Stripes UI module for administrating metadata sources and collections for the finc user community.

This is a Stripes UI module for the selection of metadata sources and collections for the finc user community.

This is a Stripes UI module for administrating locally created instances, holdings records and items.

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-invoice and start your development.

The Licenses UI Module, or ui-licenses, is a Stripes UI module used for management of licenses

The Local KB admin UI Module, or ui-local-kb-admin, is a Stripes UI module used for management of the local KB used for ERM tasks handled by the ui-agreements (Agreements) module.

This is a Folio Stripes settings module that provides a front-end for configuring various things for the edge-lti-courses Edge module that uses the LTI 1.3 standard to connect Learning Management Systems (LMSs) such as Sakai, Canvas, or Blackboard to Folio's Course Reserves app.

The MARCcat UI Module, or ui-marccat, is a Stripes UI module used for searching, sorting, filtering, viewing, editing and creating BIB record. (A 'Stripes UI module' is an NPM module that adheres to certain conventions that allow it to function within the Stripes UI framework that is part of FOLIO.)

This is a Stripes UI module for managing user profile settings. This exists only to provide a settings section: there is no app.

This is a Stripes UI module for dealing with the notes.

This is a Stripes UI module for OAI-PMH management.

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-orders and start your development.

The ui-organizations allows for the management of Organization records in FOLIO. It includes summary information, contact information and other details regarding the organization interaction and preferences.

This package furnishes a single Stripes plugin of type quick-marc, which can be included in Stripes modules by means of a <Pluggable type='quick-marc'> element. See the Plugins section of the Module Developer's Guide.

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-receiving and start your development.

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-remote-storage and start your development.

This is a Stripes UI module for making requests on items.

The Search UI Module, or ui-search, is a Stripes UI module used for searching, sorting, filtering and viewing records from the FOLIO Codex, an aggregation of bibliographic metadata from multiple sources.

This package include a Stripes handler module called servicepoints which will be executed during stripes-core initialization.

This is a Stripes UI module for Tags management.

This is a Stripes UI module for managing organization settings. This exists only to provide a settings section: there is no app.

The Users UI Module, or ui-users, is a Stripes UI module used for searching, sorting, filtering, viewing, editing and creating users. (A 'Stripes UI module' is an NPM module that adheres to certain conventions that allow it to function within the Stripes UI framework that is part of FOLIO.)

This package furnishes a single Stripes plugin of type create-inventory-records, which can be included in Stripes modules by means of a <Pluggable type='create-inventory-records'> element. See the Plugins section of the Module Developer's Guide.

This package furnishes a single Stripes plugin of type create-item, which can be included in Stripes modules by means of a <Pluggable type='create-item'> element. See the Plugins section of the Module Developer's Guide.

This source module contains the code for several Stripes UI plugins. They exists only to test the plugin support, and do not provide useful functionality.

This package furnishes a single Stripes plugin of type find-agreement, which can be included in Stripes modules by means of a <Pluggable type='find-agreement'> element. See the Plugins section of the Module Developer's Guide.

This package furnishes a single Stripes plugin of type find-contact, which can be included in Stripes modules by means of a <Pluggable type='find-contact'> element. See the Plugins section of the Module Developer's Guide.

This package furnishes a single Stripes plugin of type find-eresource, which can be included in Stripes modules by means of a <Pluggable type='find-eresource'> element. See the Plugins section of the Module Developer's Guide.

This package furnishes a single Stripes plugin of type find-erm-usage-data-provider, which can be included in Stripes modules by means of a <Pluggable type='find-erm-usage-data-provider'> element. See the Plugins section of the Module Developer's Guide.

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-plugin-find-finc-metadata-collection and start your development.

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-plugin-find-finc-metadata-source and start your development.

This package furnishes a single Stripes plugin of type find-import-profile, which can be included in Stripes modules by means of a <Pluggable type='find-import-profile'> element. See the Plugins section of the Module Developer's Guide.

This package furnishes a single Stripes plugin of type find-instance, which can be included in Stripes modules by means of a <Pluggable type='find-instance'> element. See the Plugins section of the Module Developer's Guide.

This package furnishes a single Stripes plugin of type find-interface, which can be included in Stripes modules by means of a <Pluggable type='find-interface'> element. See the Plugins section of the Module Developer's Guide.

This package furnishes a single Stripes plugin of type find-license, which can be included in Stripes modules by means of a <Pluggable type='find-license'> element. See the Plugins section of the Module Developer's Guide.

This package furnishes a single Stripes plugin of type find-organization, which can be included in Stripes modules by means of a <Pluggable type='find-organization'> element. See the Plugins section of the Module Developer's Guide.

This package furnishes a single Stripes plugin of type find-package-title, which can be included in Stripes modules by means of a <Pluggable type='find-package-title'> element. See the Plugins section of the Module Developer's Guide.

This package furnishes a single Stripes plugin of type find-po-line, which can be included in Stripes modules by means of a <Pluggable type='find-po-line'> element. See the Plugins section of the Module Developer's Guide.

This package furnishes a single Stripes plugin of type find-user, which can be included in Stripes modules by means of a <Pluggable type='find-user'> element. See the Plugins section of the Module Developer's Guide.

Stripes is a toolkit for building single-page web applications that FOLIO UI modules can run in. In addition to being the home of Stripes framework, this repository serves as a hub for shared Stripes documentation.

This is a library of React components and utility functions for use with the Stripes UI toolkit, part of the FOLIO project.

Stripes CLI is a command line interface to facilitate the creation, development, building, and testing of Stripes UI modules.

This is a library of React components and utility functions for use with the Stripes UI toolkit, part of the FOLIO project.

Stripes Connect provides essentially one service: the ability to upgrade a regular React component into a Connected Component. This is done by importing the connect() method from stripes-connect, defining a data manifest, and exporting not the React component itself but the result of wrapping it in a call to connect():

Stripes is a toolkit for building single-page web applications that FOLIO UI modules can run in. UI modules are made up of React components, some of which will be connected to back-end services provided by Okapi. Each module has a 'type' which indicates how it functions within the application. At the moment, the only 'type' is 'app' which provides a top-level component to render into a large content area.

This is a library of React components and utility functions for use with the Stripes UI toolkit, part of the FOLIO project.

This is a library of React components and utility functions for use with the Stripes UI toolkit, part of the FOLIO project.

A suite of smart components. Each communicates with an Okapi web-service in order to provide the facilities that it renders.

This is a NPM module to aid with embedding the Quill editor in Stripes applications for building templates with token substitution.

stripes-testing is a toolkit for building integration tests against Stripes UI modules and platforms. There are no tests in this repository; instead they exist in the platforms they exercise (e.g. platform-core). Tests that operate only a single app (unit tests) should be written with the BigTest toolkit instead.

A library of utility functions to support Stripes modules.

This is the 'complete' Stripes 'platform'. It consists simply of an NPM package.json that specifies the version of @folio/stripes-core and of any Stripes modules you wish to make available as part of this platform to generate client bundles along with a utility for generating module descriptors for each Stripes module.

This is the 'core' Stripes 'platform'. It consists simply of an NPM package.json that specifies the version of @folio/stripes-core and of any Stripes modules you wish to make available as part of the 'core' platform to generate client bundles along with a utility for generating module descriptors for each Stripes module.

This is the ERM Stripes 'platform'. It consists simply of an NPM package.json that specifies the version of @folio/stripes-core and of any Stripes modules you wish to make available as part of the ERM platform to generate client bundles along with a utility for generating module descriptors for each Stripes module.

The mod-aes module implements FOLIO asynchronous event service (AES). Currently, it acts as a filter to capture traffic as JSON messages. It then routes the messages to different Kafka topic according to JSON path based routing rules that are stored in mod-config.

Mod-Agreements is a FOLIO module to manage agreements which control an institutions access to resources. Normally, this will be subscribed access to packages of electronic resources, although the aim is to make the affordances offered by mod-agreements as general as possible.

The mod-audit module provides API to access and modify audit data.

The audit-filter module implements Okapi PRE and POST filters to capture audit data. It then calls mod-audit to persist the data.

This module is responsible for filtering all proxy traffic and checking for a valid token. In addition, it is responsible for retrieving the permissions for a given user and making decisions regarding access based on user permissions and defined requirements for a given path. It provides a token creation endpoint that privileged modules (such as Authentication) may make use of.

Module to provide calendar functionalities for FOLIO systems.

FOLIO compatible circulation capabilities, including loan items from the inventory.

FOLIO compatible persistent storage of loans, loan policies, circulation rules, requests, and fixed due date schedules

Codex wrapper for the EBSCO knowledge base.

Codex Wrapper for Inventory

Codex mock module - for testing and development

Codex Multiplexer backend module

Configuration module based on the raml-module-builder and a set of raml and json schemas backed by a PostgreSQL async implementation

mod-copycat is a FOLIO module that assists in Copy cataloging. It imports records from remote systems using Z39.50.

Backend CRUD storage module to support the Course Reserves functionality

FOLIO data export module.

FOLIO data import module.

Data Import Converter Storage.

RMB-based module used to load test data.

The module provides the role of delivering messages using SMTP server to send email. This module use mod-configuration to get connection parameters.

Models, Clients and Utilities for COUNTER/SUSHI standard

Module for harvesting counter reports.

The module provides information describing the notification events. The event configuration describes the event name, delivery channels, and contain references to templates for each delivery channel.

Module to provide central feesfines management for FOLIO systems.

This is the user-facing, business logic module for finances, which is comprised of this module and mod-finance-storage.

This RMB-module is responsible for the persistence of finance-related data (i.e. funds, ledgers, transactions, etc.)

Backend module for finc-config and finc-select.

GOBI® (Global Online Bibliographic Information) is the leading web-based acquisitions tool for finding, ordering and managing e-books and print books for libraries. This module allows GOBI initiated orders to be fulfilled by FOLIO.

mod-graphql is a FOLIO module, written in Node.js, that provides a GraphQL service by HTTP POST to /graphql/. It can be interrogated using any GraphQL client library, such as Apollo, and the graph it provides is auto-generated from the API description files (RAML and JSON Schema) of the modules that it's providing the GraphQL API for.

FOLIO compatible inventory module.

FOLIO compatible inventory storage module.

Mod-inventory-update is an Okapi service that can be put in front of mod-inventory-storage (Inventory Storage) for populating the storage with Instances, holdings and items according to one of multiple different update schemes.

This is the Invoice business logic module.

This is the Invoice storage module.

Broker communication with the EBSCO knowledge base (Java)

FOLIO service module - licenses.

This module is responsible for verifying the user's identity and issuing a valid JWT that can be used for system access. The implementation of this module may vary (username/password, SAML, OAuth, etc.), and it is possible for more than one Authentication module to exist in a running system. The default implementation uses a simple username and password for authentication.

This module provides SAML2 SSO functionality for FOLIO.

FOLIO Cataloguing module.

NISO Circulation Interchange Protocol (NCIP) support in FOLIO

Notes on all types of objects

Notifications to the users

Backend Module implementing the Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH Version 2.0), but providing more RESTful API than described in the specification. At the core places the /oai/records endpoint which accepts verb name as main parameter which defines what type of request is and which handler should ve invoked for processing the request.

This is the Orders business logic module.

This is the Orders storage module.

This is the Organizations business logic module.

This is the Organizations storage module.

The module provides a default rule set for a tenant and functionality to manage them via REST API and also allows to use a validation flow for a user password.

Microservice to allow 3rd party discovery services to perform FOLIO patron actions via the discovery service's UI.

FOLIO module for automated patron blocks

This module stores permissions and associations between permissions and users. It also maintains a hierarchy of permissions and sub-permissions, allowing for permissions to act as roles, rather than simple bits. It is used primarily by the Authtoken module, though it is possible that some Authentication implementations may have reason to make calls to the Permissions module as well.

The mod-pubsub module is responsible for maintaining the registration of EventTypes and for coordinating distribution of Events to the appropriate Subscribers. Folio modules may publish Events and/or subscribe to Events of specific EventTypes. It is the responsibility of Publisher modules to define the EventTypes that they will provide, which is accomplished through the use of an EventDescriptor. Note that it is possible for multiple Publishers to register for the same EventType. However, the EventType may only be defined once. Subscribing modules will register themselves to specific EvenTypes by providing a URI that will be invoked by the event manager when pushing events of matching EvenTypes. Event subscription is done on a per tenant basis.

API for quickMARC - in-app editor for MARC records in SRS.

Backend module with business logic for receiving receive and checking-in materials that have been ordered.

Microservice to allow 3rd party discovery services to determine the availability of FOLIO inventory.

Sending messages through delivery channels

FOLIO source record manager module.

FOLIO compatible source record storage module.

Central list of tags that can be assigned to various objects. Tags are simple strings like 'urgent', or 'important'. These are kept as an array of string values in the various objects that use them. This module provides a centralized repository of allowed values, which can be used for populating pull-down lists etc. The coupling is intentionally rather weak, it will be up to the UI to enforce the use of authorized tags, or not, as each library will want, and/or insert new tags into this module when the user uses a new one.

This module is responsible for storing templates and generating text, html, xml, doc, docx etc from the template. Generated payload is described by meta information which contains info about format, size and date. Supports localization of templates.

This module is responsible for importing new or already existing users into FOLIO.

Module to provide central user management for FOLIO systems.

Business logic 'join' module to provide simple access to all user-centric data.

Introduction ... ## Additional information

Common/Shared library for Edge APIs.

The purpose of this edge module is to connect LMS such as Sakai and Blackboard (LTI Platforms) to Folio via the LTI Advantage protocol for the purposes of sharing the course reserves stored in Folio.

Edge API for mod-ncip

Edge API for Metadata Harvesting (OAI-PMH Version 2.0)

The purpose of this edge API is to bridge the gap between 3rd party purchasing systems/vendors and FOLIO. More specifically, the initial implementation was built with EBSCO's GOBI (Global Online Bibliographic Interface) service in mind.

Edge API to interface with FOLIO for 3rd party discovery services to allow patrons to perform self-service actions (place holds, renewals, etc)

The purpose of this edge API is to bridge the gap between external reporting and analytics systems and FOLIO by allowing these systems to resolve FOLIO UUIDs, such as a FOLIO user id, thereby acquiring a richer set of data.

Edge API to interface with FOLIO for 3rd party discovery services to determine holdings availability.

The purpose of this edge API is to bridge the gap between self service circulation and patron services stations and FOLIO by allowing these systems to issue requests and receive responses in Standard Interchange Protocol v2 (SIP2). These requests will be serviced by FOLIO APIs and the responses will be based on FOLIO results for all supported (TBD) SIP2 commands.

This documentation includes information about the Raml-Module-Builder (RMB) framework and examples of how to use it.

This repository contains json schemas and examples for entities involved in data-import flow. It is utilized as a git submodule ('raml-storage' directory) in each of the following repositories:

Repository of RAML traits and resource type files.

Core infrastructure for event processing for the DataImport.

Utilities for DataImport modules.

This is the documentation for FOLIO apps. If working with this Hugo site locally, be sure to execute git submodule update --init --recursive before attempting to build with Hugo for the first time.

This repository contains reports and other analytics developed for FOLIO and designed to run on the Library Data Platform. At present most of the content here consists of SQL reports developed by the FOLIO reporting community and based on the requirements of FOLIO partner libraries. For more information about FOLIO reporting, see the FOLIO Reporting Special Interest Group.

The FOLIO module to store and maintain custom fields. The folio-custom-fields is designed to be a library that any module can add and use to store custom fields definitions as well as their values.

Dependency Injection support for FOLIO backend modules

FOLIO Helm charts modules repository.

This is a client library to RM API

A collection of runbooks for FOLIO installation.

This project is the set of integration tests based on karate framework

ISBN number converter utilities.

Liquibase schema migration utilities.

This project contains examples of FOLIO modules (currently a server-side Vert.x-based module, but more, e.g. a UI/front-end module will come later), and some general information about writing, packaging and describing modules.

Library with general purpose classes to help with FOLIO backend service development and testing

Basic instructions and bootstrap files for setting up a test instance of FOLIO.

Shared library for generating MARC records on-the-fly

This is a Maven archetype used to generate an RMB-based server-side module. Install this locally if you wish to build such a module.

z2folio is a Z39.50 server for FOLIO bibliographic and holdings data, supporting record retrieval in USMARC, OPAC, XML and JSON formats. The functionality is all provided by the Net::Z3950::FOLIO library, which is also part of this distribution. It is written in Perl, and follows standard Perl-module conventions.

Okapi command-line interface (yet another one)

Carrier is an open source continuous performance testing toolkit. It consists of tools and practices to integrate non-functional tests into delivery pipeline and organize effective feedback loop.

The purpose of this repository is to provide a personal data disclosure form template and related tools/scripts. Each module will specialize and store this form in the top level of their git repository. The form is a mechanism to disclose the types of personal data stored by each module. This information enables those hosting FOLIO to better manage and comply with various privacy laws and restrictions, e.g. GDPR, etc.

• Folio RFCs are stored as MarkDown documents as part of the GitHub RFC Repo.

Spring module core libraries for Spring development with Okapi.

Congratulations on creating a new Stripes UI app module! Follow the instructions below to run uiAppName and start your development.

yakbak-proxy is a simple Web proxy implemented using yakbak. It accepts incoming HTTP connections and proxies them through the nominated server, keeping a record ('tapes') of all requests and their corresponding responses. Then later you can run the same client against the same proxy server, and it will re-use the tapes. This is especially useful for testing a Web UI away from its corresponding back-end.