How-to

Explore the metadata model

Explorer opens over the metadata model itself: entities, fields and relation definitions become records you filter, group and walk, at the platform, an account or a tenant.

For: Platform administrator, Builder, Account administrator, Tenant administrator

Prerequisite

You need metadata.read at the scope you are in. Platform and account builders hold it; in a tenant, whoever may read the Metadata Designer holds it. Without it, Explorer says which key is missing and who can grant it.

Open it

  1. At the platform or an account, switch the console to that scope and open Records (its first lens is Explorer).
  2. In a tenant, open Records (its first lens is Explorer) and choose Metadata model after Explore: in the bar above the columns. You see the tenant's own definitions and the ones the platform and the account share with it.
  3. The bar names the world and the scope. Records after Explore: takes you back to the records.

Find what you need

  1. Open the columns you need with Add column: Entities, Fields, RelationDefinitions, RelationTypes, DataTypes.
  2. Use Filter by, Sort by and Group by in the column menu, for example group Fields by Data type, or Entities by Owner.
  3. Select a record to follow the model's links: an entity's fields (has field), its parent (is a), the relation definitions that start or end at it (source, target), a field's data type (typed as).
  4. Select one record and press Open record to read all of its values.

Good to know

  • The metadata world is read here and edited in the Metadata Designer. Explorer offers no Add record, Edit, Delete or Add relation in it and says so where they would be.
  • Each definition shows its owner: the Platform, the Account or the Tenant. What you see is what your scope can see through its owners, never another account's or tenant's definitions.
  • In a tenant, a field of a domain the tenant has closed is not listed, just as it is not shown with the records.
  • All of the model's links are read with the columns, so highlights and paths cover the whole model.