Skip to content

How to Configure Table Keys

TL;DR
In Settings → Table Keys, define the named join keys that let Data Tables relate to one another. A table key is referenced by Platform Entities to establish the grain at which data is joined.

Admin guide

This page is for administrators with write access to Table Keys.

What is it?

A table key is a named join key shared across Data Tables. It is the building block that lets the platform relate tables to one another and that Platform Entities reference to define a data grain.

  • Managed in Settings → Table Keys.
  • A key is intentionally minimal: a name and a description.
  • The list tracks a Usage Count so you can see how many entities depend on each key before changing it.

Before you start

  • You need write access to Table Keys in Settings.
  • Know the join concept you're naming (for example, an application identifier or a member identifier) before creating the key.

How to Configure a Table Key

Step 1: Open the Table Keys list

Go to Settings → Table Keys. The list shows each key's Name, Description, Usage Count, and audit columns (created/modified by and date).

Click + New Table Key.

Step 2: Fill in the form

Field What to enter
NameRequired A valid variable name (letters, numbers, underscores) that identifies the key, for example application_id or member_id.
DescriptionRequired What the key represents and which columns it maps to across tables.

Click Save.

Note

A key in use cannot be freely renamed or removed. Check the Usage Count first; it reflects how many Platform Entities reference the key.

What's next