Custom Fields

Custom Fields enable the saving and searching of domain-specific metadata, such as information about business functions, digital rights, or whatever suits your needs. Custom fields are also a key function when integrating Media Pocket with other systems, as all inputted custom field data is accessible via Media Pocket API.

Creating Custom Field Groups

By default, the environment does not have any custom fields. Admins can create and delete Custom Fields from the More section found in Quick Menu. Admin must first create and name the group. 

Add by default

Admins are able add Custom Field Group(s) by default to all assets by asset type/types (e.g., Image, Video, etc.). Once added, all existing assets and new assets will automatically have the created Custom Field Group(s) visible in the UI for easier data input. Admins may also update existing Custom Field Groups to be added by default. Note: Add by default do not count as null values and can therefore not be used in null search "Show only items that have values in this field group".

Allowed media types

Admins can allow custom field groups only for selected media types. For example, if you have a custom field group specifically for image assets, you can restrict its use to image assets only.

Please note, this affects only when adding new data. For example if media is removed from an asset, the field group data will still be present.

Complex fields:

Field groups can be set to be complex, which means that individual fields are linked together and form one data record. With a complex field group, a certain field can be associated to same asset several times. This enables for example adding several time periods or dates, such as airdates or usage right periods.

Hidden:

Custom field groups can be hidden from the UI. This can be used for example to hide technical integration data. Hidden groups are signified with an icon in the custom field group edit view.

Edit group order

Editing the order of the custom field groups, i.e. how they are displayed in projects/assets, is possible by rearranging the list by dragging.

Adding Custom Fields

Once the field group exists, there can be added customized fields by adding custom fields the custom field group. Each group can have several distinctive fields. Each field must have a name and a type. The type determines what kind of data the field will accept and display.

Field types are:

• Date (yyyy-mm-dd)
• Datetime (yyyy-mm-ddThh:mm:ss)
  
• Integer (whole number)
• Textbox (single row)
• Textbox (multiple rows)
• Rich text (italic, bold, underlined, list, text type)
• Boolean (true/false)
• Dropdown (the values are created and deleted from the field’s edit tool)
• Timecode: Formats HH:MM:SS:FF or HH:MM:SS.ms. Frame rates 60,50,30,25,24,20,15,10,5,3,1. - Timecode fields have a validator that checks the input to ensure that it's not possible to add a value that doesn't fit within the specified frame rate
  - Via API it's possible to get timecodes in a different format by using /api/v2/assets/:asset_id/custom_fields?modifiers=timecode_with_framerate
•  

The individual fields in a custom field group can be rearranged in the same way as the custom field groups (see above)

 

Searchable

If the field is determined to be searchable, the assets can be searched and filtered based on the data filled in the custom fields.

Read-only

Custom fields can be made read-only, which means that values cannot be edited in the Media Pocket UI. However, the fields would still be editable via the API.

Custom Field Overwrites

Overwrites allow you to overwrite the value of another custom field with the value of the selected custom field, when the source field is not empty.

When no value for the source field is present, the value of the target field will be used. Or no value at all, if the target field is empty.

Both fields must be of the same type. For example, an integer field can not be overwritten with a text field. The only exceptions are textbox and textarea fields, which can be overwritten with each other.

Only one custom field at a time can be configured to overwrite. The link icon is displayed if an active overwrite rule exists and by hovering the icon, overwrite rules are displayed.

Custom field groups that include field(s) with an active overwrite configurations will be signified with an icon.

 

Removing overwrite is done by editing the field that has the overwrite rule configured. All fields with an active rule can be distinguished by the link icon.

In Metadata View, the current overwrites are visible by hovering the overwrite (link) icon.

Using Custom Fields

Users can use custom fields to enrich their assets with needed metadata. Custom fields can be added via Metadata View. The user must first add data to at least one field for a Custom Field Group to be added to the asset/project. Assets and projects can have multiple Custom Field Groups added.

Custom Fields can be added for projects and assets. The custom fields used at a project level do not heritage to their assets.

Bulk editing custom fields

You may bulk edit custom fields of several assets at once with the bulk edit tool.

Note: If there is existing data on one or several assets, you will receive warning before saving.