All Collections
Platform Documentation
Settings module: Custom Attributes
Settings module: Custom Attributes

Here we show you how to easily use this tool in platform

Miguel Giraldo avatar
Written by Miguel Giraldo
Updated over a week ago

Platform has a data format (attributes) already established for its operation, however, there is a very simple way to enter new and/or extend them, this is done through the custom attributes which are directly assigned to the media, playlist and schedules, and they allow you to add custom metadata that will be an integral part in platform operation, these attributes will be available through the API and can be used to filter and classify specific content.

In order to get to know their functionality, we will explain how to create and manage them within the platform's default functions.

Configuration

Go to the Settings/Custom Attributes module.

By doing so, the interface opens as shown in the image:

Once there, click on the plus sign (+) that you find to the right of the module title, this opens a window where you can configure the attribute according to your needs.

Let's create an example of an attribute to add a more detailed description of a media, in addition to the default one.

  • Attribute Name, enter the name of the attribute as such to identify it within the module to which it will be integrated, for example Biography.

  • Type, select the type of attribute you want to configure, for the example, you select a Rich text type.

  • Used in, indicate in which module you want the attribute to be applied, in this case in Media.

Once the settings are done, save the changes in Save, then go to the media module and enter a specific one, there you will find in the respective section the newly created attribute, this will be available for all the media you upload in your account, both VOD and AOD.

Attribute types

For platform management, we have the following types:

  • Autocomplete: As its name suggests, it is used to autocomplete metadata fields referring to specific subjects, for example year, seasons, etc. Once an attribute of this type has been created, according to the options provided, it is displayed as a selection list.

  • Boolean: allows you to create attributes with True or False values, it is used to activate or deactivate functions within the source code of the associated module, once created, it will be displayed in the module as an on/off button.

  • Category: allows you to associate or complement the categories created in the media module, its most common use is linked to a parent category.

View inside module

The displayed list contains the subcategories created within the selected parent

category, you can consult the following link:

Attribute view

  • Day: this attribute is used to enter day-specific metadata related to a live stream or media

  • File: useful for adding files such as images, pdf documents, clips, etc. to the metadata, when added, it generates a url within the metadata in the API to download the content.


Once the file is uploaded, you can click on the link icon to visualize it through API.

  • Rich Text: It allows you to enter metadata with RTF-style rich text format, in which you can adjust the font color, alignment, even insert images, which is not possible in the platform's default text fields..

  • List: as its name suggests, it allows you to generate customized lists related to your content.

  • Number: commonly used in the OTT service to organize content such as media, schedules and live streams.

  • Tags: this attribute allows us to add additional tags to our content.

  • Text Area: it allows you to enter additional text without limit of characters, unlike rich text, this one does not let you make changes on the text entered.

  • Text: like the previous type, allows us to enter simple text, words that make reference to the content to which it is attributed.

Remember that all the information added by using custom attributes will only be visible through the API, the end user will not have access to this information.


If you have any related question, please feel free to write to us.

Atte. Mediastream team

Did this answer your question?