Zum Inhalt

AP Workflow

In GitLab werden alle Applikationsprofile (AP) von Coscine geprüft und gereviewt. Die folgende Anleitung richtet sich an die entsprechenden Admins im Coscine GitLab.

Benachrichtigung: Neuer Merge Request

  • Information über einen neues Applikationsprofil (AP) erfolgt durch den Erhalt einer E-Mail/Service Ticket mit Betreff "[Coscine] New Merge Request for an Application Profile"
  • Zusätzlich kann das AP-Repositorium in Gitlab aboniert werden (Glockensymbol: "watch" aktivieren)

AP-Review durchführen

  • Einloggen auf Coscine GitLab Seite unter Application Profiles -> Merge Requests
  • den kompletten Code unter "Changes" einsehen. Die folgenden Dinge überprüfen:
    • Titel und Beschreibung des Applikationsprofils. Passen sie zusammen? Vor allem die Deutsch-Englisch Übersetzungen?
    • Die Term-IRIs (befinden sich für das jeweilige Feld nach sh:path). Handelt es sich primär um bereits definierte Terms oder sind viele selbst-definiert?
    • English-Deutsch Übersetzungen, ergeben sie Sinn?
    • Werden verschiedene sh:datatype benutzt? Das default ist string, aber in Feldern wie bspw. "Datum" wäre date eventuell angebracht.
    • Ergeben die ausgewählten terms Sinn? (nur nach eindeutigen Diskrepanzen schauen, z.B. dcterms:author für ein Feld mit dem Name "Device" )
    • sh:targetClass URL ist die gleiche URL wie die base URL des Profils (sollte in den meisten Fällen zutreffen).
    • Base-URL (Zeile 1) überprüfen: ggf. Namen des Profils und Gruppierung einsetzen und entsprechend überall im Profil ändern.
  • Direkt im Code mittels kommentieren und spezifische Codeänderungen vorschlagen (siehe markierte Felder in Abbildung 1)

GitLab Code Suggestions

Abbildung 1 - Vorschläge in GitLab Merge Request mittels Zeilenkommentar
  • Kopieren der AP-Syntax unter "Changes" in das AIMS-Frontend:
  • Aktion -> "Erstellen", Editor-Ansicht aktivieren und Füller-Symbol zum Wechsel auf Code-Ansicht auswählen (siehe Abbildung 2)
  • Einfügen der AP-Syntax über Copy-Paste von GitLab

AP-Review

Abbildung 2 - Review von Applikationsprofilen in AIMS

Prüfung im AIMS-Generator

  • AIMS-Frontend: In der Editor-Ansicht über Zahnrad-Symbol Metadaten des APs prüfen, danach Metadaten-Ansicht aktivieren und Feldfunktionen prüfen (siehe Abbildung 1)
    • Prüfen, ob die gewählten Terms Sinn machen (IRI-Feld unter Feld Eigenschaften)
      • Wenn diese unpassend sind (z.B. hinter einem Feld welches Temperatur heißt ist http://purl.org/dc/terms/created angegeben), Kontakt mit Ersteller*in über Servicedesk Ticket aufnehmen
      • Sollte es lediglich Verbesserungsvorschläge zu den Terms geben, gerne Feedback geben, dies ist jedoch kein Grund zur Ablehnung des Applikationsprofils
  • Prüfung Ok? Weiter zum Schritt Prüfung auf DSP-10
  • Fehler/Unklarheiten? Siehe Syntax-Änderungen

Prüfung auf DSP-10

  • GitLab: Im Pipeline-Feld die Aktion "dev_deploy" starten (siehe Abbildung 2)
  • AP auf DSP-10 bzgl. Funktionalität prüfen
    • Notwendig: Zugriff via Uni-Netzwerk (ggf. Sicherheitshinweis des Browser ignorieren)
    • Einloggen auf DSP-10 mit ORCiD
    • Bei der ersten AP-Prüfung, Projekt erstellen, welches bei weiteren Prüfungen nachgenutzt werden kann
    • Dem Projekt eine Linked Data Resource hinzufügen
    • Unter Schritt 3 der Linked Data Ressourcenerstellung das zu prüfende AP auswählen
    • Prüfen, ob das AP und alle Felder korrekt angezeigt werden
    • Resource erstellen und AP in der Resource prüfen (ggf werden hier Validierungsprobleme und Bugs erst deutlich)
    • Prüfung Ok?
      • Informieren Sie das Coscine Dev Team mit einem "@" in einem GitLab-Kommentar unter der Merge-Anfrage, um sie auf LIVE zu stellen
      • Merge request bearbeiten und das Label works on DSP-10 hinzufügen
      • IT-ServiceDesk-Ticket schließen sobald der Merge request gemerged wurde
    • Fehler/Unklarheiten? Siehe Syntax-Änderungen

AP-DSP10

Abbildung 3 - Deployment eines Applikationsprofils auf DSP-10

Syntax-Änderungen

  • siehe zuerst häufige Probleme
  • Austausch bzgl. nächster Schritte mit Coscine Dev Team über GitLab-Kommentar
  • Eröffnen eines Issue in Coscine (Label: Application Profile)
  • Notwendige Änderungen beschreiben und Coscine Dev Team beauftragen (hinzufügen von Assignees)
  • Verfolgen des Issue (Notifications aktivieren)
  • Kommunikation bzgl. Status mit Ersteller*in über ServiceDesk/GitLab
  • Nach erfolgreichen Änderungen fahren Sie mit dem jeweiligen Prüfungsschritt fort

Häufige Probleme

  • Profil wird in DSP-10 nicht angezeigt
  • Felder scheinen 'verlinkt' (Eingabe in einem Feld erscheint auch in einem anderen Feld)
    • hier wurde derselbe Term bei beiden Feldern benutzt, was jedoch bei Coscine nicht unterstützt wird
    • oft reicht ein Feld, für das mehrere Eingaben möglich sind (Rücksprache mit Submitter halten)

Benachrichtigung: Erfolgreicher Merge Request

  • Nutzende über erfolgreichen Merge Request via E-Mail/Service Ticket informieren

E-Mail Template

Dear Titel + Name + Surname,

Your application profile "name of the application profile" has been successfully merged. You can now use it when creating resources in your Coscine project.

Best regards,

The Coscine Team

Log in directly to Coscine (https://coscine.rwth-aachen.de/) and use the storage space. For more information, please visit our Coscine documentation (https://docs.coscine.de/).

Your questions are not answered on our documentation and FAQ pages (https://www.coscine.de/faq/)? Then feel free to write to us via the IT-ServiceDesk at servicedesk@itc.rwth-aachen.de. Your request will then be forwarded to the Coscine team accordingly.

For regular updates on new features and further developments, please subscribe to our Coscine mailing list: https://lists.rwth-aachen.de/postorius/lists/coscine.lists.rwth-aachen.de/.