Skip to content
SurfaceDocs
FRGet started
DocsModel reference

managedModelAuthorTask

Properties, variants, types and bounds for managedModelAuthorTask.

This reference describes the full structure of managedModelAuthorTask. 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
key string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u Required. Stable semantic identifier used by references; changing it changes identity.
kind "task" Required. Selects the variant and the properties admitted in this branch.
uses string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u Required. Defines uses for this object. Observe the type, variants and bounds in the Options column.
title string; min length 1; max length 4000 Required. Title of the object or section in the interface.
initialFields Record<string, true | false OR number OR string OR Array<true | false OR number OR string>> Required. Defines initial Fields for this object. Observe the type, variants and bounds in the Options column.
completionCriteria Array<string; min length 1; max length 4000>; max length 100 Required. Conditions establishing that work is complete.
inputs Record<string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u, closed object OR closed object OR closed object OR closed object OR closed object OR closed object OR closed object OR closed object> Required. Named, typed inputs needed by the composition or operation.
inputs{key}.[kind=input].kind "input" Required. Selects the variant and the properties admitted in this branch.
inputs{key}.[kind=input].key string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u Required. Stable semantic identifier used by references; changing it changes identity.
inputs{key}.[kind=input-node-id].kind "input-node-id" Required. Selects the variant and the properties admitted in this branch.
inputs{key}.[kind=input-node-id].key string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u Required. Stable semantic identifier used by references; changing it changes identity.
inputs{key}.[kind=field].kind "field" Required. Selects the variant and the properties admitted in this branch.
inputs{key}.[kind=field].definitionPath string; min length 1; max length 600; /^workspace\/[a-z0-9-]+(?:\/surface\/[a-z0-9-]+)*$/u Required. Exact path of a definition in the Model; this is not a record instance ID.
inputs{key}.[kind=field].fieldKey string; min length 1; max length 120 Required. Key of a Field declared on the referenced Surface definition.
inputs{key}.[kind=literal].kind "literal" Required. Selects the variant and the properties admitted in this branch.
inputs{key}.[kind=literal].value string; max length 4000 OR number OR true | false OR null Required. Effective value interpreted according to the enclosing type and discriminant.
inputs{key}.[kind=collection-item].kind "collection-item" Required. Selects the variant and the properties admitted in this branch.
inputs{key}.[kind=collection-node-id].kind "collection-node-id" Required. Selects the variant and the properties admitted in this branch.
inputs{key}.[kind=iteration-number].kind "iteration-number" Required. Selects the variant and the properties admitted in this branch.
inputs{key}.[kind=step-output].kind "step-output" Required. Selects the variant and the properties admitted in this branch.
inputs{key}.[kind=step-output].stepKey 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.
inputs{key}.[kind=step-output].outputKey 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.
outputs Array<closed object>; max length 20 Required. Outputs exposed by the composition using declared names.
outputs[].key string; min length 1; max length 120; /^[a-z][a-z0-9-]*$/u Required. Stable semantic identifier used by references; changing it changes identity.
outputs[].minimum integer; ≥ 0; ≤ 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.
outputs[].maximum 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.
outputs[].result "reference" | "summary" | "outputs" | "decisions" | "nextSteps" | "blockers" Required. Defines result for this object. Observe the type, variants and bounds in the Options column.
reservedCostUnits integer; ≥ 0; ≤ 1000000 Required. Defines reserved Cost Units for this object. Observe the type, variants and bounds in the Options column.
maximumAttempts integer; ≥ 1; ≤ 10 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.

{
  "key": "client",
  "kind": "task",
  "uses": "client",
  "title": "client",
  "initialFields": {},
  "completionCriteria": [],
  "inputs": {},
  "outputs": [],
  "reservedCostUnits": 0,
  "maximumAttempts": 1
}

Complete Model index · Build a Model

Applied examples : Prepare a quote

The Flow declares Client and Need inputs, an executable step and a bounded budget.

Configuration

Contract object managedModelAuthorTask. Properties and accepted values.

{
  "key": "client",
  "kind": "task",
  "uses": "client",
  "title": "client",
  "initialFields": {},
  "completionCriteria": [],
  "inputs": {},
  "outputs": [],
  "reservedCostUnits": 0,
  "maximumAttempts": 1
}

Variation and connection

Fragment placed in flowBlueprints[].composition.inputs. Properties and accepted values.

[
  {
    "key": "client",
    "type": "surface-reference",
    "provenance": "caller",
    "minimum": 1,
    "maximum": 1
  },
  {
    "key": "need",
    "type": "text",
    "provenance": "caller",
    "minimum": 1,
    "maximum": 1
  }
]

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. Qualify need
  2. Prepare proposal
  3. Wait for decision
  4. Retain result
ILLUSTRATIVE LAYOUTClients / Quotes app
SurfaceClients / North StudioExample
managedModelAuthorTaskmanagedModelAuthorTask
Clients
MODEL CONTEXTNorth StudioDeclarative configuration
key
client
kind
task
uses
client
title
client
initialFields
Declared object

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

Search for a concept, field or action.Esc