Start Session

These plugins enable you to open an asset review session in Ooyala Flex.

Start Video Review

This plugin starts a video review session.

Properties:

Table 1.
Field Value Explanation
Icon Plugin icon
Sub-type Start Session Sub-type of this plugin
Classification Reviewer Classification of this plugin
Deployment Internal Whether the plugin is deployed inside Ooyala Flex or within another product
Supports Configuration Whether this plugin supports configuration
Supports Scripting Whether configuration supports scripting
Scripting Context asset What Ooyala Flex objects can be referenced from within the scripting context. * Note: the event object is only visible in the context of an action running in an event handler.
Undo Action Stop Video Session The action required to undo this action
Redo Action   The action required to redo this action
Compatibility 5.5 What versions of Ooyala Flex this plugin works for
Lifecycle Stable Maturity of this plugin (Experimental, Unstable or Stable)

Configuration:

Table 2.
Field Field Type Mandatory Multiplicity Description
Session name string   Session name
Initiator resource   The Ooyala Flex user who is initiating the review session.
Reviewers complex   Details of the initiating user.
  • Reviewer User
resource 1..* A Ooyala Flex user who is a reviewer in the session.
  • Reviewer Group

resource 1..* A Ooyala Flex group whose members are considered as Reviewers in the session.
  • Reviewer User List Expression
string 0..1 Reviewer list (semi-colon delimited list of user IDs). Users in this list will be added to any reviewers configured in the options above.
  • Reviewer Group List Expression

string 0..1 Reviewer list (semi-colon delimited list of group IDs). Members of groups in this list will be added to any Reviewers configured in the options above.
  • View only reviewers section
complex 0..1 Specify whether reviewers are allowed to download the asset or not. (Warning: If the download allowed is set to true then reviewers would be able to download and keep an unprotected copy of the review video. The downloaded video will not expire.)
  • View Only Reviewers
complex   Email Details of user
  • View Only Reviewer Email
string 0..* These reviwers can only watch video in review portal, these reviewers need not be mio users, the system will send an open authentication token to users who can only view video and nothing else
  • View Only Reviewer Email Expression
string 0..1 An expression which evaluates to semicolon separated Email's.
  • Message Template For External Reviewers
single option   A Message template to use for notifying the users about the review session
  • Unauthenticated Template URL
string   This mentioned URL will be authenticated and sent to User, Note: You can use place holders such as {assetId} {reviewId} to auto fill assetId and reviewId respectively.
Review Expiry Date string   Set review expiry date (dd-MM-yyyy HH:mm:ss)
Review Session Fields complex 1..* Specify field data for the review session
Instruction text   Here you can specify any instructions for the review session.
Instructions Config complex   Specify whether comment should be saved as a Ooyala Flex comment on asset
  • Record Instruction?

boolean 0..1 Record comment
  • Record Instruction Expression
  0..1 An expression which evaluates to boolean that decides whether to record initial comment in Ooyala Flex.
Asset Publish Action resource   Ooyala Flex Playout publish action to use to publish the asset (if not already published).
Message Template resource   A message template to use for notifying the users about the review session
Portal URL string   Portal Base URL to use for the session.
Custom Statuses complex 1..* You must set at least one status for the review.
  • Allow Multiple Custom status?
checkbox   Select this option to allow the reviewer to select more than one custom status simultaneously
  • Custom Status Name
string   Provide a name for each status.
  • Color for this Custom Status
Color picker   Select a colour for the status button. The colour selected is stored in HEX format uppercase, e.g. "EAEAEA".
  • Metadata definition for Custom Status
single option 0..1 Select a metadata definition that the reviewer should fill, if the reviewer chooses this status.

Start Image Review

This plugin starts an image review session.

Properties:

Table 3.
Field Value Explanation
Icon Plugin icon
Sub-type Start Session Sub-type of this plugin
Classification Reviewer Classification of this plugin
Deployment Internal Whether the plugin is deployed inside Ooyala Flex or within another product
Supports Configuration Whether this plugin supports configuration
Supports Scripting Whether configuration supports scripting
Scripting Context asset What Ooyala Flex objects can be referenced from within the scripting context. * Note: the event object is only visible in the context of an action running in an event handler.
Undo Action Stop Image Session The action required to undo this action
Redo Action   The action required to redo this action
Compatibility 5.5 What versions of Ooyala Flex this plugin works for
Lifecycle Stable Maturity of this plugin (Experimental, Unstable or Stable)

Configuration:

Table 4.
Field Field Type Mandatory Multiplicity Description
Session name string   Session name
Initiator resource   The Ooyala Flex user who is initiating the review session.
Reviewers complex   Details of the initiating user.
  • Reviewer User
resource 1..* A Ooyala Flex user who is a reviewer in the session.
  • Reviewer Group

resource 1..* A Ooyala Flex group whose members are considered as Reviewers in the session.
  • Reviewer User List Expression
string 0..1 Reviewer list (semi-colon delimited list of user IDs). Users in this list will be added to any reviewers configured in the options above.
  • Reviewer Group List Expression

string 0..1 Reviewer list (semi-colon delimited list of group IDs). Members of groups in this list will be added to any Reviewers configured in the options above.
  • View only reviewers section
complex 0..1 Specify whether reviewers are allowed to download the asset or not. (Warning: If the download allowed is set to true then reviewers would be able to download and keep an unprotected copy of the review video. The downloaded video will not expire.)
  • View Only Reviewers
complex   Email Details of user
  • View Only Reviewer Email
string 0..* These reviwers can only watch video in review portal, these reviewers need not be mio users, the system will send an open authentication token to users who can only view video and nothing else
  • View Only Reviewer Email Expression
string 0..1 An expression which evaluates to semicolon separated Email's.
Message Template For External Reviewers single option   A Message template to use for notifying the users about the review session
  • Unauthenticated Template URL
string   This mentioned URL will be authenticated and sent to User, Note: You can use place holders such as {assetId} {reviewId} to auto fill assetId and reviewId respectively.
Review Expiry Date string   Set review expiry date (dd-MM-yyyy HH:mm:ss)
Review Session Fields complex 1..* Specify field data for the review session
  • Instruction
text   Here you can specify any instructions for the review session.
Instructions Config complex   Specify whether comment should be saved as a Ooyala Flex comment on asset
  • Record Instruction?

boolean 0..1 Record comment
  • Record Instruction Expression
  0..1 An expression which evaluates to boolean that decides whether to record instruction in Ooyala Flex.
Message Template resource   A message template to use for notifying the users about the review session
Portal URL string   Portal Base URL to use for the session.
Custom Statuses complex 1..* You must set at least one status for the review.
  • Allow Multiple Custom status?
checkbox   Select this option to allow the reviewer to select more than one custom status simultaneously
  • Custom Status Name
string   Provide a name for each status.
  • Color for this Custom Status
Color picker   Select a colour for the status button. The colour selected is stored in HEX format uppercase, e.g. "EAEAEA".
  • Metadata definition for Custom Status
single option 0..1 Select a metadata definition that the reviewer should fill, if the reviewer chooses this status.

Was this article helpful?