Schnellstart für Forschungsgruppen

Technisch

1. Benennen Sie eine:n Team-Administrator:in.
Diese Person ist für die Verwaltung des Teams verantwortlich und fungiert als erste Ansprechperson für Fragen Ihrer Gruppenmitglieder. Die Person sollte eine dauerhafte Perspektive in der Gruppe haben.

2. Beantragen Sie die Einrichtung eines eLabFTW-Teams.
https://forschungsdaten-thueringen.de/antrag-elabftw.html

3. Gruppenmitglieder können nun Ihrem Team beitreten.
Anmeldung unter elabftw.hs-itz.de mit dem Hochschullogin und anschließend Auswahl des Teams.

4. Validierung neuer Mitglieder.
Team-Administrator:innen erhalten eine Benachrichtigung über neue Beitrittsanfragen direkt in eLabFTW und per E-Mail und müssen die Beitritte validieren.

5. Befördern Sie weitere Teammitglieder zu Team-Administrator:innen.

Organisatorisches

1. Machen Sie sich mit eLabFTW vertraut. 
z.B. mit Video-Tutorials, User-  und Team-Admin-Guides des Entwicklers oder den User- und Team-Admin Guides der TU Graz. Alle Funktionen von eLabFTW für Nutzende und Team-Admins können in der offiziellen Demo-Instanz des Entwicklers ausprobiert werden.

3. Entwickeln Sie eine Gruppenrichtlinie für die Nutzung von eLabFTW.
Dokumentieren Sie, wofür und wie eLabFTW in ihrer Forschungsgruppe verwendet wird. Die Gruppenrichtlinie sollte basierend auf gemachten Erfahrungen kontinuierlich angepasst werden. Dieses Beispiel illustriert eine Gruppenrichtlinie.

4. Erstellen Sie Vorlagen für Ressourcen und Experimente.
Vorlagen erleichtern die Dokumentation für Benutzer, da alle verpflichtenden und optionalen Angaben vordefiniert sind und nur noch ausgefüllt werden müssen. Dies unterstützt eine standardisierte Dokumentation.

5. Passen Sie die Teameinstellungen entsprechend Ihrer Richtlinie an.

6. Kommunizieren Sie die Richtlinie an neue Teammitglieder (Onboarding).

Nutzung

Der Dienst eLabFTW.hs-itz.de kann von allen Angehörigen der öffentlichen Thüringer Hochschulen über einen Webbrowser oder auch per Programmierschnittstelle (API) genutzt werden, sofern die Hochschule über das DFN-AAI Portal angeschlossen ist. Die Anmeldung im Browser erfolgt mit den Zugangsdaten Ihres Hochschulaccounts. Mit Funktionsaccounts ihrer Hochschule ist keine Anmeldung möglich. Bei Bedarf können durch die Systemadministratoren lokale Funktionsaccounts in eLabFTW angelegt werden. Sollte Ihre Hochschule bei der Anmeldung in der Webanwendung nicht auswählbar sein, wenden Sie sich bitte an den Helpdesk Ihres Rechenzentrums.
Personen, die keinen Account einer angeschlossenen öffentlichen Thüringer Hochschule besitzen, z.B. Kooperations- oder Projektpartner, benötigen zur Nutzung des Dienstes einen Gastaccount.

Teams

eLabFTW ist in sogenannten Teams organisiert. Ein Team umfasst eine Gruppe von Personen, die regelmäßig zusammenarbeiten, z.B. eine Forschungsgruppe. Zur Nutzung von eLabFTW ist die Zugehörigkeit zu (mindestens) einem Team eine zwingende Voraussetzung. Jedes Team wird von mindestens einer/m Team-Administrator:in (Team-Admin) verwaltet und betreut. Team-Admins können jedes Teammitglied zum Team-Admins befördern. Es sollte so wenige Team-Admins wie möglich, aber mehr als eine Person mit dieser Rolle geben.

Nach der erstmaligen Anmeldung in eLabFTW können Sie Ihr Team aus einem Dropdown-Menü auswählen. Sie können die angezeigten Teams durch das Eintippen von Text im Suchschlitz (z.B. Kürzel ihrer Hochschule) begrenzen. Sobald Ihre Beitrittsanfrage durch den oder die Team-Admin bestätigt wurde, gelangen Sie nach der Anmeldung zu Ihrem Dashboard.
Die Mitgliedschaft in mehreren Teams ist möglich. Allerdings kann die Mitgliedschaft in einem weiteren Team nicht mehr selbstständig beantragt werden, wenn Sie bereits Teil eines Teams sind. Die Team-Admins des zweiten Teams müssen Sie in diesem Fall über das Admin-Panel manuell hinzufügen.

• Sollte für Ihre Forschungsgruppe noch kein Team existieren, so können Sie ein Team über dieses Formular beantragen.
• Die Nutzung von eLabFTW als Individualnutzende:r ohne Teamzugehörigkeit wird nicht empfohlen. Sollten Sie eLabFTW dennoch ohne Teamzugehörigkeit individuell nutzen wollen, so wählen Sie bitte das Team "Without Team Yet". 
  Dieses Team teilen sich alle Individualnutzenden über alle Einrichtungen hinweg. Achten Sie deshalb besonders auf die eingestellten Sichtbarkeits- und Bearbeitungsrechte Ihrer Einträge. Wir empfehlen, die Standardeinstellung "nur für Nutzer und Admins" beizubehalten. Diese Einstellung beschränkt die Sichtbarkeit und Bearbeitung eines Eintrages auf den anlegende Nutzenden und den/die Team-Admin.

Benennung

Bei der Beantragung eines Teams können Sie den Teamnamen frei wählen. Wir empfehlen eine explizite Benennung, die es ihren Kolleg:innen einfach macht, ihr Team zu identifizieren. Ihrem gewählten Teamnamen wird das ihrer Hochschule entsprechende Kürzel vorangestellt, um die Unterscheidung zwischen Teams der verschiedenen Hochschulen zu erleichtern.

• BUW: Bauhaus-Universität Weimar
• DHGE: Duale Hochschule Gera-Eisenach
• EAH: Ernst-Abbe-Hochschule Jena
• FHE: Fachhochschule Erfurt
• FSU: Friedrich-Schiller-Universität Jena
• HfM: Hochschule für Musik Franz Liszt Weimar
• HSN: Hochschule Nordhausen
• HSS: Hochschule Schmalkalden
• TUIL: Technische Universität Ilmenau

• UE: Universität Erfurt

Nutzendengruppen

Innerhalb eines Teams können durch die Team-Admins sogenannte Nutzendengruppen angelegt werden. Diese Nutzendengruppen sind eine Zusammenfassung von Personen unabhängig von ihrer Teamzugehörigkeit und können zur Einstellung der Sichtbarkeits- und Bearbeitungsrechte eines Eintrages genutzt werden. Nutzendengruppen eignen sich somit sowohl zur Abbildung teaminterner Untergruppen als auch teamübergreifender Projektgruppen.

Funktionseinschränkungen und Störungen

Die größtmögliche Verfügbarkeit des Dienstangebots wird angestrebt, jedoch nicht garantiert. Über Funktionseinschränkungen und Störungen werden Sie, sofern technisch noch möglich, über ein Banner auf der Startseite von elabftw.hs-itz.de informiert. Unabhängig davon werden alle Störungen im Wiki der Universität Jena (öffentlich einsehbar) sowie in diesem Matrix-Kanal des Universitätsrechenzentrums (Matrix-Account notwendig) kommuniziert.

Planbare Wartungsarbeiten wie das Einspielen notwendiger Updates erfolgen mittwochs zwischen 17:00 und 22:00 Uhr. Sehen Sie in diesem Zeitraum bitte von einer Nutzung des Dienstes ab, da es zu Datenverlusten kommen kann. Die Wiederherstellung von im Wartungsfenster vorgenommenen Änderungen und von zu dieser Zeit eingespielten Daten ist im Verlustfall nicht möglich. Außerplanmäßige Wartungsarbeiten werden über das Banner auf der Startseite angekündigt. 

Probleme und Störungen melden Sie bitte über den Service Desk.

Backup und Restore

Das Universitätsrechenzentrum der Friedrich-Schiller-Universität Jena sichert den Datenbestand alle 24 Stunden. Das so angelegte Backup dient nur zur kompletten Wiederherstellung des Systems einschließlich angelegter Einträge und eingestellter Daten im Fall eines kritischen Ausfalls des Systems. Die Wiederherstellung einzelner Nutzendendaten nach eigenverantwortlicher Löschung ist nicht vorgesehen.

Nutzer:innen und Team-Admins können Einträge und angehängte Forschungsdaten eigenständig über die entsprechenden Funktionen von eLabFTW (im Browser oder über die Programmierschnittstelle/ API) in verschiedenen Formaten aus dem System exportieren. Wir empfehlen die regelmäßige Sicherung Ihrer Einträge auf Teamebene durch den Team-Admin.
Für den Export empfehlen wir das ELN File Format, welches die Metadaten eines oder mehrerer Einträge in einer JSON-Datei nach dem RO-Crate Schema speichert und gemeinsam mit an Einträge angehängten Dateien in einer Zip-Datei bereitstellt.

Lebenszyklus

Ein elektronisches Laborbuch wie eLabFTW dient der dauerhaften Aufbewahrung der Dokumentation von Experimenten im Sinne der guten wissenschaftlichen Praxis. Alle Daten in eLabFTW werden deshalb auf unbestimmte Zeit gespeichert. Nutzer:innen können Daten, für die sie Schreibrechte besitzen, löschen. Diese Löschung entfernt die Daten jedoch nicht vollständig aus dem System, sondern markiert sie nur intern als „gelöscht“. 

Empfehlungen zum Offboarding

Ausscheidenden Nutzenden empfehlen wir den Export eigener Daten, um sie etwa in einer anderen eLabFTW-Instanz weiternutzen zu können. Daten, die nicht mehr benötigt werden, sollten gelöscht werden (siehe vorheriger Abschnitt).

Anschließend sollte eine Archivierung der ausscheidenden Nutzer:innen durch den/die Team-Admin erfolgen. Dadurch wird ein Login ausgeschiedener Nutzer:innen unterbunden. 

Verantwortlichkeiten

Die Nutzung von eLabFTW ist freiwillig. Eine geplante verpflichtende Nutzung, z. B. im Rahmen der Projektdokumentation, ist vorher mit der/dem Datenschutzbeauftragten und dem Personalrat Ihrer Hochschule abzustimmen. Der Dienst dient ausschließlich der Forschungsdokumentation. Eine zweckentfremdende Nutzung wie z. B. zur Arbeitszeit- oder Leistungsüberwachung ist nicht gestattet.

Der Betrieb von elabftw.hs-itz.de erfolgt durch das IT-Zentrum der Thüringer Hochschulen (HS-ITZ) am Standort Jena. Die in eLabFTW hinterlegten Metadaten und hochgeladenen Daten sind auf Servern des Universitätsrechenzentrums der Friedrich-Schiller-Universität Jena gespeichert.

Support

Bei Fragen wenden Sie sich bitte zunächst an ihre:n Team-Admin. Probleme und Störungen können über den Service Desk gemeldet werden.

Fragen und Antworten

Wer betreibt die Instanz elabftw.hs-itz.de?

Die Instanz wird vom IT-Zentrum der Thüringer Hochschulen (HS-ITZ) durch das Universitätsrechenzentrum der Friedrich-Schiller-Universität Jena betrieben. Die Systemadministratoren sind Christian Knüpfer (Kompetenzzentrum Digitale Forschung der Universität Jena) und Hartmut Witschel (URZ der Universität Jena). Die Data Stewards des Thüringer Kompetenznetzwerks Forschungsdatenmanagement unterstützen im hochschulübergreifenden Support und bei der Durchführung von Schulungen.

Wo sind die abgelegten Daten gespeichert?

Betrieb und Speicherung erfolgen auf Servern des Universitätsrechenzentrums der Universität Jena. Die Software läuft in einer sogenannten virtuellen Maschine. Die Datenbank mit den Metadaten zu Nutzer:innen, Experimenten und Ressourcen sowie die Dateianhänge sind auf dieser virtuellen Maschine gespeichert. Perspektivisch erfolgt die Ablage der Dateianhänge auf einem CephFS-Speicher des URZ Jena.

Kann eine Struktureinheit mehrere Teams beantragen?

Ja, es gibt keine Beschränkung der Teamanzahl pro Struktureinheit. Zur Strukturierung der teaminternen oder teamübergreifenden Zusammenarbeit in Arbeitsgruppen oder Projekten stehen innerhalb eines Teams sogenannte Nutzergruppen zur Verfügung. Diese können von Team-Admins angelegt werden, um einen zusammengehörenden Personenkreis zu definieren. Nutzergruppen können analog zu Teams für die Einstellung der Sichtbarkeits- und Bearbeitungsrechte genutzt werden.

Kann man als Nutzer:in Mitglied mehrerer Teams sein?

Ja, die Mitgliedschaft in mehreren Teams ist möglich. Der Beitritt zu weiteren Teams ist jedoch nicht eigenständig möglich, sondern muss durch den Team-Admin des Zielteams erfolgen.

Wie werden die Zeitstempel für Experimente erzeugt?

Für die Erzeugung von Zeitstempeln wird der Zeitstempeldienst des DFN genutzt.

Wann wird das System aktualisiert?

Software-Aktualisierungen, sowohl von eLabFTW als auch des zugrundeliegenden Betriebssystems des Servers, werden schnellstmöglich im Wartungsfenster (jeden Mittwoch zwischen 17:00 und 20:00) eingespielt. Nutzende erfahren von anstehenden Updates und Wartungsarbeiten über ein Ankündigungsbanner auf der Startseite.

Bei umfassenderen Updates erfolgt die Information zusätzlich über das Wiki der URZ und den Matrix Kanal "Meldungen des URZ".

Wie können Daten aus bestehende eLabFTW-Instanzen in die Instanz des HS-ITZ migriert werden?

Daten können über Export auf der bestehenden Instanz und anschließendem Import auf der Zielinstanz migriert werden. Beide Instanzen sollten dafür am Besten auf die selbe Version von eLabFTW benutzen. Die Migration der Daten ganzer Teams erfordert die Einbeziehung der Systemadministrator:innen beider Instanzen. Wenden Sie sich in einem solchen Fall bitte an den Support über den Service Desk.

Eine vollständige Migration einer bestehenden Instanz ist nicht möglich.

Ist eine Kollaboration zwischen verschiedenen Instanzen möglich?

Nein, eLabFTW bietet momentan keinen instanzübergreifenden Datenaustausch an.

Gibt es eine dezidierte Instanz für die Nutzung in der Lehre?

Nein, die gibt es derzeit nicht. Einige Teams nutzen die Produktivinstanz elabftw.hs-itz.de für den Einsatz in der Lehre (z.B. Laborpraktika). Es gibt weiterhin eine Entwicklungsinstanz, die für zeitlich begrenzte Kurse genutzt werden kann. Sie ist jedoch nicht für die semestergebundene Lehre geeignet, da sie primär zum Testen neuer Updates dient und regelmäßig neu aufgesetzt wird. Die Nutzung der Entwicklungsinstanz ist mit den Systemadministratoren im Vorfeld abzusprechen.

Was sind empfehlenswerte Materialien für Neueinsteriger:innen?

• Deltablot: YouTube Tutorials, User Guide, Admin Guide
• TU Graz: User Guide, Admin Guide