Skip to content

Using workflow profiles

Overview

A workflow profile determines how a VoD item is created behind the scenes. It determines how an item is created and generates its initial content, resources and metadata. The workflow profile can be explicitly selected when uploading or converting the source file. If no selection was made, the workflow profile is determined implicitly: either the authenticated user's default profile or the account's default profile (in case the user has no default profile) is used.

The workflow application processes the ingested source file by executing the (ordered) actions of the workflow profile, turning it into a VoD item. The initial item only consists of metadata, which is (partially) inherited from the workflow profile settings (e.g. player, viewing profile).

The item metadata also includes a link to the workflow profile which has been used to create it. The workflow profile determines which roles have access to the item. Only after the workflow process has finished, is it possible to change an item's workflow profile.

Workflow profiles start with a Process action which encodes the source file into video resolution(s), optimizes them for online delivery and exports them to a Content Delivery Network. When an action has finished, the workflow application automatically starts the next action. Some actions (e.g. Edit, Approve) will only finish (succeed or fail) after user interaction. The workflow process succeeds if all actions have been executed, or fails if a critical error occurs during an action.

The item list page displays the current workflow status of each item. The 'Workflow History' tab on an item details page contains information about the workflow process.

Text input for workflow actions and tasks

HTML Entities

Text input fields only allow a limited number of HTML tags and attributes. All other tags and attributes are automatically escaped by the application. Unclosed and (some) misnested tags are also escaped.

Allowed HTML tags:

  • p
  • b
  • i
  • u
  • em
  • strong
  • a
  • ul
  • ol
  • li

Allowed HTML attributes:

  • href
  • title
  • style

Replacement Patterns

Text input in notifications, emails, posts... can make use of these replacement patterns, which are substituted by the workflow application.

  • [item:url] : URL to access the item through the workflow application
  • [item:name] : item name
  • [item:description] : item description
  • [item:tags] : comma-separated list of tags linked to the item
  • [item:privacy] : item privacy
  • [item:player:name] : name of the item's player
  • [item:viewing_profile:name] : name of the item's viewing profile
  • [item:uploader] : email of the user who uploaded the item
  • [item:language] : item language
  • [item:src_filename] : original name of the file that was uploaded when creating the item
  • [item:embed_code] : Embed code for the item
  • [item:media_url] : Download location of the media file
  • [item:video_url] : Download location of the highest resolution video
  • [item:snapshot_urls] : Comma-separated string containing the download URLs of the snapshot images
  • [workflow_profile:name] : workflow profile name
  • [workflow_profile:status] : workflow profile status
  • [workflow_action:name] : name of the current workflow action
  • [workflow_action:status] : status of the current workflow action
  • [workflow_action:info] : information saved during the workflow action (eg. set by the user during approval action)