Skip to main content

Managing Terms

This guide covers creating, editing, and linking business terms to data products and fields.

Creating a Term​

  1. Navigate to the Glossary section in your space
  2. Click New Term
  3. Fill in the required fields:
    • Name — Human-readable term name (e.g., "Annual Recurring Revenue")
    • Slug — URL-friendly identifier (e.g., annual-recurring-revenue)
    • Definition — Rich-text explanation of what this term means
  4. Optionally set:
    • Category — Group the term (e.g., "Finance", "Marketing", "Operations")
    • Status — Draft (default), Approved, or Deprecated
    • Synonyms — Alternative names (e.g., "ARR")
  5. Click Save

Editing a Term​

Open any term from the glossary list to view its detail page. Click Edit to modify the name, definition, category, status, or synonyms. Only the fields you change will be updated.

Deleting a Term​

Delete a term from its detail page. This permanently removes the term and all its product and field links. Consider setting the status to Deprecated instead if you want to preserve the definition for historical reference.

Linking Products​

Linking a term to a data product creates a semantic connection. The term appears on the product's detail page, and the product appears on the term's detail page.

  1. Open the term detail page
  2. In the Linked Products section, click Link Product
  3. Select the product from the picker
  4. The link is created immediately

To remove a link, click the Unlink button next to the product.

Linking Fields​

Field links provide column-level semantic context. When a term is linked to a field, the business definition appears inline on the product's schema tab.

  1. Open the term detail page
  2. In the Linked Fields section, click Link Field
  3. Select the field from the picker (fields are grouped by product)
  4. The link is created immediately

To remove a link, click the Unlink button next to the field.

Status Workflow​

Terms follow a simple lifecycle:

Draft → Approved → Deprecated
  • Draft — Use this while the definition is being refined. Draft terms are visible but clearly marked as unofficial.
  • Approved — Set this once the definition has been reviewed and accepted. Approved terms are the authoritative source.
  • Deprecated — Use this when a term is no longer relevant. Deprecated terms remain searchable but are visually de-emphasized.

Tips​

  • Be specific — Write definitions that distinguish this term from similar concepts. Include what it excludes as well as what it includes.
  • Use categories — Categories make browsing manageable in large glossaries. Align categories with your organizational domains.
  • Link liberally — The more terms are linked to products and fields, the easier it is for analysts to discover data by business concept.
  • Review regularly — Periodically audit Draft terms and promote them to Approved, or flag outdated terms as Deprecated.