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:
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:
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
This plugin deletes an Asset from DIVArchive.
Note: This plugin falls under the Delete Archive category.
Properties:
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:
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 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
This plugin restores an archived Asset from DIVArchive.
Note: This plugin falls under the Restore Archive category.
Properties:
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:
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:
|
DIVA Resource
This Resource provides access to an archive resource. Configuration options are governed by the specific vendor solution being used, so in this case, the configuration options are related to DIVArchive.
Properties:
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:
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 |
![]() |
The site name configured in DIVArchive | |
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 |