Metadata field naming conventions in Curator

Updated on July 2nd, 2023

A Curator system uses different kinds of metadata fields to hold data about the assets being managed by the Curator system. The two principal kinds of metadata fields are referred to as Static metadata fields and Extended metadata fields.

Static metadata fields

Static metadata fields are defined by IPV in the database tables used to hold those Curator assets managed by the Curator system. Only IPV can change and create static metadata fields as these are integral to the operation of a Curator system.

Extended metadata fields

There are two kinds of Extended metadata fields:

  • Those defined by IPV and used by the core workflows provided by IPV as part of a Curator system
  • Those created specifically to meet the needs of a customer's Curator system

Curator system default metadata fields

Curator system default metadata fields are defined and managed by IPV. These metadata fields should be considered uneditable, like Static metadata fields.

The metadata model spreadsheet that defines the Extended metadata fields required by a Curator system can be found here.

Customer-specific metadata fields

Customer-specific metadata fields are the only metadata fields that a customer can control within a Curator system. There is no limit to the number of metadata fields that a customer can define for their Curator system.

Naming convention for metadata fields

A Curator metadata field has two names; the actual name of the metadata field, plus the name that is displayed to the user via the Curator application's user interface. In all database transactions, it is the actual name of the metadata field that is used.

Actual names of metadata fields

When naming an extended metadata field for use within Curator, ensure that the following rules are applied:

  • Use only alphanumeric characters (i.e. a to z, 0 to 9) and the _ character
  • Always start a metadata field with a letter
  • Use capital letters at the start of each word in a metadata field; e.g. AspectRatio, HiResPath, ProxyExists, etc.
  • Avoid using the _ character when defining metadata fields that are required as part of the core workflows used within a Curator system.
  • For customer-specific metadata fields, use the _ character to separate parts of the name; e.g. Show_Name (this helps to distinguish between Curator system metadata fields and customer metadata fields)

Display names of metadata fields

The name displayed in the Curator application's user interface can be made up of any normal character that can be typed via a standard computer keyboard.

Was this article helpful?