FAQ content

Data Exports: Harvest your LibGuides data as XML via OAI-PMH

In this article

The OAI-PMH protocol allows your LibGuides content to be harvested by supported third-party apps, such as library catalogs, institutional repositories, or discovery layers. LibGuides supports the standard oai_dc metadata format.

To retrieve metadata from your published LibGuides content, use your base URL along with the 6 standard OAI-PMH requests, which you can learn more about via the Open Archives Initiative. All of your data is current, up to the second and will be returned in XML format.

What can be harvested?

LibGuides supports sets of objects, or you can harvest all of your data at once. Currently, the following three sets are offered for selective harvesting:

  • Guides: this includes all published (non-private) guides.
    • Available metadata includes the title, guide owner, description, customer name, assigned subjects, creation date (<dc:date>), updated date (<datestamp>), and URL.
    • To get your guides, use the guides set parameter
    • Because LibGuides supports the oai_dc metadata format, you can also include custom metadata for your guides if you have LibGuides CMS.
      • Supported elements include: title, creator, subject, description, publisher, contributor, date, type, format, identifier, source, language, relation, coverage, & rights.
      • Any supported Dublin Core fields added to your guide's metadata will be exposed to the feed and will add to, but not replace, existing feed content.
      • Field names must be in the format of dc.fieldname (e.g. dc.contributor).
  • A-Z database list: this includes all non-hidden database assets.
    • Available metadata includes the database title, description, "more info" field (if filled in), subjects, vendor, creation date, and URL (if the proxy option is enabled for the database, then this URL will be proxied).
    • To get your databases, use the az set parameter.
  • E-reserves courses: this includes all courses with either unassigned terms or terms with start and end dates in the current time period.
    • Available metadata includes the course title, description, instructor, term, URL, and course number. 
    • To your courses, use the er_courses set parameter.

Getting your OAI-PMH URL for harvesting

  1. Go to Tools > Data Exports from the command bar.
  2. Then go to the OAI-PMH tab.
  3. On this tab, you will find your base OAI-PMH URL.
    1. Below the base URL, you will also see some example request types.

Viewing the OAI-PMH URL and examples

Note: Want to add more DC fields for your guides? Add any of the supported elements to your guides using Guide Custom Metadata (LibGuides CMS only). See http://dublincore.org/documents/dces/for supported elements. Only elements in the dc.element format are supported, and metadata must be public to appear in the feed. Metadata can be imported in bulk at Admin > Metadata & URLs.