FAIR Vocabularies
FAIR custom vocabularies allow admin users to customise FAIR in the following ways:
- Create custom content for email alerts
- Customise existing links
- Create and add custom links
- Customise UI content
Users can access the Vocabularies tab via the Administer menu:
Details of the items users can customise from the Vocabularies tab are provided below.
Custom Content for Email Alerts
Users can provide custom content for all email alerts in FAIR
| Name | Description |
|---|---|
| Data access request approved email | Customise the content of the data access request approved email |
| Data access request archived email | Customise the content of the data access request archived email |
| Data access request denied email | Customise the content of the data access request denied email |
| Data access request error email | Customise the content of the data access request error email |
| Data access request email | Customise the content of the data access request email |
| Data transfer complete email | Customise the content of the data transfer complete email |
| Data transfer failed email | Customise the content of the data transfer complete email |
| Dataset update notification email | Customise the content of dataset update notification email |
| User approved email | Customise the content of the user approved email |
| User registered email | Customise the content of the user registered email |
| Service desk email | Provide a service desk email that can be referenced in custom email templates, by default this is the Aridhia service desk email |
| Service desk phone number (international format) | Provide a service desk phone number than can be referenced in custom email templates, by default this is the Aridhia service desk phone number |
| Signature company display link | Choose the display value for the Company Signature link below |
| Signature company link | Provide a default link that can be referenced in custom email templates, by default this is the Aridhia website |
Customise Existing Links
Users can provide their own custom links for existing menus and icons
| Name | Description |
|---|---|
| Cookie banner privacy link | Provide an external link for the privacy policy on the cookie consent banner |
| External links | Provide links for the external links dropdown in the top left of the UI |
| External links display name | Provide a custom name for the external links drop down |
| Feedback link | Provide a custom link for user feedback, by default this takes users to the Aridhia contact page |
| Knowledge base link | Provide a custom link to an external knowledge base, by default this goes to the Aridhia Knowledge Base |
| Knowledge base link title | Provide a custom name for the knowledge base Link, this is displayed when the user hovers over the knowledge base icon |
| Partner link | Provide a link to an external website, users can provide an image for the icon. This is disabled by default. |
| Partner link title | Provide a custom name for the partner link |
| Portal link | Enable and disable link to DRE portal |
| Terms and conditions link | Provide a link to custom terms and conditions. By default this takes users to the Aridhia DRE terms and conditions |
Create Custom Links
Users can create and add custom links to the landing page, datasets and omni-search
| Name | Description |
|---|---|
| Dataset links | Add custom links to a dataset, see link above for instructions |
| Role actions | Add custom actions to the landing page, see link above for instructions |
| Search links | Add custom links to search results |
| Search links title | Add title for custom links in search results |
Custom UI Content
In addition to the text customisation detailed below, users can also provide custom images for the landing page banner and image carousel by contacting the FAIR service desk.
| Name | Description |
|---|---|
| Landing page banner text | Customise the text in the FAIR landing page banner |
| Landing page custom content | Customise the content of the text panel on the bottom left of the landing page, by default this contains a high level description of FAIR Data Services |
| Landing page message | Customise the landing page message displayed to unapproved users |
| Landing page title | Customise the landing page title displayed to unapproved users |
Updated on October 20, 2023