Difference between revisions of "ILS Interop"

From Code4Lib
Jump to: navigation, search
(DLF ILS Discovery Interfaces)
(Existing Efforts to Review)
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 +
<h1>Work from this group has been relocated to the [http://groups.google.com/group/ils-di/web/ils-interop-discussion-home ILS-DI Google Group]</h1>
 +
 
A place to work on developing an infrastructure for interoperating between integrated library systems and other systems, but primarily discovery layers such as Blacklight, VUFind, Summon, WorldCat Local, SOPAC, Scriblio, and others.
 
A place to work on developing an infrastructure for interoperating between integrated library systems and other systems, but primarily discovery layers such as Blacklight, VUFind, Summon, WorldCat Local, SOPAC, Scriblio, and others.
  
See our mailing list at http://groups.google.com/groups/ils-di.
+
* '''[http://groups.google.com/group/ils-di Group Mailing List]'''
 +
* '''[[ILS_Interop_Mtg_Notes|Meeting Notes]]'''
  
 +
 +
== Existing Efforts to Review ==
 +
 +
* DLF ILS Discovery Interfaces (see below)
 +
* [http://www.gbv.de/wikis/cls/DAIA_-_Document_Availability_Information_API Document Availability API] and [[DAIA_extensions|DAIA Extensions]]
 +
* [http://www.jangle.org/ Jangle]
 +
* [[Umlaut|Ümlaüt]]
 +
* [http://www.extensiblecatalog.org/ XC NCIP and OAI Toolkits]
  
 
== DLF ILS Discovery Interfaces ==
 
== DLF ILS Discovery Interfaces ==
Line 11: Line 22:
  
 
===List of functionality===
 
===List of functionality===
Level 1: Basic Discovery Interfaces
+
'''Level 1: Basic Discovery Interfaces'''<br />
 
This level represents a minimal set of functions that are easily implemented and essential to support applications that provide discovery outside the ILS.
 
This level represents a minimal set of functions that are easily implemented and essential to support applications that provide discovery outside the ILS.
* HarvestBibliographicRecords (Data Aggregation, section 5.3.1)
+
* HarvestBibliographicRecords
* HarvestExpandedRecords (Data Aggregation, section 5.3.2)
+
* HarvestExpandedRecords (expanded records include bib, marc holdings, and item info)
* GetAvailability (Real Time Search, section 6.3.1)
+
* GetAvailability (for a single title or a list)
* GoToBibliographicRequestPage (OPAC interaction, section 8.3.1)
+
* GoToBibliographicRequestPage (basically the ability to link directly to an OPAC full record page)
  
Level 2: Elementary OPAC supplement
+
'''Level 2: Elementary OPAC supplement'''<br />
 
This level describes a set of functions needed for a reasonably broad range of practical discovery applications that operate in tandem with the OPAC.
 
This level describes a set of functions needed for a reasonably broad range of practical discovery applications that operate in tandem with the OPAC.
 
All of the above, plus
 
All of the above, plus
 +
* HarvestAuthorityRecords
 +
* HarvestHoldingsRecords (where 'holdings' generally refers to structured marc holdings as opposed to just item records)
 +
* GetRecords (real-time via identifiers, as opposed to harvest)
 +
* Search
 +
* Scan (support browse)
 +
* GetAuthorityRecords
 +
* Either OutputRewritablePage or OutputIntermediateFormat
  
* HarvestAuthorityRecords (Data Aggregation, section 5.3.3)
+
'''Level 3: Elementary OPAC alternative'''<br />
* HarvestHoldingsRecords (Data Aggregation, section 5.3.4)
+
* GetRecords (Real Time Search, section 6.3.2)
+
* Search (Real Time Search, section 6.3.3)
+
* Scan (Real Time Search, section 6.3.4)
+
* GetAuthorityRecords (Real Time Search, section 6.3.5)
+
* Either OutputRewritablePage or OutputIntermediateFormat (OPAC Interaction, sections 8.3.2 and 8.3.3)
+
 
+
Level 3: Elementary OPAC alternative
+
 
This level describes a set of functions needed for a practical discovery application that can operate completely independently of the OPAC.
 
This level describes a set of functions needed for a practical discovery application that can operate completely independently of the OPAC.
 
All of the above, plus
 
All of the above, plus
 +
* LookupPatron (I think this was going from a possible external identifier, like campus ID, to the internal ILS identifier)
 +
* AuthenticatePatron
 +
* GetPatronInfo (fines, holds, loans, recalls, messages, etc.)
 +
* GetPatronStatus
 +
* GetServices (services available for a particular item for a particular patron)
 +
* RenewLoan
 +
* HoldTitle
 +
* HoldItem
 +
* CancelHold
 +
* RecallItem
 +
* CancelRecall
  
* LookupPatron (Patron Functionality, section 7.2.1)
+
'''Level 4: Robust/domain specific discovery platforms'''<br />
* AuthenticatePatron (Patron Functionality, section 7.2.2)
+
* GetPatronInfo (Patron Functionality, section 7.2.3)
+
* GetPatronStatus (Patron Functionality, section 7.2.4)
+
* GetServices (Patron Functionality, section 7.2.5)
+
* RenewLoan (Patron Functionality, section 7.2.6)
+
* HoldTitle (Patron Functionality, section 7.2.7)
+
* HoldItem (Patron Functionality, section 7.2.8)
+
* CancelHold (Patron Functionality, section 7.2.9)
+
* RecallItem (Patron Functionality, section 7.2.10)
+
* CancelRecall (Patron Functionality, section 7.2.11)
+
 
+
Level 4: Robust/domain specific discovery platforms
+
 
This level describes functions required to build useful discovery applications beyond the elementary level.
 
This level describes functions required to build useful discovery applications beyond the elementary level.
 
All of the above, plus
 
All of the above, plus
 +
* SearchCourseReserves
 +
* Explain (this is really a placeholder for an SRU type explain that says which functions have been implemented)
 +
* Both OutputRewritablePage and OutputIntermediateFormat
 +
 +
== Existing Functionality ==
 +
This section shows which systems are supported by which software packages.  We should eventually build a chart; for now, we can start by listing details until we have a better idea of what standard entries belong in chart format.
  
* SearchCourseReserves (Real Time Search, section 6.3.6; for academic libraries)
+
=== VuFind ILS Drivers ===
* Explain (Real Time Search, section 6.3.7)
+
The trunk VuFind drivers support various ILS's at different levels of detail.  Some users have extended this through local customizations, but this list currently reflects only the baseline trunk code.
* Both OutputRewritablePage and OutputIntermediateFormat (OPAC Interaction, sections 8.3.2 and 8.3.3)
+
* Aleph - Item status, Patron details, Place holds (in progress in branch)
 +
* Evergreen - Item status, New item list, Patron details, Suppressed record list
 +
* Horizon - Item status, Patron details
 +
* III - Item status
 +
* Koha - Item status (incomplete)
 +
* Unicorn - Item status; additional functionality may be available through the separate [http://code.google.com/p/vufind-unicorn/ VuFind Unicorn project].
 +
* Virtua - Course reserves, Item status, Patron details, Place holds, Renew items
 +
* Voyager - Course reserves, Item status, New item list, Patron details, Place holds (in progress in branch), Suppressed record list

Latest revision as of 20:19, 4 March 2010

Work from this group has been relocated to the ILS-DI Google Group

A place to work on developing an infrastructure for interoperating between integrated library systems and other systems, but primarily discovery layers such as Blacklight, VUFind, Summon, WorldCat Local, SOPAC, Scriblio, and others.


Existing Efforts to Review

DLF ILS Discovery Interfaces

This group worked to create a spec / recommendation for a set of functions that ILS systems would implement in order to support 3rd party discovery systems.

The work of this group is archived on the DLF website (final report).

List of functionality

Level 1: Basic Discovery Interfaces
This level represents a minimal set of functions that are easily implemented and essential to support applications that provide discovery outside the ILS.

  • HarvestBibliographicRecords
  • HarvestExpandedRecords (expanded records include bib, marc holdings, and item info)
  • GetAvailability (for a single title or a list)
  • GoToBibliographicRequestPage (basically the ability to link directly to an OPAC full record page)

Level 2: Elementary OPAC supplement
This level describes a set of functions needed for a reasonably broad range of practical discovery applications that operate in tandem with the OPAC. All of the above, plus

  • HarvestAuthorityRecords
  • HarvestHoldingsRecords (where 'holdings' generally refers to structured marc holdings as opposed to just item records)
  • GetRecords (real-time via identifiers, as opposed to harvest)
  • Search
  • Scan (support browse)
  • GetAuthorityRecords
  • Either OutputRewritablePage or OutputIntermediateFormat

Level 3: Elementary OPAC alternative
This level describes a set of functions needed for a practical discovery application that can operate completely independently of the OPAC. All of the above, plus

  • LookupPatron (I think this was going from a possible external identifier, like campus ID, to the internal ILS identifier)
  • AuthenticatePatron
  • GetPatronInfo (fines, holds, loans, recalls, messages, etc.)
  • GetPatronStatus
  • GetServices (services available for a particular item for a particular patron)
  • RenewLoan
  • HoldTitle
  • HoldItem
  • CancelHold
  • RecallItem
  • CancelRecall

Level 4: Robust/domain specific discovery platforms
This level describes functions required to build useful discovery applications beyond the elementary level. All of the above, plus

  • SearchCourseReserves
  • Explain (this is really a placeholder for an SRU type explain that says which functions have been implemented)
  • Both OutputRewritablePage and OutputIntermediateFormat

Existing Functionality

This section shows which systems are supported by which software packages. We should eventually build a chart; for now, we can start by listing details until we have a better idea of what standard entries belong in chart format.

VuFind ILS Drivers

The trunk VuFind drivers support various ILS's at different levels of detail. Some users have extended this through local customizations, but this list currently reflects only the baseline trunk code.

  • Aleph - Item status, Patron details, Place holds (in progress in branch)
  • Evergreen - Item status, New item list, Patron details, Suppressed record list
  • Horizon - Item status, Patron details
  • III - Item status
  • Koha - Item status (incomplete)
  • Unicorn - Item status; additional functionality may be available through the separate VuFind Unicorn project.
  • Virtua - Course reserves, Item status, Patron details, Place holds, Renew items
  • Voyager - Course reserves, Item status, New item list, Patron details, Place holds (in progress in branch), Suppressed record list