FAIR Data Services version:
1.1.1
Summary
The 1.1.1 version of FAIR Data Services primarily focuses on adding email notifications for Data Access Requests as well improvements of displaying validation error messages and a migration of data dictionary ‘ids' to ‘codes’ – now becoming inline with other service components. Specifically, this release includes:
- Email notifications for Data Access Requests.
- Addition of ‘code’s to dictionaries.
- Inline validation error messages throughout the service
- The ability to customise the platform name specified on the home page (Default: Aridhia DRE)
- A bug fix to display the name of the dataset in the toast message when updated.
If you have any questions or feedback about our products, please do not hesitate to get in contact via our Service Desk.
Released Features
| Status | Feature | Description | Reference |
|---|---|---|---|
| Improvement | Data Access Request (DAR) notifications – for DAR-enabled customers | Email notifications have been introduced to inform the data owner when a request has been made for one of their datasets and when the data requestor when decision has been made regarding their request. | FAIR-2484 |
| Enhancement | Adding ‘codes’ to data dictionaries | Previously, dictionaries could be referenced internally and via the API by numerical id’s. These have been replaced by ‘codes’ (similar to other components of the service) that are alphanumerical and can be specified by the user upon dictionary creation. | FAIR-2272 |
| Enhancement | Inline validation messages |
Inline validation message have replaced top-level validation messages, that could be stacked if multiple were present. This is an enhancement of user experience where users can identify easier where a validation error occurs. This new messaging applies to:
|
FAIR-2341 |
| Improvement | Customisable home page organisation name via Vocabulary API. | The platform name on the home page, i.e. the ‘Aridhia DRE’ part of ‘Search across 0 dataset(s) in Aridhia DRE’ is now customisable via the Vocabulary API. | FAIR-2466 |
| Bug Fix | Hover to edit blocks editing of controlled vocabularies | The newly introduced hover to edit experience was halting users editing controlled vocabularies. A bug fix has been issued to address this. | FAIR-2511 |
| Bug Fix | Dataset name not displayed in toast message when updated | As part of a previous ticket, the dataset name disappeared from toast messages when the dataset was updated. The dataset name has now been re-added. | FAIR-2553 |
1.1.0
Summary
The 1.1.0 version of FAIR Data Services primarily focuses on adding new role administration user interface functionality as well as obtainable audit for role administration and Data Access Requests. Specifically, this release includes:
- User interface administration of Roles.
- Audited events for role administration, Data Access Requests and data upload.
- An audit read API endpoint where audit data can be retrieved for users with appropriate permissions.
- Various bug fixes regarding session expiry, API documentation and code validation.
If you have any questions or feedback about our products, please do not hesitate to get in contact via our Service Desk.
Released Features
This release brings you the following features:
| Status | Feature | Description | Reference |
|---|---|---|---|
| Improvement | FAIR Role Administration via UI | FAIR role administration was up until now, only possible via the API. From the ‘Administer’ dropdown, a ‘Roles’ menu has been added to the user interface where roles can be created, edited and deleted for users with appropriate permissions. Note: assigning roles to users via the UI will be available in a future release. | FAIR-2053 |
| Improvement | Auditing Data Access Requests (DAR) and Role Management | The following actions are now audited in FAIR: – DAR creation – DAR deletion – DAR decision (approval/denial) – Role creation – Role deletion Audit events include the user, the action and timestamp of the action. | FAIR-2367 |
| Improvement | Read FAIR audit via the API | Audited events in FAIR are now viewable via the API for users with appropriate permissions. This also includes being able to view the status of uploading CSV data. | FAIR-1891 |
| Bug Fix | Error when using non-alphanumeric characters in Search and Dataset codes. | Non-alphanumeric characters in Search and Dataset codes would be parsed in the resource URL and hence would become inaccessible. Validation has been added in the UI to disallow non-alphanumeric characters in codes. | FAIR-1819 |
| Bug Fix | Incorrect API Documentation for updating roles via the API | Removed documentation specifying that the role ‘code’ had to be added to the body of a PUT /role/{code} request. As code is included in the request, this is not needed. | FAIR-2515 |
| Bug Fix | Service failure when session token expires | In some cases when a session token expired (e.g. after 30 minutes), FAIR would become unusable unless a new session was started. This was due to the service randomly selecting a new reply_url after each session expiry. A fix has been issued where a set reply_url is always used by the service. | FAIR-2531 |
1.0.9
Summary
The 1.0.9 version of FAIR Data Services primarily focuses on adding new user interface functionality and an API improvement to ensure JSON consistency between /dataset API calls. Specifically, this release includes:
- User interface administration of themes and the Configuration Vocabulary.
- The addition of descriptions to data dictionaries.
- The ability to delete Data Access Requests (DAR) – for DAR-enabled customers
- Enhancements to the DAR request view when the panel is narrowed.
- Alignment of the /dataset GET, POST and PATCH JSON.
If you have any questions or feedback about our products, please do not hesitate to get in contact via our Service Desk.
Released Features
This release brings you the following features:
| Status | Feature | Description | Reference |
|---|---|---|---|
| Improvement | FAIR Theme and Configuration Vocabulary Administration via UI | FAIR themes and Configuration Vocabulary administration was up until now, only possible via the API. An ‘Administer’ dropdown has been added to the user interface where these features can be administered for users with appropriate permissions. | FAIR-2052 |
| Enhancement | Dictionary descriptions | Descriptions can now be added to data dictionaries, for example, to outline the purpose of the data table. This has a 4096 character limit. | FAIR-2217 |
| Improvement | Deleting my own DAR requests (for DAR-enabled customers) | DAR requests can now be deleted from within the request or from the requests list. | FAIR-1940 |
| Enhancement | Align dataset API JSON |
The JSON for GET, POST and PATCH calls to the /datasets endpoint have been aligned. Specifically:
The removal of these fields ensures the JSON retrieved from or sent to /datasets is more consistent. |
FAIR-1843 |
| Enhancement | DAR request panel narrowed enhancements (for DAR-enabled customers) |
In a narrowed request list panel:
|
FAIR-2228 |
| Bug Fix | DAR request button misaligned (IE11) – (for DAR-enabled customers) | Where no requests are present in the requests panel, the button to start a request was misaligned to the left. This has been centered inline with the presentation in other browsers. | FAIR-2234 |
1.0.8
Summary
The 1.0.8 version of FAIR Data Services primarily focuses on improved dictionary validation, click to edit experience and various bug fixes. Specifically, this release includes:
- An enhancement to ensure that dictionary and field names are SQL compliant. This is required to ensure data can be uploaded successfully to the dataset entry.
- A bug fix to ensure the number of datasets displayed on the home page is correct taking into account private datasets of other users.
- An improved dataset editing experience.
- A bug fix to ensure the data access request list filter works as expected (for DAR-enabled customers)
If you have any questions or feedback about our products, please do not hesitate to get in contact via our Service Desk.
Released Features
This release brings you the following features:
| Status | Feature | Description | Reference |
|---|---|---|---|
| Enhancement | Ensure dictionary and field names are SQL valid |
Dictionary and field names are required to be SQL compliant in the event data (e.g. csv) is uploaded to a dataset entry in FAIR as this data is then stored in the FAIR database. The dictionary and field names must adhere to the following rules:
Note: the next release will add ‘codes' to dictionaries allowing both a user-friendly name and an SQL-compliant code. |
FAIR-1724 |
| Bug Fix | Number of datasets on Home Panel incorrect | The number of searchable datasets displayed on the home panel was incorrect due to the introduction of ‘private’ datasets, i.e. the number of private datasets of other users was present in this figure. A fix has been issued to ensure the total number of datasets subtracts the number of private datasets of other users from the total number of datasets in FAIR. | FAIR-2192 |
| Enhancement | Improve the dataset click to edit experience | The click to edit experience when editing a dataset has been improved, primarily to allow fields to be copyable and URLs to become clickable where both would previously take the user into ‘edit’ mode. A user can no longer select any part of the field to make it editable – they must select the edit button adjacent to the field. Similarly for both viewing and editing, a ‘copy’ button has been added adjacent to the field. | FAIR-2125 |
| Bug Fix | 'Unauthorised' message briefly appears when opening new panels | When opening a new tab/panel, a slight flicker could sometime be seen quickly showing an ‘unauthorised’ message when the tab/panel loads. A fix has been issued to remove this flicker. | FAIR-2190 |
| Bug Fix | Data Access Request (DAR) lists filter not returning results | For DAR-enabled customers who have submitted a request or have a list of requests to review, the top right list filter would not return results. A fix has been issued ensuring the filter works with requests as expected. | FAIR-2237 |
1.0.7
Summary
The 1.0.7 version of FAIR Data Services primarily focuses on fixing bugs as well as a minor enhancement for users requesting access to data (for Data Access Request (DAR) enabled customers). Specifically, this release includes:
- A bug fix to ensure API PATCH requests to a dataset dictionary can only be applied to the specified dictionary.
- A bug fix to ensure deleted datasets are removed from search results.
- Minor UI bug fixes to ensure dataset visibility filters are present when panels are narrowed and minor API URL copy hover text.
- An enhancement to pre-populate the ‘Applicant Name’ field in the DAR form with the user’s username.
If you have any questions or feedback about our products, please do not hesitate to get in contact via our Service Desk.
Released Features
This release brings you the following features:
| Status | Feature | Description | Reference |
|---|---|---|---|
| Bug Fix | PATCH request can update dictionaries of other datasets | A fix has been issued for a bug that allowed a dictionary of another dataset (via its ‘id’) to be updated when issuing a PATCH request via the API. | FAIR-2193 |
| Bug Fix | Search re-index upon dataset deletion not working | It was possible a deleted dataset would still appear in search results due to the search index not being updated. A fix has been issued to ensure the search is re-indexed after each dataset deletion. | FAIR-2198 |
| Bug Fix | Incorrect API documentation copy button hover text | The API URL can be copied from the ‘About’ dialog from the avatar dropdown menu. A fix has been issued where the hover text that incorrectly listed ‘copy token to clipboard’ has been changed to ‘copy url to clipboard’. | FAIR-2153 |
| Bug Fix | Private/internal visibility filters not shown in Datasets panel narrow view | When using the multi-panel layout (i.e. ‘Development’), narrowing the Datasets panel would not show the private and internal filters. A fix has been issued where these not persist when the panel is narrowed in size. | FAIR-2156 |
| Enhancement | Pre-populate applicant name in Data Access Request form | For Data Access Request (DAR) enabled customers, your service user name is now automatically added to the ‘Applicant Name' field within the DAR form. | FAIR-2159 |
1.0.6
Summary
The 1.0.6 version of FAIR Data Services primarily focuses on adding Data Access Request (DAR) functionality as well as addition ways to configure FAIR and general bug fixes. Specifically, this release includes:
- The introduction of DAR allowing users to request access data by completing a DAR form, submitting for request and for reviewers to approve or deny requests.
- The upload of data (e.g. csv) to dataset entries.
- Clickable URLs in metadata.
- A Configuration Vocabulary API and the introduction of theming in FAIR.
- Public vs internal searches.
- A fix to execute the search when the search URL is executed in the browser.
- A fix to the ‘Forgot Password’ link and process.
- A fix to allow the API docs to be accessed without a trailing slash (e.g. /api/docs)
If you have any questions or feedback about our products, please do not hesitate to get in contact via our Service Desk.
Released Features
This release brings you the following features:
| Status | Feature | Description | Reference |
|---|---|---|---|
| Improvement | Access Request Dialog and API Integration | Building upon the previous release’s Requests API, a DAR request dialog has been added to include a form that the requestor must complete for review by a DAR reviewer. Currently this form is pre-configured. See the Knowledge Base for more information on requesting access. | FAIR-1889 FAIR-2073 |
| Improvement | Requestor / Review Panels and Integration | Building upon the previous release’s Requests API, requestor and reviewer panels have been created to list access requests and their current status. Reviewers can approve or deny requests and supply a reason that is then reflected back to the requestor. See the Knowledge Base for more information on viewing and reviewing requests. | FAIR-1890 FAIR-2081 FAIR-2073 |
| Improvement | Data Upload and Auditing (Beta) | Data (e.g. CSVs) can now be added to dataset entries. With the introduction of DAR, data can be delivered to an Aridhia Workspace upon reviewer approval. Note data upload is only available via the API and using a tus-client. All data upload are audited. More information on how to upload data can be found here. | FAIR-1886 FAIR-1887 |
| Enhancement | Clickable Links | Links such as URLs and ‘mailto:’ are now clickable when viewing metadata. Clicking a link will open up the link in a new tab. | FAIR-1860 |
| Improvement | Configuration Vocabulary API |
The FAIR Configuration Vocabulary API provides the ability to customise links to external sources. Supported vocabularies that can be edited are:
These vocabularies can be changed via the API for users with the ‘vocabularies/update’ permissions. See the Knowledge Base for more information on how to use the |
FAIR-1968 |
| Improvement | Introduce Theming (with Dark Theme) | Theming has now be added to FAIR allow pre-defined themes to be applied to the user interface. Currently a dark theme has been added and can be set upon request to Aridhia. | FAIR-1824 |
| Enhancement | Introduce Public Searches | Previously, all saved searches were private to the user. Now searches can be made visible to all users in FAIR to allow searches to be shared with others. | FAIR-1723 |
| Bug Fix | Execute Search upon entering Search URL | Previously a search’s URL could be copied however when executed in the browser, the search would only execute when the user pressed enter. Executed Search URLs now automatically run the search and display the results. | FAIR-2112 |
| Bug Fix | Forgot Password link not Working | Upon clicking ‘Forgot Password', the user would previously be redirected to the sign-in screen. This link has been fixed to take the user to the correct page to reset their password. | FAIR-2017 |
| Bug Fix | Trailing Slash required to access API documentation | Accessing the API docs required a trailing slash after the api documentation path (e.g. /api/docs/). There is now no need to have a trailing slash to access the API documentation. | FAIR-1808 |
1.0.5
Summary
The 1.0.5 version of FAIR Data Services primarily focuses on adding private and internal datasets with the option to switch between both as well as work to support our work towards our Data Access Requests (DAR) feature being released soon. Specifically, this release includes:
- The addition of private datasets
- An API to support the DAR feature
- A workflow process definition to support the DAR feature
- Cleanup of orphaned dataset data
If you have any questions or feedback about our products, please do not hesitate to get in contact via our Service Desk.
Released Features
This release brings you the following features:
| Status | Feature | Description | Reference |
|---|---|---|---|
| Enhancement | Introduce Private Datasets | The previous release of FAIR introduced the concept of an internal dataset (i.e. viewable to all in FAIR). This release adds 'private' datasets that are only viewable to the creating user with now the option to specify on a per-dataset, the visibility of a dataset. | FAIR-1711 |
| Improvement | DAR Requests API | To support the DAR features being released soon, a requests API has been added allowing access requests to be listed, created and deleted (e.g. by the researcher) as well as approved or denied (e.g. by the Data Steward). Users will currently need further permissions above the managed roles to call this API. | FAIR-2009 |
| Improvement | Deploy Process Definitions | To support the DAR features being released soon, a workflow process definition has been created and deployed to FAIR to allow the lifecycle of requesting access and reviewing requests. Users will currently need further permissions above the managed roles to use this feature. | FAIR-2002 |
| Bug Fix | Cleanup of Orphaned Resources | A fix as been issued to solved the problem of when dataset data (in beta) was previously added then removed, the underlying database was not deleted. This caused problems when uploading data with the same name or selecting the data (in beta). | FAIR-1710 |
1.0.4
Summary
The 1.0.4 version of FAIR Data Services primarily focuses on:
- Improvements to the attachment upload experience
- Adding the the concept of ‘internal’ datasets (those that are viewable to all within a FAIR instance)
If you have any questions or feedback about our products, please do not hesitate to get in contact via our Service Desk.
Released Features
This release brings you the following features:
| Status | Feature | Description | Reference |
| Enhancement | Re-design Attachment Upload UI and Re-position | In order to upload an attachment, the user had to drag and drop (or select) a file into a panel below the dictionary section. The file would then appear in the top right part of the page. The attachment UI has been re-designed as a table that not only displays attachments but also allows users to upload attachments within the same table. This has been re-positioned to below the dataset description. | FAIR-1729 |
| Improvement | Introduce Internal Datasets | Creating a dataset in FAIR was always viewable to all users of the FAIR instance, with no choice to specify otherwise. Our the aim is to introduce 'private' datasets (i.e. only viewable to the user) and ‘internal’ datasets (i.e. viewable to all in FAIR), with the option to specify on a per-dataset, the visibility of a dataset. This specific improvement adds the concept of the ‘internal’ dataset with ‘private’ being added in the next release. Note: you will not see any difference in FAIR until ‘private’ datasets have been added. | FAIR-1450 |
1.0.3
Summary
The 1.0.3 version of FAIR Data Services primarily focuses on adding the capability to create, edit and delete dictionary controlled vocabularies via the user interface as well as the introduction of managed and custom roles. Specifically, this release includes:
- An enhancement to create, edit and delete dictionary lookups via the user interface
- API-based self-service user permission management via roles (i.e. groups of permissions)
- An enhancement to delete attachments via the user interface
- Minor user interface improvements such as consolidating metadata download buttons to a single menu in the actions ribbon.
If you have any questions or feedback about our products, please do not hesitate to get in contact via our Service Desk.
Released Features
This release brings you the following features:
| Status | Feature | Description | Reference |
| Enhancement | Introduce Dictionary Lookups Management in UI. | Previous versions of FAIR restricted the creation, editing and deletion of data dictionary controlled vocabularies to the API. This release adds the capability of creating, editing and deleting data dictionary controlled vocabularies via the UI by selecting the 'Manage Lookups' icon in the dictionary section. | FAIR-1401 |
| Enhancement | Delete Dataset Attachments in the UI | Previous versions of FAIR restricted the deletion of dataset attachments to the API. This release adds the capability to delete attachments via the UI when selecting ‘Delete’ from the attachment’s dropdown menu. | FAIR-1603 |
| Improvement | Addition of Roles | The concept of roles (or groups of permissions) has been added to FAIR. Roles can be managed via the API where users with appropriate permissions can either use Aridhia’s provided Managed Roles or create their own and assign these to other FAIR users. More information on Roles can be found in the FAIR Knowledge Base section | FAIR-1628 |
| Enhancement | Change Location of Dataset JSON Download Buttons | The catalogue and dictionary JSON metadata download buttons were situated in dataset’s panel, however the catalogue JSON download button position didn’t clearly indicate its purpose. These buttons have been moved to the actions ribbon under the ‘Download’ button. | FAIR-1702 |
| Enhancement | Rename of ‘Upload Dataset' to ‘Create Dataset’ | When there are no datasets in FAIR, there are buttons on the Home and Datasets panel suggesting to add datasets to FAIR. These were incorrectly labelled as ‘Upload a Dataset’ and have now been changed to ‘Create a Dataset’. | FAIR-1688 |
1.0.2
Summary
The 1.0.2 version of FAIR Data Services primarily focuses on adding the capability to delete data dictionaries via the user interface, enhancing elements of the user interface and other general bug fixes. Specifically, this release includes:
- An enhancement to delete data dictionaries via the user interface
- Dynamic update of total number of datasets displayed on the home panel
- Improved messaging for unauthorised users
- Bug fixes to ensure empty attachments can’t be uploaded and that long search or dataset names are displayed correctly in dropdown menus
- Rename of ‘code’ to ‘ID’ when creating datasets or saving searches
If you have any questions or feedback about our products, please do not hesitate to get in contact via our Service Desk.
Released Features
This release brings you the following features:
| Status | Feature | Description | Reference |
| Enhancement | Deletion of Dictionaries via the UI | V1.0/1.0.1 of FAIR restricted the deletion of data dictionaries to the API, however edit of existing dictionaries was possible via the UI. This release adds the capability of deleting dictionaries via the UI by selecting the 'bin' icon in the dictionary section. | FAIR-1335 |
| Bug Fix | Correctly display total number of Datasets in Home panel | Previous releases always showed that 18 datasets were available in FAIR regardless of whether datasets were added or removed. This release correctly displays the total number of datasets in FAIR and updates when datasets are added or removed. | FAIR-1592 |
| Bug Fix | Search and Dataset names overflow on dropdown menus | The dropdown menus of the ‘Search’ and ‘Datasets' list five searches and datasets respectively. If these had long names, they would be displayed beyond the dropdown limits. A fix has been introduced to curtail the search or dataset name to the limits of the dropdown menus. | FAIR-1503 |
| Enhancement | Improve ‘Awaiting Authorisation’ message | When a user signs up to FAIR and has no permissions, an ‘Awaiting Authorisation’ is displayed. The display of this message has been improved and aligns more closely with Workspaces. | FAIR-1484 |
| Enhancement | Change creation dialog ‘Code’ to ‘ID’ | When creating a search or dataset, a user supplied ‘code’ could be given in the dialog to identify the resource. The dialog has now been changed to reference ‘ID’ as this is more familiar with users. | FAIR-1701 |
| Bug Fix | Attachment uploads of size 0 bytes still succeed | Attachments with 0 bytes that are attempted to be uploaded will receive an ‘Upload Failed’ error. | FAIR-1607 |
1.0.1
Summary
The 1.0.1 version of FAIR Data Services primarily focuses on adding the capability to add data dictionaries via the user interface, providing visibility of API documentation and other general bug fixes. Specifically, this release includes:
- An enhancement to create data dictionaries via the user interface
- The availability of API documentation at /api/docs/
- Exposing the session storage access token for API use
- Bug fixes to align ribbon icons in IE11
If you have any questions or feedback about our products, please do not hesitate to get in contact via our Service Desk.
Released Features
This release brings you the following features:
| Status | Feature | Description | Reference |
| Enhancement | Creation of Dictionaries via the UI | V1.0 of FAIR restricted the creation of data dictionaries to the API, however edit of existing dictionaries was possible via the UI. This release adds the capability of adding dictionaries via the UI by selecting the '+' icon in the dictionary section. | FAIR-1330 |
| Enhancement | Exposing API documentation | API documentation has been added to you FAIR instance which is available at /api/docs/ (note the trailing slash – to be removed in the subsequent release). This documentation is Swagger-based conforming to OpenAPI v3. | FAIR-941 |
| Improvement | Expose Access Token in UI | The user’s access token (stored in the browser) has been exposed in the UI and is available in the user’s avatar ‘About’ dialog. This allows users to exercise the API using this token (which refreshes periodically) while we implement dedicated user API access keys. | FAIR-1596 |
| Bug Fix | Align IE Ribbon Icons | A fix has been issued that addresses UI ribbon icons labels being misaligned in Internet Explorer 11 (IE11). | FAIR-1597 |
1.0
Summary
Version 1.0 is the first public release of Aridhia’s FAIR Data Services product!
FAIR Data Services gives researchers and innovators the ability to discover and understand data through dataset search, classification and efficient metadata browsing capabilities described via dataset catalogues, dictionaries and associated attached assets. Our service is built upon the FAIR Data Principles of making data Findable, Accessible, Interoperable and Reusable (FAIR).
If you have any questions or feedback about our products, please do not hesitate to get in contact via our Service Desk.
Released Features
This first release brings you the following features:
| Data Discovery |
|
| Metadata Browsing |
|
| Metadata Management |
|
| Role-based Access Control |
|
| Built on Standards |
|
| Integration with Aridhia Workspaces |
|
Product Information Information on how to use the product can be found on our
FAIR Data Services Knowledge Base. Specifically: * Understanding FAIR Data Principles and the FAIR Data Services product * How to register for the product * How to navigate within the product * How to discover and view metadata * How to create, edit and delete datasets. For more information about the product, view our
Aridhia FAIR Data Services web page or FAIR blog. Alternatively feel free to contact us.