connect
search

Creating a Metadata Field

To create and define a metadata field for an entity, perform the following steps:

  1. Open the Metadata Settings, Title sub-menu.

  2. Select the Classification tab and click Add new entity type. The Create new entity type page is displayed.

    The Create New Entity Type page

  3. Enter a suggestive name.

  4. Enter a short description for your entity.

  5. Select the Parent Type from the available options displayed in the drop-down. Note that the displayed options are the existing entities.

  6. Optional: Enable the Abstract toggle if you do not want your entity to be used in a hierarchy or assigned to a title.

  7. Click Save. The entity is created and displayed on the Classification tab.

  8. Open the previously created entity and click Create New Field. The Add new field window is displayed.

    The Add new field window

  9. Enter a unique identifier in the Name field.

  10. Select the Type of metadata field you want to create. Depending on your choice, different options are displayed. Note that the Order and Group options are common for every field type.

    1. When setting the Type field to Number, the following fields are displayed:

      1. Order, which allows you to select the order in which you want your field displayed.
      2. Group, which allows you to assign your field to a specific group.
      3. Min Value, which is the minimum field value supported.
      4. Max Value, which is the maximum field value supported.
      5. Required. When enabling this toggle, the field must be filled in the metadata set when the entity is used on a title.
      6. Localizable. When enabling this toggle, the field can be filled with information in each language supported.
      7. Searchable. When enabling this toggle, users will be able to search for the data in this field. Note that an additional toggle is displayed, Search Boost.
    2. When setting the Type field to String, the following fields are displayed:

      1. Order
      2. Group
      3. Min Length, which is the minimum length of supported characters.
      4. Max Length, which is the maximum length of supported characters.
      5. Regex, which is the regular expression that limits the format of the plain text in the field.
      6. Default Value, which specifies the default value of the field.
      7. Display name. When enabling this toggle, the field value is displayed instead of the file name.
      8. Required
      9. Localizable
      10. Multiline. When enabling this toggle, the text can be entered on multiple lines.
      11. Searchable
    3. When setting the Type field to Date, the following fields are displayed:

      1. Order
      2. Group
      3. Format, which sets the date format accepted for the field: MM/DD/YY, YYYY-MM-DD or M/D/YYYY.
      4. Required
      5. Localizable
      6. Searchable
    4. When setting the Type field to Boolean, the following fields are displayed:

      1. Order
      2. Group
      3. Localizable
      4. Searchable
    5. When setting the Type field to Array, the following fields are displayed:

      1. Order
      2. Group
      3. Min Length
      4. Max Length
      5. Regex
      6. Required
      7. Localizable
      8. Searchable
    6. When setting the Type field to File, the following fields are displayed:

      1. Order
      2. Group
      3. Media Type, which can be set to: image_media, video_media, caption_media or text_media.
      4. Aspect Ratio, which is the is the ratio of the media type’s width to its height. 
      5. Transcode Map
      6. Required
      7. Localizable
    7. When setting the Type field to Tag, the following fields are displayed:

      1. Order
      2. Group
      3. Reference Type, which is the tag type for a file. When creating a tag and selecting its type, you define on which file types it can be used.
      4. Required
      5. Localizable
    8. When setting the Type field to UIComponent, the following fields are displayed:

      1. Order
      2. Group
      3. Ui Component Type, which can be used only within task management, when creating a new task. The field can be set to: annotation, cplEditor, Metadata or preview.
      4. Required
      5. Localizable
    9. You can also select an entity type from the drop-down. Note that when creating the new field, you must go to the Titles menu, set the Title on the Metadata Set tab and reference it.

  11. Click Create Field. The field is created and displayed in the Fields section of the entity type details.

Important

Once the field is set and populated you cannot switch the field type. Request support from Ateliere if you want to change the field type.

To understand how to map your descriptive metadata to an XML, CSV or XLSX output, see Configuring Metadata Templates.

Creating a Title HierarchyImporting and Exporting Entities