# Setting up the Federator

Federation rules are set up via federation configurations, which can then be run manually, or automatically via individually-configurable frequency settings. Before setting up a configuration, the external (source) registry must be specified in the Federator's 'Registry List'.

## Specifying an external (source) registry

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%2F68w4YqO7JfMx3fsu7WjX%2Fimage.png?alt=media&#x26;token=4afb2d3a-9395-4bcb-a0c3-93ed66a85507" alt=""><figcaption></figcaption></figure>

2. Select 'Manage Federation Configurations'.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FNYPPUSSOMiARtTSPvTGH%2Fimage.png?alt=media&#x26;token=e7fe93f6-5f62-41cb-b593-429110a166c6" alt=""><figcaption></figcaption></figure>

3. Select 'Add new federation registry'.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FCONhcFEl4h07iOyjxmTD%2Fimage.png?alt=media&#x26;token=8489ab0e-fe1c-4440-a360-47393611fef3" alt=""><figcaption></figcaption></figure>

**Note:** Existing entries in the registry list can also be edited or deleted from this screen (below).

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FN8IXDbJSDEHr5eJf74yg%2Fimage.png?alt=media&#x26;token=0f9ae889-0e3c-4785-a407-03ce62a06b6e" alt=""><figcaption></figcaption></figure>

4. Populate the 'Registry Name' field as desired. This name is for human identification of the source registry.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FrcnDUPktoTyC68WZlCYz%2Fimage.png?alt=media&#x26;token=8e800027-9c8f-4418-b6f6-589202c41023" alt=""><figcaption></figcaption></figure>

5. Populate the 'Registry URL' field with the URL of the source registry, **not including** any page-related URL elements (e.g. '/home').

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FFPYnYfCVOLtqQbr6Tk2k%2Fimage.png?alt=media&#x26;token=604a9aaa-88f4-46ca-8784-7811cc4c24fb" alt=""><figcaption></figcaption></figure>

6. Select 'Add Registry'. The registry will appear in the registry list.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2F8bb6f2lM5yxnRHFQBceV%2Fimage.png?alt=media&#x26;token=464367a8-10a5-4d81-9169-f7e1fd6387d3" alt=""><figcaption></figcaption></figure>

## Creating a federation 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%2F68w4YqO7JfMx3fsu7WjX%2Fimage.png?alt=media&#x26;token=4afb2d3a-9395-4bcb-a0c3-93ed66a85507" alt=""><figcaption></figcaption></figure>

2. Select 'Manage Federation Configurations'.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FNYPPUSSOMiARtTSPvTGH%2Fimage.png?alt=media&#x26;token=e7fe93f6-5f62-41cb-b593-429110a166c6" alt=""><figcaption></figcaption></figure>

3. Select the registry that you wish to set up a federation configuration for.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FVHvoCF84NuAzCyJ2dnzf%2Fimage.png?alt=media&#x26;token=8e1dec09-4880-4a5b-ac2c-b987851be6d0" alt=""><figcaption></figcaption></figure>

4. Select 'Create New Federation Configuration'.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FNeuA3zWi2730g3IpZ9jF%2Fimage.png?alt=media&#x26;token=fa6471fb-76db-4bb9-bc32-48f8fce3151f" alt=""><figcaption></figcaption></figure>

5. Populate the 'Name' and 'Description' fields as desired to provide context for the configuration.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2F4ankwhg8ACVIpCmgrwNT%2Fimage.png?alt=media&#x26;token=9900251e-dfff-4d11-9309-a59f95fa0756" alt=""><figcaption></figcaption></figure>

6. Select the frequency with which this configuration will be run via the 'Frequency' dropdown. Options are defined as follows:

* 'Manually': The configuration is only run when manually activated
* 'Daily': The configuration will run every day at 12:00am UTC
* 'Weekly': The configuration will run every Monday at 12:30am UTC
* 'Monthly': The configuration will run on the 1st of every month at 12:15am UTC.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2F6MVpmvLeehYXgpbU9N80%2Fimage.png?alt=media&#x26;token=2028f01d-c523-4723-a33f-58408448c3fe" alt=""><figcaption></figcaption></figure>

7. Select the Stewardship Organisation and workgroup that the federated metadata will belong to via the 'Stewardship Organisation' and 'Workgroup' fields respectively.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FsNaIyb9ZbcUYBml8DAH8%2Fimage.png?alt=media&#x26;token=89120fe6-5593-4cb6-9cdc-150d51e5d703" alt=""><figcaption></figcaption></figure>

8. Select the items you wish to federate from the source registry using the 'Items' dropdown.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2Fm5Ufp0Ls0FtkPT6reX7M%2Fimage.png?alt=media&#x26;token=b7a564b1-17c1-4f44-944f-cf64c8d4bea9" alt=""><figcaption></figcaption></figure>

9. **If you wish to see what items will be federated**, select 'Preview'. A list of all items related to the items you chose will be displayed, along with whether or not they are federable.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FousDY3k6g9zfscLZSn9K%2Fimage.png?alt=media&#x26;token=efdfa07f-29f2-4e60-b934-e9d60287f4d7" alt=""><figcaption></figcaption></figure>

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FSMIPu5iO8mjPZnWEXD8K%2Fimage.png?alt=media&#x26;token=b26f2483-8160-4486-86b4-2b5c99518630" alt="" width="557"><figcaption></figcaption></figure>

10. Select 'Create Federator Configuration' once satisfied.

<figure><img src="https://1464151032-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIXci0eiRxXA0UhVYnwA2%2Fuploads%2FzlpgBuS61wakU3Xz51Le%2Fimage.png?alt=media&#x26;token=135ccbe1-908c-4ee8-b4ee-05a668f8d5ef" alt=""><figcaption></figcaption></figure>
