Tutorial Videos#

The video help library contains two types of videos:

  • Videos provided by Allegra

  • Custom or company-specific videos

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

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

  2. Insert the following property into a new line:

    videoTutorials.customUrl = {VIDEO_URL}

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

  4. Ensure that the response header returning the JSON includes the entry: Access-Control-Allow-Origin: *. Otherwise, the client won’t be able to process the response (security issues).

Video JSON Format#

Under the avatar in the top right corner, there is a link to open a list of tutorial videos. Each video can be supplemented with metadata in JSON format. This section describes the format of the videos in JSON.

{
        "en": [{
            "title": "The Video Title",
            "description": "The Video Description",
            "url": "https://www.youtube.com/embed/SxetgVfZtEU",
            "tags": "Configuration, Steps",
        },{
            "title": "Folder",
            "description": "Folder Description",
            "children": [{
                "title": "The Video Title",
                "description": "The Video Description",
                "url": "https://www.youtube.com/embed/SxetgVfZtEU",
                "tags": "Configuration, Steps",
                "perspective": "alm"
            }]
        }],

        "de": [{
            "title": "Introduction to Configuration",
            "description": "Introduction to Configuration",
            "url": "https://domain.com/video.mp4",
            "tags": "Configuration, Steps",
            "type": "native"
        }]
}

The main keys of the JSON object are valid locale codes, such as “en”, “de”. The system tries to load the videos by locale. If no video version is available in that locale, English is taken as the default.

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

The folder node format is:

  • title: required

  • description: appears on hover, required

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

The video node format is:

  • title: required

  • description: required

  • url: required

    URL leading to the video

  • tags: optional

    comma-separated words, appear on hover and can be used to search for videos by tags

  • type: optional

    Default is iframe. Possible values are:

    • native:

      The video is played using an HTML video player. In this case, the link must point to a real video file.

    • iframe:

      The video URL is embedded in an iframe. In this case, the video URL should 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