Adding a key - Developer Documentation
Skip to content

Adding a key

The user can add keys in global and custom collections. To add a new key, follow these steps:

  1. In the left navigation, click "Metadata Management". The Metadata collection overview page is displayed.
  2. In the Metadata collection overview page, choose the collection of your choice, click "Add Key".
  3. In the "General" section,

    • Enter the "Label" and "Description".
    • By default, "Key" field is automatically filled with the same name as "Label". Label name should be unique, the same label name cannot be re-used.
    • Enable "Mandatory" toggle button to define a key as "Required Field" in metadata input.

    Key General details

  4. In the "Data type for value" section, select the "Data type" and enter the values. For more information on data types, refer to Data type values.
    For example, to select "Enum values", follow these steps:

    • Select "Enum values" from the "Data type" dropdown.
    • Click "Add values".

    Key Data types

  5. In the Additional details,

    • Enable "Rules" toggle button to include this key and its values in the "Rules" section while creating a custom collection.

    Note

    This toggle button is available only while creating a key for global collection, and can be enabled only for Enum values data type.

    • Enable "Searchable" toggle button to perform search with authorized set of keys.
    • Select "Objects", "Folders" or "Objects and Folders" radio button to apply on defined keys.

    Key Additional details

    Note

    • Objects: Metadata is applied on objects.
    • Folders: Metadata is applied on folders.
    • Objects and Folders: Metadata is applied on both objects and folders. This radio button is available for only global collection.
  6. Click "Save and Publish" to publish the key or click "Save as Draft" to save the key as draft.

Note

  • When a key is in draft status, the defined "Data type" cannot be modified.
  • When a key is in published status, the defined "Data type" and their "Values" cannot be modified.

Last update: January 22, 2024