Field Configuration

If you click on a field in the canvas, the field configuration will be loaded into the Configuration panel.

The configuration options that you see in the Configuration panel depend on the metadata field that you have selected from the canvas.

In the following sections, we will describe the options available.

Display Name

The display name for the field.

Name

Name of the field.

Description

Description of the field.

The instance of a description field will be represented by an icon. When you hover over this icon, the description will appear.

Editable

This section allows you to select whether the field is editable by other users.

Searchable

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

Commentable

This section allows you to select whether the field commentable.

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.

Validation Options

Validation Options allows the you to define how values entered into a field are validated. The following fields apply:

Validation: When this checkbox 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.

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.

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 consult the API guide for more information on class name validation.

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:

Adding a new Option Value

To add a new Option value, enter the value in the Display Name box and press the green cross button.

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 the Delete icon to remove a row.

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 you to control how Number, Date and Time fields are presented to users. The options above are described below:

  • Checkbox: 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 ser to provide descriptive information about the format rules specified.

Unit Options

Unit Options apply to numeric 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:

  • Checkbox: 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

Was this article helpful?