Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt

Use this file to discover all available pages before exploring further.

As your workspace grows, finding the right Run, Asset, or Rule across hundreds of resources becomes harder. Metadata lets you define structured key-value pairs once at the organization level and apply them consistently across all your resources, so your entire team can filter and search using the same taxonomy.

​
Before you begin

​
How Metadata works

A Metadata key is a structured label defined once at the organization level and applied to any supported resource in Sift, such as a Run, Asset, Rule, or Calculated Channel. Each key has a fixed data type (String, Number, or Boolean) that cannot be changed after creation, ensuring values remain consistent across the workspace. For example, you could define a key called test_phase of type String and apply it to Runs with values like EVT (Engineering Validation Test), DVT (Design Validation Test), or PVT (Production Validation Test). Any engineer on your team can then filter Runs by test_phase to find exactly the data they need.

​
Create a Metadata key

Metadata keys are created in the Manage workspace and are available across the entire organization once created.
  1. Click your profile icon.
  2. Select Manage.
  3. In the Manage navigation menu, click Metadata.
  4. Click Create Metadata Key.
  5. In the Name box, enter a name for the Metadata key.
  6. In the Type list, select a data type for the Metadata key.
  7. Click Create.

​
Add values to a Metadata key

For String and Number keys, you can predefine a set of values that will appear as selectable options when the key is applied to a resource. This option is not available for Boolean keys, since their values are limited to true and false.
  1. Click your profile icon.
  2. Select Manage.
  3. In the Manage navigation menu, click Metadata.
  4. In the Metadata table, locate the Metadata key you want to add values to.
  5. Click Options.
  6. Select View values.
  7. In the Enter [data type] value box, enter a value.
  8. Click Add value.

​
Apply Metadata to a resource

Once a Metadata key exists, you can apply it to any supported resource. The steps vary slightly depending on the resource type.

​
Runs

  1. In Sift’s homepage, click the Run you want to add Metadata to.
  2. Click Edit.
  3. Click Add Metadata.
  4. In the Select or create key list, select a Metadata key.
  5. In the Enter or select value list, select a value.
  6. Click Save changes.

​
Assets

  1. In Sift’s homepage, click the Assets tab.
  2. Click the Asset you want to add Metadata to.
  3. Click Edit Metadata.
  4. Click + Add Metadata.
  5. In the Select or create key list, select a Metadata key.
  6. In the Enter or select value list, select a value.
  7. Click Save changes.

​
Rules and User-Defined Functions

Rules and User-Defined Functions follow the same pattern and both require publishing after saving.
  1. In Sift’s homepage, click the Rules or User-Defined Functions tab.
  2. Click the resource you want to add Metadata to.
  3. Click Edit.
  4. Click Add Metadata.
  5. In the Select or create key list, select a Metadata key.
  6. In the Enter or select value list, select a value.
  7. Click Save.
  8. Click Publish.

​
Reports

  1. In Sift’s homepage, click the Reports tab.
  2. Click the Report you want to add Metadata to.
  3. Click Edit Metadata.
  4. Click Add Metadata.
  5. In the Select or create key list, select a Metadata key.
  6. In the Enter or select value list, select a value.
  7. Click Save.

​
Report Templates

  1. In Sift’s homepage, click the Report Templates tab.
  2. Click the Report Template you want to add Metadata to.
  3. Click Edit.
  4. Click Add Metadata.
  5. In the Select or create key list, select a Metadata key.
  6. In the Enter or select value list, select a value.
  7. Click Save changes.
  8. Click Save.

​
Campaigns

  1. In Sift’s homepage, click the Campaigns tab.
  2. Click the Campaign you want to add Metadata to.
  3. Click Add Metadata.
  4. In the Select or create key list, select a Metadata key.
  5. In the Enter or select value list, select a value.
  6. Click Save.

​
Calculated Channels

  1. In Sift’s homepage, click the Calculated Channels tab.
  2. Click the Calculated Channel you want to add Metadata to.
  3. Click Edit.
  4. Click Add Metadata.
  5. In the Select or create key list, select a Metadata key.
  6. In the Enter or select value list, select a value.
  7. Click Save.
  8. Click Save changes.

​
Filter resources by Metadata

Once Metadata is applied to resources, use it to filter and find specific resources across your workspace.
  1. In Sift’s homepage, click the tab for the resource type you want to filter (for example, Runs or Assets).
  2. Click Metadata.
  3. In the Select key list, select a Metadata key.
  4. In the Enter or select value box, enter or select a value.
  5. Optional: Click + Add to add additional Metadata filters.

​
Reference