Event Plugins

This section provides a list of all event plugins. Event plugins are referenced by event handlers and are run whenever an event is matched by an event filter.

Business Intelligence

This plugin sends Ooyala Flex events, serialized as JSON data to external elastic search data stores for further analysis. You can use the event handler filter to send all data or a subset. Once inside elastic search you can generate near real-time information on Ooyala Flex's performance and activities.

Properties:

Table 1.
Field Value Explanation
Icon Plugin icon
Sub-type Event Handler Sub-type of this plugin
Classification Event Handler 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 event What Ooyala Flex objects can be referenced from within the scripting context.
Undo Action   The Action required to undo this action
Redo Action   The Action required to redo this action
Compatability 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
Url string   Url to send the put request
Index Name string   Elastic search description
Type Name string   Type name description

Job Executing

This Plugin specifies an action plugin to run when an event has been matched. This results in a job being created and registered with the job scheduler.

Properties:

Table 3.
Field Value Explanation
Icon Plugin icon
Sub-type Event Handler Sub-type of this plugin
Classification Event Handler 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 event What Ooyala Flex objects can be referenced from within the scripting context.
Undo Action   The action required to undo this action
Redo Action   The action required to redo this action
Compatability 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
Action Config Action   Name of action config to be executed by the event handler

 

 

Mail Dispatching

This plugin supports the sending of an email to users specified in the configuration options. This plugin relies on mail templates.

Some common use cases for this plugin are:

• Send an email when a user has been added to a user group

• Send email on user password reset

• Email on a user being enabled

Expression script is very useful in order to identify who should be emailed. For example, filtering for a user event type and using #{event.Ooyala FlexObject.name} will notify the user of the event that has been filtered.

Properties:

Table 5.
Field Value Explanation
Icon Plugin icon
Sub-type Event Handler Sub-type of this plugin
Classification Event Handler 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 event What Ooyala Flex objects can be referenced from within the scripting context.
Undo Action   The action required to undo this action
Redo Action   The action required to redo this action
Compatability 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
Message Template Message Template   The message template to use.
Recipients complex   Recipients of the email
  • Account
Account 0..* 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
  • Expression
string 0..* An evaluated expression resulting in an email address, user name or group name
Subject string   Subject of the mail. Subject specified in the template will be used, if this is blank
Sender string   Sender of the mail. Sender specified in the template will be used, if this is blank

Script Executing

This plugin executes some script when it is run by the event handler.

More information about scripting is provided in the API Guide.

Properties:

Table 7.
Field Value Explanation
Icon Plugin icon
Sub-type Event Handler Sub-type of this plugin
Classification Event Handler 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 event What Ooyala Flex objects can be referenced from within the scripting context.
Undo Action   The action required to undo this action
Redo Action   The action required to redo this action
Compatability 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
Groovy Script script   Script content (create a method called execute())

Notifications

Followed Notification

This plugin notifies users of updates made to Ooyala Flex objects that they are following. This plugin is a specialised type of notification plugin.

This plugin generates notifications for users. The notifications will appear in each users's Event pop-up box. A user can also configure their profile to control whether events are emailed to them or sent via SMS.

Properties:

Table 9.
Field Value Explanation
Icon Plugin icon
Sub-type Event Handler Sub-type of this plugin
Classification Event Handler 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 event What Ooyala Flex objects can be referenced from within the scripting context.
Undo Action   The action required to undo this action
Redo Action   The action required to redo this action
Compatability 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
Message Template Message Template   The message template to use.
SMS Template Message Template   The SMS template to use.

Notification

This general purpose notification plugin notifies users of updates made to Ooyala Flex objects. This Plugin is a specialised type of notification plugin.

This plugin generates notifications for users. The notifications will appear in each users's Event pop-up box. A user can also configure their profile to control whether events are emailed to them or sent via SMS.

This plugin supports notifying groups of users. The plugin supports most of the Ooyala Flex grouping structures:

• Account

• Sub-Account

• User Group

• Workspace

• User

Properties:

Table 11.
Field Value Explanation
Icon Plugin icon
Sub-type Event Handler Sub-type of this plugin
Classification Event Handler 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 event What Ooyala Flex objects can be referenced from within the scripting context.
Undo Action   The action required to undo this action
Redo Action   The action required to redo this action
Compatability 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
Message Template Message Template   The message template to use.
SMS Template Message Template   The SMS template to use.
Recipients complex   Recipients of the email
  • Account
Account 0..* 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
  • Expression
string 0..* An evaluated expression resulting in an email address, user name or group name

Owned Object Notification

This plugin notifies owners of updates made to Ooyala Flex objects that they own. This plugin is a specialised type of notification plugin.

This plugin generates notifications for users. The notifications will appear in each users' Event pop-up box. A user can also configure their profile to control whether events are emailed to them or sent via SMS.

Table 13.
Field Value Explanation

Icon

Plugin icon
Sub-type Event Handler Sub-type of this plugin
Classification Event Handler 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 event What Ooyala Flex objects can be referenced from within the scripting context.
Undo Action   The action required to undo this action
Redo Action   The action required to redo this action
Compatability 5.x What versions of Ooyala Flex this plugin works for
Lifecycle Stable Maturity of this plugin (Experimental, Unstable or Stable)

Configuration:

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

Task Assignment Notification

This plugin notifies users that a user task has been assigned to them. This plugin is a specialised type of notification plugin.

This plugin generates notifications for users. The notifications will appear in each users' Event pop-up box. A user can also configure their profile to control whether events are emailed to them or sent via SMS.

Properties:

Table 15.
Field Value Explanation
Icon Plugin icon
Sub-type Event Handler Sub-type of this plugin
Classification Event Handler 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 event What Ooyala Flex objects can be referenced from within the scripting context.
Undo Action   The action required to undo this action
Redo Action   The action required to redo this action
Compatability 5.x What versions of Ooyala Flex this plugin works for
Lifecycle Stable Maturity of this plugin (Experimental, Unstable or Stable)

Configuration:

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

Internal Script Executor

Properties:

Table 17.
Field Value Explanation
Icon Plugin icon
Sub-type Event Handler Sub-type of this plugin
Classification Event Handler 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 event What Ooyala Flex objects can be referenced from within the scripting context.
Undo Action   The action required to undo this action
Redo Action   The action required to redo this action
Compatability 5.x What versions of Ooyala Flex this plugin works for
Lifecycle Stable Maturity of this plugin (Experimental, Unstable or Stable)

Configuration:

Table 18.
Field Field Type Mandatory Multiplicity Description
Groovy Script script   Script content (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.

Was this article helpful?