1. Release Notes for FAIR Data Services

Release Notes for FAIR Data Services

FAIR Data Services version:

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.02 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
  • Search for datasets relevant to your research project using text-based simple or complex search queries.
Metadata Browsing
  • Understand existing datasets by viewing metadata including catalogue and field-level descriptions.
  • Download machine-readable dataset metadata.
Metadata Management
  • Upload your dataset metadata and associated attachments (e.g. PDFs, json, etc) to be discovered by others.
Role-based Access Control
  • Self-service signup with role-based user permissions. This includes read only and edit/update roles.
Built on Standards
  • Uses the Data Catalog Vocabulary (DCAT) for dataset instance-level descriptions.
Integration with Aridhia Workspaces
  • Single Sign On (SSO) between FAIR and Workspace services.
  • Consistent Aridhia DRE user interface.

Product Information

Information on how to use the product can be found on our FAIR Data Services Knowledge Base. Specifically:

For more information about the product, view our Aridhia FAIR Data Services web page or FAIR blog. Alternatively feel free to contact us.