Skip to content
SurfaceDocs
FRGet started
DocsModel reference

surfaceCompositionCatalogueIdentity

Properties, variants, types and bounds for surfaceCompositionCatalogueIdentity.

This reference describes the full structure of surfaceCompositionCatalogueIdentity. 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
contract "SurfaceCompositionCatalogue@1" Required. Exact discriminant of this contract variant. Match the literal value shown.
version "0.0.0.1" Required. Declared content or publication version identifying the applicable interpretation.
hash string; /^[a-f0-9]{64}$/u Required. Defines hash for this object. Observe the type, variants and bounds in the Options column.

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.

{
  "contract": "SurfaceCompositionCatalogue@1",
  "version": "0.0.0.1",
  "hash": "cbf91be40bfe4936f9b58e035fae20055be2f5f7b0a1fc1c188a5b6c5d3d6d58"
}

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

Component properties RecordField.props. Properties and accepted values.

{
  "recordProfileKey": "client",
  "fieldPath": "fields/notes"
}

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
ILLUSTRATIVE LAYOUTClients / Quotes app
SurfaceClients / North StudioExample
surfaceCompositionCatalogueIdentitysurfaceCompositionCatalogueIdentity
Clients
MODEL CONTEXTNorth StudioDeclarative configuration
recordProfileKey
client
fieldPath
fields/notes

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

Search for a concept, field or action.Esc