Custom Data

Custom metadata, also referred to as custom data is stored in a schema, also known as a metadata profile. You can create multiple schemas and assign them to any Kaltura object. The KMC supports schemas for entries and categories only.  To extend the metadata of an entry, you need to create a custom schema for entries.

Custom data is stored as an XSD schema that you can use to create, edit, and manipulate data. You can also use the XSD schema to generate you own metadata interface. Custom data XSDs are account specific.

Types of Metadata

Kaltura supports three types of metadata for its media assets.

  1. Technical metadata (read only) – includes the technical attributes of the media file. For example, the file type, duration, file format. See KalturaMediaInfo in the API Documentation, for a full list of predefined fields.
  2. Basic metadata – includes Name, Description, Tags, and Categories’ fields. In addition, Kaltura allows referencing the media entry using an external identifier which can be stored in the Reference ID field.
  3. Custom metadata – includes custom fields, defined under one or more schemas, which allow enhancing any media object into a custom business object.

Commercial users, please contact your account manager to enable this feature in your account.

Technical metadata, also known as system metadata, is generated automatically during ingestion and encoding of the file. All technical metadata information can be accessed through the Kaltura APIs.

Basic metadata is the information you input to the KMC through the Metadata tab. The Reference ID field allows storing an external identifier for supporting integrations with systems external to Kaltura or can be used to match a filename to an entry using the Drop Folder feature.  See Automated Content Ingestion via a Drop Folder. Tags are comma separated and can be used as filters for searching through your content. Categories allow assigning media objects to taxonomies.

Metadata Actions

You can manage assets and metadata through the:

  • KMC UI - You can edit basic and custom metadata for a single asset or apply a change of a few basic metadata fields to multiple selected assets.
  • KMC Entries Bulk upload (CSV/XML) – You can add assets in batch, combining both media files and associated metadata. (See Bulk Upload and FTP Upload). 
  • Kaltura APIs – All metadata-related functionality available through the KMC can also be performed using the Kaltura APIs. The APIs also expose additional functionality not available through the KMC. For more information see here.

Kaltura Custom Metadata Functionality

You can create a unique metadata schema. The entire schema management is done via the KMC UI.  You can add fields of the following types:

  • Custom Schema Title – enter a title.
  • Description – enter a description.
  • System Name –  enter a system name
  • Apply to – select either Entries or Categories.
  • Click Add Custom Field
  • Select the Field Type.

    • Text field – values are free text.
    • Date - a date field
    • Entry-ID list - a list to a different entry (asset) that can be used to create compound structure. Examples of this would be, Related Videos, linking trailer to full-length film etc.
    • Text select list - this is like the text field, also known as List of Values, this option allows the publisher to define a predefined list of fields to be used. After you enter the values, you are presented with a select box element to select a value from the existing list (for example countries, months).

Each field type opens a different configuration screen.

  • Text field – values are free text.
  • Date - a date field
  • Entry-ID list -  a list to a different entry (asset) that can be used to create compound structure. Examples of this would be, Related Videos, linking trailer to full-length film etc. For example, you can label this field Related Entry’s and then add files in the metadata tab. See Related Entries.

  • Text select list  - this is like the text field, also known as List of Values. This option allows the publisher to define a predefined list of fields to be used. After you enter the values, you are presented with a select box element to select a value from the existing list (for example countries, months).

     

The following is an example of a Custom Metadata Schema.

Using Custom Data for Entries

As a best practice we recommend richly mapping your media assets with metadata to make your assets more findable and better used as business objects.

You can fill in the values for the defined schema for each media asset (entry). The UI elements are built per the field type supporting text fields, checkboxes for multiple selections (from predefined values list), date selector (for date fields), text list (for multiple value fields), and linked entries (for creating structure).

The schemas you customize may be used for viewing and editing, as well as for filtering, search, and syndication rules. Custom data may be used as a condition for distributing content. For example, if you are trying to distribute data and a custom data field has been defined and expected by the distribution channel, if the custom data is not received, the content will not be distributed.

Searching (and creating syndication rules) by a custom field is integrated into the KMC UI and workflows. 

Using Custom Data for Categories

Using Custom Data for categories is useful when you need to set the category itself with non-standard metadata. You can manage metadata for display on the channel page in your application, within the category object and not through entries’ metadata. You can create complex filters to control which categories and channels to display in different areas of your website and specify other options.

Creating and managing categories’ custom data is identical to how entries’ custom data schemas and values are managed and set in the KMC. Custom Data schemas should be set to apply on entries or on categories and cannot apply on both.

NOTE: The categories’ custom data is not inherited by the entries associated with each category. Categories’ custom data is solely related to the category object and applies on category related Kaltura API calls only.

Managing Schemas

A schema is a model for describing the structure of information. Each data schema holds a list of customized fields. An XSD (XML Schema Definition) provides a way to describe and validate data in an XML environment.

Some schemas are not editable. These are schema that were created outside the KMC.

Adding a Schema

To add a schema

  1. Select the Settings icon and then select the Custom Data tab.
  2. Click Add Custom Schema. The Add Custom Schema page appears.

    The Add Custom Schema window appears.
  3. Enter the Custom Schema Title and Description.
  4. Enter the System Name (optional). This field is required if you are uploading content using Bulk XML files or if you need access to the schema via the API.
  5. Select what entity to apply the metadata to. The options are Entries or Categories.
  6. Click Add Custom Field.

Adding Custom Data Fields

To add custom data fields

  1. Select the Settings icon and then select the Custom Data tab.
  2. Click Add Custom Schema. The Add Custom Schema page appears. See Adding a Schema.
  3. Click Add Custom Field. The Add Custom Field window appears.
  4. Select the Field type. See Kaltura Custom Metadata Functionality.
  5. Enter values for the field or list. The following is an example for a Text field entry.
  6. Enter the Field Label.
  7. (Optional) Add a Description, or Full Description.
  8. Toggle on Searchable if you want to be able to search for the custom data field.
  9. Click Add. The Custom Fields List is displayed.

The following is an example of entering data as a Text Select list for the field Publishing Values.

The following screen displays the Metadata tab including a schema with a Text Select field chosen.

Related Entries

To add related entries using a schema

  1. Create a schema and add the entryID field. Optionally label it Related Entries as in this example. See Adding Custom Metadata Fields.
  2. Select an Entry and select the Metadata tab.
  3. Scroll to the Related Entries field and click +Add/Remove Linked Entries.
  4. Click Add Entry and select entries from the Entries table to the Selected Entries list and click Add Entries.
  5. Click Save.

The related entries will be displayed in the Metadata tab for the entry.

Setting Values for Metadata Fields - Per Category

Custom Data values are set to categories in a similar way they are set for entries.

To add values to the custom metadata fields

  1. Select the Settings icon and then select the Custom Data tab.
  2. Click Add Custom Schema.The Add Custom Schema page appears. See Adding a Schema.
  3. Check Categories.
  4. Click Add Custom Field. The Add Custom Field window appears.
  5. Add custom fields and values as you want and click Add.
  6. Click Save.

To edit a schema

Select the checkbox and then click on the Title.

Enter an System Name if you plan on filtering by topics in KMS.

In This Article