A slug is a unique identifier for an entity on the Tetra Data Platform (TDP), such as an artifact or an organization. You can use an entity's slug to reference that entity elsewhere. For example, you can reference an Intermediate Data Schema (IDS) by its slug when defining a namespace or in a protocol.

Slug Examples

Slug Type	Description	Examples	Identifier Usage	Pointer Usage
Organization (Orgslug)	Organizations have a slug called an orgslug. An organizational slug is required for some tasks, such as running an API call or creating a self-service pipeline or app. You can locate your organizational slug on the Organizational Details page.	`your-company`, `tetrascience-dev`	In TDP account setup, the slug is the org's identity.	In namespaces (for example, `private-orgslug`), the slug points to the referenced org.
IDS	Different types of Intermediate Data Schemas (IDSs) are also identified by slugs. For example, `lcuv-empower` and `akta` are two slugs that are related to instrument vendors. You can locate these IDS-type slugs on the IDS page.	`lcuv-empower`, `akta`, `chromeleon`	In IDS artifacts, the slug is the IDS's identity.	In pipelines and SQL queries, the slug points to the target IDS type.
Pipeline Protocol	These slugs serve as unique identifiers for some of the different components in a protocol (such as a step name). For a detailed description of these slugs, and how to use them if you are creating a pipeline yourself, see Protocol YAML Files.	`thermo-fisher-RAW-to-IDS`, `raw-to-ids`	In `protocol.yml` files, the slug is the protocol's identity.	In pipeline configurations, the slug points to the protocol.
Task Script	Task script slugs identify scripts that contain the business logic executed by pipeline steps.	`empower-raw-to-ids`, `push-to-eln`	In task script `manifest.json` files, the slug is the script's identity.	In protocol `steps[].task.slug` steps, the slug points to the referenced script.
Function	Function slugs identify individual functions within a task script that can be invoked by protocol steps.	`process_file`, `main`, `push-it`	In `config.json` functions arrays, the slug is the function's identity.	In protocol `steps[].task.function` steps, the slug points to the referenced function.
Tetraflow Pipeline	Tetraflow pipeline slugs identify SQL-based data transformation pipelines that generate custom Lakehouse tables.	`analytics-transform`, `ids-to-delta`	In `tetraflow.yml` files, the slug is the Tetraflow pipeline's identity.	In Tetraflow pipeline configurations, the slug points to the pipeline.

Documentation Feedback

Do you have questions about our documentation or suggestions for how we can improve it? Start a discussion in TetraConnect Hub. For access, see Access the TetraConnect Hub.

📘
NOTE
Feedback isn't part of the official TetraScience product documentation. TetraScience doesn't warrant or make any guarantees about the feedback provided, including its accuracy, relevance, or reliability. All feedback is subject to the terms set forth in the TetraConnect Hub Community Guidelines.