How-to

Design an application at the platform

An application a package delivers is more than its catalogue row: at the platform you give it a runtime — workspaces, navigation and a default workspace — and A_EntityViews, publish the runtime, and a capability version that carries the application carries all of it.

For: Builder, Platform administrator

Prerequisite

  • application.write at the platform to author runtimes, and application.publish to publish them; metadata.write at the platform for A_EntityViews.
  • An application the platform owns (Domains, under Settings, in a platform domain), the platform entities its workspaces open with (Metadata Designer), and, for an A_EntityView, a platform EntityView (Workflow & EntityView Designer).

Steps

  1. Switch to the platform and open Model under Build.
  2. Under Create a platform runtime, choose the application and press Create runtime.
  3. Press Open. Add a workspace for each area of the application: a key, a name, Explorer, the entities it opens with, and whether people can add a column and see relations.
  4. Choose the Default workspace and press Make default.
  5. Add the navigation items in the order they should read — a group item has no workspace, a child item goes under another — and use Move up / Move down until How the navigation reads is right.
  6. Press Publish version 1. If something is missing, the reasons are listed and nothing is published.
  7. For an A_EntityView, open Workflow & EntityView Designer, go to the A_EntityView tab, choose the platform EntityView and the application, and create it; bind or narrow its fields there.
  8. Open the capability under Capabilities, add the application to its Contents, and publish the capability version.

Result

The capability's Dependency lock lists the application with its runtime version (for example training_and_advisory@v1), every workspace and navigation item of that version, and its A_EntityViews, each pulled in by the application and locked at its revision.

Keep in mind An application whose platform runtime has no published version is carried as its catalogue row only, and the contents say so. Only Explorer workspaces run today; a version with another workspace type is refused at publish.

Tip To change a published runtime, press New draft version: the draft starts as a copy of the published version — its workspaces, navigation and default workspace — and the published version keeps running — and stays in any package already locked — until the draft is published.