Metadatamanagement (MDM) Dokumentation

User-Rollen

Im Metadatenmanagementsystem (MDM) gibt es mehrere User-Rollen, für die jeweils nur bestimmte Teile der Dokumentation von Interesse sind. Im folgenden werden daher die Rollen aufgeführt und kurz erklärt.

Public User

Student, Researcher

Data Provider

DZHW interne/externe DatengeberIn, siehe Metadatenabgabe (Data Provider).

Publisher

DZHW-FDZ MitarbeiterIn

Admin

Weist User-Rollen zu.

Metadatenabgabe (Data Provider)

Allgemeines

Der Datenaufnahmeprozess im FDZ des DZHW

Das FDZ des DZHW stellt Daten quantitativer und qualitativer Erhebungen aus dem Feld der Hoch-schul- und Wissenschaftsforschung zur Verfügung. Ein fester Bestandteil dieser Arbeit ist zunächst der Prozess der Datenaufnahme, welcher im FDZ des DZHW durch ein selbst entwickeltes System, das Metadatenmanagementsystem (MDM) unterstützt wird. Das Besondere am MDM ist, dass Informationen über die eigentlich erhobenen Forschungsdaten, also Metadaten, erfasst werden. Für die strukturierte Aufnahme der Metadaten sind sieben unterschiedliche Ebenen im MDM vorgesehen: Studie, Erhebungen, Erhebungsinstrumente, Fragen, Datensätze, Variablen und Publikationen.

Innerhalb der Aufnahme von Forschungsdaten wird anhand der Metadaten auf diesen Ebenen erfasst, welcher Studie sowie Erhebung die Daten angehören, welche Erhebungsinstrumente genutzt wurden, welche Fragen darin gestellt wurden, welche Datensätze existieren, welche Variablen sich darin befinden und welche Veröffentlichungen bereits mit den Daten realisiert worden sind. Dadurch, dass alle Ebenen miteinander verknüpft sind, wird eine umfassende Durchsuchbarkeit aller verfügbaren Daten, die vom FDZ des DZHW über das MDM verwaltet werden, ermöglicht. Das System ist über die Website https://metadata.fdz.dzhw.eu zu erreichen.

_images/01_de.png

Darstellung der verschiedenen Ebenen im MDM, Ebene Studie aktiv

Die eigenständige Abgabe von Metadaten

Wenn Sie Ihre Daten im FDZ des DZHW abgeben möchten, erfassen Sie die projektbezogenen Metadaten selbst und können diese teilweise eigenständig in das MDM hochladen.

Die Abgabe der Metadaten ist innerhalb der einzelnen Ebenen unterschiedlich komplex, sodass die Daten für jede der sieben Ebenen separat erfasst und hochgeladen werden müssen. Hierfür hat das FDZ des DZHW feste Strukturen entwickelt, die im weiteren Verlauf dieser Anleitung für jede Ebene detailliert erläutert werden. Diesen Vorgaben ist unbedingt Folge zu leisten, damit ein erfolgreicher Upload der einzelnen Metadaten gewährleistet werden kann.

Aktuell können einige Metadaten bereits über eine Eingabemaske im MDM direkt eingetragen werden. Für die übrigen Ebenen müssen Excel-Tabellen ausgefüllt werden. Zusätzlich ist auf manchen Ebenen das Erstellen von weiteren Anhängen (vgl. Kapitel 2.5) vorgesehen. Die Excel-Tabellen und eventuelle Anhänge müssen für jede Ebene dann entweder in einer bestimmten Ordnerstruktur ins MDM hochgeladen werden oder zunächst dem FDZ zur weiteren Bearbeitung geschickt werden. Tabelle 1 zeigt eine erste Übersicht über das Vorgehen der Metadateneingabe auf jeder Ebene, detaillierte Erläuterungen werden in den nachstehenden Kapiteln folgen.

Tabelle 1: Vorgehen bei der Metadateneingabe pro Ebene

Ebene Metadaten eingeben Zusätzliche Dateien Metadaten abgeben
Studie Eingabemaske Anhänge (PDF) Eingabemaske ausfüllen
Erhebungen Eingabemaske Anhänge (PDF) Eingabemaske ausfüllen
Erhebungs- instrumente Excel-Tabelle/ Eingabemaske Anhänge (PDF, Excel) Ordner ins MDM laden/ Eingabemaske ausfüllen
Fragen Excel-Tabelle (oder Zofar) Fragebilder (.png) Im Vorlage-Ordner speichern
Datensätze Excel-Tabelle Anhänge (PDF) Ordner ins MDM laden
Variablen mind. 1 Excel-Tabelle mind. 1 Datensatz (Stata) Im Vorlage-Ordner speichern
Publikationen
Informationen dem FDZ schicken

Vorbereitende Schritte

Registrierung

Sie müssen sich zunächst auf https://metadata.fdz.dzhw.eu registrieren, um die Berechtigung für das Anlegen eines Projektes sowie das Hochladen von Metadaten zu erhalten. Dies können Sie über die Sidebar links auf der Website erledigen:

_images/02_de.png

Registrierung im MDM

Da das FDZ Ihre Registrierungsanfrage zunächst bestätigen muss, kann es etwas dauern, bis Sie freigeschaltet sind. Sie bekommen dann eine Bestätigung per Email.

Neues Projekt anlegen

Nach erfolgreicher Registrierung können Sie ihr Projekt im MDM anlegen, indem Sie sich in der Sidebar links anmelden:

_images/03_de.png

Anmeldung im MDM

Nach erfolgreicher Anmeldung erscheint in der Sidebar das folgende Feld:

_images/04_de.png

Bereich für Verwaltung von Projekten im MDM

Über den Plus-Button können Sie ein neues Projekt anlegen (vgl. Abb. 5). Als Projektname müssen Sie eine bestimmte ID angeben, welche das FDZ zuvor speziell für Ihr Projekt vergeben hat und Ihnen mitteilen muss (z. B. „gra2005“ für das Absolventenpanel 2005). Das Projekt ist dadurch im MDM angelegt, aber noch nicht automatisch freigegeben. Solange das Projekt noch nicht freigegeben wurde, können Sie es jederzeit über den Mülleimer-Button ganz links (vgl. Abb. 5) wieder löschen.

_images/05_de.png

Ein neues Projekt im MDM anlegen

Sie können nun beginnen, Ihr Projekt mit Metadaten zu füllen. Wie genau dies funktioniert, wird im Folgenden zunächst prinzipiell erläutert, ehe die konkret geforderten Metadaten in den einzelnen Ebenen in Kapitel 4 detailliert beschrieben werden.

Notwendige Schnittstellen und Dateien

Grundsätzlich gibt es zwei verschiedene Möglichkeiten Metadaten einzutragen bzw. hochzuladen: Eingabemasken und Excel-Tabellen. Eingabemasken ermöglichen eine komfortable Abgabe der Metadaten direkt auf der Website, während Excel-Tabellen zunächst ausgefüllt und im Anschluss daran entweder in einer bestimmten Ordnerstruktur (vgl. Kapitel 3.4) abgelegt und im MDM hochgeladen oder dem FDZ zur weiteren Bearbeitung zugeschickt werden müssen.

Eingabemasken

Für die Ebenenen Studie, Erhebungen und Instrumente steht bereits die Nutzung von Eingabemasken im MDM zur Verfügung. Jede Maske umfasst verschiedene Felder, welche mit den einzutragenden Informationen beschriftet sind. Einige Felder sind verpflichtend auszufüllen und deshalb mit einem Sternchen versehen. Sie werden beim Speichern der Eingaben automatisch darauf hingewiesen, wenn noch Felder offen sind, die nicht leer bleiben dürfen. Die Bedienung der Eingabemasken ist weitgehend intuitiv und an vielen Stellen selbsterklärend. Im Rahmen der relevanten Ebenen Studie, Erhebungen und Instrumente wird die Handhabung der jeweiligen Eingabemasken dann konkret gezeigt (s. Kapitel 4.1 und 4.2).

Excel-Tabellen

Für die weiteren Ebenen können Sie bereits vorbereitete Excel-Tabellen verwenden, in denen verschiedene Metadaten spaltenweise erfasst werden. Diese Excel-Tabellen finden Sie im Vorlage-Ordner der jeweiligen Ebene (vgl. Kapitel 3.4). Welche Metadaten Sie an welcher Stelle in der Excel-Tabelle eintragen müssen, erkennen Sie an den bereits vorgegebenen Spaltenüberschriften in der ersten Zeile der Tabelle. Dort stehen die Bezeichnungen der jeweiligen Metadaten, welche auf den ersten Blick etwas kryptisch erscheinen, innerhalb der noch folgenden Beschreibung der einzelnen Ebenen jedoch näher erläutert werden. Beispiele für Spaltenüberschriften in Abb. 6: number = Nummer des Instruments (Spalte A), surveyNumbers = Nummern der zugehörigen Erhebungen (Spalte B).

_images/06_de.png

Spaltenüberschriften, Excel-Vorlage für die Ebene Erhebungsinstrumente

Die Suffixe „.de“ und „.en“ sind Teil vieler Spaltenüberschriften und weisen auf die Sprache des einzutragenden Metadatums hin. Beispiel in Abb. 7: Beschreibung des Instruments auf Deutsch (Spalte C), Beschreibung des Instruments auf Englisch (Spalte D).

_images/07_de.png

Sprachensuffixe, Excel-Vorlage für die Ebene Erhebungsinstrumente

Ab der zweiten Zeile sind die Tabellenvorlagen leer und hier nur für das Beispiel bereits gefüllt (vgl. Abb. 8). Dort können Sie Ihre Inhalte entsprechend der Spaltenüberschriften eintragen. Inhaltliche Hilfen hierfür finden Sie in den Erklärungen zu den einzelnen Ebenen.

_images/08_de.png

Beispiele für den Inhalt der einzelnen Metadaten, Excel-Vorlage für die Ebene Erhebungsinstrumente

Bitte beachten Sie außerdem:

  • Die Excel-Tabellen enthalten je nach Ebene unterschiedlich viele Tabellenblätter, die Sie bearbeiten müssen.

  • Die Anzahl der Spalten pro Tabellenblatt variiert, sodass ein seitliches Scrollen oftmals notwendig ist.

  • Es gibt Metadaten, die Sie ausfüllen müssen, und solche, die Sie ausfüllen können. Die konkreten Ausfüllanweisungen finden Sie in Kapitel 4.

    Kontrolliertes Vokabular

Für einige Metadaten gibt es ein sogenanntes „kontrolliertes Vokabular“, d. h. dort können nur bestimmte Inhalte in die Spalten eingetragen werden. In diesen Spalten wird Ihnen in jeder Zelle eine Auswahl der möglichen Antworten anhand eines Drop-Down-Menüs angeboten und Sie müssen diese nur auswählen.

Häufig ist es der Fall, dass aus dem kontrollierten Vokabular einer bestimmten Zelle automatisch der Inhalt der nächsten Zelle folgt. Für dieses Szenario sind die Excel-Vorlagen vorbereitet, d. h. in den betreffenden Spalten sind über mehrere Zeilen bereits Formeln hinterlegt, die die nächste Zelle automatisch füllen und Ihnen viel Tipparbeit ersparen (vgl. Abb. 9). Die Vorlagen sind für alle Fälle vorbereitet, so dass die Formeln auch in höher nummerierten Zeilen stehen werden, die Sie voraussichtlich nicht mehr benötigen (bis einschließlich Zeile 20 der Excel-Vorlage für die Ebenen Instrumente sowie Datensätze, bis einschließlich Zeile 2000 der Excel-Vorlage für die Fragen- und Variablenebene). Zum leichteren Erkennen sind die betreffenden Zeilen in den Vorlagen bereits grau hinterlegt.

_images/09_de.png

Beispiel für eine Formel in einer befüllten Zelle in der Excel-Vorlage für die Ebene Datensätze

_images/10_de.png

Beispiel für eine Formel in einer leeren Zelle in der Excel-Vorlage für die Ebene Datensätze

Da Formeln in solchen Zellen, die nicht mit Inhalt befüllt sind (vgl. Abb. 10), einen fehlerhaften Upload der Excel-Tabelle hervorrufen, müssen die überflüssigen Formeln aus den nicht benötigten Zeilen herausgelöscht werden. Dies können Sie erledigen, indem Sie die nicht benötigten der grau eingefärbten Zeilen bis einschließlich der Zeile 20 (für Instrumente und Datensätze) bzw. der Zeile 2000 (für Fragen- und Variablenebene) markieren und über das Menü per „Blattzeilen löschen“ komplett entfernen (vgl. Abb. 11).

_images/11_de.png

Beispiel für das Löschen nicht benötigter Formeln aus der Excel-Vorlage für die Ebene Datensätze

Anhänge

Für einige Ebenen können verschiedene Anhänge entweder direkt über die Eingabemasken oder innerhalb der festgelegten Ordnerstruktur (vgl. Kapitel 3.4) im MDM hochgeladen werden. Zu den Anhängen zählen z. B. der Daten- und Methodenbericht auf der Studienebene sowie Fragebögen oder Codierlisten auf Instrumentenebene. Diese Dokumente müssen als Dateien im PDF- oder Excel-Format vorliegen (Details dazu finden Sie innerhalb der einzelnen Ebenen in Kapitel 4) und zudem nach bestimmten Richtlinien benannt werden. Für die Anhänge im PDF-Format gilt es darüber hinaus zu beachten, dass dokumenteigene Metadaten wie Autor und Titel aus der PDF-Datei gelöscht werden. Dies können Sie im PDF-Dokument über „Datei“ -> „Eigenschaften…“ erledigen.

Für das Hochladen der Metadaten über Excel-Tabellen gilt, dass die Anhänge im MDM in der Reihenfolge dargestellt werden, in der sie in der Excel-Tabelle eingetragen wurden. Genaue Informationen dazu finden Sie in den Erläuterungen für die einzelnen Ebenen.

Die korrekte Anordnung der Dateien im Ordner

Für einen erfolgreichen Upload der Metadaten über Excel-Tabellen müssen Sie sämtliche Dateien ihrer zugehörigen Ebene entsprechend in den vom FDZ vorbereiteten Vorlage-Ordner ablegen, welcher nach der jeweiligen Ebene benannt ist. Dieser Ordner sowie auch seine Unterordner sind mit englischen Begriffen betitelt. So heißt z. B. der Ordner der Instrumentenebene „instruments“ und der Ordner der Datensatzebene „dataSets“. Der Unterordner, welche alle Anhänge enthält, heißt unabhängig von der Ebene immer „attachments“. Die Reihenfolge der Dateien im Ordner sowie in den Unterordnern spielt keine Rolle. Da meist eine Sortierung nach alphabetischer Reihenfolge voreingestellt ist, steht der „attachments“-Ordner an erster Stelle, während die Excel-Tabelle erst danach folgt. Die vorliegende Ordnerstruktur am Beispiel der Instrumentenebene zeigt Abb. 12.

_images/12_de.png

Ordnerstruktur am Beispiel der Instrumentenebene

Die Abgabe von Metadaten für die einzelnen Ebenen

Studie (study)

Übersicht

Anhand der Informationen, die Sie bzgl. Ihrer Studie an das MDM liefern, wird dort später eine Übersichtsseite erstellt, die im Folgenden am Beispiel des Absolventenpanels 2005 dargestellt wird:

_images/13_de.png

Studienübersicht im MDM am Beispiel des Absolventenpanels 2005

Eine neue Studie anlegen

Nachdem Sie ein neues Projekt erstellt haben (vgl. Kapitel 2.2), können Sie nun innerhalb des Projektes eine Studie anlegen. Dazu finden Sie im Reiter „Studien“ unten rechts auf der Seite einen orangefarbenen Plus-Button. Wenn Sie mit dem Mauszeiger über diesen Button fahren, erscheinen links davon zwei weiße Buttons (vgl. Abb. 14).

_images/14_de.png

Optionen für das Anlegen einer Studie

Über den weißen Ordner-Button können Studieninformationen weiterhin mittels Ordner, der eine Excel-Tabelle und Anhänge enthält, hochgeladen werden, wobei diese Variante hier nicht weiter erläutert wird, da sie von der Eingabemaske abgelöst wurde. Mit einem Klick auf den weißen Plus-Button öffnet sich die Eingabemaske, in der Sie Ihre Informationen zur Studie ablegen können.

Eingabemaske

Die Eingabemaske auf Studienebene besteht aus den vier Abschnitten „Details“, „Studienbeschreibung“, „Projektmitarbeiter(innen)“ sowie „Materialien zu der Studie“. Der Abschnitt „Details“ ist der umfangreichste und wird im Folgenden aufgrund der Veranschaulichung mit bereits eingetragenen Informationen dargestellt (hier beispielhaft: 21. Sozialerhebung):

_images/15_de.png

Eingabemaske auf Studienebene, Abschnitt „Details“ am Beispiel der 21. Sozialerhebung

Nach dem Öffnen der Eingabemaske erscheint ganz oben die aus ihrem Projektnamen automatisch generierte ID für die Studienseite (s. rotes Kästchen in Abb. 15). Einige Felder, die Sie frei ausfüllen können, verfügen über einen Zeichenzähler, der Sie darüber informiert, wie viele Zeichen Sie dort insgesamt eintragen dürfen und wie viele Zeichen Sie bereits eingetragen haben (s. blaues Kästchen in Abb. 15). Außerdem finden Sie teilweise Drop-Down-Menüs vor, in denen Sie aus vorgegebenen Alternativen auswählen können (s. grünes Kästchen in Abb. 15).

Im zweiten Abschnitt der Eingabemaske müssen Sie eine Beschreibung Ihrer Studie sowohl auf Deutsch als auch auf Englisch eingeben. Für ein Beispiel ist im Folgenden die Beschreibung der 21. Sozialerhebung abgebildet:

_images/16_de.png

Eingabemaske auf Studienebene, Abschnitt „Studienbeschreibung“ am Beispiel der 21. Sozialerhebung

Im dritten Abschnitt der Eingabemaske geben Sie die Mitarbeiter(innen) Ihres Projekts ein. Für die Eingabe weiterer Personen klicken Sie einfach auf den blauen Plus-Button (s. Abb. 17). Wenn mindestens zwei Personen eingetragen sind, erscheinen die Pfeil-Buttons als aktiv (Farbwechsel von grau zu blau). Dann können Sie die Reihenfolge der Personen ändern, indem Sie die Namen nach oben oder unten verschieben. Links neben den bereits aufgeführten Personen erscheint in jeder Zeile ein blauer Button mit einem Mülleimer-Symbol, mit dem Sie den jeweiligen Namen wieder löschen können. Mit dem orangefarbenen Save-Button unten rechts können Sie Ihre Eingaben jederzeit abspeichern. Dies müssen Sie spätestens jetzt tun, da Sie ansonsten den letzten Abschnitt der Eingabemaske („Materialien zu der Studie“) nicht bearbeiten können.

_images/17_de.png

Eingabemaske auf Studienebene, Abschnitt „Projektmitarbeiter(innen)“

Im vierten und letzten Abschnitt der Eingabemaske können Sie Materialien zur Studie ablegen. Dazu klicken Sie auf den blauen Plus-Button (s. Abb. 18), woraufhin sich ein Dialog öffnet, in dem Sie eine Datei hochladen und diese näher beschreiben können. Die hier relevanten Materialien sind momentan der deutsch- und englischsprachige Daten- und Methodenbericht (DMB) sowie eine englischsprachige study overview. [1] Die Eingaben müssen Sie anschließend über den orangefarbenen Save-Button abspeichern. Mit den Pfeil-Buttons können Sie dann ggf. die Reihenfolge bereits eingegebener Materialien verändern. Wenn Sie eine geänderte Reihenfolge beibehalten möchten, müssen Sie erneut speichern.

_images/18_de.png

Eingabemasken auf Studienebene, Abschnitt „Materialien zu der Studie“

Editieren und historisieren

Falls Sie Ihre Informationen auf Studienebene nicht in einem Vorgang eingeben und hochladen können oder möchten, ist es immer möglich, dass Sie Ihre bisherigen Eingaben abspeichern und zu einem späteren Zeitpunkt weiter bearbeiten. Hierfür wird Ihnen im Reiter „Studien“ am rechten Rand neben Ihrer Studie ein Stift-Button angezeigt, über den Sie wieder in die Eingabemaske gelangen (s. Abb. 19).

_images/19_de.png

Weitere Bearbeitung einer bereits abgespeicherten Studie

Ebenso können Sie ältere Versionen Ihrer abgespeicherten Eingaben wiederherstellen, indem Sie im Bearbeitungsmodus den Historisierungs-Button (blauer Pfeil-Button über dem Save-Button unten rechts auf der Seite) verwenden (s. Abb. 20).

_images/20_de.png

Ältere Versionen einer Studie wiederherstellen

Bei einem Klick auf den Historisierungs-Button öffnet sich ein Dialog, der die verschiedenen Versionen der Studie anzeigt (s. Abb. 21). Zudem sind der Name des Nutzers, der die entsprechende Version der Studie gespeichert hat, sowie das Änderungsdatum sichtbar. Durch Klicken auf die Version wird diese wiederhergestellt, aber nicht automatisch als aktuelle Version gespeichert. Dies müsste über einen Klick auf den Save-Button erfolgen. Zu beachten ist, dass Materialien zur Studie nicht historisiert werden.

_images/21_de.png

Dialog zur Historisierung innerhalb einer Studie

Erhebungen (surveys)

Übersicht

Mit den Informationen über die Erhebung(en), die Sie innerhalb Ihrer Studie durchgeführt haben, wird im MDM folgende Übersichtsseite erstellt:

_images/22_de.png

Erhebungsübersicht im MDM am Beispiel der ersten Welle (Bachelor) im Absolventenpanel 2005

Eine neue Erhebung anlegen

Wenn Sie eine Studie angelegt haben (vgl. Kapitel 4.1), können Sie über den Reiter „Erhebungen“ eine neue Erhebung innerhalb Ihrer Studie erstellen. Hierzu finden Sie unten rechts auf der Seite – ebenso wie bei der Studie – einen orangefarbenen Plus-Button (vgl. Abb. 23). Wenn Sie mit dem Mauszeiger darüberfahren, erscheinen die beiden weißen Buttons, von denen Sie den Plus-Button anklicken, um die Eingabemaske zu öffnen. Bitte beachten Sie, dass Sie mehrere Erhebungen über die Eingabemaske in der richtigen Reihenfolge eingeben müssen, da die IDs beim Anlegen einer neuen Erhebung automatisch generiert werden und sich später nicht mehr verändern lassen.

_images/23_de.png

Optionen für das Anlegen einer Erhebung

Eingabemaske

Die Eingabemaske auf Erhebungsebene besteht aus den drei Abschnitten „Details“, „Weitere Informationen zum Rücklauf“ sowie „Materialien zu der Erhebung“. Im Folgenden wird der Abschnitt „Details“ – aufgrund der Länge in zwei Teilen – dargestellt:

_images/24_de.png

Eingabemaske der Erhebungsebene, Abschnitt „Details“ Teil 1

Beim Anlegen einer Erhebung wird automatisch die ID auf Basis des Projektnamens generiert (s. rotes Kästchen, Abb. 24, hier als Beispiel der 21. Sozialerhebung). Neben den bereits aus der Studienebene bekannten Funktionen gibt es in dieser Eingabemaske zusätzlich eine Kalenderfunktion (s. blaue Kästchen, Abb. 24), welche die Feldzeit des Projekts erfasst und in Abb. 25 dargestellt ist:

_images/25_de.png

Kalenderfunktion auf der Erhebungsebene

Im zweiten Teil der Eingabemaske für die Erhebungsebene gibt es die Besonderheit, dass sich die Rücklaufquote automatisch ermitteln lässt (s. Abb. 26). Sie können den Rücklauf auch manuell eingeben. Hierbei ist zu jedoch beachten, dass sich bereits eingegebene Zahlen bei Brutto- und Netto-Stichprobe bei nicht automatisch anpassen.

_images/26_de.png

Eingabemaske der Erhebungsebene, Abschnitt „Details“ Teil 2

Um den nächsten Abschnitt in der Eingabemaske („Weitere Informationen zum Rücklauf“ [2]) bearbeiten zu können, müssen Sie die bisherigen Eingaben abspeichern. Dann können Sie deutschsprachige und/oder englischsprachige Grafiken zum Rücklauf entweder über den blauen Plus-Button oder per Drag & Drop hochladen und dann mit dem Save-Button speichern. Diese Grafiken dürfen im svg-, png- oder auch PDF-Format vorliegen. Über den Button mit dem Mülleimer-Symbol lassen sich hochgeladene Dateien wieder löschen (s. Abb. 27).

_images/27_de.png

Eingabemaske der Erhebungsebene, Abschnitt „Weitere Informationen zum Rücklauf“

Im letzten Abschnitt der Eingabemaske können – wie auch bei der Studie – Materialien hinzugefügt werden (s. Abb. 28). Die Funktionsweise ist identisch zu der auf Studienebene. [3]

_images/28_de.png

Eingabemaske der Erhebungsebene, Abschnitt „Materialien zu der Erhebung“

Editieren und historisieren

Falls Sie Ihre Informationen auf Erhebungsebene nicht in einem Vorgang eingeben und hochladen können oder möchten, ist es immer möglich, dass Sie Ihre bisherigen Eingaben abspeichern und zu einem späteren Zeitpunkt weiter bearbeiten. Hierfür wird Ihnen im Reiter „Erhebungen“ am rechten Rand ein Stift-Button angezeigt, über den Sie wieder in die Eingabemaske gelangen. Außerdem finden Sie dort auch einen Button mit Mülleimer-Symbol, mit dem Sie die Erhebung komplett löschen können (s. Abb. 29).

_images/29_de.png

Weitere Bearbeitung einer bereits abgespeicherten Erhebung

Es ist außerdem möglich, ältere Versionen der bereits gespeicherten Eingaben wiederherzustellen. Im Bearbeitungsmodus gibt es auch auf der Erhebungsebene einen Historisierungs-Button, den Sie rechts unten über dem Save-Button betätigen können (s. Abb. 30).

_images/30_de.png

Ältere Versionen einer Erhebung wiederherstellen

Bei einem Klick auf den Historisierungs-Button öffnet sich ein Dialog, der die verschiedenen Versionen der Erhebung anzeigt (s. Abb. 31). Zudem sind der Name des Nutzers, der die entsprechende Version der Studie gespeichert hat, sowie das Änderungsdatum sichtbar. Durch Klicken auf die Version wird diese wiederhergestellt, aber nicht automatisch als aktuelle Version gespeichert. Dies müsste über einen Klick auf den Save-Button erfolgen. Zu beachten ist, dass Materialien zur Erhebung nicht historisiert werden.

_images/31_de.png

Dialog zur Historisierung innerhalb einer Erhebung

Erhebungsinstrumente (instruments)

Übersicht

Wenn Sie Informationen über Ihre Erhebungsinstrumente aufnehmen, wird folgende Übersicht im MDM erstellt:

_images/32_0.de.png

Instrumentenübersicht im MDM am Beispiel des Fragebogens der ersten Welle im Absolventenpanel 2005

Eingabemaske

Erhebungsinstrumente lassen sich per Eingabemaske erfassen und editieren. Dafür darf die Studie aktuell nicht released sein. Um ein Erhebungsinstrument mittels Eingabemaske anzulegen muss man sich im Datenaufbereitungsprojekt im Instrumentereiter befinden. Anschließend wird der Plusbutton gedrückt und es öffnet sich der Dialog um ein neues Instrument anzulegen.

_images/add_instrument_de.png

Plusbutton

_images/add_instrument_manually_de.png

Manuelles Anlegen des Instruments.

Die Eingabemaske besteht aus den Pflichtfeldern Beschreibung, Titel, Typ und Erhebung, sowie den nicht verpflichtenden Feldern Untertitel und Anmerkungen.

Des weiteren können weitere Materialien zum Instrument hochgeladen werden. Um weitere Materialien hochzuladen muss zunächst das Instrument abgespeichert sein. Im Anschluss muss der Plusbutton gedrückt werden, woraufhin sich ein Dialog öffnet (s. Abb. 35), in welchem der Anhang hochgeladen werden kann und Metadaten zur Datei eingegeben werden können. Um die Datei hochzuladen wird auf den Büroklammer-Button gedrückt und es öffnet sich ein weiterer Dialog. Alle Felder dieses Dialogs sind verpflichtend. Anschließend lässt sich der Anhang mit dem Speichern-Button (Diskettensymbol unten rechts) speichern.

_images/instruments_anhang_dialog.png

Instrumente Anhang

Excel-Tabelle

Sie können für jede Ihrer Erhebungen alle zugehörigen Instrumente inkl. Anhänge innerhalb einer Tabelle eintragen und hochladen. Dazu müssen Sie die Excel-Datei instruments.xlsx ausfüllen, welche aus zwei Tabellenblättern besteht: instruments und attachments. Nachstehend finden Sie die Erläuterungen zur Tabelle:

Tabelle 2: Ausfüllanweisungen für die Excel-Tabelle „instruments“

Tabellenblatt 1: instruments
Es können mehrere Instrumente eingetragen werden (= mehrere Zeilen möglich, ein Instrument pro Zeile)
Spaltenüberschrift Muss ich das ausfüllen? Was muss ich eintragen?
number Ja Nummer des Instrumentes (fortlaufend)
surveyNumbers Ja Nummer der zugehörigen Erhebungen
description.de/en Ja Beschreibung des Instrumentes
title.de/en Ja Titel des Instruments
subtitle.de/en Nein Untertitel des Instruments
type Ja

Instrumenttyp:

„PAPI“ (paper and pencil interview),

„CAPI“ (computer-assisted personal interview),

„CATI“ (computer-assisted telephone interview),

„CAWI” (computer-assisted web interview)

annotations.de/en Nein Anmerkungen zum Instrument
Tabellenblatt 2: attachments
Es können mehrere Anhänge eingetragen werden (= mehrere Zeilen möglich, ein Anhang pro Zeile)
Spaltenüberschrift Muss ich das ausfüllen? Was muss ich eintragen?
filename Ja Name der Datei im attachments-Ordner (z. B. „gra2005_W1_Questionn aire_de.pdf“)
type.de/en Ja

de: „Fragebogen“, „Filterführungsdiagra mm“, „Variablenfragebogen“ , „Sonstige“;

en: „Questionnaire“, „Question Flow“, „Variable Questionnaire“, „Other“

description.de/en Ja Beschreibung des Dokuments
language Ja

Sprache des Anhangs

Bitte verwenden Sie eine Abkürzung nach ISO 639-1:

    1. „de“, „en“
instrumentNumber Ja Nummer des dem Anhang zugehörigen Instruments

Zu den möglichen Anhängen zählen z. B. Fragebögen, Variablenfragebögen sowie Filterführungsdiagramme [4]. Diese müssen als PDF-Dateien vorliegen. [5] Außerdem können an dieser Stelle Codierlisten, welche als Excel-Tabelle vorliegen müssen, erfasst werden. Alle Anhänge werden im Ordner attachments abgelegt.

Für den Upload der Dateien ins MDM muss die Ordnerstruktur wie in Abb. 36 vorliegen.

_images/32_1_de.png

Ordnerstruktur: Inhalt des Ordners instruments

Hochladen können Sie den Ordner im Reiter Instrumente entweder über den orangefarbenen Plus-Button (unten rechts) oder per Drag & Drop.

Fragen (questions) [6]

Übersicht

Zu den einzelnen Fragen eines Instruments (sprich: Fragebogen) können Sie Informationen in das MDM übermitteln, in welchem dann für jede Frage folgende Übersichtsseite erstellt wird:

_images/33_de.png

Fragenübersicht im MDM am Beispiel der Frage 1.1 des Fragebogens der ersten Welle im Absolventenpanel 2005

Auf dieser Ebene werden Informationen über alle Fragen für jedes einzelne Erhebungsinstrument einer Studie abgeben. Der Einspeisungsprozess dieser Informationen hängt vom Typ des Erhebungsinstrumentes ab. Während Daten aus Onlinebefragungen, die mit ZOFAR, dem Datenerhebungssystem den DZHW, durchgeführt wurden, direkt aus dem System heraus extrahiert werden (siehe Questions (ZOFAR)), müssen Daten aus allen anderweitig durchgeführten Befragungen – sowohl andere Onlinebefragungen als auch PAPI-Befragungen – manuell erfasst werden (siehe Questions (manuell)). Im Folgenden werden beide Vorgehensweisen schrittweise beschrieben.

Questions (manuell)

Excel-Tabelle

Um Metadaten auf der Fragenebene in manueller Weise zu erfassen, müssen Sie die Excel-Datei questions.xlsx ausfüllen, welche die beiden Tabellenblätter questions und images beinhaltet. Sie können alle Fragen aus allen Erhebungsinstrumenten in einer einzigen Exceltabelle erfassen:

Tabelle 3: Ausfüllanweisungen für die Excel-Tabelle „questions“

Tabellenblatt 1: questions
Es können mehrere Fragen eingetragen werden (= mehrere Zeilen möglich, eine Frage pro Zeile)
Spaltenüberschrift Muss ich das ausfüllen? Was muss ich eintragen?
indexInInstrument Ja Nummer der Frage im Fragebogen, nach der die Reihenfolge festgelegt wird (ganzzahlig)
questionNumber Ja Fragenummer, idealerweise selbsterklärend aus Instrument (z. B. 1.1)
instrumentNumber Ja Nummer des Instruments
questionsText.de/en Ja „Übergreifender“ Fragetext, bei Itembatterien oder komplexen Fragen der einleitende Fragetext. Bei „einfachen“ Fragetypen der komplette Fragetext.
instruction.de/en Nein wenn vorhanden, Anweisungstext der Frage
introduction.de/en Nein wenn vorhanden, Einleitungstext der Frage
type.de/en Ja

de: „Einfachnennung“, „Offen“, „Mehrfachnennung“, „Itembatterie“ oder „Matrix“ (eine Anleitung zur Einteilung der verschiedenen Fragetypen kann unter https://github.com/dz hw/metadatamanagement /files/1421895/Anleit ung_Vergabe_Fragetype n.docx gefunden werden)

en: „Single Choice“, „Open“, „Multiple Choice“, „Item Set“ or „Grid“.

topic.de/en Nein Themenblock, in dem die Frage im Instrument eingeordnet ist (idealerweise direkt aus Instrument entnehmbar)
successorNumbers Nein Fragenummern der nachfolgenden Frage(n) (Angabe in einer Zeile durch Komma getrennt)
technicalRepresentati on.type x* Herkunft des Codeschnipsels (z. B. „ZOFAR-Question Markup Language“)
technicalRepresentati on.language x* Technische Sprache des Codeschnipsels (z. B. XML)
technicalRepresentati on.source x* Codeschnipsel, um Frage technisch abbilden zu können (z. B. QML-Schnipsel)
additionalQuestionTex t.de/.en Nein Weitere Ausführungen der Frage, die nicht im Fragetext stehen, wie z. B. der Itemtext (bei Itembatterien) oder Antworttext (bei Mehrfachnennungen). Aktuell ist diese Information für den Nutzenden des MDM nicht sichtbar, sondern wird nur bei einer Volltextsuche berücksichtigt.
annotations.de/en Nein Anmerkungen zur Frage

x* = nur, wenn technicalRepresentation vorhanden (wird dann automatisch von ZOFAR geliefert)

Tabellenblatt 2: images
Es können mehrere Bilder eingetragen werden (= mehrere Zeilen möglich, ein Bild pro Zeile)
Spaltenüberschrift Muss ich das ausfüllen? Was muss ich eintragen?
fileName Ja Dateiname des Bildes (z.B. „1.1_1.png“)
questionNumber Ja Dem Bild zugeordnete Fragenummer
instrumentNumber Ja Nummer des zum Bild gehörenden Instruments
language Ja

Sprache des Bildes

Bitte verwenden Sie eine Abkürzung nach ISO 639-1: z. B. „de“, „en“

indexInQuestion Ja Auf das wievielte Bild der Frage bezieht sich die Zeile? (Liegt pro Frage nur ein Bild vor, steht hier immer 1)

Mit dem zweiten Tabellenblatt images erfassen Sie Informationen zu den Fragebildern, welche Sie für jede Frage mit hochladen müssen. Zu jeder Frage muss mindestens ein Bild (es können auch mehrere sein) im png-Format vorhanden sein. Die Fragebilder können z. B. mit Ragtime extrahiert werden, sofern der Fragebogen auch mit Ragtime erstellt wurde. Ansonsten lassen sich die Fragebilder auch aus einer PDF-Datei erstellen. [7] Anleitung für beiden Varianten finden Sie unter https://github.com/dzhw/metadatamanagement-io/wiki/Bilderfassung-aus-RagTime und https://github.com/dzhw/metadatamanagement-io/wiki/Bilderfassung-aus-pdf.

Die fertig ausgefüllte Excel-Datei sowie die Bilder zu den Fragen speichern Sie dann in dem Ordner, den das FDZ für Sie vorbereitet hat. Das FDZ greift daraufhin auf die Dateien zu, verarbeitet sie weiter und lädt die Metadaten für die Fragenebene dann selbst ins MDM.

Questions (Zofar)

Bei Onlinebefragungen mit Zofar können die Metadaten für Fragen automatisch extrahiert werden (.jsons + .pngs).

Der Prozess befindet sich gerade im Aufbau…

Datensätze (dataSets)

Übersicht

Mit den Informationen über die Datensätze, welche Sie aus den Daten Ihrer Studie erstellt haben, wird für jeden dieser Datensätze folgende Übersicht im MDM angezeigt:

_images/34_0.png

Datensatzübersicht im MDM am Beispiel des Personendatensatzes (Bachelor) im Absolventenpanel 2005

Eingabemaske

Datensätze lassen sich auch per Eingabemaske anlegen und editieren. Hierfür muss man auf den Reiter Datensätze klicken (Abb. 1), anschließend auf das Plussymbol (Abb. 39) in der unteren rechten Ecke klicken und dann auf das Stiftsymbol (Abb. 40) („Klicken um einen Datensatz manuell zu erstellen“).

_images/new_dataset_de.png

Neuen Datensatz hinzufügen.

_images/new_dataset_step2_de.png

Klicken um einen Datensatz manuell zu erstellen.

Die mit * markierten Felder sind verpflichtend. Die verknüpften Erhebungen werden nach einem Klick in das Feld „Erhebungen“ automatisch vorgeschlagen und können per Klick ausgewählt werden. Im Anschluss werden die Subdatensätze per Eingabemaske auf der selben Seite eingegeben. Weitere Subdatensätze können per Klick auf das Plussymbol hinzugefügt werden. Nachdem gespeichert wurde, lassen sich weitere Materialien zum Datensatz hinzufügen.

Excel-Tabelle

Auf der Datensatzebene werden alle Datensätze und Subdatensätze [8], die einer Studie zugeordnet sind, erfasst. Ihre Informationen zu den Datensätzen können Sie in die Excel-Tabelle dataSets.xlsx, welche aus drei Tabellenblättern (dataSets, subDataSets und attachments) besteht, eintragen.

Tabelle 4: Ausfüllanweisungen für die Excel-Tabelle „dataSets“

Tabellenblatt 1: dataSets
Es können mehrere Datensätze eingetragen werden (= mehrere Zeilen möglich, ein Datensatz pro Zeile)
Spaltenüberschrift Muss ich das ausfüllen? Was muss ich eintragen?
number Ja Nummer des Datensatzes (laufende Nummer, eindeutig im Datenaufbereitungspro jekt)
description.de/en Nein Beschreibung des Datensatzes
type.de/en Ja

de: „Personendatensatz“, „Episodendatensatz“;

en: „Individual Data“, „Spell Data“

format.de/en Nein de: „breit“, „lang“; en: „wide“, „long“
surveyNumbers Ja Nummern der zum Datensatz gehörenden Erhebungen
annotations.de/en Nein Anmerkungen zum Datensatz
Tabellenblatt 2: subDataSets
Es können mehrere Subdatensätze eingetragen werden (= mehrere Zeilen möglich, ein Subdatensatz pro Zeile)
Spaltenüberschrift Muss ich das ausfüllen? Was muss ich eintragen?
name Ja Dateiname des „physikalischen“ Datensatzes ohne Dateikürzel (z. B. „gra2005_tS_p_c_1-0-0 “)
numberOfObservations Ja Anzahl der Beobachtungseinheiten in einem Datensatz (z. B. Anzahl der Befragten)
accessWay Ja „download-cuf“, „download-suf“, „remote-desktop-suf“ oder „onsite-suf“
description.de/en Ja Beschreibung des Datensatzes
dataSetNumber Ja Nummer des zugehörigen Datensatzes
citationHint.de/en Nein Hinweise zur Zitation: Primärforscher_1, Primärforscher_2 & Primärforscher_3 (Jahr). Studientitel. Aufbereitet durch FDZMitarbeiter_1, FDZMitarbeiter_2 & FDZMitarbeiter_3, doi: 10.21249/DZHW:a-Z0-9: 0-9.0-9.0-9, released Jahr. Hannover: FDZ-DZHW.
Tabellenblatt 3: attachments
Es können mehrere Anhänge eingetragen werden (= mehrere Zeilen möglich, ein Anhang pro Zeile)
Spaltenüberschrift Muss ich das ausfüllen? Was muss ich eintragen?
fileName Ja Name der Datei im attachments-Ordner (z. B. „DataSetReport-abs200 5-ds1.pdf“)
title Ja Titel des Anhangs
description.de/en Ja Beschreibung des Anhangs
language Ja Sprache des Anhangs Bitte verwenden Sie eine Abkürzung nach ISO 639-1: z. B. „de“, „en“
dataSetNumber Ja Nummer des zugehörigen Datensatzes

Wenn Sie Materialien auf Ebene der Datensätze haben, können Sie diese auch hier wieder im Ordner attachments ablegen. [9]

Um den erfolgreichen Upload der Informationen ins MDM gewährleisten, ist auf Datensatzebene folgende Ordnerstruktur vorgegeben:

Ordnerstruktur: Inhalt des Ordners dataSets

_images/34_1_de.png

Hochladen können Sie den Ordner im Reiter Datensätze entweder über den orangefarbenen Plus-Button (unten rechts) oder per Drag & Drop.

Variablen (variables) [10]

Übersicht

Anhand der Informationen, die Sie auf Ebene der Variablen abgeben, wird für jede Variable eine Übersichtsseite im MDM erstellt:

_images/35_de.png

Variablenübersicht im MDM am Beispiel der Variable „1. Studium: Beginn (Semester)“ im Absolventenpanel 2005, erste Welle (BA)

Die Erstellung der Variablenebene beinhaltet einerseits recht viel Aufwand, da für jeden Datensatz eine eigene Excel-Tabelle mit Informationen zu allen Variablen geliefert werden muss. Viele Informationen müssen manuell eingetragen werden, einige können – sofern die Befragung über Zofar stattgefunden hat – auch direkt aus Zofar extrahiert werden oder sogar aus der Excel-Tabelle der Frageebene importiert werden.

Die Variablenebene ist andererseits sehr wertvoll im Hinblick auf die Nachnutzbarkeit der Forschungsdaten. Wenn Metadaten auf dieser Ebene vorhanden sind, können die dazugehörigen Daten auch aus inhaltlicher Sicht umfassend durchsucht werden, sodass Analysepotential auch für sehr spezielle Fragestellungen direkt sichtbar wird.

Für die Darstellung der Metadatenaufnahme auf Variablenebene gilt es noch folgende Dinge zu beachten:

  • Wenn Sie mehrere Datensätze liefern: Es darf kein Variablenname doppelt vorkommen.
  • Missings müssen global definiert sein, d. h. sie müssen für alle Variablen eines Datensatzes gelten.

Excel-Tabelle

Ausfüllen müssen Sie je nach Anzahl der Datensätze mindestens eine Excel-Datei mit dem Namen vimport_ds***Nr.*.xlsx, wobei die „Nr.“ im Dateinamen der Nummer des dazugehörigen Datensatzes entsprechen muss, d. h. die Variablen des Datensatzes mit der Nummer 1 muss vimport_ds1.xlsx heißen usw. Die Datei enthält die beiden Tabellenblätter variables und relatedQuestions.

Tabelle 5: Ausfüllanweisungen für die Excel-Tabelle „vimport_ds*Nr*.“

Tabellenblatt 1: variables
Es können mehrere Variablen eingetragen werden (= mehrere Zeilen möglich, eine Variable pro Zeile)
Spaltenüberschrift Muss ich das ausfüllen? Was muss ich eintragen?
name Ja Variablenname
surveyNumbers Ja* Angabe aller der Variablen zugehörigen Erhebungsnummern (in einer Zelle durch Komma getrennt)
scaleLevel.de/.en Ja de: „nominal“, „ordinal“, „intervall“ oder „verhältnis“ en: „nominal“, „ordinal“, „intervall“ or „ratio“
panelIdentifier Nein* Identifier zur eindeutigen Zuordnung von Panelvariablen. Präfix muss aus der Projekt-ID + Nummer des Datensatzes bestehen (Beispiel: gra2005-ds1), der hintere Teil des Identifiers ist beliebig wählbar, muss aber eindeutig sein. Beispiel: Sind die Variablen astu01a und bstu01a aus dem 1. Datensatz des Projekts gra2005 Panelvariablen, so könnte der Identifier gra2005-ds1-stu01a lauten.
annotations.de/en Nein Anmerkungen zur Variablen
accessWays Ja* Mögliche Zugangswege: Download-CUF, Download-SUF, Remote-Desktop-SUF, On-Site-SUF. Bei mehreren Zugangswegen sind den verschiedenen Zugangswegen entsprechend Spalten vorhanden, die mit „nicht verfügbar im … “ überschrieben sind. Für jede Variable muss dann ein „x“ gesetzt werden, wenn ´diese über den jeweiligen Zugangsweg nicht vorhanden ist.
filterDetails.descrip tion.de/.en Nein Verbalisierte Beschreibung des Variablenfilters
filterDetails.express ion [11] Ja, wenn Filter vorhanden Regel, die in der angegebenen „Sprache“ (.expressionLanguage) beschreibt, welche Teilpopulation zu dieser Variable hin gefiltert wurde (auch verschachtelte Filterführung wird beachtet (PAPI))
filterDetails.express ionLanguage [12] Ja, wenn Filter vorhanden Sprache des Filterausdrucks: „Stata“
generationDetails.des cription.de/.en Nein Beschreibung, wie die Variable erzeugt wurde, wenn sie nicht direkt aus dem Fragebogen abgelesen werden kann (Beispiel, siehe Abschnitt „Generierungsdetails“)
generationDetails.rul e Ja, wenn Variable generiert Regel, die in der angegebenen „Sprache“ (.ruleExpressionLangu age) beschreibt, wie die Variable erzeugt wurde (Beispiel, siehe Abschnitt „Generierungsregel (Stata)“)
generationDetails.rul eExpressionLanguage Ja, wenn Variable generiert Sprache der Erzeugungsregel: „Stata“ oder „R“
derivedVariablesIdent ifier Nein*

Identifier zur eindeutigen Zuordnung von abgeleiteten Variablen. Präfix muss aus der Projekt-ID + Nummer des Datensatzes bestehen (Beispiel: gra2005-ds1), der hintere Teil des Identifiers ist frei wählbar, muss aber eindeutig sein.

Beispiel: Wurde die Variable astu01a_g1 aus astu01a abgeleitet, so könnte der Identifier gra2005-ds1-astu lauten.

Wichtig: Alle Variablen, aus denen die abgeleitete Variable entstanden ist, müssen berücksichtigt werden (sowohl aufwärts als auch abwärts).

Beispiel: Von der tatsächlichen Hochschule wird sowohl der Hochschulort (West-/Ostdeutschland ) als auch der Hochschulort nach Bundesländern abgeleitet.

doNotDisplayThousands Seperator Nein Wenn bei der Anzeige der Werte einer Variablen keine Tausendertrennzeichen angezeigt werden sollen, muss hier „true“ angezeigt werden (z. B. Jahreszahlen). Bleibt das Feld leer, wird dies als „false“ interpretiert, d.h. es werden Tausendertrennzeichen angezeigt.

* Wenn eigene Konventionen verwendet werden, muss das Feld manuell ausgefüllt werden. Bei Verwendung von FDZ-eigenen Schemata kann dieses Feld auch leer gelassen werden.

Tabellenblatt 2: relatedQuestions
Variablen, die mit mehreren Fragen verbunden sind, können mehrfach aufgeführt werden. Variablen, die keiner Frage (oder keinem Instrument) zugeordnet sind, müssen nicht eingetragen werden.
Es können mehrere verbundene Fragen eingetragen werden (= mehrere Zeilen, eine verbundene Frage pro Zeile)
Spaltenüberschrift Muss ich das ausfüllen? Was muss ich eintragen?
name Ja Variablenname
relatedQuestionString s.de/.en Nein Text, der den Frageinhalt der Variable darstellt. Also Fragetext der dazugehörigen Frage plus evtl. weitere Ausführungen wie bspw. der Itemtext (bei Itembatterien) oder der Antworttext (bei Einfach- oder Mehrfachnennungen)
questionNumber Ja Nummer der zur Variablen zugehörigen Frage im Fragebogen
instrumentNumber Ja Nummer des zur Variablen zugehörigen Fragebogens

Dem Namen entsprechend wird aus den Informationen des zweiten Tabellenblatts die Verknüpfung zwischen einer Variablen und der dazugehörigen Frage aus dem Erhebungsinstrument erstellt. Für eine nachvollziehbare Dokumentation dieser Verbindung ist die Erstellung eines Variablenfragebogens sehr hilfreich. Aus diesem kann die Verknüpfung aus Variable und Frage problemlos abgelesen werden. Abb. 42 zeigt beispielhaft, dass den Variablen astu08a bis astu08e die Frage 1.8 zugeordnet ist.

_images/36_de.png

Ausschnitt aus dem Variablenfragebogen des Absolventenpanels 2005, erste Welle, Frage 1.8

Außer der/den Excel-Tabelle/n müssen Sie für jede Tabelle noch den zugehörigen Stata-Datensatz liefern, aus dem die Variablen stammen. Diese Dateien speichern Sie dann in dem Ordner, den das FDZ für Sie vorbereitet hat. Das FDZ greift daraufhin auf die Dateien zu, verarbeitet sie weiter und lädt die finalisierten Metadaten für die Variablenebene dann selbst ins MDM.

Publikationen (relatedPublications)

Überblick

Auf der Ebene der Publikationen werden wissenschaftliche Veröffentlichungen, welche auf Grundlage von Daten Ihres Projekts verfasst worden sind, erfasst. Die Informationen, die Sie im Hinblick auf Ihre Publikationen abgeben, werden im MDM für jede Veröffentlichung wie folgt dargestellt:

_images/37_de.png

Publikationsübersicht im MDM am Beispiel einer Veröffentlichung, welche im Rahmen des Absolventenpanels 2005 verfasst wurde

Wenn Sie Publikationen zu Ihren Daten abgeben möchten, senden Sie dem FDZ per Mail die PDF-Datei Ihrer Publikation sowie den dazugehörigen Zitationshinweis zu. Die weitere Bearbeitung wie z. B. die Registrierung für das Erhalten einer DOI und den Upload ins MDM übernimmt das FDZ.

Die Freigabe eines neuen Projekts

Wenn Sie alle Metadaten ausgefüllt bzw. ans FDZ gesendet haben, melden Sie sich beim FDZ mit dem Hinweis, dass Sie Ihre Daten nicht weiter editieren möchten. Das FDZ nimmt ihre Daten dann in die sogenannte Release-Pipeline auf. Die finale Freigabe erfolgt dann über einen dafür benannten Mitarbeiter des FDZ, den Release-Manager.

Anhang

Checkliste für Abgabe der Metadaten

Vor Abgabe bzw. dem Hochladen der Daten sind folgende Punkte zu überprüfen:

☐ Ordnerstruktur und Dateinamen sind unverändert

☐ Excel-Dateien sind richtig und vollständig ausgefüllt

  • verpflichtende Felder sind ausgefüllt (vgl. Kapitel 4)
  • es sind keine Fehlermeldungen vorhanden
  • die Daten wurden auf Richtigkeit überprüft

☐ Metadaten sind aus PDF-Dokumenten entfernt (vgl. Kapitel 3.3)

☐ Nicht benötigte Zeilen entfernt (vgl. Kapitel 3.2)

  • instruments.xlsx: löschen bis Zeile 20
  • dataSets.xlsx: löschen bis Zeile 20
  • questions.xlsx: löschen bis Zeile 2000
  • variables.xlsx: löschen bis Zeile 2000

☐ Dateien sind richtig abgegeben worden

☐ In das Metadatensystem eingegeben
  • Studie (study)
  • Erhebungen (surveys)
☐ In das Metadatensystem hochgeladen
  • instruments.xlsx
  • dataSets.xlsx
☐ In der Ordnerstruktur abgelegt
  • questions.xlsx
  • variables.xlsx
[1]Bitte beachten Sie, die dokumenteigenen Metadaten der PDF-Dateien vorab zu löschen (vgl. Kapitel 3.3).
[2]Rücklaufgrafiken sind nur im Dokumentationsstandard der Stufe 3 gefordert. Die Erläuterungen zu den drei verschiedenen Dokumentationsstandards finden Sie in den Dokumenten „Anforderungen an Daten und Dokumentation im FDZ des DZHW“.
[3]Bitte beachten Sie, die dokumenteigenen Metadaten bei PDF-Dateien vorab zu löschen (vgl. Kapitel 3.3).
[4]Filterführungsdiagramme sind erst ab der 2. Dokumentationsstufe gefordert. Die Erläuterungen zu den drei verschiedenen Dokumentationsstandards finden Sie in den Dokumenten „Anforderungen an Daten und Dokumentation im FDZ des DZHW“.
[5]Bitte beachten Sie, die dokumenteigenen Metadaten der PDF-Dateien vorab zu löschen (vgl. Kapitel 3.3).
[6]Metadaten auf Fragenebene sind erst ab der 2. Dokumentationsstufe gefordert. Die Erläuterungen zu den drei verschiedenen Dokumentationsstandards finden Sie in den Dokumenten „Anforderungen an Daten und Dokumentation im FDZ des DZHW“.
[7]Bitte beachten Sie, die dokumenteigenen Metadaten der PDF-Dateien vorab zu löschen (vgl. Kapitel 3.3).
[8]Mit Subdatensätzen sind solche gemeint, die Sie nach einer Anonymisierung Ihrer Daten erhalten. Sie können mehrere Stufen der Anonymisierung verwenden, wobei jede Stufe einen eigenen Zugangsweg zu den anonymisierten Daten mit sich bringt. Für jeden Zugangsweg wird dann ein eigener Subdatensatz erstellt (vgl. hierzu „accessWay“ im Tabellenblatt „subDataSets“).
[9]Bitte beachten Sie, die dokumenteigenen Metadaten bei PDF-Dateien vorab zu löschen (vgl. Kapitel 3.3).
[10]Metadaten auf Variablenebene sind erst ab der 2. Dokumentationsstufe gefordert. Die Erläuterungen zu den drei verschiedenen Dokumentationsstandards finden Sie in den Dokumenten „Anforderungen an Daten und Dokumentation im FDZ des DZHW“.
[11]Nur in der Dokumentationsstufe 3 gefordert. Die Erläuterungen zu den drei verschiedenen Dokumentationsstandards finden Sie in den Dokumenten „Anforderungen an Daten und Dokumentation im FDZ des DZHW“.
[12]Nur in der Dokumentationsstufe 3 gefordert. Die Erläuterungen zu den drei verschiedenen Dokumentationsstandards finden Sie in den Dokumenten „Anforderungen an Daten und Dokumentation im FDZ des DZHW“.

Javadoc

eu.dzhw.fdz.metadatamanagement.common.domain

Common domain objects which can be used in all other subdomains of this application.

AbstractRdcDomainObject

public abstract class AbstractRdcDomainObject

Base class for all rdc domain objects. All domain objects inherit the fields from this base class.

Fields
createdBy
private String createdBy

The name of the user which has created this object.

createdDate
private LocalDateTime createdDate

The date and time (in UTC) when this domain object was created.

lastModifiedBy
private String lastModifiedBy

The name of the user who last saved this object.

lastModifiedDate
private LocalDateTime lastModifiedDate

The date and time when this object was last saved.

version
private Long version

Number which is incremented on each save of this object.

Counter

public class Counter

Counter document which can be used to get an incremented sequence number per document id.

Fields
id
private String id

The id of the counter, e.g. „orders“.

seq
private long seq

The current sequence number.

I18nString

public class I18nString

Strings that can be represented in English and German.

Fields
de
private String de

The german version of this string.

en
private String en

The english version of this string.

Period

public class Period

Objects representing periods in time. All periods must have a start date and an end date and the start date must be before or equal to the end date.

Fields
end
private LocalDate end

The end date of the period. Mandatory and must not be before start date.

start
private LocalDate start

The start date of the period. Mandatory and must not be after end date.

Person

public class Person

A representation of a person.

Fields
firstName
private String firstName

The first name of the person. Must not be empty.

lastName
private String lastName

The last name of the person. Must not be empty.

middleName
private String middleName

The middle name of the person.

Resolution

public class Resolution

Representation of the resolution of images.

Fields
heightY
private Integer heightY

The height in pixel.

widthX
private Integer widthX

The width in pixel.

eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain

Domain objects describing eu.dzhw.fdz.metadatamanagement.datasetmanagement.domain.DataSets.

DataSet

public class DataSet extends AbstractRdcDomainObject

A dataset contains Variables. It results from at least one Survey.

Fields
annotations
private I18nString annotations

Arbitrary additional text for the dataset. Must not contain more than 2048 characters.

dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject to which this dataset belongs. The dataAcquisitionProjectId must not be empty.

description
private I18nString description

A short description of the dataset. It must be specified in at least one language and it must not contain more than 2048 characters.

format
private I18nString format

The format of the dataset. Must be one of Format.

id
private String id

The id of the dataset which uniquely identifies the dataset in this application. The id must not be empty and must be of the form dat-{{dataAcquisitionProjectId}}-ds{{number}}$. The id must not contain more than 512 characters.

number
private Integer number

The number of the dataset. Must not be empty and must be unique within the DataAcquisitionProject.

studyId
private String studyId

The id of the Study to which this dataset belongs. Must not be empty.

subDataSets
private List<SubDataSet> subDataSets

List of SubDataSets (concrete accessible files) within this dataset. Must contain at least one element. There must not be more than one SubDataSet per AccessWays.

surveyIds
private List<String> surveyIds

List of ids of Surveys of this DataAcquisitionProject. The dataset contains results from these Surveys. Must contain at least one element.

surveyNumbers
private List<Integer> surveyNumbers

List of numbers of Surveys of this DataAcquisitionProject. The dataset contains results from these Surveys. Must contain at least one element.

type
private I18nString type

The type of the dataset. Must be one of DataSetTypes and must not be empty.

DataSetAttachmentMetadata

public class DataSetAttachmentMetadata extends AbstractRdcDomainObject

Metadata which will be stored with each attachment of a DataSet.

Fields
dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject to which the DataSet of this attachment belongs. Must not be empty.

dataSetId
private String dataSetId

The id of the DataSet to which this attachment belongs. Must not be empty.

dataSetNumber
private Integer dataSetNumber

The number of the DataSet to which this attachment belongs. Must not be empty.

description
private I18nString description

A description for this attachment. It must be specified in at least one language and it must not contain more than 512 characters.

fileName
private String fileName

The filename of the attachment. Must not be empty and must contain only (german) alphanumeric characters and „_“ and „-“ and „.“.

id
private String id

The id of the attachment. Holds the complete path which can be used to download the file.

indexInDataSet
private Integer indexInDataSet

The index in the DataSet of this attachment. Used for sorting the attachments of this DataSet. Must not be empty.

language
private String language

The language of the attachments content. Must not be empty and must be specified as ISO 639 language code.

title
private String title

The title of the attachment in the language of the attachment. Must not be empty and must not contain more than 2048 characters.

DataSetTypes

public class DataSetTypes

All possible types of a DataSet.

Fields
ALL
public static final Set<I18nString> ALL
EPISODE_RECORD
public static final I18nString EPISODE_RECORD
PERSONAL_RECORD
public static final I18nString PERSONAL_RECORD

Format

public class Format

All possible formats of a DataSet.

Fields
ALL
public static final Set<I18nString> ALL
LONG
public static final I18nString LONG
WIDE
public static final I18nString WIDE

SubDataSet

public class SubDataSet

A subdataset is part of a DataSet and describes the concrete analyzable file which is accessible by a given access way.

Fields
accessWay
private String accessWay

The access way of this subdataset. Describes how the user will be able to work with the data set. Must not be empty and be one of AccessWays but not AccessWays.NOT_ACCESSIBLE.

citationHint
private I18nString citationHint

A hint telling how to cite this subdataset in publications. Must not contain more than 2048 characters.

description
private I18nString description

A description for this subdataset. It must be specified in at least one language and it must not contain more than 512 characters.

name
private String name

The filename of the subdataset without extension. Must not be empty and must not contain more than 32 characters.

numberOfObservations
private Integer numberOfObservations

The number of rows (observations or episodes) which are present in this subdataset. Must not be empty.

eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain

Domain objects describing eu.dzhw.fdz.metadatamanagement.instrumentmanagement.domain.Instruments.

Instrument

public class Instrument extends AbstractRdcDomainObject

An instrument (e.g. a questionnaire) which was used in at least one Survey.

Fields
annotations
private I18nString annotations

Arbitrary additional text for this instrument. Must not contain more than 2048 characters.

dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject to which this instrument belongs. The dataAcquisitionProjectId must not be empty.

description
private I18nString description

A short description of the instrument. It must be specified in at least one language and it must not contain more than 512 characters.

id
private String id

The id of the instrument which uniquely identifies the instrument in this application. The id must not be empty and must be of the form ins-{{dataAcquisitionProjectId}}-ins{{number}}$. The id must not contain more than 512 characters.

number
private Integer number

The number of the instrument. Must not be empty and must be unique within the DataAcquisitionProject.

studyId
private String studyId

The id of the Study to which this instrument belongs. Must not be empty.

subtitle
private I18nString subtitle

An optional subtitle of the instrument. It must not contain more than 2048 characters.

surveyIds
private List<String> surveyIds

List of ids of Surveys of this DataAcquisitionProject. The instrument has been used in these Surveys. Must contain at least one element.

surveyNumbers
private List<Integer> surveyNumbers

List of numbers of Surveys of this DataAcquisitionProject. The instrument has been used in these Surveys. Must contain at least one element.

title
private I18nString title

The title of the instrument. It must be specified in at least one language and it must not contain more than 2048 characters.

type
private String type

The type of this instrument. Must be one of InstrumentTypes and must not be empty.

InstrumentAttachmentMetadata

public class InstrumentAttachmentMetadata extends AbstractRdcDomainObject

Metadata which will be stored with each attachment of a Instrument.

Fields
dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject to which the Instrument of this attachment belongs. Must not be empty.

description
private I18nString description

A description for this attachment. It must be specified in at least one language and it must not contain more than 512 characters.

fileName
private String fileName

The filename of the attachment. Must not be empty and must contain only (german) alphanumeric characters and „_“ and „-“ and „.“.

id
private String id

The id of the attachment. Holds the complete path which can be used to download the file.

indexInInstrument
private Integer indexInInstrument

The index in the Instrument of this attachment. Used for sorting the attachments of this Instrument. Must not be empty.

instrumentId
private String instrumentId

The id of the Instrument to which this attachment belongs. Must not be empty.

instrumentNumber
private Integer instrumentNumber

The number of the Instrument to which this attachment belongs. Must not be empty.

language
private String language

The language of the attachments content. Must not be empty and must be specified as ISO 639 language code.

type
private I18nString type

The type of this attachment. Must not be empty and must be one of InstrumentAttachmentTypes.

InstrumentAttachmentTypes

public class InstrumentAttachmentTypes

All valid types of an instrument attachment.

Fields
ALL
public static final Set<I18nString> ALL
OTHER
public static final I18nString OTHER
QUESTIONNAIRE
public static final I18nString QUESTIONNAIRE
QUESTION_FLOW
public static final I18nString QUESTION_FLOW
VARIABLE_QUESTIONNAIRE
public static final I18nString VARIABLE_QUESTIONNAIRE

InstrumentTypes

public class InstrumentTypes

All valid types of an instrument.

Fields
ALL
public static final Set<String> ALL
CAPI
public static final String CAPI
CATI
public static final String CATI
CAWI
public static final String CAWI
PAPI
public static final String PAPI

eu.dzhw.fdz.metadatamanagement.ordermanagement.domain

Domain objects describing eu.dzhw.fdz.metadatamanagement.ordermanagement.domain.Orders.

Customer

public class Customer

Details of a customer who has ordered Products.

Fields
email
private String email

Email address of the customer. Must be a valid email address and must not be empty.

name
private String name

Name of the customer as given in the shopping cart. Must not be empty.

Order

public class Order extends AbstractRdcDomainObject

Order (DTO) containing all relevant information of a Customer and her Products.

Fields
customer
private Customer customer

The Customer who has placed this order. Must not be null.

id
private String id

The id of an order. It is a number which is generated by a sequence (see Counter.

languageKey
private String languageKey

The key of the preferred language (either „de“ or „en“) of the Customer. Must not be empty.

products
private List<Product> products

List of data Products the Customer want to order. Must not be empty.

state
private OrderState state

The current state of the order. One of OrderState.

OrderState

public enum OrderState

The states an Order can have.

Author:René Reitmann
Enum Constants
CREATED
public static final OrderState CREATED
NOTIFIED
public static final OrderState NOTIFIED

Product

public class Product

Data Product which can be ordered by a customer.

Author:René Reitmann
Fields
accessWay
private String accessWay

The access way to the DataSets which the Customer wants to have.

dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject in which this product was generated. Must not be empty.

study
private Study study

The (partial) Study of this product. Must not be empty.

version
private String version

The version of the DataSets which the Customer wants to have.

Study

public class Study

Partial eu.dzhw.fdz.metadatamanagement.studymanagement.domain.Study which is part of a Product. It is a copy of the eu.dzhw.fdz.metadatamanagement.studymanagement.domain.Study attributes which is made when the Customer places the orders.

Fields
annotations
private I18nString annotations

The annotations of the eu.dzhw.fdz.metadatamanagement.studymanagement.domain.Study.

id
private String id

The id of the eu.dzhw.fdz.metadatamanagement.studymanagement.domain.Study. Must not be empty.

title
private I18nString title

The title of the eu.dzhw.fdz.metadatamanagement.studymanagement.domain.Study. Must not be empty neither in German nor in English.

eu.dzhw.fdz.metadatamanagement.projectmanagement.domain

Domain objects describing eu.dzhw.fdz.metadatamanagement.projectmanagement.domain.DataAcquisitionProjects.

DaraUpdateQueueItem

public class DaraUpdateQueueItem extends AbstractRdcDomainObject

Publishing metadata to da|ra will be done asynchronously and repeated as long as the update queue item has not been processed successfully and has therefore been deleted.

Fields
id
private String id

The id of the update queue item. It is generated by the database.

projectId
private String projectId

The id of the DataAcquisitionProject which needs to be sent to da|ra. Must not be empty and there must be at most one update queue item in the database for any project.

updateStartedAt
private LocalDateTime updateStartedAt

Timestamp at which the update has been started.

updateStartedBy
private String updateStartedBy

Id of the process who started the updated. Stored in order to avoid having multiple concurrent processes sending data to da|ra.

DataAcquisitionProject

public class DataAcquisitionProject extends AbstractRdcDomainObject

The data acquisition project collects the metadata for the data products which are published by our RDC. One project can contain one Study, many Surveys, many Instruments and Questions, and many DataSets and Variables. A project can be currently released (visible to public users) or not. When a publisher releases a project and its version is greater than or equal to 1.0.0 then the metadata is published to da|ra.

Fields
hasBeenReleasedBefore
private Boolean hasBeenReleasedBefore

Flag indicating whether this project has ever been released in its life. It is used to ensure that project cannot be deleted once they have been released.

id
private String id

The id of this project. Must not be empty and must only contain lower cased (english) letters and numbers. Must not contain more than 32 characters.

release
private Release release

A valid Release object. Null if the project is currently not released. The version of a Release must be a syntactically correct according to semver (major.minor.patch) and must not be decreased.

Release

public class Release

The release object contains the version and a timestamp of the current release.

Fields
date
private LocalDateTime date

The timestamp (in UTC) indicates when a publisher has released the DataAcquisitionProject. Must not be empty.

version
private String version

A valid semver version (major.minor.patch). Must not be empty and must not contain more than 32 characters. A version of a DataAcquisitionProject must not be decreased.

eu.dzhw.fdz.metadatamanagement.questionmanagement.domain

Domain objects describing eu.dzhw.fdz.metadatamanagement.questionmanagement.domain.Questions.

ImageType

public enum ImageType

Enum representing supported types of question images.

Enum Constants
PNG
public static final ImageType PNG

Question

public class Question extends AbstractRdcDomainObject

A question is part of an Instrument which has been used in at least one Surveys. The responses to a question are stored in Variables.

Fields
additionalQuestionText
private I18nString additionalQuestionText

Arbitrary additional question text which has been presented to the participant. Must not contain more than 1 MB characters.

annotations
private I18nString annotations

Arbitrary annotations to this question. Must not contain more than 2048 characters.

dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject to which this question belongs. The dataAcquisitionProjectId must not be empty.

id
private String id

The id of the question which uniquely identifies the question in this application. The id must not be empty and must be of the form que-{{dataAcquisitionProjectId}}-ins{{instrumentNumber}}-{{number}}$. The id must not contain more than 512 characters.

indexInInstrument
private Integer indexInInstrument

The index of the question in the Instrument. Used for sorting the questions.

instruction
private I18nString instruction

The instruction for the participant which tells how to give the answers to this question. Must not contain more than 1 MB characters.

instrumentId
private String instrumentId

The id of the Instrument to which this question belongs. Must not be empty.

instrumentNumber
private Integer instrumentNumber

The number of the Instrument to which this question belongs. Must not be empty.

introduction
private I18nString introduction

The introduction of this question which gives more context to the participant before asking the question. Must not contain more than 2048 characters.

number
private String number

The number of the question. Must not be empty and must be unique within the Instrument. Must contain only (german) alphanumeric characters and „_“,“-“ and „.“ and must not contain more than 32 characters.

questionText
private I18nString questionText

The question the Surveys participant was asked. It must be specified in at least one language and it must not contain more than 2048 characters.

studyId
private String studyId

The id of the Study to which this question belongs. Must not be empty.

successorNumbers
private List<String> successorNumbers

List of numbers of the Questions which directly follow this question in the Instrument.

successors
private List<String> successors

List of ids of the Questions which directly follow this question in the Instrument.

technicalRepresentation
private TechnicalRepresentation technicalRepresentation

A TechnicalRepresentation of this question. This is optional and can be used to add the source code of the question which was used to generate it.

topic
private I18nString topic

The topic or section in the Instrument to which this question belongs. It must not contain more than 2048 characters.

type
private I18nString type

The type of the question. Must be one of QuestionTypes and must not be empty.

QuestionImageMetadata

public class QuestionImageMetadata extends AbstractRdcDomainObject

The metadata for one question images. One question image displays the question in one language with one given resolution.

Fields
containsAnnotations
private Boolean containsAnnotations

Flag indicating whether the image contains annotations which highlight parts that were only visible to specific participants. These annotations were not visible to the participants.

dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject of the Question to which this image belongs. Must not be empty.

fileName
private String fileName

The name of the images file. Must not be empty and must only contain (german) alphanumeric characters and „_“,“-“ and „.“.

imageType
private ImageType imageType

The type of this image. Must be one of ImageType and must not be empty.

indexInQuestion
private Integer indexInQuestion

The index in the Question of this image. Used for sorting the images of this Question. Must not be empty.

language
private String language

The language of the question text on this image. Must not be empty and must be a valid ISO 639 code.

questionId
private String questionId

The id of the Question to which this image belongs. Must not be empty.

resolution
private Resolution resolution

The resolution of the image.

QuestionTypes

public class QuestionTypes

All valid types of a Question.

Fields
ALL
public static final Set<I18nString> ALL
GRID
public static final I18nString GRID
ITEM_SET
public static final I18nString ITEM_SET
MULTIPLE_CHOICE
public static final I18nString MULTIPLE_CHOICE
OPEN
public static final I18nString OPEN
SINGLE_CHOICE
public static final I18nString SINGLE_CHOICE

TechnicalRepresentation

public class TechnicalRepresentation

The technical representation of a Question which was used to generate the question for instance in an online Instrument.

Fields
language
private String language

The technical language of the source of this representation. E.g. „qml“. Must not be empty and must not contain more than 32 characters.

source
private String source

The source code of the question. Must not be empty and must not contain more than 1 MB characters.

type
private String type

The type of the technical representation. E.g. „zofar“. Must not be empty and must not contain more than 32 characters.

eu.dzhw.fdz.metadatamanagement.relatedpublicationmanagement.domain

In the domain layer are all domain classes of the related publication.

author:Daniel Katzberg

RelatedPublication

public class RelatedPublication extends AbstractRdcDomainObject

Domain Object for the Related Publications.

Author:Daniel Katzberg
Fields
abstractSource
private I18nString abstractSource
authors
private String authors
dataSetIds
private List<String> dataSetIds
doi
private String doi
id
private String id
instrumentIds
private List<String> instrumentIds
language
private String language
publicationAbstract
private String publicationAbstract
questionIds
private List<String> questionIds
sourceReference
private String sourceReference
studyIds
private List<String> studyIds
studySerieses
private List<I18nString> studySerieses
surveyIds
private List<String> surveyIds
title
private String title
variableIds
private List<String> variableIds
year
private Integer year

eu.dzhw.fdz.metadatamanagement.studymanagement.domain

Domain objects describing eu.dzhw.fdz.metadatamanagement.studymanagement.domain.Studys.

DataAvailabilities

public class DataAvailabilities

The data’s availability of a Study can be in one of these states.

Fields
ALL
public static final Set<I18nString> ALL
AVAILABLE
public static final I18nString AVAILABLE
IN_PREPARATION
public static final I18nString IN_PREPARATION
NOT_AVAILABLE
public static final I18nString NOT_AVAILABLE

Study

public class Study extends AbstractRdcDomainObject implements StudySubDocumentProjection

A study contains all metadata of a DataAcquisitionProject. It will get a DOI (Digital Object Identifier) when the DataAcquisitionProject is released.

Fields
annotations
private I18nString annotations

Arbitrary additional text for this instrument. Must not contain more than 2048 characters.

authors
private List<Person> authors

List of Persons which have performed this study. Must not be empty.

dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject to which this study belongs. The dataAcquisitionProjectId must not be empty.

dataAvailability
private I18nString dataAvailability

The current state of the data’s availability. Must be one of DataAvailabilities and must not be empty.

description
private I18nString description

A description of the study. It must be specified in at least one language and it must not contain more than 2048 characters.

id
private String id

The id of the study which uniquely identifies the study in this application. The id must not be empty and must be of the form stu-{{dataAcquisitionProjectId}}$. The id must not contain more than 512 characters.

institution
private I18nString institution

The name of the institution which has performed this study. It must be specified in German and English and it must not contain more than 512 characters.

studySeries
private I18nString studySeries

The name of the series of studies to which this study belongs.. If specified it must be specified in German and English. It must not contain more than 512 characters and must not contain „,“.

surveyDesign
private I18nString surveyDesign

The survey design of this Study. Must be one of SurveyDesigns and must not be empty.

title
private I18nString title

The title of the study. It must be specified in German and English and it must not contain more than 2048 characters.

StudyAttachmentMetadata

public class StudyAttachmentMetadata extends AbstractRdcDomainObject

Metadata which will be stored with each attachment of a Study.

Fields
dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject to which the Study of this attachment belongs. Must not be empty.

description
private I18nString description

A description for this attachment. It must be specified in at least one language and it must not contain more than 512 characters.

fileName
private String fileName

The filename of the attachment. Must not be empty and must contain only (german) alphanumeric characters and „_“ and „-“ and „.“.

id
private String id

The id of the attachment. Holds the complete path which can be used to download the file.

indexInStudy
private Integer indexInStudy

The index in the Study of this attachment. Used for sorting the attachments of this Study. Must not be empty.

language
private String language

The language of the attachments content. Must not be empty and must be specified as ISO 639 language code.

studyId
private String studyId

The id of the Study to which this attachment belongs. Must not be empty.

title
private String title

An optional title of this attachment in the attachments‘ language. It must not contain more than 2048 characters.

type
private I18nString type

The type of the attachment. Must be one of StudyAttachmentTypes and must not be empty.

StudyAttachmentTypes

public class StudyAttachmentTypes

All valid types of a StudyAttachmentMetadata.

Fields
ALL
public static final Set<I18nString> ALL
METHOD_REPORT
public static final I18nString METHOD_REPORT
OTHER
public static final I18nString OTHER

SurveyDataTypes

public class SurveyDataTypes extends DataTypes

List of types of data, which a Study can consist of. It will be computed from the Surveys of a Study.

Fields
ALL
public static final Set<I18nString> ALL
MIXED_METHODS
public static final I18nString MIXED_METHODS

SurveyDesigns

public class SurveyDesigns

List of currently supported survey designs.

Fields
ALL
public static final Set<I18nString> ALL
CROSS_SECTION
public static final I18nString CROSS_SECTION
PANEL
public static final I18nString PANEL

eu.dzhw.fdz.metadatamanagement.surveymanagement.domain

Domain objects describing eu.dzhw.fdz.metadatamanagement.surveymanagement.domain.Surveys.

DataTypes

public class DataTypes

Types of data, which a Survey can produce.

Fields
ALL
public static final Set<I18nString> ALL
QUALITATIVE_DATA
public static final I18nString QUALITATIVE_DATA
QUANTITATIVE_DATA
public static final I18nString QUANTITATIVE_DATA

Population

public class Population

Details of the population of a Survey.

Fields
description
private I18nString description

A description of the population. It must be specified in at least one language and it must not contain more than 2048 characters.

title
private I18nString title

A short title for the population. It must be specified in at least one language and it must not contain more than 512 characters.

Survey

public class Survey extends AbstractRdcDomainObject

A survey is conducted to examine a population on the basis of a sample. The resulting DataSets can be used to make statements about the population.

Fields
annotations
private I18nString annotations

Arbitrary additional text for this survey. Must not contain more than 2048 characters.

dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject to which this survey belongs. The dataAcquisitionProjectId must not be empty.

dataType
private I18nString dataType

The type of data which the survey produced. Must be one of DataTypes and must not be empty.

fieldPeriod
private Period fieldPeriod

The period during which the survey has been conducted or is expected to be conducted. Must not be empty.

grossSampleSize
private Integer grossSampleSize

The gross sample size represents the number of participants which have been invited to take part in the Survey. Must not be negative.

id
private String id

The id of the survey which uniquely identifies the survey in this application. The id must not be empty and must be of the form sur-{{dataAcquisitionProjectId}}-sy{{number}}$. The id must not contain more than 512 characters.

number
private Integer number

The number of the instrument. Must not be empty and must be unique within the DataAcquisitionProject.

population
private Population population

Details about the Population. Must not be empty.

responseRate
private Double responseRate

The response rate is the quotient of the gross sample size and the sample size. Must be between 0 and 100.

sample
private I18nString sample

The sampling method is the procedure for selecting sample members from a population. It must be specified in at least one language and it must not contain more than 2048 characters.

sampleSize
private Integer sampleSize

The sample size is the number of participant which took part in the survey. Must not be empty and must not be negative.

studyId
private String studyId

The id of the Study to which this survey belongs. Must not be empty.

surveyMethod
private I18nString surveyMethod

The survey method briefly describes how the data were collected. It must be specified in German and English and it must not contain more than 2048 characters.

title
private I18nString title

The title of the instrument. It must be specified in German and English and it must not contain more than 2048 characters.

wave
private Integer wave

Number of the wave which this Survey represents. Will be ignored if the Study is not organized in waves. Must not be empty and must be greater than or equal to 1.

SurveyAttachmentMetadata

public class SurveyAttachmentMetadata extends AbstractRdcDomainObject

Metadata which will be stored with each attachment of a Survey.

Fields
dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject to which the Survey of this attachment belongs. Must not be empty.

description
private I18nString description

A description for this attachment. It must be specified in at least one language and it must not contain more than 512 characters.

fileName
private String fileName

The filename of the attachment. Must not be empty and must contain only (german) alphanumeric characters and „_“ and „-“ and „.“.

id
private String id

The id of the attachment. Holds the complete path which can be used to download the file.

indexInSurvey
private Integer indexInSurvey

The index in the Survey of this attachment. Used for sorting the attachments of this Survey. Must not be empty.

language
private String language

The language of the attachments content. Must not be empty and must be specified as ISO 639 language code.

surveyId
private String surveyId

The id of the Survey to which this attachment belongs. Must not be empty.

surveyNumber
private Integer surveyNumber

The number of the Survey to which this attachment belongs. Must not be empty.

title
private String title

A title of this attachment in the attachments‘ language. It must not contain more than 2048 characters.

SurveyResponseRateImageMetadata

public class SurveyResponseRateImageMetadata extends AbstractRdcDomainObject

Metadata which will be stored with each response rate image of a Survey.

Fields
dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject to which the Survey of this response rate image belongs. Must not be empty.

fileName
private String fileName

The filename of the image. Must not be empty and must contain only (german) alphanumeric characters and „_“ and „-“ and „.“.

id
private String id

The id of the response rate image. Holds the complete path which can be used to download the file.

language
private String language

The language used in the response rate image. Must be either „de“ or „en“.

surveyId
private String surveyId

The id of the Survey to which this response rate image belongs. Must not be empty.

surveyNumber
private Integer surveyNumber

The number of the Survey to which this response rate image belongs. Must not be empty.

eu.dzhw.fdz.metadatamanagement.variablemanagement.domain

Domain objects describing eu.dzhw.fdz.metadatamanagement.variablemanagement.domain.Variables.

AccessWays

public class AccessWays

An access way of a Variable or a DataSet indicates how the data user will be able to work with the data.

Fields
ALL
public static final Set<String> ALL
DOWNLOAD_CUF
public static final String DOWNLOAD_CUF
DOWNLOAD_SUF
public static final String DOWNLOAD_SUF
NOT_ACCESSIBLE
public static final String NOT_ACCESSIBLE
ONSITE_SUF
public static final String ONSITE_SUF
REMOTE_DESKTOP
public static final String REMOTE_DESKTOP

DataTypes

public class DataTypes

The technical type which the ValidResponses have.

Fields
ALL
public static final Set<I18nString> ALL
DATE
public static final I18nString DATE
NUMERIC
public static final I18nString NUMERIC
STRING
public static final I18nString STRING

Distribution

public class Distribution

A distribution contains the descriptives of a Variable meaning its ValidResponses, Missings and Statistics.

Fields
maxNumberOfDecimalPlaces
private Integer maxNumberOfDecimalPlaces

Integer used for rounding the values of this Variable when displaying it. It is computed during the import of the Variable by finding the maximum number of decimal places in the list of ValidResponses.

missings
private List<Missing> missings

List of Missings of this Variable. Must not contain more than 7000 entries and the code of the Missings must be unique.

statistics
private Statistics statistics

Descriptive metrics of this Variable.

totalAbsoluteFrequency
private Integer totalAbsoluteFrequency

The total absolute number of ValidResponses and Missings. Must not be empty.

totalValidAbsoluteFrequency
private Integer totalValidAbsoluteFrequency

The total absolute number of ValidResponses. Must not be empty.

totalValidRelativeFrequency
private Double totalValidRelativeFrequency

The quotient from totalValidAbsoluteFrequency and totalAbsoluteFrequency. Must not be empty.

validResponses
private List<ValidResponse> validResponses

List of ValidResponses of this variable. Must not contain more than 7000 entries and the value of the ValidResponses must be unique.

FilterDetails

public class FilterDetails

Filter details of a Variable describe the condition which must have evaluated to true before a participant was asked a Question resulting in this Variable. All participants for which the conditions evaluates to false will have a Missing in this Variable.

Fields
description
private I18nString description

A description of this filter condition. Must not contain more than 2048 characters

expression
private String expression

A technical expression describing the condition which must have evaluated to true. The expression is given in the expressionLanguage. Must not be empty and must not contain more than 2048 characters.

expressionLanguage
private String expressionLanguage

The name of the language in which the expression was given. Must not be empty and must be one of FilterExpressionLanguages.

FilterExpressionLanguages

public class FilterExpressionLanguages

All supported expression languages for FilterDetails.

Fields
ALL
public static final Set<String> ALL
SPEL
public static final String SPEL
STATA
public static final String STATA

GenerationDetails

public class GenerationDetails

Generation details describe how a Variable was generated from one or more input Variables.

Fields
description
private I18nString description

A description of this generation rule. Must not contain more than 2048 characters

rule
private String rule

The computation rule in the ruleExpressionLanguage which was used to generate this Variable. Must not contain more than 1 MB characters.

ruleExpressionLanguage
private String ruleExpressionLanguage

The language which was used to describe this rule. Must be one of RuleExpressionLanguages.

Missing

public class Missing

A missing or missing value is a value in a Variable which represents a reason why no observation (ValidResponse) has been stored. It also contains its frequency.

Fields
absoluteFrequency
private Integer absoluteFrequency

The absolute number of occurrences of this missing. Must not be empty.

code
private String code

A (unique in this Variable) code for this missing. Must not be empty.

label
private I18nString label

A label describing this missing. Must not contain more than 512 characters.

relativeFrequency
private Double relativeFrequency

The quotient from absoluteFrequency and Distribution.totalAbsoluteFrequency. Must not be empty.

RelatedQuestion

public class RelatedQuestion

A related question is a Question which has been asked to generate the values of a Variable. It contains the ids of the Instrument and the Question as well as all Strings of the Question which are related to this Variable.

Fields
instrumentId
private String instrumentId

The id of the Instrument of this Question. Must not be empty.

instrumentNumber
private String instrumentNumber

The number of the Instrument of this Question. Must not be empty.

questionId
private String questionId

The id of the corresponding Question. Must not be empty.

questionNumber
private String questionNumber

The number of the corresponding Question. Must not be empty.

relatedQuestionStrings
private I18nString relatedQuestionStrings

All Strings (concatenated) of this Question which „belong“ to this Variable. These Strings typically overlap with String from other Variables of the same Question.

RuleExpressionLanguages

public class RuleExpressionLanguages

All supported expression languages for GenerationDetails.

Fields
ALL
public static final Set<String> ALL
R
public static final String R
STATA
public static final String STATA

ScaleLevels

public class ScaleLevels

The scale level (or level of measurement) classifies the nature of information within the values assigned to a Variable (ValidResponses). It determines which mathematical operations can be performed with the values.

Fields
ALL
public static final Set<I18nString> ALL
INTERVAL
public static final I18nString INTERVAL
NOMINAL
public static final I18nString NOMINAL
ORDINAL
public static final I18nString ORDINAL
RATIO
public static final I18nString RATIO

Statistics

public class Statistics

Descriptive metrics of this Variable.

Fields
deviance
private Double deviance

See Deviance (Wikipedia).

firstQuartile
private String firstQuartile

Splits off the lowest 25% of the values (ValidResponses) of this Variable from the highest 75%. Must not contain more than 32 characters.

highWhisker
private Double highWhisker

The highest value still within 1.5 IQR of the third quartile.

kurtosis
private Double kurtosis

See Kurtosis (Wikipedia).

lowWhisker
private Double lowWhisker

The lowest value still within 1.5 IQR of the first quartile.

maximum
private String maximum

The maximum of the values (ValidResponses) of this Variable. Must not contain more than 32 characters.

meanDeviation
private Double meanDeviation

See Mean Absolute Deviation (Wikipedia).

meanValue
private Double meanValue

The arithmetic mean of the values (ValidResponses) of this Variable.

median
private String median

The median is the value separating the higher half from the lower half of the values (ValidResponses) of this Variable. Must not contain more than 32 characters.

minimum
private String minimum

The minimum of the values (ValidResponses) of this Variable. Must not contain more than 32 characters.

mode
private String mode

The mode is the value (ValidResponse) that appears most often.

skewness
private Double skewness

See Skewness (Wikipedia).

standardDeviation
private Double standardDeviation

Measure that is used to quantify the amount of variation of the values (ValidResponses) of this Variable.

thirdQuartile
private String thirdQuartile

Splits off the highest 25% of the values (ValidResponses) of this Variable from the lowest 75%. Must not contain more than 32 characters.

StorageTypes

public class StorageTypes

All supported storage types of Variables.

Fields
ALL
public static final Set<String> ALL
ANY
public static final String ANY
BUILTIN
public static final String BUILTIN
BYTECODE
public static final String BYTECODE
CHAR
public static final String CHAR
CHARACTER
public static final String CHARACTER
CLOSURE
public static final String CLOSURE
COMPLEX
public static final String COMPLEX
DOTDOTDOT
public static final String DOTDOTDOT
DOUBLE
public static final String DOUBLE
ENVIRONMENT
public static final String ENVIRONMENT
EXPRESSION
public static final String EXPRESSION
EXTERNALPTR
public static final String EXTERNALPTR
INTEGER
public static final String INTEGER
LANGUAGE
public static final String LANGUAGE
LIST
public static final String LIST
LOGICAL
public static final String LOGICAL
NULL
public static final String NULL
PAIRLIST
public static final String PAIRLIST
PROMISE
public static final String PROMISE
RAW
public static final String RAW
S4
public static final String S4
SPECIAL
public static final String SPECIAL
SYMBOL
public static final String SYMBOL
WEAKREF
public static final String WEAKREF

ValidResponse

public class ValidResponse

A valid response represents one observation of a Variable and its frequency.

Fields
absoluteFrequency
private Integer absoluteFrequency

The absolute number of occurrences of this observation. Must not be empty.

label
private I18nString label

An optional label for the value of this observation.

relativeFrequency
private Double relativeFrequency

The quotient from absoluteFrequency and Distribution.totalAbsoluteFrequency. Must not be empty.

validRelativeFrequency
private Double validRelativeFrequency

The quotient from absoluteFrequency and Distribution.totalValidAbsoluteFrequency. Must not be empty.

value
private String value

The value which has been observed (e.g. was responded by the participant). Must not be empty and must not contain more than 256 characters.

Variable

public class Variable extends AbstractRdcDomainObject

A variable contains the results from at least one Survey. These results can be the responses from participants of an online survey, hence a variable can result from RelatedQuestions. A variable is part of exactly one DataSet.

Fields
accessWays
private List<String> accessWays

The access way of this variable. Depends on the sensitivity of the data and describes how the data user will be able to work with the data. Must not be empty and be one of AccessWays.

annotations
private I18nString annotations

Arbitrary additional text for this variable. Must not contain more than 2048 characters.

dataAcquisitionProjectId
private String dataAcquisitionProjectId

The id of the DataAcquisitionProject to which this variable belongs. The dataAcquisitionProjectId must not be empty.

dataSetId
private String dataSetId

The id of the DataSet to which this variable belongs. Must not be empty.

dataSetNumber
private Integer dataSetNumber

The number of the DataSet to which this variable belongs. Must not be empty.

dataType
private I18nString dataType

The technical type which the ValidResponses have. Must be one of DataTypes and must not be empty.

derivedVariablesIdentifier
private String derivedVariablesIdentifier

Identifier used to group variables within this DataSet which have been derived from each other. For instance one variable might be an aggregated version of the other. Must be of the form {{dataAcquisitionProjectId}}-ds{{dataSetNumber}}-{{string}}$. Must not contain more than 512 characters and must contain only (german) alphanumeric characters and „_“ and „-„.

distribution
private Distribution distribution

The Distribution contains the descriptives of this variable meaning ValidResponses, Missings and Statistics.

doNotDisplayThousandsSeparator
private Boolean doNotDisplayThousandsSeparator

Flag indicating whether the ValidResponses should be displayed with a thousands separator or not. For instance years (1970) are numeric but should not be displayed with a thousands separator. Default value is false indicating that the ValidResponses are displayed with thousands separator.

filterDetails
private FilterDetails filterDetails

FilterDetails of a variable describe the condition which must have evaluated to true before a participant was asked a Question resulting in this variable.

generationDetails
private GenerationDetails generationDetails

GenerationDetails describe how this variable was generated from one or more input variables.

id
private String id

The id of the variable which uniquely identifies the variable in this application. The id must not be empty and must be of the form var-{{dataAcquisitionProjectId}}-ds{{dataSetNumber}}-{{name}}$. The id must not contain more than 512 characters.

indexInDataSet
private Integer indexInDataSet

The index in the DataSet of this variable. Used for sorting the variables of this DataSet and for displaying successors and predecessors of this variable. Must not be empty and the successor of this variable must have indexInDataSet incremented by one.

label
private I18nString label

The label of the variable should describe its content. It must be specified in at least one language and it must not contain more than 512 characters.

name
private String name

The name of the variable as it is used in the DataSet. It must not be empty and must be unique in the DataSet. It must contain only alphanumeric (english) characters and „_“. The first character must not be a number. It must not contain more than 32 characters.

panelIdentifier
private String panelIdentifier

Identifier used to group variables within this DataSet which measure the same across multiple waves. Must be of the form {{dataAcquisitionProjectId}}-ds{{dataSetNumber}}-{{string}}$. Must not contain more than 512 characters and must contain only (german) alphanumeric characters and „_“ and „-„.

relatedQuestions
private List<RelatedQuestion> relatedQuestions

List of RelatedQuestions which have been asked to generate the values of this variable.

relatedVariables
private List<String> relatedVariables

List of ids of variables which are „related“ to this variable. The type of relation is arbitrary.

scaleLevel
private I18nString scaleLevel

The scale level (or level of measurement) classifies the nature of information within the values assigned to this variable (ValidResponses). It determines which mathematical operations can be performed with the values. It must be one of ScaleLevels and must not be empty. If the data type of this variable is DataTypes.DATE then the ScaleLevel must be ScaleLevels.ORDINAL.

storageType
private String storageType

Associated with each data type is a storage type. For instance numerics can be stored as integer or double. Must be one of StorageTypes and must not be empty.

studyId
private String studyId

Id of the Study to which this variable belongs.

surveyIds
private List<String> surveyIds

List of ids of Surveys which have been conducted to create this variable. Must not be empty.

surveyNumbers
private List<Integer> surveyNumbers

List of numbers of Surveys which have been conducted to create this variable. Must not be empty.

Indizes und Tabellen