Skip to content
SurfaceDocs
FRGet started
DocsManage & troubleshoot

Data residency

Define storage and processing boundaries.

An explicit constraint

Residency defines where data may be stored and processed. It applies to Surface resources and connections used for work. A preferred region for latency is different from a mandatory residency boundary.

Parameter Expected value Effect
Authorized region Effective organization boundary Restricts processing
Storage Compatible resources Retains content within scope
AI provider Compatible endpoint and conditions Respects the execution constraint
Diagnostic Compatibility or refusal reason Explains unavailable operations

Example

If an organization requires European Union processing, its quote drafting profile selects compatible resources. Better latency elsewhere does not permit crossing that boundary. If no authorized compatible resource exists, work identifies what is missing.

Check the whole journey

Review storage, processing, exports and external services. An interface selection alone does not prove residency. Connections and profiles require configuration consistent with organizational policy.

Encryption addresses protection; profiles select execution resources.

Applied examples : Prepare processing with its sources

Declare required sources and connection capabilities. Effective residency remains configured and enforced in Surface.

Configuration

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

{
  "key": "quote-context",
  "targetDefinitionPaths": [
    "workspace/quotes/surface/quote"
  ],
  "sources": [
    {
      "key": "client",
      "kind": "relation",
      "definitionPaths": [
        "workspace/clients/surface/client"
      ],
      "linkTypePaths": [
        "application/client"
      ],
      "queryKey": null,
      "required": true,
      "revision": "current",
      "priority": 1,
      "maximumItems": 1,
      "maximumCharacters": 8000
    }
  ],
  "maximumCharacters": 16000
}

Variation and connection

Fragment placed in publication. Properties and accepted values.

{
  "kind": "workspace-application",
  "license": "Proprietary",
  "requiredCapabilities": [],
  "requiredConnections": [
    "document.export"
  ]
}

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. Runtime profile
  2. Connections
  3. Residency
  4. Save
ILLUSTRATIVE LAYOUTClients / Quotes app
SurfaceClients / North StudioExample
Data residencyPrepare processing with its sources
Clients
Processing region
Region selected in Surface
Storage
According to account policy
Authorized access
Authorized members
Search for a concept, field or action.Esc