Skip to content
SurfaceDocs
FRGet started
DocsModel reference

surfaceTriggerDeadline

Properties, variants, types and bounds for surfaceTriggerDeadline.

This reference describes the full structure of surfaceTriggerDeadline. 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 "SurfaceTriggerDeadline@2" Required. Exact discriminant of this contract variant. Match the literal value shown.
sourceQueryKey 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.
maximumScheduledNodes integer; ≥ 1; ≤ 10000 Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema.
lateToleranceMs integer; ≥ 0; ≤ 86400000 Required. Defines late Tolerance Ms for this object. Observe the type, variants and bounds in the Options column.
localTime string; /^(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d$/u; optional Optional. Local time in the required format, interpreted in the declared timezone.

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": "SurfaceTriggerDeadline@2",
  "sourceQueryKey": "releases",
  "maximumScheduledNodes": 100,
  "lateToleranceMs": 0,
  "localTime": "09:00:00"
}

Complete Model index · Build a Model

Applied examples : Propose a review at the right time

A change to the amount proposes a review; a deadline bounds the watched objects.

Configuration

Contract object surfaceTriggerDeadline. Properties and accepted values.

{
  "contract": "SurfaceTriggerDeadline@2",
  "sourceQueryKey": "pending-quotes",
  "maximumScheduledNodes": 50,
  "lateToleranceMs": 300000
}

Variation and connection

Fragment placed in triggers[]. Properties and accepted values.

{
  "key": "quote-review",
  "enabledByDefault": false,
  "event": {
    "kind": "revision",
    "definitionPaths": [
      "workspace/quotes/surface/quote"
    ],
    "fieldKeys": [
      "amount"
    ]
  },
  "ruleKeys": [
    "positive-amount"
  ],
  "actionKey": "review-quote",
  "mode": "propose",
  "executionCapability": null,
  "maximumCascadeDepth": 1,
  "historicalEvents": "explicit-backfill-only"
}

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
surfaceTriggerDeadlinesurfaceTriggerDeadline
Clients
MODEL CONTEXTNorth StudioDeclarative configuration
sourceQueryKey
pending-quotes
maximumScheduledNodes
50
lateToleranceMs
300000

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

Search for a concept, field or action.Esc