How-to

Publish reference data from the platform

Reference data is the lists others point at — countries, industries, course levels. It is published once, at the platform, on a reference entity's page in the Metadata Designer; every tenant reads it, and no tenant can change it.

For: Builder, Platform administrator

Prerequisite

  • metadata.write at the platform.
  • A platform entity whose role is Reference (set under Settings), with the fields each record holds — for example Code and Label.

Steps

  1. Switch the console to the platform, open Metadata Designer and select the reference entity.
  2. Under Reference records, in Add a reference record, give a Key — stable: what a course's level or a client's industry points at, for example intermediate — and a value per field. Press Publish record.
  3. For a longer list, under Publish many from a sheet, choose a CSV file or an Excel workbook (.xlsx) with a key column and one column per field (by key or name), and press Publish from the sheet. A key the entity already has changes that record; a new key adds one.
  4. To correct a record, press Change on its row, edit the values and press Save record; Remove takes it out.
  5. To ship the list with a package, open the capability page and add the entity under Reference data in Add to the contents.

Result

Every tenant that reads the entity reads the records: on the entity's page in its Metadata Designer and in its column in Explorer, read only, with the reason said. A package that carries the reference data locks the records as they are at publish, with a fingerprint of the rows; a later change reaches a package in its next version.

Keep in mind A record's values must be the entity's fields, readable as their data types, with the required ones set and the entity's rules met; a sheet with one row that does not pass publishes nothing and lists every reason. Someone else's change since you opened a record is not overwritten: reload it and change it again.

Tip A tenant cannot add a record to a reference entity, or change one, anywhere: reference data is changed only here, at the platform.