Message

These plugins help you to work with messages in your Workflows.

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:

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 to select an automatic retry
Timeout   Whether 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:

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"

Backlot Message

This plugin provides a flexible means of making HTTP requests to Backlot, and processing Backlot responses.

Properties:

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 to select a Time Out
Auto Retry   Whether 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:

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:

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 to select a timeout
Auto retry   Whether 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:

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:

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 to select a timeout
Auto retry   Whether 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:

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:

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 to select a timeout
Auto retry   Whether 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:

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:

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:

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
Parent topic: Action Plugins
https://help.ooyala.com/sites/all/libraries/dita/en/media-logistics/flex/dev/53/action_plugins_53_message.html

Was this article helpful?

Rate this article:
AAA