Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs/usage/fair.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
sidebar_position: 12
title: FAIR
---

# FAIR aspects

FAIR stands for Findable, Accessible, Interoperable and Reusable. It applies to research data and an ELN such as eLabFTW can help you make your research data more FAIR.

## Persistent identifiers in eLabFTW

### elabid

This is an immutable identifier generated for each Experiment or Resource and looks like this:

`20260612-8d5f3a5b81a395c113f954d33d5a7d4da30a7bc9`

It starts with the creation date followed by a random string of characters.


### ORCID

ORCID ([website](https://orcid.org/)) are identifiers for researchers. It is possible to set your ORCID from your profile:

- Go on Settings page
- Go on Account tab
- Set your ORCID

#### Automatic ORCID assignation

Since version 5.6 it is possible to define an attribute at the IdP level so ORCID can be populated from SAML response. For example, set `eduPersonOrcid` or `1.3.6.1.4.1.5923.1.1.1.16` in IdP attributes, so user accounts will get assigned an ORCID directly upon login if it is sent by the IdP.

### ROR

ROR ([website](https://ror.org/)) are identifiers for organizations. It is possible to define ROR associations at three different levels:

- Instance level
- Team level
- User level

As a Sysadmin, you can add ROR from the Sysconfig page. These will then apply to everyone on the instance.

As a team Admin, you can add ROR from the Admin panel. These will then apply to everyone in your team.

As a User, you can add ROR from your Profile page.

ROR are exported in `.eln` exports, and also visible in PDF exports.

![ROR association interface](/img/fair-ror.webp)

### ELN

The `.eln` file format, based on **RO-Crate** allows you to export and import data to and from your eLabFTW instance. See [Import/Export page](/docs/usage/import-export).
Binary file added static/img/fair-ror.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.