Wait

These plugins help you to add wait steps into your Workflows.

Backlot Wait For Remote Ingest Action

This plugin works together with the Backlot Remote Ingest Publish action plugin. When the Backlot Remote Ingest Publish plugin triggers an ingest by uploading a manifest file, the Backlot Wait for Remote Ingest action monitors the ingest. Configuration for this plugin is not required, as this plugin takes the information from the configuration that has been set in the Backlot Remote Ingest Publish plugin.

The Backlot Remote Ingest Publish action plugin can be found here.

For additional information, please read the Basic and Manifest-based Ingest section in the Backlot: About Ingesting Content guide.

Properties:

Table 1.
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.5.3 What versions of Ooyala Flex this plugin works for
Lifecycle Stable Maturity of this plugin (Experimental, Unstable or Stable)

Internal 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.

Properties:

Table 2.
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 3.
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 ).
Requires Lock single option 1 Type of lock required on asset

External Scripted Wait

Configuration:

Table 4.
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)

Properties:

Table 5.
Field Field Type Mandatory Multiplicity Description
Class Name string   Fully qualified class name to use.
JAR File URL string 1 Jar File (URL) containing the external class.
Timeout string / single option   Timeout period (#)
Polling Time Period string / single option   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 6.
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 7.
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 8.
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 9.
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 pime 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 10.
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 11.
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 12.
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 13.
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 14.
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:

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)
Requires Lock single option 1 Type of lock required on asset

Groovy Scripted Wait for Named Signal

Use this plugin to configure the action a node takes when a named signal is received from the “Find and Signal Named Signal Wait” plugin.

The workflow instance remains at the node until the script evaluation returns “true.”

You can set a timeout period to cancel the wait, allowing the workflow instance to continue.

Properties:

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:

Field Field Type Mandatory Multiplicity Description
Signal Name string   Name of signal that job waits for

Wair for Signal

complex   Wait instructions
  • Wait for Signal Expression
script 0..1 Expression to decide whether to wait for signal
  • Groovy Script
complex 0..1  
  • Script Contents
complex    
  • Groovy Script
string 0..1 Script Content (create a method called execute())
  • Groovy Script File
file 0..1 Groovy Script File (create a method called execute())
  • Script Imports
complex    
  • JAR File URL
string 0..* Jar File URL to be imported into the script
  • Script Import
string 0..* Script import to use
Requires Lock single option 0..1 Type of lock required on asset

Backlot Wait for Live Status

This plugin works together with the Backlot Bucket to Bucket Publish action plugin. When the Backlot Bucket to Bucket Publish plugin triggers an ingest by uploading a manifest file, the Backlot Wait for Live Status action monitors the ingest.

The Backlot Bucket to Bucket Publish action plugin can be found here.

For additional information, please read the Basic and Manifest-based Ingest section in the Backlot: About Ingesting Content guide.

Properties:

Table 15.
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 to select a timeout
Auto retry   Whether to select an automatic retry
Compatibility 5.5.3 What versions of Ooyala Flex this plugin works for
Lifecycle Stable Maturity of this plugin (Experimental, Unstable or Stable)

Configuration:

Field Field Type Mandatory Multiplicity Description
API Key string   Backlot API key
API Secret string   API Secret
Embed Code string 0..1 The ID of Backlot's published asset
External ID string 0..1 Default asset ID
Timeout integer   Timeout period. A single option menu gives a choice of units of time - the default is seconds.
Polling Time Period integer   Polling time period, at least 10 seconds. A single option menu gives a choice of units of time - the default is seconds.

Was this article helpful?