User Defined Object Types

In Ooyala Flex you are able to create custom object types. These are known as 'user defined object types'. Unlike the system object types, you can customise these in a variety of ways so that they meet the needs of your organisation. You can add a display name, plural name, description, and even add icons so that your user defined object type is easily identifiable in Ooyala Flex. For example if you were a production company you might want to create a custom object called "Series".

You can create relationships between your various custom object types using the Objects feature, as well as between custom object types and system object types. For example you could create a child object type called "Episode", and add as many episodes to a series as you wanted.

Below is an example of an object relationship hierarchy with three levels of user defined object types:

Creating a User Defined Object Type

1) In the Ooyala Flex console, click the Settings tab, located on the right side of the screen.

2) On the toolbar, click Object Types.

3) In the Object Types section, click New.

4) In the Create new Object Type section, fill in the details for your new object type. Some of these fields are mandatory and some are not.

5) In the Name field, enter a name, for example Episode. Your custom object can be called anything you like.

6) In the Description field, you can enter an optional description which tells others about your custom object type.

7) In the Display Name field, enter a display name for the object. It is probably helpful that the Display Name and Name fields match.

8) In the Plural Name field, enter the plural name for your object. For example: if your object was called an Episode, then the plural would be Episodes.

9) In the Small Icon field, click the Choose File button and select the image you wish to use for the small icon. This image must be 16 x 16 pixels.

10) In the Normal Icon field, click the Choose File button and select the image you wish to use for the normal sized icon. This image must be 22 x 22 pixels.

11) In the Large Icon field, click the Choose File button and select the image you wish to use for the large icon. This image must be 64 x 64 pixels.

12) Once you've filled in the mandatory fields for your new custom object type, click Save to finalise.

13) Click Enable to enable your user defined object type.

User Defined Object Type Properties

You can set certain properties for your user defined object types.

Note: If you have already enabled your user defined object, you must disable it before changing any properties.

To set properties for your user defined object type, follow these steps:

1) In the Object Details section, click the Properties tab.

2) Under the Properties tab, click the Edit link.

3) Select the properties you wish to assign to the your user defined object type.

4) Click Save to finalise.

5) Click Enable, to enable the object.

The properties that can be assigned to your user defined object type are as follows:

Root Object Type:This property is relevant when you are creating hierarchies using the objects feature. A root object type is an object that is the first level of an object hierarchy.

Panel Supported: You can choose this property if you want the object type to be panel supported.

Workspace Supported: You can choose this property if you want your object to be workspace supported.

Attachment Supported: You can choose this property if you want to be able to attach files to your object.

Duplicate Name Supported: You can choose this property if you want your object to support duplicate names.

Duplicate Child Name Supported: You can choose this property if you want your object to support duplicate child names.

Panel URL: This is the field in which you enter the URL for the panel.

Approval Supported: You can choose this property if you want your object to support approval.

Comment Supported: You can choose this property if you want people to be able to comment on your object.

Run Rules for User Defined Object Types

User defined object types support the use of run-rule expressions. In order to use a run-rule expression against a user defined object type, simply enter a run-rule expression in the Run-Rule Expression field, found in the Details section for a user defined object type.

The run rule that you enter has to be a boolean, e.g. it will equal to either true or false, and it will use the following variables:

• Current user (user)

• Current object - i.e. parent object (parent)

• Metadata expressions of parent object (@@ @@)

Example:

${user.role.mioObject.name == "Admin" && parent.mioObject.name == "My Production && "@@productionid@@" == "123"}

Was this article helpful?