Configuring Service Vocabularies

FAIR allows the configurability of aspects (or vocabularies) that the customer may like to customise in a self-service manner. Vocabularies are pre-configured within FAIR and have default values. These values are then modified by the API to custom locations a user specifies.

The following vocabularies exist that are detailed below:

  • 'Terms & conditions' from the avatar dropdown menu.
  • The 'Aridhia DRE FAIR' logo on the top left of FAIR.
  • An external link or dropdown of links from the FAIR header (i.e. where the Aridhia DRE FAIR logo and search bar are).
  • The DRE name specified on the home page
  • Data Access Request email contents for when a request has been made or been approved or denied emails.

Service Vocabularies

Terms and Conditions

The 'Terms & conditions' link in the user’s avatar dropdown menu can be customised to a link of your choosing. t_and_cs-206x300.png

Aridhia DRE FAIR logo / Portal Link

The link of the service logo located on the top left of the portal can be customised, e.g. to a landing page.


  • Default value: no value. Selecting the icon will take you back to the home page.

Custom Dropdown

A link or dropdown of links can be added to FAIR in the top header bar, e.g. to a list of Workspace in different geographical regions.


  • Default value: no value. No external link or series of links will appear unless added.

DRE Name

The name of the DRE specified on the home page.


  • Default value: 'Aridhia DRE'

DAR Email Notification Contents

The contents of the emails for the request, approved and denied DAR emails.


The email content can be adjusted in the 'Body' text box. Information can be brought in from FAIR using pre-defined variables. These are:

  • Owner of the dataset: <%= @context[:owner][:name] %>
  • The requesting user's name: <%= @context[:requester][:name] %>
  • The requesting user's email: <%= @context[:requester][:email] %>
  • The DRE name: <%= @context[:platform_name] %>
  • URL to the requested dataset: <%= dataset[:url] %>
  • Name of the requested dataset: <%= dataset[:name] %>
  • Link to the request: <%= @context[:url] %>
  • ID of the request: <%= @context[:code] %>
  • Name of the request: <%= @context[:fields][:name] %>
  • Email of reviewer: <%= @context[:approver][:email] %>
  • Name of the reviewer: <%= @context[:approver][:name] %>

Configuring Vocabularies

Service Vocabularies can be configured by the service administrator (or those with an appropriate role). Vocabulary management can be found by navigating to 'Administer' in the menu and then 'Vocabularies'. See the article 'Service Vocabulary API' for information how to modify vocabularies via the API.


The supported vocabularies are displayed in the panel. Vocabularies can be edited by selecting the vocabulary name or via 'Open' from the vocabulary dropdown.


The resulting dialog allows the user to change the data (e.g. links) associated with the vocabulary. In the example below, the Custom Dropdown links can be added/modified.


The changes are instantly available when 'Modify' has been selected.

Updated on September 18, 2023

Was this article helpful?