Tutorial videos

Tutorial videos#

The video help library contains two kinds of videos:

  • Videos provided by Allegra

  • Custom or company-owned videos

Both types are defined in JSON format. The Allegra-provided videos are supplied by Allegra. The JSON and the URL are initialized automatically. To define the custom videos, follow these steps:

  1. Open $ALLEGRA_HOME/GeneralSettings.properties (see GeneralSettings.properties)

  2. Add the following property on a new line:

    videoTutorials.customUrl = {VIDEO_URL}

  3. The {VIDEO_URL} should be a valid GET endpoint. The URL must return valid JSON that describes the videos. Example: https://www.alltena.com/getVideos.php

  4. Make sure that the response header returning the JSON includes the entry: Access-Control-Allow-Origin: *. Otherwise the client will not be able to process the response (security issues).

Video JSON format#

Below the avatar in the top right corner there is a link to open a list of tutorial videos. Each video can be enriched with metadata in JSON format. This section describes the format of the videos in the 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"
        }]
}

The top-level keys of the JSON object are valid locale codes, such as “en”, “de”. The system tries to load the videos by locale. If no version of a video exists for that locale, English is used as the default.

The JSON contains two different kinds of nodes: folders and videos. The main difference is that a folder node has a children property.

The format of a folder node is:

  • title: required

  • description: appears on mouse-over, required

  • children: either a folder or a list of video objects required

The format of a video node is:

  • title: required

  • description: required

  • url: required

    URL that points to the video

  • tags: optional

    comma-separated words; they appear on mouse-over and allow searching by tags.

  • type: optional

    The default is iframe. Possible values are:

    • native:

      The video is played with an HTML video player. In this case the link must point to an actual video file.

    • iframe:

      The video URL is inserted into an iframe. In this case the video URL must be embeddable in an iframe, like the embedded YouTube video URL. Only the URL from the iframe is needed.

  • perspective: optional

    If not present, the video is visible in all perspectives. If defined, the video is only visible in the respective perspective. Possible values are:

    • tm: task management perspective

    • scrum: Scrum perspective

    • wiki: wiki perspective

    • pm: project management

    • alm: application lifecycle management

    • admin: administration perspective

Contents