Metadata

Metadata contains detailed information about the entire research project, including the title, research field, description, project authors, tags, and functionality status. Metadata is necessary to publish a capsule and enables quicker search results by using a keyword search when you publish the capsule internally. All the information is indexed for searching on the Code Ocean Explore page.

The metadata folder has the path of /metadata in a capsule, which is invisible in a reproducible run, but accessible in any Cloud Workstation.

Metadata Editor

Click the metadata folder to open the metadata editor.

Enter the information in the text fields provided:

• Name: This is the title of the capsule. Use a name that's easy to search and understand for both you and others in the future. Conform to your company’s internal project naming conventions.

• Research field: Enter the relevant research field.

• Description: Describe what the capsule is about to help yourself or your colleagues understand it in the future.

• Authors: Enter the names of the people who created the capsule.

• Tags: Enter keywords that people might search on to help them find the capsule in the future.

Functionality Status

Functionality Status appears on the metadata page only if the Capsule has the App Panel in use.

If Functionality Status does not appear on the Metadata screen, select the App Panel tab in the left toolbar. Use this field to determine whether to lock the Released Capsule to App Panel. Select the functionality that will be available in the published capsule:

• All functionality available - all the Capsule's functionalities are available to users, including seeing the Files panel and executing a Reproducible run.

• Run-only functionality available - other users can see only the App Panel and run the Capsule with parameters.

The metadata.yml File

Most of the information you enter in the metadata editor is stored in the metadata.yml file. You open and edit it directly as a text file.

Show Capsule ID for Released Capsules under Metadata

This feature allows users to find the ID of a release capsule which is required for certain APIs, for example, the run capsule API.

Custom Metadata

Custom Metadata for data improves the search, management, and organization of Code Ocean Data Assets. Metadata is managed at the deployment level by Admins, and have the following properties:

• Key Name

• Value Type

• Input Type

• Value

• Units

• Required

• Active

Metadata is added by users and can be edited 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.