FAQ content

Data Exports: export LibGuides content in XML format

In this article

Export a guide's content as XML

You can request an export of a guide in XML format, which is useful if you need to index your guide's content in a discovery layer or institutional repository. Because these files will appear as XML markup, they aren't ideal for making readable backups of your guides. Instead, we recommend creating an HTML backup of your guide.

  1. While editing your guide, click on the Guide Information () menu.
  2. Under BACKUP/EXPORT, select Request XML Export.

Selecting Request XML Export from the Guide Information menu

  1. The request will be queued up and a confirmation message will appear. Click the Close button to continue.
    • Please allow up to 24 hours for your request to be processed by our server.
    • You'll receive a notification email once your XML file is ready, with a link to the Data Exports page where you will be able to download it.

Example confirmation message for an XML export request 

Export all LibGuides content as XML

The XML export option can be helpful if you would like to import your LibGuides content into an external system or search tool that supports XML format, or if you would just like to keep a backup of your data in XML. These XML files will include:

  • The customer information for your site, including the name, ID, location, and institutional URL.
  • Your site's information, including the name, ID, domain name, and admin.
  • User account information, including a user's name, email address, and profile image URL.
  • Group information (if you have LibGuides CMS), including the group's type, name, URL, description, and (if a restricted group) password.
  • Subject categories, including the name and URL.
  • Tags
  • Database asset vendors
  • Guides, including the ID, type, name, description, URL, owner information, group affiliation, status, subjects, tags, pages, and boxes. Each box will include the details of the assets contained inside of the box

NoteXML exports can only be made by admin-level accounts.

To request an XML export for your site:

  1. Go to Tools > Data Exports from the command bar.
  2. Click on the Request Export button on the XML tab.
    1. Select XML: All Content if you want the export file to include both published and unpublished content.
    2. Select XML: Public Content Only if you only want to export content that is published and visible to the public.
  3. In the Actions column, click on the Download () icon to download a ZIP file containing your XML data export.
    • Note: Your request will be queued up on the server. Because these can be large files, it may take a little time before your file is generated. You'll receive an email notification once your file is ready for download and a completion date will appear in the Export Date column.

Example of requesting an XML data export 

Downloading an XML export

Once you receive a notification that your XML export is ready:

  1. Go to Tools > Data Exports.
  2. The list of pending and completed exports will be found under the XML tab.
  3. Find your report and click on its Download () icon in the Actions column.

Downloading an XML export