Manifest: Template.json
  • 11 Jul 2024
  • 1 Minute to read

Manifest: Template.json


Article summary

This guide is for the Dise One playout engine only. Please reference other guides for Dise Premium & Dise Lite.

The manifest file provides vital information about the template to the system:

{
    "name": "My First Template",
    "contentBasePath": "",
    "application": "template.html",
    "options": {
        "apiVersion": 2,
        "templateVersion": 3,
        "defaultDuration": 10,
        "targetWidth": 1920,
        "targetHeight": 1080,
        "scalePreview": true,
        "scalePlayer": true,
        "allowReuse": false,
        "enableAltMedia": false
    },
    "fields": [
        {
            "type": "text",
            "key": "heading",
            "caption": "Enter your headline",
            "default": "",
            "required": true
        },
        {
            "type": "textarea",
            "key": "body",
            "caption": "Enter your text",
            "default": "",
            "required": false
        },
        {
            "key": "media",
            "caption": "Choose a Picture or Video",
            "type": "content",
            "required": false,
            "mediaType": "video/mp4",
            "options": [
                {
                    "path": "/Media"
                },
                {
                    "path": "/"
                }
            ]
        }
    ]
}

Properties

Below is a description of each field.  Optional fields are marked with a *

PropertyTypeDefaultDescription
namestring
Name of the template.
applicationstring
Path to main application for this template.
contentBasePathstring
Base directory for media.
optionsobject
Defined below.
customEditor *string
Path to custom editor.
fieldsarray
Defined below.

Options

OptionTypeDefault Description
apiVersion *number2CMS API version number.
templateVersion *number3Template API version number.
defaultDuration *number10Default duration when creating content.
targetWidthnumber
Content width in pixels.
targetHeightnumber
Content height in pixels.
allowReuse *booleanfalseIf template accepts multiple preload/shift.
scalePreview *booleantrueIf CMS is allowed to scale preview.
scalePlayer *booleantrueIf playback is allowed to scale content.
enableAltMedia *booleantrueIf converted/transcoded version of media should be used.
templateMetadata *any
Optional metadata to the template.

Fields

This array contains the definition of all fields the template uses. Each element in the array should be a json object with the following properties:

The following editable field types are supported:

Field typeDescription
textSingle-line text.
textareaMulti-line text.
checkboxBoolean checkbox.
selectSelection of single option from list.
contentChoose or upload single file.
contentlistChoose or upload multiple files.
numberNumeric.
rangeNumeric range slider.
dateChoose date using calendar widget.
colorChoose RGB color using palette widget.
sectionA special field that groups fields graphically in the CMS editor.
Each section contains children with arbitrary fields as above.
Sections can also include sections. Sections do not have a key.

Each field type is described in detail in the next section


Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.