> For the complete documentation index, see [llms.txt](https://help.aristotlemetadata.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.aristotlemetadata.com/special-features/harvester/creating-new-harvest-configurations.md).

# Creating new harvest configurations

{% hint style="info" %}
Harvest configurations can only be created by registry Administrators.
{% endhint %}

Harvester configurations are used to define the settings of recurrent OAI-PMH[^1] harvesting routines.

From [LinkedIn](https://www.linkedin.com/advice/3/what-benefits-challenges-oai-pmh-metadata-harvesting): *OAI-PMH is a set of standards and guidelines that define how metadata can be exchanged among different systems. OAI-PMH is based on the concept of data providers and service providers. Data providers are the systems that expose their metadata through OAI-PMH, while service providers are the systems that harvest and use the metadata from data providers. OAI-PMH uses HTTP and XML as the communication and data formats, and supports six basic requests: Identify, ListMetadataFormats, ListSets, ListIdentifiers, ListRecords, and GetRecord. These requests allow service providers to retrieve information about the data providers, their metadata formats, their collections, and their individual records.*

### Prerequisites

For a harvest configuration to be created, you will need:

* A compatible OAI-PMH provider's URL (e.g. <https://datacatalogue.cessda.eu/oai-pmh/v0/oai>)
* A custom transformation service to have been set in the 'Custom Transformation Service List' (see [Managing custom transformation services](/special-features/harvester/managing-custom-transformation-services.md)).

### How to create a new harvest configuration

1. Select 'Administrator  tools' from the dashboard side panel.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2F8h3GiQn4kBiQdKnKkqON%2Fimage.png?alt=media&amp;token=f8d4d89b-0470-485c-99e6-e8f3eb680d82" alt=""><figcaption></figcaption></figure>

2. Select 'Manage Harvester Tasks'.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FKcMwxA1PFMjxO0jX0soy%2Fimage.png?alt=media&amp;token=309a543b-97fd-454c-8f3f-11f87cbe0a0d" alt=""><figcaption></figcaption></figure>

3. Select 'Add new harvest configuration'.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2Fm6EuDl3bEfSAmZoeEkK0%2Fimage.png?alt=media&amp;token=80b7882a-3f1e-4481-ac74-b6fd92da8c83" alt=""><figcaption></figcaption></figure>

4. Select 'Add new harvest configuration'.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FYRWvj08ndOb5Afke3tgg%2Fimage.png?alt=media&amp;token=fa9ede29-e018-4c64-9045-b1870658e114" alt=""><figcaption></figcaption></figure>

5. Populate the 'URL' field with an appropriate OAI-PMH provider's URL address.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2F3RM3bYXdKEMobIsUAgDo%2Fimage.png?alt=media&amp;token=62d25dbc-730c-4ca4-963e-7539c1c33ca0" alt=""><figcaption></figcaption></figure>

6. **If you wish to add custom keys or values to the header of the http request**, select 'Show advanced options, populate the relevant fields and select the '+' to add however many you require.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FQIhYxLenfd6NSaLcTs2d%2Fimage.png?alt=media&amp;token=028da1ef-791e-4bd5-8cda-2c3f8c5bf61a" alt=""><figcaption></figcaption></figure>

7. Select 'Validate'.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FXI3eGp9HxvzBOHX358Uv%2Fimage.png?alt=media&amp;token=d861d3fc-1d9c-4ff5-8945-daf03a26de0a" alt=""><figcaption></figcaption></figure>

8. Select a metadata prefix from the 'Metadata Prefix' dropdown.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2F1RzOaw7Wxm90203dCKZb%2Fimage.png?alt=media&amp;token=5eaa5689-f0ad-4d22-95ad-ba5cf7a2d071" alt=""><figcaption></figcaption></figure>

9. Select a custom transformation service from the 'Transformation Service' dropdown.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FlcVvkNCsr0l1ntF0sPfD%2Fimage.png?alt=media&amp;token=037cf7ce-834b-4348-98c6-828c4fde0ff7" alt=""><figcaption></figcaption></figure>

**Note:** See [Managing custom transformation services](/special-features/harvester/managing-custom-transformation-services.md) for instructions on creating new custom transformation services.

10. Select whether the configuration will be active, or paused upon creation using the 'Status' dropdown.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2Fe67iGMaRONcMSjgqFWZO%2Fimage.png?alt=media&amp;token=606bd9f0-4972-4dc8-90ac-21ed4a01f163" alt=""><figcaption></figcaption></figure>

11. Populate the following fields as desired:
    * 'Set Spec': A set of items to be harvested from the registry can be specified in this field. **Note:** This field is non-editable after creation of the harvester configuration
    * 'Frequency': The frequency with which the configuration will harvest the specified items
    * 'Notifying Email': An email address can be entered here for its owner to be informed of the outcome of each of the configuration's harvests
    * 'Identifier': An identifier to harvest can be optionally specified in this field. **Note:** This field is non-editable after creation of the harvester configuration
    * 'Error Handling': This field is used to specify whether the harvest will be:
      * 'Atomic': Harvested items will only be saved if every item is successfully harvested
      * 'Non atomic': Harvested items will be saved as they are harvested, even if other items in the harvest are not successfully harvested
    * 'Assigned User': The user responsible for this harvest configuration
    * 'Workgroup': The workgroup optionally responsible for this harvest configuration.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FsmACaDEnivqkZ7GTS3n3%2Fimage.png?alt=media&amp;token=f6fd0f3c-4b23-4e67-869c-3151faa6c426" alt=""><figcaption></figcaption></figure>

12. Select 'Create'.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FFfD1OB8LWswCrFCnPINI%2Fimage.png?alt=media&amp;token=41cefe42-0f6c-4af4-935d-4c197134c809" alt=""><figcaption></figcaption></figure>

13. The configuration will now appear in the 'Harvester Configurations' list. From here it can be:
    * Manually run via 'Run Task'
    * Edited via 'Edit'
    * Deleted via 'Delete'.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2Fx44uyVlwNsp3bppgEIxG%2Fimage.png?alt=media&amp;token=392c02ff-9f92-4320-befd-07bf17bd2fee" alt=""><figcaption></figcaption></figure>

**Note:** If a task is run manually, it cannot be cancelled or stopped until it has completed.

[^1]: Open Archive Initiative Protocol for Metadata Harvesting