Set up Custom Metadata

Custom Metadata is configured by Administrators at the deployment level to improve the search, management, and organization of Code Ocean Data Assets.

It has the following properties: Key Name, Value Type, Input Type, Value, Units, Required, and Active. After the Custom Metadata is created, users add metadata and can edit it as experiments progress.

Note: Once created, Metadata Keys cannot be edited or deleted, only deactivated, due to system-wide implications. Ensure Metadata Keys are carefully created to avoid errors.

Properties of the Custom Metadata Key

Key Name (required)

• The name of the Key

Value Type (required)

• The available value types are "Number", "String", or "Date". "Number" and "Date" optionally allow you to set bounds.

Input Type (required)

• The available input types are "List", "Text box", or "String". The corresponding file will appear for the List to add items to the list.

Units (optional)

• Set pre-defined units for the metadata Values.

Required (boolean)

• When the checkbox is checked, a user will need to provide a Value to create a new Data.

Active(boolean)

• Active metadata keys will be visible to users when creating and searching for Data in Code Ocean.

Adding new Custom Metadata Key

1. Click "Add" in the top right corner

1. Complete the form

1. Click "Add Key" to submit the form and create the Custom Metadata.

Modify the Custom Metadata Key

1. Hover over the Key and click on the gear icon

1. Modify the pop-up form

2. Click "Edit Key" to save the changes