TetraScience

Tetra Data Platform Documentation

Welcome to TetraScience Tetra Data Platform (TDP) documentation site. Here, you'll find Product Documentation, API Documentation, and Release Notes for TDP components.

Release Notes    API Documentation

Applying Metadata, Tags, and Labels to Files

Metadata, Tags, and Labels can be used to annotate your files, trigger pipelines and more without changing the actual data in your files. Metadata, Tags, and Labels can also be used to trigger pipelines and are able to be searched. You can add metadata, tags, and labels in multiple places in the product. For example, you can add, edit, and delete metadata entries, tags, and labels when you:

  • View search results
  • Add files from an agent (you can add metadata, but not labels)
  • View pipeline processing details for a file
  • Add or edit a connector

For a basic overview of metadata, tags, and labels, see this topic.

To learn how you can manage metadata, tags, and labels for your organization, see this topic.

Adding, Editing, and Deleting File Metadata

The steps for adding, editing, and deleting metadata are the same, because they are all done using the same widget, which is shown below. (This widget appears in several different pages in the software.)

Metadata, Tags, and Labels WidgetMetadata, Tags, and Labels Widget

Metadata, Tags, and Labels Widget

To see the characters you can use for metadata field names and values, see this topic.

Adding File Metadata

To add file metadata, complete the following steps.

  1. In the page or popup window that has the option to add the metadata, click Advanced Fields to see more of the page.
Metadata and TagsMetadata and Tags

Metadata and Tags

  1. Click the Add Metadata link.
  2. To add metadata, do one of the following.
    • To add a new metadata field, type the field name in the text box. "Create" appears in front of what you just typed. Click the text that says "Create: [your new field]" to create the new metadata field.
Create a new metadata fieldCreate a new metadata field

Create a new metadata field

  * If you want to *use a field that already exists* click the down arrow in the field name and select the metadata field name from the list that appears.
Select from the metadata listSelect from the metadata list

Select from the metadata list

  1. Enter a value in the value text field, then press enter. If you want to add new metadata entries, repeat these steps.

Editing File Metadata

To edit file metadata, in the Advanced Fields section of the page, change the metadata field name and/or the value, then press return.

Deleting File Metadata

To delete file metadata, in the Advanced Fields section of the page, click the delete button for the metadata you want to delete.

Supported Characters for Metadata Names and Values

Metadata field names (keys) can consist of the following characters:

  • ^[0-9a-zA-Z-_+ ]+$

Metadata values can be any combination of the following:

  • All alphanumeric characters
  • spaces
  • plus sign
  • dash
  • period
  • underscore
  • comma
  • forward slash

Adding and Deleting File Tags

The steps for adding and deleting file tags are the same, because they are all done using the same widget, which is shown below. (This widget appears in several different pages in the software.)

Metadata, Tags, and Labels WidgetMetadata, Tags, and Labels Widget

Metadata, Tags, and Labels Widget

To see the characters you can use for tag values, see this topic.

Adding File Tags

To add file tags, complete the following steps.

  1. In the page or popup window that has the option to add tags, click Advanced Fields to see more of the page.
Metadata and TagsMetadata and Tags

Metadata and Tags

  1. Click Add Tag.
Add TagAdd Tag

Add Tag

  1. Type the name of the tag, then press enter. Repeat these steps to add other tags.
Several Tags AddedSeveral Tags Added

Several Tags Added

Editing File Tags

You cannot edit a file tag. Attach a different tag, you'll need to delete it, then add a new one.

Deleting File Tags

To delete file tag, in the Advanced Fields section of the page, click the delete button for the tag you want to delete.

Supported Characters for Tags

Tags can consist of the following characters:

  • All alphanumeric characters
  • spaces
  • plus sign
  • dash
  • period
  • underscore
  • forward slash

Adding, Editing, and Deleting File Labels

The steps for adding, editing, and deleting labels are the same, because they are all done using the same widget, which is shown below. (This widget appears in several different pages in the software.)

Metadata, Tags, and Labels WidgetMetadata, Tags, and Labels Widget

Metadata, Tags, and Labels Widget

To see the characters you can use for label field names and values, see this topic.

Adding File Labels

To add file labels, complete the following steps.

  1. In the page or popup window that has the option to add a label, click the Add New Label option.
Metadata and TagsMetadata and Tags

Metadata and Tags

  1. Click the Add New Label link.
  2. To add a label, do one of the following.
    • To add a new label field, type the field name in the text box. "Create" appears in front of what you just typed. Click the text that says "Create: [your new field]" to create the new label field.
Create a new metadata fieldCreate a new metadata field

Create a new metadata field

  * If you want to *use a field that already exists* click the down arrow in the field name and select the label field name from the list that appears.
Select from the metadata listSelect from the metadata list

Select from the metadata list

  1. Enter a value in the value text field, then press enter. If you want to add new labels, repeat these steps.

Editing File Labels

To edit file labels, in the Advanced Fields section of the page, change the labels field name and/or the value, then press return.

Deleting File Labels

To delete file labels, in the Advanced Fields section of the page, click the delete button for the label you want to delete.

Supported Characters for Label Names and Values

Label names can consist of the following characters:

  • ^[0-9a-zA-Z-_+. ]+$

Label values can be any combination of the following:

  • All alphanumeric characters
  • spaces
  • plus sign
  • dash
  • period
  • underscore
  • comma
  • forward slash

Updated 5 months ago


Applying Metadata, Tags, and Labels to Files


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.