Skip to content
SurfaceDocs
FRGet started
DocsModel reference

WorkspaceRecordPresentation · types

Interfaces, values and named contracts for WorkspaceRecordPresentation.

The following types define named objects and their relationships. Tables include inherited properties. Schema-derived types refer to their validated structures; a TypeScript declaration does not replace the compiler’s semantic checks.

WorkspaceRecordPresentation

Complete current metadata, independent of runtime content or grants.

export type WorkspaceRecordPresentation = z.infer<typeof workspaceRecordPresentationSchema>;

WorkspaceRecordProfile

One explicitly declared record type and its native edit Form.

export type WorkspaceRecordProfile = z.infer<typeof workspaceRecordProfileSchema>;

WorkspaceRecordValueSource

Native property, exact Field path or declared readonly calculation used for display.

export type WorkspaceRecordValueSource = z.infer<typeof workspaceRecordValueSourceSchema>;

WorkspaceRecordQueryBinding

Parameters bound to an existing named Query.

export type WorkspaceRecordQueryBinding = z.infer<typeof workspaceRecordQueryBindingSchema>;

WorkspaceRecordTableColumnSource

Table-only sources retain metrics, native related records and readonly calculations.

export type WorkspaceRecordTableColumnSource = z.infer<
  typeof workspaceRecordTableColumnSourceSchema
>;

All references

Applied examples : Visible notes, accessible settings

Place follow-up on the Surface and email in settings, while retaining the same Fields.

Configuration

Fragment placed in presentation.recordProfiles[].detail.sections. Properties and accepted values.

[
  {
    "kind": "fields",
    "key": "follow-up",
    "label": "Client follow-up",
    "fieldPaths": [
      "fields/notes",
      "fields/status"
    ]
  }
]

Variation and connection

Fragment placed in presentation.recordProfiles[].detail.settings. Properties and accepted values.

{
  "fieldPaths": [
    "fields/email"
  ]
}

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
WorkspaceRecordPresentation · typesVisible notes, accessible settings
Clients
NS
North StudioActive client · Professional services
StatusActive
Notes and follow-up

The client wants a proposal for a new project. Clarify requirements and confirm the budget before review.

Editable text on the Surface
Record settings
Search for a concept, field or action.Esc