Lehrvideos

Lehrvideos#

Die Video-Hilfebibliothek enthält zwei Arten von Videos:

  • Von Allegra bereitgestellte Videos

  • Benutzerdefinierte oder unternehmenseigene Videos

Beide Typen sind im JSON-Format definiert. Die von Allegra bereitgestellten Videos werden von Allegra zur Verfügung gestellt. Das JSON und die URL werden automatisch initialisiert. Um die benutzerdefinierten Videos zu definieren, befolgen Sie bitte diese Schritte:

  1. Öffnen Sie $ALLEGRA_HOME/GeneralSettings.properties (siehe GeneralSettings.properties)

  2. Fügen Sie die folgende Eigenschaft in eine neue Zeile ein:

    videoTutorials.customUrl = {VIDEO_URL}

  3. Die {VIDEO_URL} sollte ein gültiger GET-Endpunkt sein. Die URL muss ein korrektes JSON zurückgeben, das die Videos beschreibt. Beispiel: https://www.alltena.com/getVideos.php

  4. Stellen Sie sicher, dass der Antwort-Header, der das JSON zurückgibt, den Eintrag: Access-Control-Allow-Origin: * enthält. Andernfalls wird der Client nicht in der Lage sein, die Antwort zu verarbeiten (Sicherheitsprobleme).

Video JSON-Format#

Unter dem Avatar in der oberen rechten Ecke befindet sich ein Link, um eine Liste mit Lehrvideos zu öffnen. Jedes Video kann durch Metadaten im JSON-Format ergänzt werden. Dieser Abschnitt beschreibt das Format der Videos im JSON.

{
        "en": [{
            "title": "Der Videotitel",
            "description": "Die Videobeschreibung",
            "url": "https://www.youtube.com/embed/SxetgVfZtEU",
            "tags": "Konfiguration, Schritte",
        },{
            "title": "Ordner",
            "description": "Ordnerbeschreibung",
            "children": [{
                "title": "Der Videotitel",
                "description": "Die Videobeschreibung",
                "url": "https://www.youtube.com/embed/SxetgVfZtEU",
                "tags": "Konfiguration, Schritte",
                "perspective": "alm"
            }]
        }],

        "de": [{
            "title": "Einführung in die Konfiguration",
            "description": "Einführung in die Konfiguration",
            "url": "https://domain.com/video.mp4",
            "tags": "Konfiguration, Schritte",
            "type": "native"
        }]
}

Die Haupttasten des JSON-Objekts sind gültige Gebietsschemacodes, wie „en“, „de“. Das System versucht, die Videos nach Gebietsschema zu laden. Falls keine Videoversion in diesem Gebietsschema vorhanden ist, wird Englisch als Standard genommen.

Das JSON enthält zwei verschiedene Arten von Knoten: Ordner und Videos. Der Hauptunterschied liegt darin, dass ein Ordnerknoten eine children-Eigenschaft hat.

Das Format des Ordnerknotens ist:

  • title: erforderlich

  • description: erscheint beim Überfahren mit der Maus, erforderlich

  • children: entweder ein Ordner oder eine Liste von Videoobjekten erforderlich

Das Format des Videoknotens ist:

  • title: erforderlich

  • description: erforderlich

  • url: erforderlich

    URL, die zum Video führt

  • tags: optional

    durch Kommata getrennte Wörter, erscheinen beim Überfahren mit der Maus und man kann Videos nach Tags suchen

  • type: optional

    Standard ist iframe. Mögliche Werte sind:

    • native:

      Das Video wird mit einem HTML-Videoplayer abgespielt. In diesem Fall muss der Link auf eine echte Videodatei verweisen.

    • iframe:

      Die Video-URL wird in ein Iframe eingefügt. In diesem Fall sollte die Video-URL in ein Iframe eingebettet werden können, wie die eingebettete YouTube-Video-URL. Es wird nur die URL aus dem Iframe benötigt.

  • perspective: optional

    Falls nicht vorhanden, ist das Video in allen Perspektiven sichtbar. Wenn definiert, ist das Video nur in der jeweiligen Perspektive sichtbar. Mögliche Werte sind:

    • tm: Perspektive für Aufgabenmanagement

    • scrum: Scrum-Perspektive

    • wiki: Wiki-Perspektive

    • pm: Projektmanagement

    • alm: Anwendungslebenszyklusmanagement

    • admin: Administrationsperspektive

Inhalt