Skip to content

How to Configure Platform Entities

TL;DR
In Settings → Platform Entities, define the data grains the platform works at (for example, application and customer), each backed by a table key and placed at a hierarchy level. Registered objects are then anchored to one of these entities.

Admin guide

This page is for administrators with write access to Platform Entities. Set up Table Keys first.

What is it?

A platform entity defines a grain of data, such as one row per application or one row per customer. It ties that grain to a table key and places it in a hierarchy so the platform knows how grains relate (for example, many applications under one customer).

  • Managed in Settings → Platform Entities.
  • Each entity is backed by a table key and sits at a numeric hierarchy level.
  • Registered objects reference an entity to declare the grain they operate at.

Before you start

  • You need write access to Platform Entities in Settings.
  • The table key the entity will use must already exist.
  • Decide the hierarchy ordering across your entities before creating them (lower numbers are higher in the hierarchy).

How to Configure a Platform Entity

Step 1: Open the Platform Entities list

Go to Settings → Platform Entities. The list shows Name, Alias, Table Key, Hierarchy Level, Description, and audit columns. Click + New Platform Entity.

Step 2: Fill in the form

Field What to enter
NameRequired A human-readable name, for example Application or Customer.
AliasRequired A valid variable name used to reference the entity programmatically.
Table KeyRequired The table key that identifies a row at this grain.
Hierarchy LevelRequired A number ordering this entity in the hierarchy. Use it to express that one grain rolls up into another.
DescriptionRequired What this grain represents.

Click Save.

Note

Once an entity is in use by registered objects, some fields become read-only to protect the objects anchored to it.

What's next