Field Configuration

If you click on a field in the Metadata Canvas, the Field configuration will be loaded into the Configuration Panel.

The configuration options that you see in the Configuration Panel depends on the Metadata Field that you have selected from the Metadata Canvas.

In the following sections, we describe all options available.

Basic Details

This section is always present:

• The top icon shows the Field Type and the current name.

• Display name is mandatory

• Description is optional

Editable Details

This section allows you to select whether the Field is editable by other Users.

Searchable Details

This section allows you to select whether the Field is searchable by other Users in search forms.

Default Value

This section allows you to select whether the Field is searchable by other Users in search forms.

Note: If you try and type in a default value that is not valid for the chosen Field Type, a validation error will be shown in red.

Form Type

The Form Type applies to most Field Types. The Form Types available depend on the Metadata Field Type.

Multiplicity Type

The Multiplicity Type applies to most Field Types and indicates how many instances of this Field Type can exist.

Generated Value

If selected, the value of this Field Instance will be generated automatically on creation.

Validation Options

Validation Options allow the User to define how values entered into a Field are validated. The following Fields apply:

Validation: When this check box is selected it implies validation rules are applied. The following Fields are also available.

Required: This is the most simple rule and simply states the validation applies and only Fields with values entered will be accepted.

Description: This option allows the User to provide a description of the validation rule. This can be presented to a User when they are filling in the form Field to ensure that they know what the validation rules are.

Max. Length: This is another simple rule that, if set, enforces a maximum text length for an entry type.

Script: This field allows the User to validate a rule against some script. Please see the API Guide for more information on scripting.

Class Name: This is an advanced field that allows a developer to specify a class name to be used for the purposes of validating a Field entry. Please see the API Guide for more information on class name validation.

The Script field expects an Expression Script which is used to validate the value of the Metadata Field value.

The following Objects are accessible in the scripting context:

value: The raw value associated with the variable instance.

variable: The Variable Object

variableInstance: The Variable Instance Object.

Note: If the Expression Script is badly formatted, the font will turn red.

Option Values

This option type allows for the specification of option values for Single-option and Multi-option Field Types. The options panel offers a range of editing features as listed below:

Use the Ctrl key when clicking on rows to select more than one row at a time.

Adding a new Option Value:

To add a new Option value, enter the value in the text box and press the green cross button or press the Return key.

Select the default Value:

For Multi-option Field types you can select more than one default value. For a Single-option type you can select only one.

Deleting an Option Value with a Button:

Click on one or more rows with your mouse and then click the delete button to remove a row.

Deleting Row with Right-click:

Alterely, select one or more entries and right-click on a row and then click delete.

Drag and Drop:

You can select one or more rows and drag them to different positions in the table to change ordering of values.

Row Editing:

Once in place, you can edit the name and display name of a row by double-clicking on a cell. You can also edit the Display Name if you wish to give it a more human-readable value.

Duplicate Value Validation:

If you enter a value that already exists in the Name column, the text will turn red to warn you that this value is not valid. This does not apply to the Display Name column. When you first enter a value, the name and display name take the same value. You can edit the display name if you wish to make it more human-readable. A Boolean Field Type field is in fact a type of Option Field. When you create a Boolean Type, you are presented with an Option panel with only two options, true and false. You can only select one default value.

Backing Store Values

If you select an Option Type Field, then if you select the Backing Store field, the Option Values panel (shown above) is hidden and the Backing Store panel appears.

You can select the backing store Type and Identifier value.

Formatting Options

Formatting rules allow the User to control how Number, Date and Time fields are presented to Users. The options above are described below:

Check box: Check this box if you wish to support formatting

Formatting: For Number, Date and Time Field Types, formatting can be provided to control how a number is presented to Users.

Format Description: An optional field that allows for a User to provide description information about the format rules specified.

Unit Options

Unit Options apply to Number Field types and allow you to specify Units for a chosen Number Field.

Object Types

If you create a Field of Type Object, you will be asked to choose your Object Type from a drop down list of Ooyala Flex Object Types.

Permission Options

Ooyala Flex's metadata framework supports per-Field access control. This means that Users can specify which User Groups can view and edit a particular Field in a Schema Instance.

If you select the Permissions checkbox then the Permissions panel becomes visible. If you enable Permissions, then no Access is available until you apply Access to individual Groups. To do this, click on Access and then select read or read and write.

The options available are as follows:

Check box: Check this box if you wish to support permissions

Access: This means that the selected User Group has access to the Field

Read: This means that the selected User Group has read access to the Field (cannot edit)

Edit: This means that the selected User Group has edit access to the Field (cannot also read)