How-to

Put content into a capability

A capability version is a package: on the capability page, its Contents section references what the package delivers — entities, EntityViews, applications, roles, configuration, an onboarding journey, help — and publishing locks all of it at its current revision.

For: Builder, Platform administrator

Prerequisite

  • capability.write at the platform to add and remove references; capability.publish to publish.
  • A capability draft (Capability Studio, New capability draft), and the artefacts it will carry, owned by the platform: entities from the Model (under Build), domains and applications from Domains (under Settings), roles from Roles (under People and access, Create a role), configuration values from Configuration (under Settings, Set a value at the Platform), an onboarding journey from the Journeys (under Build; its key is its arrival and cell, for example provisioned-tenant-consume), and so on. A tenant's artefact never goes into a package.

Steps

  1. Switch to the platform and open Capabilities under Build, then click the capability's name.
  2. Scroll to Contents — version N. Its latest version must be a draft.
  3. In Add to the contents, choose a Kind and then the artefact. Press Add.
  4. Read what the reference pulls in: an entity brings its fields, its ISA parents and the relations whose both ends the package carries; an EntityView brings its entity and domain; an application brings its domain and — once it has a published platform runtime — that runtime version, its workspaces, its navigation and the platform's A_EntityViews of it.
  5. Repeat for every artefact. Read the list under “What these references touch and the package does not carry” — for example a relation whose other end is not in the package — and add what is missing.
  6. Under At publish, press Publish version N.

Result

The version is published and its Dependency lock is shown: every carried artefact, chosen or pulled in, with its revision (a version number, or when it last changed) and a fingerprint. The version's contents no longer change.

Keep in mind If any reference cannot be carried — it no longer exists, belongs to a tenant, or has nothing to lock (a journey with no published version) — nothing is published, and the message names each reference and the reason.

Tip Reference data is a reference entity's records, published in the Metadata Designer, locked with a fingerprint of the records; sample data is a dataset of the version's own Sample data section, locked with a fingerprint of its rows. A platform workflow is carried at its published version with its states, transitions, guards, effects and the actions they run; an entity brings its validation rules, computed fields and record actions.