1. Home
  2. Release Notes for FAIR Data Services
Searching...

Release Notes for FAIR Data Services

FAIR Data Services version:

1.2.5

Summary

The 1.2.5 version is focused around the oAuth Gateway. Essential work to enable further improvements around DARs and other features.

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
Task Align FAIR Authentication to use the oAuth Gateway
  • Sign in/sign out/password reset all work as expected

    • Sign in redirects back to FAIR as authenticated user.
  • Commons mode is not supported yet.
Task Fix Logout and Password Reset redirecting to Workspaces when using oauth-gateway auth

As a logged in user in FAIR, logout redirects to a FAIR URL

As an unauthenticated user (commons mode disabled), when I navigate to FAIR and click the “Forgot your password?” link and follow the steps to change my password, I am redirected back to FAIR.

Bug Fix Notifications rendering bad URL with oauth-gateway authentication For a given dataset after creating a Data Access Request:

  • the user is sent an email containing a valid link.
  • the data owner of the dataset is sent an email containing a valid link.
Bug User is always redirected to /#/data/home on browser tab load

Navigating directly (ie with no existing FAIR browser window open) to a FAIR URL such as /#/data/datasets will open the /#/data/datasets page with an authenticated session.

Bug Duplicate fetch to user record on login creates 2 audit events

Only 1 audit event is recorded upon user sign in.

1.2.4

Summary

The 1.2.4 version enables upload to distinguish data files and attachments and therefor enables more configuration. Additionally the audit show now errors when a data transfer did not work.

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
Story Audit details on selection failures when a DAR transfer fails

A data transfer now fails due to mismatched dictionary table + data source fields:

  • Audit shows details on failing field + table
  • The audit messages are accessible from the fair-ui.
Task File Uploads – Allow Data File Type to be set in Attachment Upload

Now data files and attachments can be distinguished and different permissions can be configured. Permissions There are now a set of datafiles category permissions. These mirror attachment permissions but include ingest (ingest has been removed from attachments) and does not include download from standard user role. A data steward has the full set of datafiles permissions A standard user can see that there are datafiles An observer can see that there are datafiles To upload datafiles user must also have the can_upload_data permission on the dataset.

UI

  • When clicking on “Assign data to dictionary“ on the data file tool bar it should open a dialog. The dialog will provide three options:
  • When no dictionary exists, the dialog should provide an option where the user can create a new dictionary.
  • When one dictionary exists, the dialog should provide options where the user can add data to an existing dictionary or create a new dictionary.
  • When many dictionaries exist, the dialog provides options where the user can add data to a dictionary from the list or create a new dictionary.
  • Each of these options should give the user the ability to delete their file after transfer success
  • The option to convert to dictionary should only be visible if file is a csv and user has the correct permissions
  • On create a new dictionary will be created through the dataset patch endpoint and then ingested as a dictionary via the API. The dictionary definition should match the file headers.
  • When adding to an existing the dictionary, it does not need to create the dictionary and begins to transfer the file to that dictionary.

API New endpoints have been added: /files/datasets/:code/datafiles – upload & download /datasets/:code/datafiles/(:id) – list and delete datafiles

Task Authorized IP ranges should be defined on Kubernetes Services Security improvements around the Kubernetes Service Management API.
Task Add deploy stage to FAIR build pipelines

Deployment and testing improvements for continuous integration and delivery.

1.2.3

Summary

The 1.2.3 version improves API usability, enables smoother deployment and small UX improvements.

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
Task Fix inconsistencies in dataset and catalogue swagger docs

see: Swagger UI or on your own swagger documentation.

Task FAIR API: Worked example for create/update cycle of datasets

Dataset update cycle can now be demonstrated.

Task Checkbox for deleting a long life token are disabled when token has expired Now user can interact with the checkbox and delete expired tokens.
Story Synthetic data delivery on demand (alpha)

Synthetic data delivery on demand is now possible but not enabled in production because of security and policy concerns.

Task Add Request and transfer permissions to curated system roles

The data access request and transfer user flow is possible with a standard user as the requester and a data steward as the approver.

Improvement K8s upgrade still causes downtime

K8s upgrade most likely does not causes downtime anymore.

Task Build a new FAIR staging environment to be used for CI/CD purposes Improvements in continuous integration and continuous deployment.
Bug Dataset view: Dictionary Table header floating UX bug

Fields that have been scrolled passed do not appear above the header. The header now remains at the top.

1.2.2

Summary

The 1.2.2 version enables a visibility of a dataset after search and introduces API changes around dataset and catalogue, please use {code} instead of {id} for those.

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
Story Show dataset visibility in UI search and metadata

Users can understand what kind of visibility the has dataset they are viewing.

  • When viewing a catalogue entry
  • When viewing search results

Visibility levels: Private / Public / Internal

Is visible on: Datasets table, Saved searches table, Dataset list, Search results.

Task Coalesce datasets and catalogues

API changes around datasets and catalogues. Please check the swagger docs: fair.preview.aridhia.io/api/docs/

Bug Horizontal scroll bar introduced when error displayed on fetching attachments in narrow panel When on narrow mode the element widths do not make the horizontal scrollbar appear.
Task Destroy Blob Data After FAILED Data Load
  • Uploaded CSV data files against a dictionary are removed after 30 days (can be configured)
  • Job will run every 6 hours

Note that a successful upload automatically deletes the data file.

1.2.1

Summary

The 1.2.1 version enables a log retention time just for the FAIR Audit , the Camunda token handling was improved including security improvements and bug fixes.

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
Improvement Make FAIR custom log retention independent from overall log analytics retention period
  • A new hub can be deployed with a separate retention policy for Fair Audit custom log in the log analytics workspace.
  • Can upgrade existing hub with separate retention policy for Fair Audit.
  • Non FairAudit_CL logs expire as per log workspace retention period.
Task Create and pass a long life token to Camunda replacing interim single use secret

Camunda workflows continue to operate as normal using long-life tokens to authenticate against FAIR.

System tokens created for Camunda workflows are only visible to admin users who can delete them if required. There is a new system role:

Request Notification Updates This contains a new token-only permission: requests.notify.

Task Remove Default Disclaimer from FAIR Transfers to the Workspace When transfers are made between FAIR and Workspaces, there is no default disclaimer in the XML anymore.
Task Azure Security Center scans 3rd party images We now scan FAIR 3rd party images for security vulnerabilities.

1.2.0

Summary

The 1.2.0 version includes an extension for permissions on token roles and various UI and UX improvements.

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
Enhancement Broaden Scope of Token Role Permissions The following permissions have been added to token roles:

  • All dataset permissions except download
  • All attachment permissions except download
  • All search permissions
  • All request permissions (including workflows)
  • Audit read
  • Selection read

The read-metrics token role has been updated with the following permissions:

  • Dataset audit
  • Search audit
  • Requests read and audit
  • Audit read
FAIR-3197
Enhancement Workspace destination selection in DAR There is now a label: “Only requests to a workspace you are a member of can be approved” and no workspace is selected by default. FAIR-3332
Enhancement Improve formatting on the DAR feedback – 'reason for decision' – field Data owner can now enter markdown in the feedback form and this is replicated on the request page. FAIR-3106
Bug UI: Incorrect text contrast on buttons for creating new dataset/request/finding data Text contrast now correct on all buttons for all themes in relation to the background. FAIR-3097
Bug UI: DAR – divider between radio buttons and dataset is misaligned Alignment is now fixed in the DAR-UI. FAIR-3152
Bug UX: Deleting a dictionary lookup results in a blank page Users who delete a lookup and apply changes will now be returned to the catalogue page, whether there are any other lookups or not. FAIR-2966
Task Security: Update Feature-Policy Headers to Permissions-Policy FAIR response headers are now shown as Permissions-policy rather than Feature-policy. FAIR-3252
Task Design Cohort Builder UX Finished UX design draft for the Cohort Builder feature. FAIR-3167

1.1.9

Summary

The 1.1.9 version includes an improved Search and bug fixes related to UI, messaging and data access request, dataset creation and data delivery.

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
Enhancement Search Revision 2: Search is not matching all dictionary fields Search improved:

  • Exact phrase matching works now (double quotation)
  • Improved dictionary and lookup matching
  • Limitation still exists due to azure index limits (lookup/dictionary > 3000 fields)
FAIR-3224
Bug UI – Audit log shows only the last 20 entries Now full available history is provided FAIR-3160
Bug Quotation and Degree Characters are retained in the transfer process Quotation and degree characters are now retained FAIR-3131
Bug UI – Dictionary names cut off and not fully shown Extra long dictionary names can now be read by a user. FAIR-3103
Bug [Notifications] Retrying to send a failed email message does not work In case sending an email fails, message is now resend FAIR-3050
Enhancement Camunda workflow errors cannot currently be accessed through the FAIR API or are displayed in the UI Errors in a data access requests are now displayed to the requester FAIR-2943
Enhancement Dictionary: duplicate entire rows Copying a row now creates a new row based on that row setting and all values except the name FAIR-2928
Enhancement Show a "There are no permissions to display" message when filtering permissions for a role returns no results When there are no permissions to display show the message: "There are no permissions to display" FAIR-2577

1.1.8

Summary

The 1.1.8 version includes Long Life Tokens, an improved Search and bug fixes related to Guest UI, dataset creation and data delivery.

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
Feature Long Life Tokens A user with token.create permission can create a long life token with following content:

  • Name
  • Code
  • Description
  • Expiry date (with a max value)
  • IP Range
  • Role

This can be done via API and UI.

FAIR-2976
Enhancement FAIR Search Revision: Version 1
  • Defined a set of search cases for testing
  • Improved Azure search default configuration
FAIR-2921
Bug Datasets created via API with no lookup section were invalid against schema
  • Dataset.lookups is now optional
  • User can create a dataset with an empty lookups section (0 item array)
  • Users can edit the created dataset in the UI
FAIR-2880
Bug Guest/Observer mode shows multiple select checkbox in dataset list without permission in this mode Observer/Guest users only see options available to their role. FAIR-2960
Bug UI shows button to edit for Guest user without permission to edit Observer/Guest users do not see misleading labels anymore. FAIR-2961
Bug XML files from FAIR transfers missing “Name” attribute Changed the JSON to XML conversion for the data transfer to a workspace. FAIR-3159
Bug Handle CSV Dataset upload to Postgres with blank Column Names Blank columns now raise an error. FAIR-3104

1.1.7

Summary

The 1.1.7 version includes small UX improvements and bug fixes related to uploading and the FAIR API.

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
Bug Transfer fails when selecting from zero row dictionaries Now an error is raised for zero row dictionaries, no files are uploaded. FAIR-3105
Improvement Allow users to see entity level audits A user with audit privileges can now see:

  • History of a role
  • History of a request
  • History of a dataset where they have read_audit permission
  • History of a search where they have read_audit

Audit events on transfers now reference the parent request.

FAIR-2935
Bug Remove 'name' in catalogue section A call to GET /datasets/{code} now returns dataset JSON without the redundant ‘name’ attribute. FAIR-2817
Enhancement Vibrant theme tooltips same as background colour Tooltips now use a colour that does not match the ribbon colour in the vibrant theme. FAIR-2766
Bug Uploading multiple resources results in resources file list overlapping dataset dictionary Now there is a scroll bar if there are are 6 or more resources. FAIR-2585
Feature Introduce Formatting in Descriptions It is possible now to have new paragraphs and bullet points in catalogue descriptions. FAIR-1703
Bug Updating a role is not audited It is now audited when a role is updated and an administrator (or any user with permission to update roles), can see that in the Audit tab. FAIR-2932

1.1.6

Summary

The 1.1.6 version allows users to upload their data as an attachment to a data dictionary. We are also working on the ability to transfer data into Aridhia workspaces upon approval. More information about these features can be found in our knowledgebase.

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 Request Data Transfer We have added the ability for data to be transferred to an Aridhia workspace upon approval.
Once approved, and if marked correctly, Data Transfer Requests can be sent to a Workspace.
More information is available on our knowledgebase. 		FAIR-2905/2907
Improvement Upload of data via attachments It is now possible to upload data to FAIR services by adding an attachment against a data dictionary in the UI.
CSV data can be added like an attachment to a data dictionary where it is stored as a resource.
Users can continue to upload data via the API. 		FAIR-2743
Enhancement Tooltips in narrow view We have made an enhancement so that tool tips are now shown in narrow view. FAIR-2901
Enhancement Public Datasets for Commons mode We have developed the data Commons Mode which allows non-authenticated users to access public datasets when the mode is turned on.
For more information about using Commons Mode, please contact the Aridhia team or check our knowledgebase. 		FAIR-2710
Bug Large field names not wrapped We fixed a bug where long field names were not wrapped meaning that they overlapped other words on screen. FAIR-2516
Bug Knowledgebase links from FAIR home page We have changed a link to the knowledgebase so that the “Learn” link on the FAIR homepage now links to the knowledgebase FAIR homepage. FAIR-2919

1.1.5

Summary

The 1.1.5 version of FAIR Data Services focuses on improving our Swagger documentation. We have also been working on our Upload UI and Public metadata functions which are due to be released soon.

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 General improvements to Swagger Documentation We have made some improvements to our swagger documentation so that they are up to date. FAIR-2790

1.1.4

Summary

The 1.1.4 version of FAIR Data Services primarily focuses on adding the capabilities to add custom Data Access Request (DAR) forms and allow Administrators to view audit and registered user lists. Specifically, this release includes:

  • Custom DAR forms and assigned to DAR workflows (via API)
  • Adding a ‘Audit’ panel to allow service Administrators (or those with the appropriate permissions) to view user audit.
  • Allowing service Administrators (or those with the appropriate permissions) to view user a list of service users and minimal information about these users.
  • Improvements to Omnisearch
  • A FAIR API script to download all existing DAR requests.

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 Introducing custom DAR forms Previously, a Data Access Request included a pre-defined DAR form that was applied to all requestable datasets. With great demand to allow data owners to specify the information they would like be collected from the user at the time of requesting access, we have introduced custom DAR forms. DAR forms are represented as JSON objects that can then be assigned to an existing DAR workflow via the API. FAIR-2510
Enhancement Adding user Audit to the UI User audit was previously only available via the API for users with Administrator permissions. This audit log has been added to the user interface via the ‘Audit’ menu, displaying the who, what, and when of audited events in the service. FAIR-2510
Improvement Adding user lists to the UI For users with Administrator permissions, the ‘Administer’ dropdown now contains a link to a users panel, listing all registered users, their assigned role and whether they are approved into the system. FAIR-2510
Enhancement Improving Omnisearch results Omnisearch now indexes the following information: * External links vocabulary * Privacy policy * Terms and conditions * API documentation FAIR-2510
Improvement Download all existing DAR requests A script has been created to download all existing (i.e. not deleted) DARs from FAIR. This script has been added to the FAIR API utilities repo at: https://github.com/aridhia/fair-api-beta-utilities FAIR-2812

1.1.3

Summary

The 1.1.3 version of FAIR Data Services primarily focuses on internal improvements to support upcoming features such as data delivery between FAIR Data Services and Workspaces as well as a bug fixing regarding searching the Aridhia Knowledge Base. Specifically, this release includes:

  • Introducing API routes for data transfers
  • A fix allowing the Knowledge Base to be searched within the service.

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 Introducing API routes for data transfers API endpoints have been added to FAIR to allow data transfers between FAIR and Workspaces, e.g. after a Data Access Request. This data delivery pipeline is still in development hence these API endpoints are unavailable until this feature is released. FAIR-2700
Bug Fix The Knowledge Base search is broken The URL to search the Knowledge Base was changed hence this has been updated in FAIR. FAIR-2822

1.1.2

Summary

The 1.1.2 version of FAIR Data Services primarily focuses on adding user approval/disapproval functionality via the API as well as improved metadata and data upload validation and various bug fixes. Specifically, this release includes:

  • Addition of user approval and disapproval capabilities via the API.
  • Improved metadata and data upload validation.
  • A bug fix to redirect the user to a logout page upon logout.
  • A bug fix to ensure the metadata attachment table does not overlap other components.
  • A bug fix to ensure the search index is updated when a dataset’s visibility is updated via the UI.
  • A bug fix to ensure ‘https://’ is copied when the API endpoint is copied from the UI.

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
Enhancement User approval/disapproval via the API Previously, user approval and disapproval could only be performed by Aridhia. To make this self-service, this functionality is now possible via the API via the ‘/users/approve' and ‘/users/unapprove’ endpoints. Users will now also receive a default role upon signup (typically Observer unless other specified). This can be changed by the service Administrator at any time. FAIR-2022
Enhancement Improved validation for metadata and data uploads Both user-interface and API validation has been improved for metadata and data uploads. Specifically:

  • Metadata and data can now support the use of PostgreSQL keywords, e.g. GROUP.
  • Metadata and data can now support the use of capitalised fields.
    		• FAIR-2171
    Bug Fix Logging out of FAIR doesn’t redirect to logout page Upon user logout, FAIR now redirects the user to a logout page following the approach of logout from a Workspace. FAIR-2093
    Bug Fix Overlapping metadata attachment table A fix has been issued where the metadata attachment table sometimes could overlap into the data dictionary section depending on the size of the attachment table. FAIR-2522
    Bug Fix Dataset visibility changes in UI do not update search index A fix has been issued to update the search index when the visibility of a dataset is changed in the UI, e.g. if a dataset’s visibility is changed to private, it no longer appears in search results. FAIR-2558
    Bug Fix API Endpoint ‘Copy’ button does not copy ‘https://’ A fix has been issued to copy the entire API string, including ‘https://’ when selecting the ‘Copy’ button against the API endpoint text box in the ‘About’ dialog. FAIR-2514

    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:

  • Saving searches
  • Creating datasets
  • Edit a dataset catalogue
  • Adding dictionary
  • Edit a dictionary description
  • Requesting access to a dataset
  • Creating roles
  • Saving a theme Improved messaging will be applied to dictionary editing in a future release.
    		• 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

    Archive

    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:

  • GET/PATCH: the “metadata” top-level field in both the catalogue and dictionary sections has been removed.
  • POST: the “datasets” top-level field has been removed, hence batch uploading of multiple datasets in a single API call is no longer possible.

    • 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:

  • Long request names no longer introduce a horizontal scrollbar. The name now wraps with the request name box.
  • A gap has been introduced to ensure the request filter does not overlap with request details.
    		• 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:

    • lower case
    • alphanumeric and underscores
    • must start with a letter
    • fields must be unique in a dictionary
    • the dictionary name must be unique within a dataset

    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:

    • Terms and conditions link
    • The service logo link (top left)
    • A custom dropdown containing a series of links from the top menu bar.

    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

    Configuration Vocabulary API.

    		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
    • 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: * 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.