managedDocumentProfileV3

This reference describes the full structure of managedDocumentProfileV3. 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	"DocumentProfile@3"	Required. Exact discriminant of this contract variant. Match the literal value shown.
key	string; min length 1	Required. Stable semantic identifier used by references; changing it changes identity.
source	closed object OR closed object OR closed object OR closed object	Required. Defines source for this object. Observe the type, variants and bounds in the Options column.
source.[kind=home-section].kind	"home-section"	Required. Selects the variant and the properties admitted in this branch.
source.[kind=home-section].sectionKey	string; min length 1	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
source.[kind=home-section].queryKey	string; min length 1	Required. Reference to a declared Query; scope and authorization remain enforced by the data engine.
source.[kind=home-section].viewKey	string; min length 1	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
source.[kind=work-query].kind	"work-query"	Required. Selects the variant and the properties admitted in this branch.
source.[kind=work-query].experienceKey	string; min length 1	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
source.[kind=work-query].sectionKey	string; min length 1	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
source.[kind=work-query].bindingKey	string; min length 1	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
source.[kind=work-query].viewKey	string; min length 1	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
source.[kind=collection].kind	"collection"	Required. Selects the variant and the properties admitted in this branch.
source.[kind=collection].destinationKey	string; min length 1	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
source.[kind=collection].queryKey	string; min length 1	Required. Reference to a declared Query; scope and authorization remain enforced by the data engine.
source.[kind=collection].viewKey	string; min length 1	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
source.[kind=record-query].kind	"record-query"	Required. Selects the variant and the properties admitted in this branch.
source.[kind=record-query].recordProfileKey	string; min length 1	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
source.[kind=record-query].queryBindingKey	string; min length 1	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
source.[kind=record-query].viewKey	string; min length 1	Required. Stable key reference to the corresponding named declaration; the compiler checks existence and compatibility.
exportFormats	Array<"markdown" | "pdf">; min length 1; max length 2; semantic validation	Required. Defines export Formats for this object. Observe the type, variants and bounds in the Options column.
budget	closed object	Required. Defines budget for this object. Observe the type, variants and bounds in the Options column.
budget.maximumRows	integer; ≥ 1; ≤ 1000	Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema.
budget.maximumPages	integer; ≥ 1; ≤ 100	Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema.
budget.maximumOutputBytes	integer; ≥ 1024; ≤ 16777216	Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema.

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": "DocumentProfile@3",
  "key": "collection-knowledge-categories",
  "source": {
    "kind": "collection",
    "destinationKey": "knowledge",
    "queryKey": "knowledge-categories",
    "viewKey": "knowledge-categories-view"
  },
  "exportFormats": [
    "markdown",
    "pdf"
  ],
  "budget": {
    "maximumRows": 250,
    "maximumPages": 20,
    "maximumOutputBytes": 2000000
  }
}

Related references

Complete Model index · Build a Model

Applied examples : Client notes and exported document

Content stays editable in the record; the export profile selects the authorized quotes.

Configuration

Contract object managedDocumentProfileV3. Properties and accepted values.

{
  "contract": "DocumentProfile@3",
  "key": "client-quotes-export",
  "source": {
    "kind": "record-query",
    "recordProfileKey": "client",
    "queryBindingKey": "client-quotes",
    "viewKey": "quotes-table"
  },
  "exportFormats": [
    "markdown"
  ],
  "budget": {
    "maximumRows": 100,
    "maximumPages": 4,
    "maximumOutputBytes": 1000000
  }
}

Variation and connection

Component properties NativeContent.props. Properties and accepted values.

{
  "recordProfileKey": "client",
  "contentKind": "document"
}

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. Quote S-1042
2. Subject and need
3. Proposal
4. Retained references

SurfaceClients / North StudioExample

managedDocumentProfileV3managedDocumentProfileV3

Clients

MODEL CONTEXTNorth StudioDeclarative configuration

key

client-quotes-export

source

Declared object

exportFormats

1 item

budget

Declared object

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