Basic Concepts: Slugs

A slug is a unique identifier. The term is also used to denote a reference to a unique identifier (pointer). In the Tetra Data Platform, any concept which needs to be uniquely referenced is assigned a slug. For example, the following concepts all have slugs:

  • Organizations: Organizations have a slug that is sometimes referred to as an orgslug. An organizational slug is required for some tasks, such as running an API or creating a self-service pipeline. You can find your organizational slug in the Organizational Details page.

  • IDS: Different types of Intermediate Data Schemas are also identified by slugs. For example, lcuv-empower and akta are two slugs that are related to vendors of instruments. You can find those slugs in the View IDS Types page.

  • Pipeline Protocols: These slugs serve as unique identifiers for some of the different components in a protocol, like a step name. A detailed description of these slugs and how they are used if you are creating a pipeline yourself are in the Slugs and Self-Serve Pipelines topic.

There are other slugs in the TDP than those listed here. Understanding the basic concept of a slug is helpful as you use the software.

Did this page help you?