Most things in Ooyala Flex are objects. As such, configuring Ooyala Flex involves creating, editing, and configuring various object types in the Settings and Access sections. The configuration screens in Ooyala Flex are split up into a sub-sections for each object type.
It's also worth reminding readers that Ooyala Flex supports fine-grained access control. Therefore the configuration sub-sections available to you depends on your role and your role's associated permissions.
The actions and properties available when creating and configuring Ooyala Flex objects vary based on the object type. For example, some object types can be started and stopped, such as the resource object type. Others cannot.
Copying an Object
Some objects support copying. When you copy an object, a new object is created that duplicates all of the properties of the original object. The super user is then required to enter a new name for the object. Copying is an extremely useful and time-saving when you wish to create a new object that is based on the properties of an existing object.
1) To copy an object, navigate to the Object Details section of the object you wish to copy, for example an action.
2) In the Object Setting view, click the Copy icon.
3) In the Copy section, enter a name for your copy, and any other details that are applicable to the specific object type.
4) Click the Save button to finalise.
5) The copied object will initially be disabled when created. So in order to start utilising it, you must enable it first.
Exporting and Importing Objects
Many object types in the Access and Settings sections can be exported and imported in XML format. This functionality is extremely useful when super users wish to copy configurations from one Ooyala Flex environment to another.
To export an object, simply click the Export icon in the Object Setting view.
Then if you are a Super User, your web browser will then commence the download of the object data to your local computer.
An example of the contents of an exported object file is shown below:
Importing an Object
1) To import an object, simply click the Import Icon in the Fixed List view.
2) In the Import section, click the Choose File button.
3) When you have chosen your the file, click Upload.
If you are going to import an object from another account there are three parameters that may need to be changed. These are:
Some object types support extended configuration through an additional Configuration tab. This tab allows super users to enter further configuration information through a custom form. Within some configuration screens, there are some fields (or entire sections) that are optional. These are made available by clicking on the + symbol. If you wish to remove these configuration items later, simply click the - symbol and the options and any associated values will be deleted.
Where values can be added to extended configuration fields, super users have the option of adding fixed values or a script. A script is a fragment of code that is evaluated at run-time to generate an output value. Scripting is an extremely valuable tool as it offers the ability to add more intelligence to the behaviour of Ooyala Flex and further customise the platform in a more dynamic way.
The screen shot below shows a Configuration tab with scripting inserted into a field.
Some object types support plugins. A plugin is a functionality of code developed against Ooyala Flex's API that implements specific functionality. Plugins allow developers to extend the functionality of Ooyala Flex. Examples of object types that support plugins are:
- Timed actions
- Event handlers
If an object type supports plugins then when a new object of this type is created, you will be asked to select a specific plugin type. If the plugin is configurable, then you will be presented with an Extended Configuration tab which enables the plugin properties to be configured.
The below screen shot shows a plugin being selected when creating a new action:
1) Create a new Action and select a plugin from the Plugin drop down.
2) Once created, you can further configure the properties for this plugin, using the Extended Configuration tab.
Objects and Metadata
Some object types support metadata schema. A schema is used to associate data fields with an object type. This means that when a new object is created, Ooyala Flex will automatically create a new schema instance for that object.
Some object types allow you to define variants. A variant is a more specific type of an existing object type which is defined by a user. For example Ooyala Flex supports the asset object type. This means that in Ooyala Flex you can create, update and search for assets. But what about if you want to create a new object type that is like an asset but more specific? What if you wish to assign different data fields to your more specific type?
Let's say you want to create a type called "Video" that is simply a type of asset with more specific data fields. To do this you create a Variant. When you create a variant, you do the following:
1) Select the Ooyala Flex object type you want to base your variant on (i.e. Asset).
2) Create a name for your variant (i.e. Video).
3) Supply an optional metadata schema to help describe properties of your video.
Now, every time you create a new asset, you have the option of creating an asset of the type "Video", which will comprise its own metadata schema specific to that variant.
Once you have created your new "Video" variant ,you can create new variants and you can also search by objects of type "Video".
The following object types support variants:
Group asset image
Note: Variants can only be created from existing Ooyala Flex object types, not object types that are created by users (user defined object types).
It is possible to create multiple variants for a single object type. As a result of this, you can also specify the default variant for an object type. This means that when an object is created, if no variant is explicitly selected, the default variant will be chosen.
Variants and Schema
A variant can support more than one schema. This means that when you create a new instance of an object that supports variants, you not only select a variant, you also select the schema you wish to apply. A variant always has one default schema. If you create a new variant without specifically selecting a schema, then the default will be assigned.
Variants and Metadata
If the object type you are configuring supports variants, and a variant has been set up for this object type in your account, the following options apply.
• When you create a new object of this type you will be asked to select the particular variant and metadata schema as shown below:
• When you edit the object properties, you will be presented with a metadata sub-tab as shown below:
• When you edit the object properties, you will be able to change the current variant and schema:
Some objects support the concept of approval. When an object is approved by a user it is set to approved and an approved event is triggered. When approving an object an optional comment can be added. This comment is stored in the comments stored with each object. Conversely, objects that support approval can also be un-approved. When un-approving an object an optional comment can be added.
Note: Approval functionality is only available if the relevant permissions have been enabled in the user's role.
Some object types support locking. This means that only one update can be made to an object at a time. This can be extremely important under some circumstances. For example if a job is moving an asset object from one location to another it would not be prudent to allow another job to run the same move on the same asset object. This could result in unpredictable outcomes and lead to system instability.
There lock types supported in Ooyala Flex are:
Exclusive: Exclusive locks. When a statement modifies data, its transaction holds an exclusive lock on data that prevents other transactions from accessing the data. This lock remains in place until the transaction holding the lock issues a commit or rollback.
Shared: Shared locks exist when two transactions are granted read access. One transaction gets the shared lock on data and when the second transaction requests the same data it is also given a shared lock. Both transactions are in a read-only mode, updating the data is not allowed until the shared lock is released.
Some object types support locking. This means that how they are accessed and updated can be controlled by Ooyala Flex. If the object being reviewed supports locking, the locking field will be present. If the object is locked, you will be able to inspect information about what other object is locking this object.
If an object is locked, the lock symbol will be shown.
Note: Certain objects support locking, whilst others don't. Above we have used an asset as an example.
While an object is locked you can roll over the symbol to see what objects are locking that one. The Lock Owner field shows the object ID of the locking object. Clicking on this field will take you to the Details view for the lock owner.