A.2 Language used by the ingestion (workflow implementation)

The json language used to define a Workflow is very simple, there are two main objects:

• the Workflow json object having the following main information
  • the name of the Workflow
  • a list of variables. In case several tasks of the Workflow use the save value, it can be created a variable and the tasks can refer just to this variable
  • a reference to the first task of the Workflow that will be executed
• the Task json object having the following main information
  • the type field identifies the activity the task has to be done (i.e.: concat, cut, ...)
  • the parameter fields needed to execute the task
  • the task to be executed in case of success, error and complete events

__WORKFLOW__ json object:
    {
        // any variable defined here can be used (${VarName1}) in any task
        // optional
	"variables":
        [
            {
	        "varName1": "value 1",
	        "description": "description 1"
            },
            {
	        "varName2": "value 2",
	        "description": "description 2"
            },
	    ...
	],

        // optional
        "label": "name of the Workflow",

        // optional
        "description": "description of the Process/ingestion",

        // optional, default is Workflow
        "type": "Workflow",

        // optional, default is false (MMSGUI just does not show it by default)
        "hidden": false,

        // first task to be executed
        "task": __TASK__
    }

__TASK__ json object:
    {
        // optional
        "label": "name of the task",

        // One of the types defined by CatraMMS, i.e.: Add-Content, Encode,
        // Concat-Demux, Cut, EMail-Notification, ...
        "type": "...",

        // The parameters used to execute the task, they depend on the Type of Task
        "parameters": 
        {
            .....
        },
        // task executed in case of success
        // optional
        "onSuccess": 
        {
            // this task, by default, receives as input, the output of the parent task 
            "task": __TASK__
        },
        // task executed in case of error
        // optional
        "onError": 
        {
            // this task, by default, receives as input, the output of the parent task 
            "task": __TASK__
        },
        // task executed in any case
        // optional
        "onComplete": 
        {
            // this task, by default, receives as input, the output of the parent task 
            "task": __TASK__
        }
    }

// A special 'Type' of a Task is "GroupOfTasks", in this case Task will be:
"task": 
{
    "type": "GroupOfTasks",
    "parameters": 
    {
        // parallel or sequential
        "executionType": "parallel",

        "tasks": 
        [
            __TASK__,
            __TASK__
            ...
        ],
        // task executed in case of success
        // optional
        "onSuccess": 
        {
            // this task, by default, receives as input, the output of all the tasks defined by the above 'tasks' json field 
            "task": __TASK__
        },
        // task executed in case of error
        // optional
        "onError": 
        {
            // this task, by default, receives as input, the output of all the tasks defined by the above 'tasks' json field 
            "task": __TASK__
        },
        // task executed in any case
        // optional
        "onComplete":
        {
            // this task, by default, receives as input, the output of all the tasks defined by the above 'tasks' json field
            "task": __TASK__
        }                                                                                                   
    }
}