Workflow

These plugins enable you to work with Workflows in Ooyala Flex. This includes launching Workflows, using decisions in your Workflows, and ingesting Assets via Workflows.

Default Launch Workflow

This Plugin supports the launching of a Workflow. This can be launched as a Job against an Asset or inside an existing Workflow.

A Workflow definition must be specified. In addition, one can also specify if any variables in the existing Workflow Context should be inherited from the Workflow that launched the new Workflow.

Properties:

Table 1.
Field Value Explanation
Icon Plugin icon
Sub-type Launch Workflow Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Auto retry   Whether or not to select an automatic retry
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Timeout   Whether or not to select a timeout

Configuration:

Table 2.
Field Field Type Mandatory Multiplicity Description
Workflows complex 1..* Workflows
Workflow single option   Name of the workflow definition to be launched
Inherit Variables? check box   Inherit variables from the parent workflow instance?
Workflow String Variable complex 1..* Workflow String Variable
Key string   Key of the string variable
Value string   Value of the string variable
Workflow Object Variable complex 1..* Workflow Object Variable
Key string   Key of the object variable
Value string   Value of the object variable
Workflow Date Variable complex 1..* Workflow Date Variable
Key string   Key of the object variable
Value single option   Date value (dd-MM-yyyy HH:mm:ss)
Workflow Workspace string   Workspace in which to create the launched workflow. If this is not configured, the workspace of the job will be used.

Launch and Wait Workflow

This Plugin supports the launching of a Workflow. This can be launched as a Job against an Asset or inside an existing Workflow. This Plugin differs from the Default Launch Workflow Plugin as the Workflow that launches the new Workflow waits until the newly launched Workflow completes.

A Workflow definition must be specified. In addition, one can also specify if any variables in the existing Workflow Context should be inherited from the Workflow that launched the new Workflow.

Properties:

Table 3.
Field Value Explanation
Icon Plugin icon
Sub-type Launch Workflow Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x 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
Workflow Workflow Definition   Name of the workflow definition to be launched
Inherit Variables? boolean   Inherit variables from the parent workflow instance?
Workflow Variable complex 0..*  
Name string   Name of the variable
Value text   Value of the variable

Launch Vantage Workflow Transcode

This Plugin supports the execution of a Telestream Vantage Workflow.

Properties:

Table 5.
Field Value Explanation
Icon Plugin icon
Sub-type Launch Workflow Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

If the Folder Resource is specified, then the Filesystem path is ignored. If the Folder Resource is not specified, then a Filesystem path must be specified.

Table 6.
Field Field Type Mandatory Multiplicity Description
Vantage Workflow Name string   Workflow name to launch
Vantage workflow variable complex 0..* Vantage workflow variable container
Variable Name string   Variable name
Variable Value string   Variable value
Ingest workflow outputs boolean   If set to true will ingest the workflow outputs as child Assets
Destination complex   The final location of the output file
Folder Resource Resource (Folder)   The output file will be placed in the specified Folder Resource
Filesystem Path string   The output file will be placed in the specified server filesystem location

Command Line Script

This Plugin allows for the running of a command line executable.

The following option sets are worthy of note:

Mail Handler: Allows for the specification of emails to send, following the completion of the command, depending on a certain response code.

Workflow Handler: Allows for the launching of Workflows, following the completion of the command, depending on a certain response code.

Command Handler: Allows for the launching of other Actions, following the completion of the command, depending on a certain response code.

Properties:

Table 7.
Field Value Explanation
Icon Plugin icon
Sub-type Script Sub-type of this Plugin
Classification Workflow Classification of this Plugin
Deployment Internal Classification of this Plugin
Supports Configuration Whether this Plugin supports configuration
Supports Scripting Whether configuration supports Scripting
Scripting Context job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 8.
Field Field Type Mandatory Multiplicity Description
Command Line string   Command Line which can be a beanshell expression to be run
Command Timeout integer   Timeout in minutes for the command to be run. If set to 0 timeout is ignored
Mail Handler complex 0..* Mail Handlers that can be triggered by this command Execution
Result integer   Result integer code that will trigger the execution of this mail handler
Recipients string   Recipients for this Email
Mail Template string   Mail Template Name to use for this Email
Context Variables complex 0..* Context Variables for use in the mail handler
Key string   Key for key value pair
Value string   Value for key value pair, can be a beanshell expression
Workflow Handler complex 0..* Workflow Handlers that can be triggered by this command Execution
Result integer   Result integer code that will trigger the execution of this workflow handler
Workflow Definition Workflow Definition   Name of the workflow definition to launch after upload
Context Variables complex 0..* Context Variables for use in the mail handler
Key string   Key for key value pair
Value string   Value for key value pair, can be a beanshell expression
Command Handler complex 0..* Command Handler that can be triggered by this command Execution
Result integer   Result integer code that will trigger the execution of this command handler
Command Class string   Class name for this command
Properties complex 0..* Context Variables for use in the command handler
Key string   Key for key value pair
Value string   Value for key value pair, can be a beanshell expression

Workflow Cancel

This Plugin supports the cancelling of running Workflow Instances. The Plugin supports either a single Workflow Instance Id or a search criteria in order to match and cancel multiple Workflow Instances.

Properties:

Table 9.
Field Value Explanation
Icon   Plugin icon
Sub-type Workflow Cancel Sub-type of this Plugin
Classification Cancel 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 10.
Field Field Type Mandatory Multiplicity Description
Workflow Instance ID string 0..1 ID of the Workflow instance
Search Criteria complex 0..1 Workflow Criteria used for searching
  • Workflow Definition
Workflow Definition   Specify workflow definition
  • Workflow Variable
complex 0..1 Workflow Context Variable Name and Value used for searching

Name

string   Name of the variable

Value

text   Value of the variable

Decision

Approval Decision

This Plugin determines whether the Asset in the Workflow Context has been approved. If it has been, a true value is returned and the Workflow will follow that Transition. If it hasn't been, a false value is returned and the false Transition will be followed.

Properties:

Table 11.
Field Value Explanation
Icon Plugin icon
Sub-type Decision Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Aspect Ratio Decision

This Plugin compares the specified aspect ratio with the aspect ratio of the Asset in the Workflow Context and determines whether they match. If they match a true value is returned and the Workflow will follow that Transition. If they don't, a false value is returned and the false Transition will be followed.

The following aspect ratio types can be selected:

• Frame aspect ratio

• Display aspect ratio

• Pixel aspect ratio

Ooyala Flex has the ability to automatically recognise the technical structure of Assets.

Properties:

Table 12.
Field Value Explanation
Icon Plugin icon
Sub-type Decision Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Auto retry   Whether or not to select an automatic retry
Timeout   Whether or not to select a timeout
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 13.
Field Field Type Mandatory Multiplicity Description
Ratio to Compare single-option    
X Value integer    
Y Value integer    

Metadata Value Decision

This Plugin compares the specified Metadata Field name and value in the configuration with the same Field in the Metadata associated with the Asset in the Workflow Context and determines whether they match. If they match a true value is returned and the Workflow will follow that Transition. If they don't, a false value is returned and the false Transition will be followed.

Properties:

Table 14.
Field Value Explanation
Icon Plugin icon
Sub-type Decision Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 15.
Field Field Type Mandatory Multiplicity Description
Variable Name string    
Values To Be Matched Against string    

Default Decision

This Plugin evaluates an Asset Context Expression in the configuration with the Asset in the Workflow Context and determines whether it matches Assets in the Workflow Context. If they match a true value is returned and the Workflow will follow that Transition. If they don't, a false value is returned and the false Transition will be followed.

Properties:

Table 16.
Field Value Explanation
Icon Plugin icon
Sub-type Decision Sub-type of this Plugin
Classification Workflow Classification of this Plugin
Deployment Whether the plugin is deployed inside Ooyala Flex or within another product
Supports Configuration job, asset, event * Whether this Plugin supports configuration
Scripting Context   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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 17.
Field Field Type Mandatory Multiplicity Description
Expression string   Asset Hierarchy Expression to Validate

Groovy Scripted Decision

This Plugin allows for the provision of some Script to decide on a Decision path to take in a Workflow Instance.

Properties:

Table 18.
Field Value Explanation
Icon Plugin icon
Sub-type Decision Sub-type of this Plugin
Classification Workflow 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 Services, Context * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Properties:

Configuration:

Table 19.
Field Field Type Mandatory Multiplicity Description
Script complex   Script

Groovy Script

script 0..1 Script Content (execute() must return a boolean value)

Groovy Script File

file   Script Content (execute() must return a boolean value)
Script Imports complex   Script Imports

JAR File URL

string 1..* Jar File URL to be imported into the script.

Script Import

string 1..* Script import to use.

 

Groovy Scripted Multi-Decision Action

This Plugin allows for the provision of some Script to decide on a Decision path to take in a Workflow Instance. The Script must return true or false. This plugin makes use of the Groovy SDK. The script can return any string value which matches the name of one of the output transitions. More information about Scripting is provided in the API Guide.

Properties:

Table 20.
Field Value Explanation
Icon Plugin icon
Sub-type Decision Sub-type of this Plugin
Classification Workflow 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 Services, Context * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 21.
Field Field Type Mandatory Multiplicity Description
Script Complex   Script

Groovy Script

Script 0..1 Script Content (execute() must return a boolean value)

Groovy Script File

File   Script Content (execute() must return a boolean value)
Imports Complex   Imports

JAR File URL

String 0..* Script import to use

Script Imports

String 0..* Script import to use

Live Workflow Instance Exists

This Plugin checks whether there are other Workflow Instances of a specified Definition running against the current Asset in the Workflow Context. This Plugin is useful for knowing whether the Asset in the current Workflow is currently being processed in another live Workflow Instance.

Properties:

Table 22.
Field Value Explanation
Icon  
Sub-type Decision  
Classification Workflow  
Deployment Internal  
Supports Configuration  
Supports Scripting  
Scripting Context job, asset, event *  
Undo Action    
Redo Action    
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x  
Lifecycle Stable  

Configuration:

Table 23.
Field Field Type Mandatory Multiplicity Description
Workflow Definition Workflow Definition   Name of the workflow definition for checking instances

Scripted Decision

This Plugin allows for the provision of some Script to decide on a Decision path to take in a Workflow Instance. The Script must return true or false.

More information about Scripting is provided in the API Guide.

Properties:

Table 24.
Field Value Explanation
Icon Plugin icon
Sub-type Decision Sub-type of this Plugin
Classification Workflow 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
Scripting Context job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Auto retry   Whether or not to select an automatic retry
Timeout   Whether or not to select a timeout
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 25.
Field Field Type Mandatory Multiplicity Description
Script complex    
  • Groovy Script
script 0..1 Script Content (execute() must return a boolean value)
  • Groovy Script File
file 0..1 Groovy Script File (execute() must return a boolean value)

Workflow Instance State Decision

This Plugin allows you to check the state of a Workflow Instance: existing, running or completed and return true or false. It also allows you to execute a new Workflow Instance if one is not found.

The configuration options are based on two main sections:

Search Criteria: The Workflow Definition, Workflow state and Context Variable values to match against.

Launch Criteria: The Workflow to launch and any Context Variables to map from the existing Workflow Instance.

Properties:

Table 26.
Field Value Explanation
Icon Plugin icon
Sub-type Decision Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 27.
Field Field Type Mandatory Multiplicity Description
Search Criteria complex 1 Workflow Criteria used for searching
  • Workflow Definition
Workflow Definition   Specify workflow definition
  • Workflow Variable
complex 0..* Workflow Context Variable Name and Value used for searching

Name

string   Name of the variable

Value

text   Value of the variable
  • State
single-option   The state of the workflow instance(s)
  • Exclude cancelled or cancelling workflows?
boolean   Exclude workflows which are 'Cancelled' or 'Cancelling' from the search.
Launch Criteria complex 1 Options for launching a new workflow
  • Launch workflow if no results returned
boolean   Launch a new workflow for the given definition and variables (specified below) if no results are returned.
  • Launch Workflow Variable
complex 0..* Workflow context variable name and value to be passed into the new workflow

Name

string   Name of the variable

Value

text   Value of the variable

Ingest

Process Ingest

This Plugin supports the ingest of an Asset that is specified as a file path variable in the Workflow Context. It works in a very similar way to the Default Ingest Plugin, but sets the Asset that has been specified into the Workflow Context. This Plugin tends to be used when a Workflow is run from an Inbox or Hotfolder Resource.

Table 28.
Field Value Explanation
Icon Plugin icon
Sub-type Ingest Sub-type of this Plugin
Classification I/O 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

If the Folder Resource is specified, then the Filesystem path is ignored. If the Folder Resource is not specified, then a Filesystem path must be specified.

The Variant options allow for specifying the Variant type of the Asset on ingest.

Table 29.
Field Field Type Mandatory Multiplicity Description
Copy Source File boolean   If set to true copy from source file, otherwise move the source file
Folder Resource Resource (Folder)   The output file(s) will be placed in the specified Folder Resource
Filesystem Path string   The output file(s) will be placed in the specified server filesystem location
Reference Name string   Reference Name

Variant

complex 0..1 Specify the Variant and optionally the Metadata Definition to set on the asset. If not specified, a default will be used if it has been configured.
  • Variant
string   The Variant to set. This must be a valid configured Variant name.
  • Metadata Definition
Metadata Definition 0..1 The Metadata Definition to set. If not specified, a default will be used if it has been configured.

Create Object

Create Child User Defined Object

This Plugin supports the creation of a new User Object and assigning it to a parent Object.

Properties:

Table 30.
Field Value Explanation
Icon   Plugin icon
Sub-type Create Object Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable

Configuration:

Table 31.
Field Field Type Mandatory Multiplicity Description
Parent Details complex    
  • Parent User Object
User Object 1 Parent Object ID
  • Parent User Object ID
string    
Child Type User Object Type 1 Child Object Type
Number of Children complex 1 Number of Children to Create
  • Parent Data Field
string 1 Parent Data Field Name containing number of Children
  • Number of Children
string 1 Number of Children to Create
Parent Data Field to Inherit string 0..* Field Inherited from parent

Create User Defined Object

This Plugin supports the creation of a new User Object.

Properties:

Table 32.
Field Value Explanation
Icon   Plugin icon
Sub-type Workflow Sub-type of this Plugin
Classification Internal Classification of this Plugin
Deployment Whether the plugin is deployed inside Ooyala Flex or within another product
Supports Configuration Whether this Plugin supports configuration
Supports Scripting job, asset, event * Whether configuration supports Scripting
Scripting Context   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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 33.
Field Field Type Mandatory Multiplicity Description
Name string   Object Name
Description text   Object description
Type Root User Object Type   Object Type

Create VFS Placeholder Asset

This plugin supports the creation of a VFS Placeholder Asset.

Properties:

Table 34.
Field Value Explanation
Icon   Plugin icon
Sub-type Create Object Sub-type of this Plugin
Classification Internal Classification of this Plugin
Deployment Whether the plugin is deployed inside Ooyala Flex or within another product
Supports Configuration Whether this Plugin supports configuration
Supports Scripting job, asset, event * Whether configuration supports Scripting
Scripting Context   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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 35.
Field Field Type Mandatory Multiplicity Description
Name String   Object Name
Description Text   Object description.
Asset Type Resource   The Placeholder Asset Type to create.
Asset Origin Resource   The origin to set on the asset.
Variant and Metadata Complex 0..1 Specify the Variant and optionally the Metadata Definition to set on the asset. If not specified, a default will be used if it has been configured.
  • Variant Name

String   The Variant to set. This must be a valid configured Variant name
  • Metadata Details
Complex 0..1 Metadata Details

Metadata Definition

Resource 0..1 The Metadata Definition to set. If not specified, a default will be used if it has been configured.

Source JSON Variable

String 0..1 Source JSON Variable

Source XML Details

Complex 0..1 Source XML Details.

Source XML

String Source XML.

Source XML VFS Location

String 0..1 The Source XML Virtual filesystem location

Protocol

Resource   Protocol for accessing the location

Hostname

String   Hostname for accessing the location (mandatory except for file, s3, google or dropbox protocols)

Port

String   Port for accessing the location (mandatory except for file, s3, google or dropbox protocols) (#)

Path

String   Path for accessing the location (absolute path starting with / except for ftp, sftp, ftps which are relative to the User's home directory)

Username

String   Username for authentication (not required for file protocol)

Password

String   Password for authentication (not required for file, s3, google or dropbox protocols)

Key

String   Key for authentication (only applicable to s3, google and dropbox protocols)

Secret

String   Secret for authentication (only applicable to s3, google and dropbox protocols)

Token

String   Token for authentication (only applicable to google and dropbox protocols)

Bucket

String   Only applicable to S3 protocol

Private Key File Only

File   Only applicable for SFTP certificate authentication

Source XML Variable

String 0..1 Source XML Variable.

XSLT

File 0..1 XSLT file.
Relationships Complex   Relationships
  • Child
String 0..1 Child

Parent File Asset

String   Parent File asset.

Asset ID

String 0..1 Asset ID

Asset

Resource 0..1 Asset
  • Reference Name
String   Reference name which will be set to asset.
Member Complex 1..* Member.
  • Parent Group
Complex   Parent Group
  • Group ID

String 0..1 Group ID.
  • Group
Resource 0..1 Group
Membership Name String   Optional membership name to set on the group-member relationship.
Parent Object Details Complex 0..1 Parent Object Details
  • Parent ID
String 0..1 Parent ID
  • Parent
Resource 0..1 Parent
Set in Context Resource   Set in Context
Store asset as variable string 0..1 Variable name to store asset as workflow variable.

Message

HTTP Request Message

This Plugin provides an extremely flexible means of making HTTP requests and processing HTTP responses against external HTTP services.

The configuration options are all pretty explanatory but the following options are worthy of note:

Request Type: Allows you to specify the type of HTTP Method.

Headers: Allows you to create HTTP headers.

Authentication: Basic authentication parameters can be specified.

Fail Job on Error: Whether to fail the Job if the remote HTTP service returns an error.

Request Data: A data payload to send with the request, including an optional stylesheet to apply to the payload before sending.

Get Parameters: Key-values arguments to send to the remote HTTP service.

Response Variable: Whether to save the response as a Workflow Context Variable.

Properties:

Table 36.
Field Value Explanation
Icon Plugin icon
Sub-type Send Message Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Auto retry   Whether or not to select an automatic retry
Timeout   Whether or not to select a timeout
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 37.
Configuration Field Type Mandatory Multiplicity Description
HTTP Request Message complex   HTTP Request Message.
  • URL
string   URL for the request
  • Request type
single-option   Request type.
  • Headers
complex 0..* Additional headers to be added to the request

Name

string   Header name

Value

string   Header value
  • Basic Authentication
complex 0..1 Basic Authentication.

Username

string   Username to use for Basic Authentication.

Password

password   Password to use for Basic Authentication.
  • Fail Job on Error
boolean   Should the Job fail if the service returns an error?
  • Request
complex 0..1 Request data to be sent for a PUT or POST method

Request Data

text   Request body

Content Type

string   Content Type.

Character Set

string   Character Set.

XSLT

file 0..1 Stylesheet to apply to request data XML
  • Parameters
complex 0..1 Key/Value Pairs to be used as GET parameters.

Key

string   Key name.

Value

string   Value of key.
  • Response
complex 1  

Save response as variable

boolean   Save the response as the workflow variable: "httpResponse"

Ooyala HTTP Message Request

Properties:

Table 38.
Field Value Explanation
Icon Plugin icon
Sub-type Send Message Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Time Out   Whether or not to select a Time Out
Auto Retry   Whether or not to use Auto Retry
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 39.
Configuration Field Type Mandatory Multiplicity Description
HTTP Request Message complex   HTTP Request Message.
Base URL string   Base URL for the request.
Request Path string   Request path
API Key string   The API key
API Secret string   The API secret
Request Type single option   The request type

GET

       

POST

       

PUT

       

DELETE

       

PATCH

       
Headers complex 0..* Additional headers to be added to the request

Name

string   Header name

Header Value

string   Header value
Fail Job on Error boolean 1 Should the Job fail if the service returns an error?
Request complex 0..1 Request data to be sent for a PUT or POST method

Request Data

string   Request body

Content Type

string   Content type

Character Set

string  

Character set

XSLT

file 0..1 Stylesheet to apply to request data XML
Parameters complex 0..* Key/Value Pairs to be used as GET parameters

Key

string   Key name

Value

string   Value of key
Response complex   The response

Save response as variable

boolean   Save the response as the workflow variable: "httpResponse"

 

Send Email Message

This Plugin supports the sending of an email to a groups of Users. The Plugin supports all of the Ooyala Flex grouping structures:

• Account

• Sub-Account

• User Group

• Workspace

• User

It's also possible to specify a single User, an email address or an Expression Script that resolves to an email address.

Properties:

Table 40.
Field Value Explanation
Icon Plugin icon
Sub-type Send Message Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 41.
Field Field Type Mandatory Multiplicity Description
Message Template Message Template   The message template to use.

Attachment

complex   Add an attachment to the email
  • File Path
string 0..* File Path of the attachment
  • Attachments
string   Attachment name

Recipients

complex   Recipients of the email
  • Account
Account   All enabled Users within the Account
  • Sub-Account
Sub-Account 0..* All enabled Users within the sub-Account
  • Group
Group 0..* All enabled Users within the group
  • Workspace
Workspace 0..* All enabled Users within the workspace
  • User
User 0..* A specific User
  • Email Address
email 0..* A specific email address
  • Expression
string 0..* An evaluated expression resulting in an email address, User name or group name

Soap Request Message

This Plugin provides an extremely flexible means of making SOAP requests and processing SOAP responses against external SOAP services.

The configuration options are all pretty explanatory but the following options are worthy of note:

End Point: The SOAP end point.

Authentication: Basic authentication parameters can be specified.

Fail Job on Error: Whether to fail the Job if the remote SOAP service returns an error.

Request Data: A data payload to send with the request, including an optional stylesheet to apply to the payload before sending.

Response Variable: Whether to save the response as a Workflow Context Variable.

Properties:

Table 42.
Field Value Explanation
Icon Plugin icon
Sub-type Send Message Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 43.
Field Field Type Mandatory Multiplicity Description
SOAP Request Message complex   SOAP Request Message.
  • End Point
string   End point to send request to.
  • SOAP Action
string   SOAP Action.
  • Basic Authentication
complex 0..1 Basic Authentication.

Username

string   Username to use for Basic Authentication.

Password

password   Password to use for Basic Authentication.
  • Fail Job on Error
boolean   Should the Job fail if the service returns an error?
  • Request
complex 1 Request data.

Request Data

text   Request data Contents (XML)

XSLT

file 0..1 Stylesheet to apply to request data XML
  • Response
complex 1  

Save response as variable

boolean   Save the response XML as the workflow variable: "document"

Signal Job Message

Properties:

Table 44.
Field Value Explanation
Icon Plugin icon
Sub-type Send Message Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 45.
Field Field Type Mandatory Multiplicity Description
Workflow Definition Workflow Definition   Name of the workflow definition
Workflow Variable complex 0..* Workflow Context Variable Name and Value
  • Name
string   Name of the variable
  • Value
text   Value of the variable
Workflow Node Name string   Name of the workflow node

Scripted HTTP Message

Description

This plugin enables you to create a HTTP request, but also embed a Groovy Script which allows you to process the response.

Properties:

Table 46.
Field Value Explanation
Icon Plugin icon
Sub-type Message Sub-type of this Plugin
Classification Workflow 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 Any Variable that you define* 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 47.
Field Field Type Mandatory Multiplicity Description
HTTP Request Message Complex   HTTP Request Message

URL

String   URL for the request
URL Request Type String   Request Type

GET

       

POST

       

PUT

       

DELETE

       

PATCH

       
Headers Complex 0..* Additional Headers to be added to the request

Header Name

String   Header Name

Header Value

String   Header value
Basic Authentication Complex 0..1 Basic Authentication

Username

String   Username to use for basic authentication

Password

Password   Password to use for basic authentication
OAuth 2.0 Authentication Complex 0..1 Auth 2.0 Authentication

Token URL

String   The Token URL

Client ID

String   The Client ID for obtaining the token

Client Secret

Password   The Client Secret for obtaining the token

Fail Job on Error

Boolean   Should the job fail if the service returns an error?

Yes

       

No

       
Request Complex 0..1 Request data to be sent for PUT or POST method
Request Data Body Text   Request Data Body

Content Type

String   Content Type

Character Set

String   Character Set

XLST

File 0..1 Stylesheet to apply to request data XML

File Name

String   The name of the file

File Path

String   The file path
Parameters Complex 0..* Key/Value pairs to be used as GET parameters

Key Name

String   Key Name

Value

String   Value
Result Processing Complex 0..1 Result Processing

Variable Name

String   The HTTP responseObject variable for use in the Groovy Script

Groovy Script

Script   Groovy Script to execute for post processing

Script Imports

Complex   Script Imports

JAR File URL

String 0..* The JAR File URL to be imported into the script

Script Import

String 0..* Script import to use

Script

Default Script

This Plugin allows for the provision of some Script that can carry out some functionality.

More information about Scripting is provided in the API Guide.

Properties:

Table 48.
Field Value Explanation
Icon Plugin icon
Sub-type Script Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 49.
Field Field Type Mandatory Multiplicity Description
Script complex    
  • Groovy Script
script 0..1 Script Content (create a method called execute())
  • Groovy Script File
file 0..1 Groovy Script File (create a method called execute())

External Script Action

Properties:

Table 50.
Field Value Explanation
Icon Plugin icon
Sub-type Script Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 51.
Field Field Type Mandatory Multiplicity Description
Class Name String   Fully qualified class name to use.
JAR File URL String 0..1 Jar File (URL) containing the external class

 

Groovy Script Action

Properties:

Table 52.
Field Value Explanation
Icon Plugin icon
Sub-type Script Sub-type of this Plugin
Classification   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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 53.
Field Field Type Mandatory Multiplicity Description
Script Contents complex 1  

Groovy Script

script   Script Content (create a method called execute())

Groovy Script File

file   Groovy Script File (create a method called execute())

Script Imports

complex 0..1  

JAR File URL

string 1..* Jar File URL to be imported into the script.

Script Import

string 1..* Script import to use.

Remote SSH Command Line Script Action

This plugin enables you to connect onto a remote server and run a Shell command. Ooyala Flex will then monitor that for you.

Properties:

Table 54.
Field Value Explanation
Icon Plugin icon
Sub-type Script Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 55.
Field Field Type Mandatory Multiplicity Description
Remote Host String   Remote Host or IP Address
Port Integer   Remote Port
SSH User String   SSH User Name
Credentials Complex   Credentials

SSH Password

Password   SSH Password

SSH Key File

File 0..1 SSH Private Key File

File Name

String     File Name

File Path

File Path     File Path
Command String   Command to Execute
Known Hosts File Location String 0..1 Known Hosts File Location
Result Processing Complex 0..1 Result Processing

Variable Name

String   The CommandResponse Object variable name for use in the Groovy script

Groovy Script

script   Groovy Script to execute for post processing

Script Imports

Complex   Script Imports

JAR File URL

String 0..* JAR File URL can be imported into the script

Script Import

String 0..* Script Import to use

Validate

Default Validate Action

This Plugin functions in similar fashion to Decision Plugins. A Validation Profile is specified and it is run against the Asset in the Workflow Context. The Plugin will evaluate to a true or false value.

Properties:

Table 56.
Field Value Explanation
Icon Plugin icon
Sub-type Validate Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 57.
Field Field Type Mandatory Multiplicity Description
Validation Profile Validation Profile (All)   The validation profile to be applied.

Hierarchy Validation Action

This Plugin functions in a similar fashion to Decision Plugins. It also extends the functionality of Default Validate Plugin and allows for the validation of multiple Assets that are resolved through the use of Asset Context Syntax. This Plugin only returns true if all referenced Assets validate successfully against the specified Validation Profile.

You can run this Plugin against an Asset Group, and validate 1 or more expressions (each expression can resolve to 0 or * Assets) - for each of the Assets resulting from the expression. They can either be set to validate against any of the profiles you specify or ALL of them.

This also returns false if the expression returns no Assets.

Properties:

Table 58.
Field Value Explanation
Icon Plugin icon
Sub-type Validate Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 59.
Field Field Type Mandatory Multiplicity Description
Validation Entry complex 1..* Validation Entry
  • Asset Hierarchy
string   Asset Context Hierarchy
  • Match Against
single-option   Match Against
  • Validation
Validation Profile (All) 1..* Validation definition

Pre-Ingest Validate Action

This Plugin functions in similar fashion to Decision Plugins. A Validation Profile is specified and it is run against the a file path in the Workflow Context. The Plugin will evaluate to a true or false value.

This Plugin is useful for scenarios where an Asset should not be ingested by Ooyala Flex unless it is deemed valid.

Properties:

Table 60.
Field Value Explanation
Icon Plugin icon
Sub-type Validate Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 61.
Field Field Type Mandatory Multiplicity Description
Validation Profile Validation Profile (All)   The validation profile to be applied.

Wait

Scripted Wait

This Plugin allows for the provision of some Script that executes at specified intervals. The Workflow Instance will remain at this Node until the Script evaluation returns true. A Timeout period can be specified to cause the wait to cancel and the Workflow to continue after a specified time.

More information about Scripting is provided in the API Guide.

Properties:

Table 62.
Field Value Explanation
Icon Plugin icon
Sub-type Wait Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatibility 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 63.
Field Field Type Mandatory Multiplicity Description
Script complex    
  • Groovy Script
script 0..1 Script Content (execute() must return a boolean value)
  • Groovy Script File
file   Groovy Script File (execute() must return a boolean value)
Timeout long 0..1 Timeout Period
Polling Time Period long   Polling Time Period in seconds( >= 10s ).

Delay Workflow

This Plugin is used to delay the Execution of a Workflow Instance and remain at this Node until a timeout period has expired.

Properties:

Table 64.
Field Value Explanation
Icon Plugin icon
Sub-type Wait Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatability 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 65.
Field Field Type Mandatory Multiplicity Description
Number of Seconds integer   Number of seconds workflow should waits upto to execute next node.
Context Variables complex 0..* Workflow context variables
  • Name
string   Name of the context variable to be added in workflow context variables.
  • Value
string   Value of the context variable to be set against variable specified in name.

Metadata Wait

This Plugin waits until a certain Metadata Field value associated with the Asset in the Workflow Context matches the one specified in the options below. A timeout and polling period can also be specified.

Properties:

Table 66.
Field Value Explanation
Icon Plugin icon
Sub-type Wait Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatability 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 67.
Field Field Type Mandatory Multiplicity Description
Variable Name string    
Values To Be Matched Against string   Supports regex and "&" and "|" operators
Timeout long   Timeout Period
Polling Time Period long   Polling Time Period in seconds( >= 10s ).

Vantage Workflow Wait

This Plugin is to wait for the completion of a Workflow that runs within Telestream Vantage. It supports a timeout and polling interval.

Properties:

Table 68.
Field Value Explanation
Icon Plugin icon
Sub-type Wait Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Auto retry   Whether or not to select an automatic retry
Timeout   Whether or not to select a timeout
Compatability 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 69.
Field Field Type Mandatory Multiplicity Description
Vantage Endpoint string    
Workflow ID Variable Name string    
Timeout long   Timeout Period
Polling Time Period long   Polling Time Period in seconds( >= 10s ).

Wait for Signal

This Plugin causes a Node to wait until it receives a certain number of signals.

Properties:

Table 70.
Field Value Explanation
Icon Plugin icon
Sub-type Wait Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatability 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)
Table 71.
Field Field Type Mandatory Multiplicity Description
Number of Required Signals string 0..1  

Groovy Scripted Wait Action

This plugin allows for the provision of some script that executes at specified intervals. The Workflow Instance will remain at this Node until the script evaluation returns 'true'. A Timeout period can be specified to cause the wait to cancel and the Workflow to continue after a specified time. This plugin uses a new SDK.

Properties:

Table 72.
Field Value Explanation
Icon Plugin icon
Sub-type Wait Sub-type of this Plugin
Classification Workflow 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 job, asset, event * 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   The Action required to undo this Action
Redo Action   The Action required to redo this Action
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry
Compatability 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)

Configuration:

Table 73.
Field Field Type Mandatory Multiplicity Description
Script Type Complex   Script Type

Groovy Script

Script 0..1 Script Content (execute () must return a Boolean value)

File Name

String   The name of the file

File Path

String   The file path
Script Imports Complex   Script Imports

JAR File URL

String 0..* JAR File URL to be imported into the script

Script Import

String 0..* Script import to use
Timeout Long   The timeout period
Polling Time Period Long   Polling Time Period in seconds (>= 10s)

Deliver

Aspera Console Deliver

A plugin that allows integration with the Aspera console transfer resource. This plugin triggers and then monitors Aspera deliveries

Properties:

Table 74.
Field Value Explanation
Icon Plugin icon
Sub-type Deliver Sub-type of this Plugin
Classification Workflow 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
Compatability 5.x What versions of Ooyala Flex this Plugin works for
Lifecycle Stable Maturity of this Plugin (Experimental, Unstable or Stable)
Timeout   Whether or not to select a timeout
Auto retry   Whether or not to select an automatic retry

Configuration:

Table 75.
Field Field Type Mandatory Multiplicity Description
Transfer Name String   Aspera Transfer Name
Transfer Comment Text   Aspera Transfer Comment
Transfer Source Complex   Details about the Transfer Source
Source IP String   Source IP Address

Source Port

Integer   Source Port

Source EndPoint ID

Integer   Source EndPoint ID

Source User

String   Source Aspera User Name

Source Password

Password   Source Aspera Password

Source Path

String 1..* Source Path
Transfer Destination Complex   Details about the Transfer Destination

Destination IP

String   Destination IP Address

Destination Port

Integer   Destination Port

Destination EndPoint

Integer   Destination EndPoint

Destination User

String   Destination Aspera User Name

Destination Password

Password   Destination Password

Destination Path

String   Destination Path
Retries Complex   Details about entry retries

Enable Retries

Boolean   Enable Retries

Attempts

Integer   Number of Attempts

Interval

Integer   Interval length in seconds
Delete Source Files after Transfer Complex   Source File Deletion

Enable Delete Source

Boolean   Enable Deletion

Delete Empty Directories?

Boolean   Delete Empty Directories?

Was this article helpful?