Screen guide

Capabilities

The screen where you turn on and install the published capabilities your tenant can see. This is the last step on the way a capability defined and published in the studios reaches the tenant.

For: Tenant administrator

What's on this screen

Every published capability your active tenant can see is listed with its name, version and canonical address: those published by the platform, those published by your Account, and the tenant's own capabilities. A capability published by another Account doesn't appear here, and neither do drafts. If an install is running or has failed, an Install steps section opens below. On the left, the same capabilities with their install state (Not installed, Installing, Install failed, Installed); choose one to see it alone on the right, or leave the choice empty to see them all.

Turning on and installing a capability

  1. Press Activate on the capability's row. The request is saved and the row shows "Requested, not installed".
  2. Press Install on the same row. An install plan is created, an install run is started and the steps run right away; when the screen comes back, the row shows "Installed" or "Install failed".
  3. Read the steps in the Install steps section: validate-config (is the version still published and visible to this tenant), resolve-dependency (is the solution lock in place, and are the required dependencies installed in this tenant), prepare-runtime and apply-binding ("skipped" with a reason, because no capability declares a runtime or binding today), publish-capability (writes the switch marker that makes the capability active in this tenant), verify-activation (reads the marker and the lock again and verifies them).

States

On the rowWhat it meansWhat you can do
Activate buttonNot requested yet.Request it
Requested, not installedThere is a request, but no install has been started.Install
InstallingA run stopped halfway (for example, the process running it was interrupted). The daily scheduled job resumes such a run from where it stopped.Wait; a second run can't be started
Install failedThe last run failed, was rolled back or was cancelled.Read the steps and Install again
InstalledThe last run finished successfully: the capability has an active switch marker and a passed verification in this tenant.—

In a failed install, the step that failed shows in red with its own error code and reason (for example REQUIRED_DEPENDENCY_NOT_ACTIVE: a required dependency isn't installed in this tenant); the steps after it stay grey with a "did not run because a step failed" note. The red step is the one to fix. Each skipped step shows why it was skipped.

Watch out

Keep in mind Requesting and installing need scope.write in the tenant scope; seeing the list needs capability.read. If the install is rejected with NO_DEPENDENCY_SET, the party that published the capability hasn't declared that version's dependencies. This is fixed with Declare no dependencies in the studio of the capability's owner: Capability Studio for platform capabilities, Account Studio for Account capabilities. Install starts the run and runs it to the end; it then shows "Installed (run N)" or "Install failed (run N): step … — CODE". N is the run's number. After fixing the cause of a failed install, you can try again with Install; the new run gets a new number and the steps show only the latest run.