vHMML Data Portal Help


Full vHMML datasets

The full vHMML Reading Room dataset available on the Download Datasets page represents the latest version of all active records in vHMML as uploaded each night at 12:01 AM CST (6:01 AM GMT). Users can download the full dataset (all records, all metadata fields) in JSON format only. The metadata schema and definitions of each field in the downloaded file can be found on the Data Portal Schema page.

vHMML Data Portal also allows users to download a selection of the major fields of all active records in vHMML Reading Room in either JSON or CSV format. This download option includes the following fields: Country, City, Repository, Shelfmark, HMML Project Number, and PURL (permanent URL linking to the record).

Curated datasets

vHMML Data Portal allows users to search the records in vHMML Reading Room to create a curated dataset of records selected by the users. Results are displayed in a table showing the Country, City, Repository, Shelfmark, HMML Project Number, and PURL.

The curated dataset can be downloaded in two formats: a JSON file that contains the full metadata of all selected records, or a JSON file with the limited metadata of Country, City, Repository, Shelfmark, HMML Project Number, and PURL as found in the displayed table.

Due to search engine and dataset limitations, vHMML Data Portal search cannot serve up more than 10,000 results for any query. If your curated dataset exceeds 10,000 records you will need to narrow your search results prior to exporting a particular dataset. You can then created other curated datasets to export all the metadata you need.

Users interested in converting JSON files into CSV files or other formats can explore the data tools and some sample projects.

Searching vHMML Data Portal

vHMML Data Portal uses the same search engine and dataset as vHMML Reading Room. A complete introduction and guide to the search engine can be found on the vHMML Reading Room help page.