> 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/federator/setting-up-the-federator.md).

# 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="/files/B28az8wqGeD4DeMmlDYj" alt=""><figcaption></figcaption></figure>

2. Select 'Manage Federation Configurations'.

<figure><img src="/files/iI7brSxPEbvEaJE4sxTq" alt=""><figcaption></figcaption></figure>

3. Select 'Add new federation registry'.

<figure><img src="/files/qN0gXHY8EATrqpAt4PjV" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/SRgbn4vsEKewvtGZTHHi" 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="/files/3nQx9hjk4X9Zrcx70eCL" 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="/files/MuFweyQ4MO7iVskKptiq" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/UlI6yzo4i88JzGxg4Yrd" alt=""><figcaption></figcaption></figure>

## Creating a federation configuration

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

<figure><img src="/files/B28az8wqGeD4DeMmlDYj" alt=""><figcaption></figcaption></figure>

2. Select 'Manage Federation Configurations'.

<figure><img src="/files/iI7brSxPEbvEaJE4sxTq" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/Nvs6MUeVhtChC8vifDc2" alt=""><figcaption></figcaption></figure>

4. Select 'Create New Federation Configuration'.

<figure><img src="/files/emGZXhzWxWD5L7kjvatZ" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/0PUEltkETmOBFUbZgjyZ" 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="/files/FiKTfXZK37fztDlsOEyd" 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="/files/LDXfeQUP9AblTvNVwnzv" alt=""><figcaption></figcaption></figure>

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

<figure><img src="/files/6dQtmMAlWLxoQZKiPNfd" 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="/files/23K8XkykZPhFZO5qbk9m" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/rdOy2S1kd68G1YMxvFWP" alt="" width="557"><figcaption></figcaption></figure>

10. Select 'Create Federator Configuration' once satisfied.

<figure><img src="/files/yyXM6SJWCVJe6vudJB36" alt=""><figcaption></figcaption></figure>
