DIVArchive Integration

Ooyala Flex has integrated with Oracle, via the creation of three DIVArchive action plugins. This is the first integration of an archive system with Ooyala Flex. Below is a list of DIVArchive related plugins. These plugins revolve around the archiving of media assets. These plugins will enable you to archive, delete, restore, and purge your assets respectively.

The asset types that are currently supported for use with DIVArchive, are as follows:

  • Media assets
  • Text assets
  • Image assets
Note: Group assets are not currently supported.

In order to make use of the DIVArchive functionality, there are a number of prerequisites that you must take into consideration. These are as follows:

  • You must have DIVA credentials i.e you must have credentials that enable you to access the DIVA Configuration Utility.
  • You must define the source and destination in Configuration Utility: The source and destination are essentially locations that the DIVArchive system has access to. When adding the source, you will need to specify a source type from the Source Type field in DIVArchive Configuration Utility. The source types that are currently supported by Ooyala Flex are as follows:
    • CIFS (Common Internet File System)
    • DISK
    • FTP Standard
    • MediaGrid
    • Local
  • You must set up and configure DIVArchive in Ooyala Flex. This involves configuring the DIVArchive resource. When specifying locations, you must map these locations in the Resource plugin’s Folder Mapping field.
  • You must define a media name in Configuration Utility, and then reference the Media Name field in the DIVArchive action plugin. Media name can refer to media or storage plan.

In the diagram below, you can see how each of the DIVArchive plugins relate to each other, and in what order they can be used:

DIVArchive Action

This plugin archives an asset as a new object in DIVArchive.

Note: Only individual assets are currently supported. So you can only archive one asset at a time.
Note: Despite the fact that the DIVArchive plugin falls under the "Archive" category the DIVArchive action is distinctly different and separate from the standard Ooyala Flex Archive action.
Note: When you are setting up the DIVArchive plugin, you must first ensure that you have specified a source and a destination in the DIVArchive UI.

Properties:

Table 1.
Field Value Explanation
Icon Plugin icon
Sub-type Archive Sub-type of this plugin
Classification Capacity 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.3 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
External Resource Single option   The External Resource which will process specified assets.
Asset Context String   The asset context hierarchy expression referencing the assets to be archived.
Archive Params complex   Archive Params details of archive service

Object Name

string   Name of the Object to be archived.

Object Category

string   Category of the Object.

Source

string   Name of the Source (e.g. video server, browsing server). This name must be known to the DIVArchive Configuration Description.

Media Name

string   The Tape Group or Disk Array on which the object is to be saved.

Delete On Source

Boolean   The delete on source variable is used as archived params.

Comment

string   The comment is used as archived params.

DIVA Delete Action

This plugin deletes an asset from DIVArchive.

Note: This plugin falls under the Delete Archive category.

Properties:

Table 3.
Field Value Explanation
Icon Plugin icon
Sub-type Delete Archive Sub-type of this plugin
Classification Capacity 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.3 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
External Resource Single option   The external resource which will process specified assets.
Media Name string   The tape group or disk array from which the object will be deleted.
Instance ID string   Disk or tape instance number to be deleted. This is assigned in DIVArchive and can be verified in Ooyala Flex using DIVArchive tab in asset. (#)
Priority Level string   A value between 0...100 (not included). This will be used in DIVArchive system to manage the job priority. (#)

 

DIVA Restore Action

This plugin restores an archived asset from DIVArchive.

Note: This plugin falls under the Restore Archive category.

Properties:

Table 5.
Field Value Explanation
Icon Plugin icon
Sub-type Restore Archive Sub-type of this plugin
Classification Capacity 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.3 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
External Resource single option   The external resource which will process specified assets.
Destinations complex 0..* Name of the destination(s) configured in DIVArchive.

Destination

string   Name of the destination(s) configured in DIVArchive.

Destination Path

    Path on the destination(s).
Priority Level string   A value between 0...100 (not included). This will be used in DIVArchive system to manage the job priority. (#)
Restore Options string  

Command line style parameters that can be added to the request. These options supersede any options specified in the DIVArchive Database

Additional Services single option  

Restore overwrite option.

The options for this field are as follows:

  • Default: Operate using the default setting in the DIVA Manager Configuration.

  • Do not overwrite: Do not overwrite existing files on the destination server. The Action will fail if the file already exists.

  • Do not check existence: Do not check existence of the file on the server.

  • Delete and write: Force delete and rewrite if the file exists on the server.

DIVArchive Resource

This resource provides access to networked transcode resources. Configuration options are governed by the specific vendor solution being used, so in this case, the configuration options are related to DIVArchive.

Properties:

Table 7.
Field Value Explanation
Icon Plugin icon
Sub-type External Sub-type of this plugin
Classification Process 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   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
Integration Service complex   DIVA Archive Integration service details

Hostname

string   Hostname for accessing the location

Port

string   Port for accessing the location (#)

Username

string   Username for authentication

Password

string   Password for authentication

Site Name

string   Username for authentication

Response Timeout

string   Response timeout

Userinfo

string   User Information
Folder Mapping complex 0..* Base VFS locations for the location of files once a destination is defined it will be used as restore location.

Flex Base VFS Location

    Details for a base vfs location

Protocol

single option   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

file   Only applicable for SFTP certificate authentication

DIVA Archive Base VFS Location

complex   Details for a diva archive base vfs location

Protocol

single option   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

file   Only applicable for SFTP certificate authentication

DIVArchive Video Restore

The DIVArchive Video Restore plugin gives you the ability to either restore a whole video, or perform a partial restore on a video that is currently in archive.  You can only restore a single asset at a time.

Important points:

When performing a partial restore, you must specify an in timecode and an out timecode in the configuration for the plugin. Timecode In and Timecode Out, values should be in HH:MM::SS:FF Format.

Note: This is a distinctly different plugin to the Restore Archive plugin. The Restore plugin is a file restore.
Note: This plugin falls under the Restore Archive sub-type.
Note: Video Partial Restore on a DIVA object with multiple assets and for an asset group is not supported.

Properties:

Table 9.
Field Value Explanation
Icon Plugin icon
Sub-type Restore Archive Sub-type of this plugin
Classification Capacity 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 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
 External Resource  Single Option   The External Resource which will process specified assets.
Asset Context string   The asset context hierarchy expression referencing the assets to be restored. e.g.: To restore all assets from an Asset Group enter *.
DIVA Object Name Category string 0..1 On Archive Flex has created DIVA object name using 'Object Name'+'Object Category' fields from Archive config. If an Asset is archived in multiple DIVAObjects, use this expression to select specific DIVAObject, e.g. myassetid+mycategory.
Video File Details complex 0..1 Configuration used to create video file from source file.
Timecode In (HH:MM:SS:FF) string   Start time-code of the file. If not defined then DIVA Service will consider default value "00:00:00:00".
Timecode Out (HH:MM:SS:FF) string   End time-code of the file. If not defined then DIVA service will consider default value "99:99:99:99".
Destination File Name string   File Name of restored video file at destination. Default will be in format asset-name_TC-IN_TC-OUT.
Destinations complex 0..1 Restore destinations. If empty the file will be restored to the current asset location.
Destination string   Asset(s) will be restored to the configured path in DIVA Destination config. If asset was archived with subfolder (e.g. copy/file1.mp4), it will be appended to Destination path.
Destination Path string   Use this path to append additional subfolder to the configured path in DIVA Destination config. If asset was archived with subfolder (e.g. copy/file1.mp4), this will be appended after the Destination Path.
Move Restored Assets to Current Location Check box   DIVA will restore always to the asset original location when it was archived. If Flex asset has been moved (or in Delete resource) since it was archived, this option will move back to current asset location from the restored original location.
DIVA Video Partial Restore to create a clip from Restored File? Check box   This option will import video partial restore asset as new Flex media asset with RENDER_CLIP relation to original archived asset. This option will be ignored if Destination param is configured (use another explicit Import action in this case).
Priority Level string   A value between 0...100 (not included). This will be used in DIVArchive system to manage the job priority. (#)
Restore Options string   Command line style parameters that can be added to the request. These options supersede any options specified in the DIVArchive Database
Additional Services  Single option   Restore overwrite option.

Was this article helpful?