Technical options and shared repository

Harvesting options

There are a variety of different ways you can contribute your metadata to DigitalNZ:

XML Sitemap

An XML Sitemap is a file that lists URLs for a site along with additional metadata about each URL (when it was last updated, how often it usually changes, and how important it is, relative to other URLs in the site). An XML Sitemap is quite different from the commonly known ‘sitemap’ that is for a list of pages of a website. We can set our harvester to check out your XML sitemap and pick up any new content that appears. Here is an example of what an XML site map looks like on the DigitalNZ website.

RSS feed

We can use RSS feeds for quick daily harvests of your metadata. The RSS feed needs to point to the stuff that you want us to be harvesting. Here is an example of a feed we use to harvest from Quakestories


Open Archives Initiative Protocol for Metadata Harvesting is the most efficient harvest method because it can be scheduled to run regularly and automatically to pick up only new or modified records. OAI-PMH is aimed at institutional repositories containing digital content. You can learn more about OAI-PMH at Here is an example of what the data in OAI-PMH looks like from Kete West Coast.


An Application Programming Interface puts data into a format that can be easily connected to or built upon. APIs often return a set of results in XML format which can be consumed by our harvester. Here is an example of an API that we use to harvest from the Auckland War Memorial Museum .

A file

You can also send us either a list of links, or an xml file, of your content. We use this to extract what we can from your web pages. We only use this method if your site isn't updated regularly. This is because you have to let us know when your site changes.

Hosting options

If your content doesn't have a home then you could look into our Shared Repository service. Contact us to discuss if it's suitable for your situation.

Partnering with others

You might be interested in partnering with one of the collaborative initiatives we work with to harvest content. For example, NZ Museum .

What is the Shared Repository?

Organisations can use the Shared Repository to store access copies of NZ digital items that have nowhere else to be hosted. The service is designed as an access repository of last resort for those digital items that would otherwise not be publicly available. It is suitable for small digital collections.

The service includes simple metadata management and object upload facilities, and all repository items are automatically shared via the DigitalNZ APIs and search features. This is different from the basic DigitalNZ Search service that only aggregates metadata, in that this system can actually hold digital objects and allow metadata to be edited.

The service was originally developed to hold open-access research outputs, but it is now available for other types of material.

Who can load material into the Shared Repository?

Priority goes to Crown Research Institutes, government departments and other organisations who hold research material. But any organisation who has NZ digital items that are not otherwise publicly available is eligible.

Within these organisations, staff can be granted rights to load up and administer the digital objects themselves.

Who can access research in the Shared Repository?

There is no native Shared Repository website where people can go to see the materials; instead, items are automatically shared via the DigitalNZ Search website. All items in the Shared Repository are publicly accessible via DigitalNZ Search, as there is no private or protected access option available.

How much does it cost to participate in the Shared Repository (e.g. set up and ongoing annual fee/subscription)?

The Shared Repository is currently available at no cost-although, remember that it is only suitable as an access repository for small digital collections. There are no immediate plans to recover costs for this service but we reserve the right to introduce costing models at a later date should ongoing funding for the service be required. You will be notified by email if a costing model is being considered and may choose to discontinue your use of the Shared Repository.

What about copyright?

When you deposit a copy of an item into the Shared Repository you are in most cases creating a new "copy" of that object.

This means that you need to have copyright or a copyright licence to place it in the repository, unless the item is out of copyright.

If the item is a published work, check the publishing contract to see what copies are and aren’t allowed.

Copyright ownership does not change hands when you place material in the repository and will continue to be retained either by the author/s or the publisher. We are not asking or encouraging you to transfer copyright.

What is the relationship between the Shared Repository, DigitalNZ, and KRIS?

KRIS, the Kiwi Research Information Service, migrated to the DigitalNZ platform in 2011. Items in the Shared Repository can be included in KRIS via the DigitalNZ APIs.

How will you preserve the items in the Shared Repository?

The Shared Repository is designed as an "access repository", that will make digital items publicly accessible for the lifetime of the service. No mechanism for long-term digital preservation has been designed. If you are concerned about the long-term preservation of your materials please discuss this with us, and we can put you in contact with other experts in this field.

What kind of support is available to me as a user of the Shared Repository?

DigitalNZ staff are available to support you in your use of the Shared Repository system-including training on how to use the system and troubleshooting. Contact for support.

A straight-forward user guide is available:

DigitalNZ Shared Repository User Guide (Doc)

DigitalNZ Shared Repository User Guide (PDF)

How do I begin?

Review the terms of use for the Shared Repository then get in touch via We’ll discuss the options with you.