Definition of Scope

(DRAFT) An Integration is a system or service, external to FOLIO, where we need to support automated data exchange between FOLIO and that external system.  The data may flow in to FOLIO from the external system, from FOLIO to the external system, or bidirectionally.  It may be transactional in nature, or it may be a bulk/batch process.  Where possible, well-known standard protocols should be used.  

Regular and ad hoc reporting

• Most libraries need reporting tools to support daily operational needs and workflows, extend FOLIO functionality, and allow links to other systems
• Libraries who run reports need the ability to define, code and run custom defined reports.
• An LDP app is in development 
• LDLite is also an available tool - https://github.com/library-data-platform/ldlite

External tools in use

At least one FOLIO adopter library is known to be using these tools.

• LDP (Library Data Platform) - see https://docs.folio.org/docs/reporting/
• Panorama - see https://www.ebsco.com/products/panorama

Standards and Integrations with other systems

User Management

• Most academic libraries will want integration with a campus identity management system, as well as the ability to support users that are not in that system. The campus identity management system maintains identities, including inflow and outflow.
• Most academic libraries also need to support Single Sign-On, including support for federated signon, e.g. InCommon (U.S. Higher Ed.)
• User management may also play a part in access control - Users data can verify eligibility, provide physical access (cardswipe/turnstile) and provide network access (RADIUS, local AD domain)
• External tools that are not in user management area rely on user management workflows to govern authorization (e.g., locker rental DB at UChicago.)

Note that FOLIO provides a bulk update user account module - mod-user-import (https://github.com/folio-org/mod-user-import)

External tools

At least one FOLIO adopter library is known to be using these tools in integration workflows.

• PeopleSoft Campus Solutions

Desired integrations

FOLIO adopting libraries are interested in integrations with the following tools:

Resource Management - Acquisitions

• As of the Lotus release, FOLIO supports exporting orders in EDIFACT format, and importing invoices in EDIFACT format, but does not yet support order import in EDIFACT format. See UXPROD-531 - Getting issue details... STATUS
• Many libraries have home-grown tools used in Acquisitions (like Cornell's POOF tool). Those are not listed here, but are important considerations for implementers.

External tools

At least one FOLIO adopter library is known to be using these tools.

• GOBI API 

Desired integrations

FOLIO adopting libraries are interested in integrations with the following tools:

• OASIS (Proquest/Coutts)
• SAP

Resource Management - Electronic Resource Management (ERM)

• FOLIO provides built-in integration with EBSCO Holdings Management via the FOLIO eHoldings app
• FOLIO also provides support for a local knowledge base using the Local KB Admin app 

External tools

At least one FOLIO adopter library is known to be using these tools in integration workflows.

• EBSCO Holdings Management

Desired integrations

FOLIO adopting libraries are interested in integrations with the following tools:

• ERM LAS:eR 
• SFX
• 360 KB
• Roam (https://roam.plus/)

Metadata Management

Cataloging

• OCLC integrations 
  • WorldCat Metdadata API
    • setting and deleting of holdings
    • batch cataloging, import batches of OCLC records by OCLC number
  • WorldCat Search API
    • advanced searching of WorldCat
    • used in workflows to feed OCLC numbers to Metadata API
  • Direct export from OCLC to local system via TCP/IP 
    • Export from OCLC surfaces MARC record in local system

Special Collections

• Most special collections workflows are focused on record description, maintaining item provenance information, and supporting reading room usage.
• FOLIO does not provide built-in support for reading room functionality, though it can easily support library-use-only items.

External tools

At least one FOLIO adopter library is known to be using these tools in integration workflows.

• ArchivesSpace
• AEON

Desired integrations

FOLIO adopting libraries are interested in integrations with the following tools:

• AtoM (https://www.accesstomemory.org/en/)

Resource Access

• Resource Access integrations primarily focus on user records (listed above), resource sharing, self-check tools, and course reserves
• FOLIO provides a native course app and a module to support LTI connectivity, see
  • https://github.com/folio-org/edge-lti-courses
  • https://github.com/folio-org/ui-lti-courses
• FOLIO supports both NCIP and SIP2, see
  • https://github.com/folio-org/mod-ncip
  • https://github.com/folio-org/edge-ncip
  • https://github.com/folio-org/edge-sip2
• FOLIO supports Z39.50, see
  • https://github.com/folio-org/Net-Z3950-FOLIO
• FOLIO supports remote storage to facilitate use of off-site high-density library facilities. Currently  CAIASoft and Dematic  are  supported.  See
  • https://github.com/folio-org/edge-caiasoft
  •  https://github.com/folio-org/edge-dematic

External tools

At least one FOLIO adopter library is known to be using these tools in integration workflows.

• ReShare
• Relais
• MeeScan
• Sakai
• Ares

Desired integrations

FOLIO adopting libraries are interested in integrations with the following tools:

• ILL-Server (HBZ)

Financial Integrations

• This will vary greatly library to library, depending on the systems that the institution is using.

• Voucher feed to Comptroller
• Payment systems for patron charges (or integration w/ 3rd party systems)
  
  • Staff-facing for service desk payments
  • Online patron-facing for self-service
  • PCI compliant (Moneris preferred vendor)

• Export patron financial info to external systems
  • e.g. Bursar, collections agencies

Auxiliary Library Systems

• Institutional Repository
• Digital Collections/Resource Management
• Off-site storage and/or Automated Storage and Retrieval (ASR) systems
  • Export records to ASR
  • ASR updates item status in LMS
  • request items from ASR

Discovery Layer

• Institutions who have adopted or plan to adopt FOLIO are known to be using EDS, VuFind, or Blacklight
• VuFind has developed a FOLIO driver - see https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/ILS/Driver/Folio.php
• FOLIO provides some modules to support patron and discovery connection - see
  • https://github.com/folio-org/mod-patron
  • https://github.com/folio-org/edge-patron
  • https://github.com/folio-org/mod-rtac
  • https://github.com/folio-org/edge-rtac

• circulation and inventory APIs will be used directly
  • UChicago driver for OLE queries the db directly in many read-only cases because OLE APIs too slow in some cases
  • Cornell does the same with Voyager APIs for same reason 
• MyAccount feature relies on VuFind to access patron data
  • VuFind needs knowledge of both campus and non-campus borrowers in LMS
  • How does authentication for MyAccount work so patron can access their data
  • Proxy borrower support?
  • Need "Patron Empowerment" APIs
• map lookups, missing items form, report a problem form request data from OLE but exist outside of VuFind. 
• some requests come in for OLE data feeds, like a feed to provide info about techbar item availability. 

Related Implementation Issues

• Security review with IT Services
• FERPA requirements for data?
• Hosted? If run locally, how does it sit in the data center? (e.g. is vendor login access required?)
• Can we run test systems for operations, integrations, and upgrades?
• Client distribution (if not web-based): are there local desktop clients that need to be used?
• For hosting, what requirements do we have for performance
• how does the system perform authority control?