Screen guide

Workflow & EntityView Designer

The screen where you design and publish EntityViews, Workflows and A_EntityViews — for the active Tenant, or at the platform the platform's own, which every tenant reads and a package carries.

For: Builder, Tenant administrator

Lenses and tabs

The three designers are one Model tool: its bar's lenses are Entities (the Metadata Designer), Views, Workflows, Actions and Runtimes. Views holds the EntityView and A_EntityView tabs below; Workflows is its own lens. An entity chosen in Entities is carried: the source row says it (Entity: …), every lens narrows to it — its views, its workflows, its actions, the runtimes with a workspace that opens on it — and its × shows every entity in that lens. In a tenant, Your changes (N) beside it opens everything the tenant changed over what is defined above it, in one list.

TabWhat you do
EntityViewCreate a view for a Domain and an Entity; bind an existing Field or create and bind a new Domain-specific Field; choose whether parent Entities (ISA) and Relations are shown in the view; change its status.
WorkflowDefine a Workflow for an Entity, add its States and Transitions — each with the permission it needs, the fields it requires, its guards and its effects — and publish the version. In a tenant on its own entities or a platform entity it reads; at the platform on a platform entity.
A_EntityViewDerive an Application-specific view from an EntityView (the tenant's own or a platform view it reads); inherit Fields from the parent view or add Fields specific to that Application; change its status.

Where a view reaches

Under each view's code, Where it reaches opens the view on the right of the Model tool: its entity and domain, the version in force with its status, and who owns it. Fields it shows lists the fields its version binds, in order, a hidden one marked so; Open on a field goes to the Entities lens on that field, which says where the field itself reaches. Where it reaches lists the applications that narrow the view (opening the A_EntityView tab), in a tenant its own layer over the view and how many fields it changes, and the workflows and actions on its entity, which run on the records the view shows — each opening its lens with the entity kept. When none of these exist it says so. A view has no sections of its own: its fields carry their order.

Where a transition reaches

In the Workflows lens, under each transition, Where it reaches opens it on the right: its workflow and version, its entity, the states it moves between and the permission it needs. Rules says the relations it requires, its guards and its effects in words. Where it reaches lists the fields it requires, tests in a condition or sets in an effect — Open goes to the Entities lens on that field — and the actions its effects run, each opening the Actions lens with that action beside it. A transition that reads no field and runs no action only moves the record, and it says so. A tenant's own steps are listed under Your steps and are not opened here.

The parts of this screen

The designer
  • Publishing a WorkflowFrom a draft to a published workflow: states, transitions, effects and the checks before publishing.
  • The statuses of a viewActive, deprecated, migration-only and retired: what each means and what can follow it.
Rules and ownership
At the platform