Federating content from another Aristotle Metadata Registry | Aristotle Metadata Registry help documentation

Aristotle Metadata Registry help documentation

Content can only be federated from another Aristotle Metadata Registry by an Administrator.

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

Select 'Administrator tools' from the dashboard side panel.

Select 'Manage Federation Configurations'.

Select 'Add new federation registry'.

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

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

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

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

Creating a federation configuration

Select 'Administrator tools' from the dashboard side panel.

Select 'Manage Federation Configurations'.

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

Select 'Create New Federation Configuration'.

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

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.

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

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

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.

Select 'Create Federator Configuration' once satisfied.

Manually running a federation task

Note: Federation tasks can be run manually even if their 'Frequency' is not set to 'Manually'.

Select 'Administrator tools' from the dashboard side panel.

Select 'Manage Federation Configurations'.

Select the registry that you wish to run a federation configuration for.

Select the configuration you wish to run.

Notes:

Configurations can also be edited or deleted from the above screen by selecting 'Edit' or 'Delete' respectively (below)
- The only parameters of a federation configuration that cannot be edited are the Stewardship Organisation and workgroup that items are federated into.

Select 'Run Task'. Federation will begin immediately.

If you wish to view the current status of a federation configuration, select 'Logs'.

The value of the 'Actions' column will change from 'in_progress' to 'completed_success' when the task completes. Once the task has completed successfully, the federated items can be found in the specified workgroup.

Note: A configuration's 'Log ID' can be selected to view configuration details in JSON format (below).