surfaceCompositionWorkActionParams

This reference describes the full structure of surfaceCompositionWorkActionParams. Paths include nested objects, list items and conditional branches. A branch selected by kind, contract or mode only admits its own properties.

Structure and values

Field	Options / expected values	Description
experienceKey	string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
sectionKey	string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
bindingKey	string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
scope	"rootWork" | "selectedStage" | "retainedTarget"	Required. Defines scope for this object. Observe the type, variants and bounds in the Options column.
actionKey	string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u	Required. Reference to a declared Action; rendering does not execute it.

Reading the contract

A path ending in [] describes each list item; {key} describes each dictionary value. The ↻ marker refers to the same recursive expression. Closed objects reject additional properties. Semantic validation denotes an additional check: matching a type does not make a reference, permission or transition valid. References must resolve in the Model and the current user context.

An older variant cannot accept properties belonging to a newer variant. The compiler checks the version and consistency of the complete Model.

Structural example

This fragment passes the schema for this section. Its business references must be defined in the enclosing Model.

{
  "experienceKey": "client",
  "sectionKey": "client",
  "bindingKey": "client",
  "scope": "rootWork",
  "actionKey": "client"
}

Related references

Complete Model index · Build a Model

Applied examples : Choose each component for its role

The Field edits Notes; the table presents quotes from a relation group.

Configuration

Contract object surfaceCompositionWorkActionParams. Properties and accepted values.

{
  "experienceKey": "client",
  "sectionKey": "client",
  "bindingKey": "client",
  "scope": "rootWork",
  "actionKey": "client"
}

Variation and connection

Component properties QueryTable.props. Properties and accepted values.

{
  "binding": {
    "kind": "record-relations",
    "recordProfileKey": "client",
    "groupKey": "quotes"
  }
}

UI layout example

The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.

1. Client identity
2. Notes and follow-up
3. Settings
4. Linked quotes

SurfaceClients / North StudioExample

surfaceCompositionWorkActionParamssurfaceCompositionWorkActionParams

Clients

MODEL CONTEXTNorth StudioDeclarative configuration

experienceKey

client

sectionKey

client

bindingKey

client

scope

rootWork

actionKey

client

Values above follow the configuration fragment; references resolve in the complete Model.