Script

These plugins help you to work with scripts in your workflows.

Internal 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 1.
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 2.
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 3.
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 4.
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 5.
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 6.
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.
Requires Lock single option 1 Type of lock required on Asset

External Scripted Decision

Properties:

Table 7.
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 8.
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.

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 9.
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 10.
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 command response 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

Database Import Script

This plugin allows you use a script to import from a database.

Properties:

Table 11.
Field Value Explanation
Icon Plugin icon
Sub-type Script 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:

Table 12.
Field Field Type Mandatory Multiplicity Description
Database Source Details complex    
  • Connection URL
string   Database connection URL. For a CSV file, this is the source folder that contains the CSV files.
  • Database Type
single option    
  • Custom JDBC Driver
complex 0..1 Database source details
  • JAR File URL
string 1..* JAR file URL that contains the JDBC driver
  • JDBC Driver
string   Fully qualified class name of the JDBC driver
  • User Name
string   Database connection user name
  • Password
string   Database connection password
  • SQL Query
string   SQL query to execute
Result processing complex    
  • Variable Name
string   The DatabaseResponse object variable name for use in the Groovy script
  • Groovy Script
complex    
  • Script
string   Groovy script to execute post processing
  • 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

Was this article helpful?