Allgemeines
Um Ihnen das Erstellen eigener Applikationsprofile zu vereinfachen, steht Ihnen auf Coscine ein Generator für benutzerdefinierte Applikationsprofile bereit. Dieser erlaubt das Erstellen von Applikationsprofilen und übernimmt dabei die Prüfung auf syntaktische Korrektheit.
Neues Applikationsprofil erstellen
Bei der Erstellung einer neuen Ressource können Sie bei Schritt 3 "Metadaten einer Ressource" entweder ein bereits vorhandenes Applikationsprofil auswählen oder die Option "Neu Erstellen" auswählen (siehe Abbildung unten). Durch die Auswahl "Neu Erstellen" gelangen Sie auf die Seite des Applikationsprofil-Generators.
Über den Applikationsprofil-Generator
Applikationsprofile werden in Coscine mit SHACL formuliert und im RDF-Datenformat geführt. Dieses Format gewährt Nutzenden die Möglichkeit, die Struktur Ihrer Metadaten festzulegen. Um Ihnen die Erstellung von Applikationsprofilen zu erleichtern, gibt es in Coscine den Applikationsprofil-Generator. Dieser bietet ein GUI-Interface zum leichteren Erstellen von Applikationsprofilen.
Menüleiste des Applikationsprofil-Generators
Nach Aufruf der o.g. URL werden Sie mit dem oben bebilderten Interface konfrontiert. Beachten Sie, dass einige der oben beschriebenen Schaltflächen in der Menüleiste unter Umständen nicht in jedem Zustand des Generators verfügbar sind. Als oberstes befindet sich eine Menüleiste, in der Sie verschiedene Aktionen vornehmen können:
Über "Aktion" (siehe Abbildung oben) gelangen Sie auf folgende Optionen:
Erstellen
- Erstellen Sie ein neues Applikationsprofil von Grund auf
Hinweis
Wir empfehlen diese Option eher für Profis - als Anfänger macht es Sinn sich an einem bereits etablierten Applikationsprofil zu orientieren und dieses den eigenen Bedürfnissen anzupassen.
Kopieren
- Kopieren Sie ein bereits bestehendes Applikationsprofil um neue Felder hinzuzufügen oder alte Felder zu löschen
- Diese Änderungen können dann in einem neuen Applikationsprofil veröffentlicht werden
Erweitern
- Erweitern Sie ein bereits bestehendes Applikationsprofil um neue Felder
- Bereits bestehende Felder des Applikationsprofils können nicht verändert werden
- Diese Änderungen können dann in einem neuen Applikationsprofil veröffentlicht werden
Neue Version
- Hierbei erstellen Sie eine neue Version eines bereits bestehenden Applikationsprofils
- Sie bleiben im Kontext der vorherigen Version des Applikationsprofil, Änderungen sind technisch nachvollziehbar
- Basierend auf der vorherigen Version können neue Felder hinzugefügt bzw. alte Felder gelöscht werden.
- Diese Änderungen können dann in einem neuen Applikationsprofil veröffentlicht werden.
Hinweis
Wenn ein Applikationsprofil als 'Geschlossen' eingestellt ist, kann dieses nicht erweitert werden. Deshalb ist bei geschlossenen Applikationsprofilen unter den Aktionen die entsprechende Aktion "erweitern" nicht auswählbar.
Token hinzufügen
Sollten Sie über Coscine zum Applikationsprofil-Generator navigiert worden sein, können Sie diese Funktion ignorieren. Ansonsten können Sie über "Token hinzufügen" (siehe Abbildung oben) ein persönliches Coscine Benutzertoken angeben, welches Ihnen fortan erlaubt Ihr Applikationsprofil direkt zu veröffentlichen. Ohne Token können Sie ein Applikationsprofil nur lokal speichern.
Editor, Graph und Vorschau der Metadaten
Mittig oben finden Sie die drei miteinander verknüpften Schaltflächen "Editor", "Graph" und "Metadaten" (siehe Abbildung oben). Über einen Mausklick können Sie zwischen der Editor-Ansicht, einer graphischen Darstellung der Abhängigkeiten (Graph) und einer Vorschau der Metadaten auf das finale Applikationsprofil umschalten, z.B. um Ihren bisherigen Fortschritt auf Funktionalität und Korrektheit zu überprüfen.
Code-Ansicht
Über die Code-Ansicht (das Füller-Symbol, bzw. Stapelsymbol - siehe auch Abbildung unten) können Sie in der Sparte "Detailansicht" zwischen dem eigentlichen RDF-Format und der benutzerfreundlicheren Darstellung dieses Formats durch den Generator umschalten.
Speichern
Die "Speichern"-Schaltfläche (siehe Abbildung oben) erlaubt Ihnen Ihr Applikationsprofil.
- lokal auf Ihrer Festplatte zu speichern (immer als Sicherungskopie empfohlen)
- über die Schaltfläche "Senden" via Git-Anfrage zur Veröffentlichung auf Coscine zu stellen
- Hinweis: Vor Veröffentlichung wird das Applikationsprofil vom FDM Team geprüft, daher kann die Implemetierung in Coscine bis zu 4 Wochen dauern.
Web-Oberfläche des Applikationsprofil-Generators
Das Interface teilt sich auf in vier Spalten:
Verfügbare Applikationsprofile
Hier finden Sie eine Übersicht über alle in Coscine öffentlich zugänglichen Applikationsprofile. Über das Textfeld ganz oben haben Sie die Möglichkeit die gelisteten Applikationsprofile namentlich zu filtern. Mit einem Klick auf einen Listeneintrag wird das entsprechende Applikationsprofil in den Generator geladen und Ihnen zur Betrachtung zur Verfügung gestellt. Sie können die einzelnen Felder des Applikationsprofils dann in der Sparte Detailansicht einsehen.
Vokabularterme
Mittels dieser Sparte lässt sich nach bestehenden und etablierten Vokabulartermen suchen. Möchten sie beispielsweise Ihrem Applikationsprofil ein Datum-Feld hinzufügen, so können Sie in der Suchleiste nach dem Stichwort "date" suchen und dieses Feld in das eigene Applikationsprofil übernehmen. Die Suchfunktion durchsucht dabei alle Ontologien des NFDI4Ing Terminology Service. Schweben Sie mit dem Mauszeiger über die Suchergebnisse um den Ursprung der jeweiligen Felder zu erfahren. Klicken Sie auf ein Feld, so wird dies dem aktuellen Applikationsprofil hinzugefügt und erscheint folglich in der Sparte "Detailansicht".
Detailansicht
In der Detailansicht werden alle Felder des aktuell ausgewählten Applikationsprofils aufgeführt. Sollten Sie das Profil gerade bearbeiten oder erweitern, können Sie die Felder anklicken um Sie mittels der letzten Sparte zu bearbeiten. Über das rote Kreuz ganz rechts können Sie einzelne Felder wieder entfernen. Dies können Sie jedoch nur, wenn Sie ein Applikationsprofil bearbeiten (also wenn Sie es über das Aktionsmenü zur Bearbeitung geladen haben oder ein neues Profil erstellt haben).
- Zahnrad: Applikationsprofile editieren
| Eigenschaft | Bedeutung | Entspricht |
|---|---|---|
| URL des Applikationsprofils | Auswählbar, hinter /ap/ ist ein eindeutiger Name für das Applikationsprofil anzugeben. "https://purl.org/coscine/ap/engmeta" | subject/baseURL |
| Titel | Frei gewählter Name des Applikationsprofil | dcterms:title |
| Beschreibung | Inhaltliche Beschreibung | rdfs:comment |
| Ersteller | Person, die das Applikationsprofil erstellt hat | dcterms:creator |
| Erstelldatum | Datum an dem das Applikationsprofil erstellt wurde | dcterms:created |
| Lizenz | Lizenz unter der das Applikationsprofil veröffentlicht wurde | dcterms:license |
| Disziplin | Domäne in der das Applikationsprofil angesiedelt ist | dcterms:subject |
| Abgeleitet von | Bei der Option "Erweitern" wird hier das zugrundeliegende Applikationsprofil angezeigt | sh:node |
| Zielkasse | URL des Applikationsprofils (s.o.) kopieren oder Klasse einer Ontologie angeben | sh:targetClass |
| Geschlossen | Legt fest, ob weitere Metadatenfelder von Nutzenden angegeben werden können | sh:closed |
Feld Eigenschaften
Haben Sie in der Detailansicht ein Feld ausgewählt, so erscheinen dessen Parameter und Eigenschaften zur Bearbeitung in der Sparte "Feld Eigenschaften".
Standardeigenschaften
| Eigenschaft | Bedeutung | Entspricht |
|---|---|---|
| Term IRI | Pfad/URL zur Definition des Terms | SHACL sh:path |
| Feld Name | Anzeigename des Feldes in Coscine | SHACL sh:name |
| Minimale Erforderliche Einträge | Anzahl der Werte, die mindestens vom Nutzer angegeben werden müssen | SHACL sh:minCount |
| Maximale Mögliche Einträge | Anzahl der Werte, die maximal vom Nutzer angegeben werden können | SHACL sh:maxCount |
| Position auf Metadaten-Formular | Darstellungsreihenfolge der Eigenschaft unter den anderen Eigenschaften | SHACL sh:order |
| Eigenschaftstyp | Art der Eigenschaft - Standardmäßig "Datentyp" | Eigenschaftstyp |
| Datentyp | Datentyp/-format der erwarteten Eingabewerte (Default: string) auf Basis der XML Schema Datatypes | SHACL sh:datatype |
Eigenschaftstypen
| Eigenschaft | Bedeutung | Entspricht |
|---|---|---|
| Datentyp | Expliziter Datentyp, z.B. string, date, integer | SHACL sh:datatype |
| Node Kind | Aktuell in Coscine nicht unterstützt | SHACL sh:nodeKind |
| Klasse | Eingegebener Wert muss eine Instanz der Klasse sein, z.B. http://purl.org/dc/dcmitype/ (Definition) | SHACL sh:class |
| Node | Zeigt auf ein anderes validierendes Applikationsprofil, z.B. https://purl.org/coscine/ap/engmeta | SHACL sh:node |
| Liste | Liste von String-Werten, z.B. Apfel, Banane, Orange | SHACL sh:in |
| Wert | Expliziter erwarteter Wert (aktuell in Coscine nicht unterstützt) | SHACL sh:hasValue |
String Eigenschaften
| Eigenschaft | Bedeutung | Entspricht |
|---|---|---|
| Standardwert | Standardmäßig im Feld vorgegebener Wert | SHACL sh:defaultValue |
| Minimale Länge | Minimales Vorkommen des Wertes | SHACL sh:minLength |
| Maximale Länge | Maximales Vorkommen des Wertes | SHACL sh:maxLength |
| Regex Pattern | Regex Pattern zur Überprüfung des Wertes | SHACL sh:pattern |
| Regex Flags | Regex flags | SHACL sh:flags |
Wert Eigenschaften
| Eigenschaft | Bedeutung | Entspricht |
|---|---|---|
| Minimum Exklusive | Festlegen der Wertebereiche für den Term, Minimum Exklusive (Beispiel: Min. Exlusive= "1" dann ist der Wert "1" nicht erlaubt) | SHACL sh:minExclusive |
| Minimum Inklusive | Festlegen der Wertebereiche für den Term, Maximum Inklusive | SHACL sh:minInclusive |
| Maximum Exklusive | Festlegen der Wertebereiche für den Term, Maximum Exklusive | SHACL sh:maxExclusive |
| Maximum Inklusive | Festlegen der Wertebereiche für den Term, Maximum Inklusive | SHACL sh:maxInclusive |
Administrative Eigenschaften
| Eigenschaft | Bedeutung | Entspricht |
|---|---|---|
| Beschreibung | Für den Nutzer sichtbare Beschreibung des Felders | SHACL sh:description |
| Fehlermeldung | Fehlermeldung, die bei einem generellen Fehler ausgegeben wird | SHACL sh:message |
| Fehler-Schwere | Die Schwere des Fehlers | SHACL sh:severity |
Eigenschaften zu Bedingten Applikationsprofilen
| Eigenschaft | Bedeutung | Entspricht |
|---|---|---|
| Bedingtes Applikationsprofil | Auswahl URL des bedingten Applikationsprofils | SHACL sh:qualifiedValueShape |
| Minimale Anzahl bedingter Applikationsprofile | Angabe der minimal gestatteten Anzahl bedingter Applikationsprofile | SHACL sh:qualifiedMinCount |
| Maximale Anzahl bedingter Applikationsprofile | Angabe der maximal gestatteten Anzahl bedingter Applikationsprofile | SHACL sh:qualifiedMaxCount |
| Bedingte Applikationsprofile können disjunkt sein | Ein-/Ausschalten ob Applikationsprofile disjunkt sein können | SHACL sh:qualifiedValueShapesDisjoint |
Hinweis
Für eine einfachere Auswahl eines passenden Datentypen gerne die folgende Abbildung zur Orientierung nutzen und/oder auf der dazu zugehörigen Seite weitere Informationen nachlesen.
Fehler-Schwere
| Eigenschaft | Bedeutung | Entspricht |
|---|---|---|
| Info | Bei fehlerhaftem Eintrag erscheint eine Information zum Fehler (aktuell in Coscine nicht unterstützt) | SHACL sh:Info |
| Warning | Bei fehlerhaftem Eintrag erscheint eine Warnung zum Fehler (aktuell in Coscine nicht unterstützt) | SHACL sh:Warning |
| Violation | Bei fehlerhaftem Eintrag wird der Metadatensatz in Coscine nicht gespeichert | SHACL sh:Violation |
Beispiel
Um Ihnen die Benutzung des Formgenerators zu veranschaulichen haben wir ein kurzes Beispiel zur Anwendung angefertigt: Beispiel: Applikationsprofil erstellen.