Docs / Glossary

Glossary

A-Z definitions for every term across FlowMason docs. When the term has a deeper home in the docs, follow the link.

A

ADR. Architecture Decision Record. Append-only why-decision log. See ADR index.

Allowlist. Per-SObject Org Chat policy (FM_Org_Chat_Allowlist__mdt). Controls which objects the assistant can read / update / insert / delete and at what LIMIT.

AsyncExecution. Polling handle for an async pipeline run. getStatus / isDone / getOutput / cancel.

Async tokens. Per-async-branch correlation keys in ExecutionState.asyncTokens. Used by ParallelExecutor + WaitForSignal.

B

BaseComponent. Abstract base for every pipeline stage. Subclasses: BaseNode, BaseLLMNode, BaseOperator, BaseFlowControl.

Buffered circuit. CircuitBreaker mode that writes failed attempts to FM_Circuit_Queue__c for replay instead of failing fast.

Bulkify. Trigger framework auto-batches one-record-per-call into one Queueable per chunk, saving callout budget.

C

Callable. Apex System.Callable interface. Plugin extension hook for SubPipeline / InvocableApex.

Circuit breaker. Operator that fails fast (or buffers) when downstream failure rate crosses threshold.

Component. One stage type in pipeline JSON stages[].type. Registered via FM_Component_Type__mdt.

Confirmation key. Single-use token returned by FmOrgChatDmlPreview.dryRun. Required for applyDml. Second leg of the DML two-step.

Context (ExecutionContext). Mutable per-run bag: input, stage outputs, variables, FLS provenance.

D

Decomposer. FmOrgChatDecomposer planner LLM that breaks a chat question into a structured plan (REL-3 enriched).

Density modifier. comfortable / compact UI variant in v2 Org Chat layout.

Direct mode. LLM call hits the vendor API directly (vs trust-layer mode that routes through Einstein Models API).

Discovery nudge. Permset-gated suggestion appended when the user references an in-org but non-allowlisted SObject. ADR-015.

DML two-step. Org Chat write flow: dryRun → modal preview → user types object name to confirm → apply. Three independent fail-closed gates. ADR-005 / ADR-006.

E

ExecutionResult. Terminal pipeline outcome: success / yielded / paused / error.

ExecutionState. Serialisable snapshot for yield / pause / resume. schemaVersion = 1.

ExecutionTrace. Aggregated trace for the inspector + telemetry.

Executor (single). PipelineRunner.executeFromMapWithState. The one true execution loop. All entry points funnel here.

F

Fallback chain. config.providerFallback: ["anthropic", "openai"]. Try first; on failure go to second.

Few-shot. Input/output pairs prepended to the user prompt when useFewShot: true.

FLS (Field-Level Security). Salesforce per-field permission. Enforced via FMSecurityUtil + FMPromptGuard.

FMConfig. Apex facade for FM_Config__mdt reads. Always pass a literal default.

FMSoqlValidator. 8-gate SOQL sanitiser. The trust boundary on every assistant-generated SOQL.

G

Governor monitor. GovernorMonitor polls platform limits and returns yield decisions to the executor.

Governor yield. Runtime suspends the pipeline mid-run when a limit threshold trips, persists state, resumes via Queueable.

I

Idempotency key. Caller-supplied dedup token on PipelineRunner.execute / enqueue.

InputMapper. Resolves placeholders against the current ExecutionContext.

Inspector. fmInspector LWC. Post-mortem view for one PipelineExecution__c. See Inspector.

INV-1. On-demand introspection layer (FMOrgIntrospector.scopedExcerpt). Per-turn org-context excerpt. ADR-014.

INV-2. Nightly inventory harvest into FM_Org_Inventory_Snapshot__c.

Inventory pill. UI badge in Org Chat header showing inventory freshness + row count.

K

Kill switch. Single MDT flag or permset revoke that disables a capability without redeploying.

L

LLMProvider. Apex interface every LLM provider implements. LLMToolCapableProvider is the optional ADR-013 extension.

LWC. Lightning Web Component. FlowMason ships ~30. See LWC Components.

M

Manifest excerpt. Per-turn org-context payload threaded into the LLM prompt when orgChatManifestEnabled = true.

MDT (Custom Metadata Type). SFDX-deployable read-only configuration. FlowMason ships 22.

Models API. Salesforce-native Einstein LLM endpoint. Charged in Einstein Requests, not USD.

N

Named Credential. Salesforce-managed external endpoint + auth bundle. FlowMason never calls a raw URL. Always via NC.

Named Principal. Single-user identity bound to a Named Credential. Used for service-account-style auth.

O

Operator. Pipeline stage that does data transform / IO. Subclass of BaseOperator.

Org Chat. Chat-with-your-data surface (fmOrgChat LWC). ADR-002 / ADR-009.

P

Permset (Permission Set). Salesforce permission grant. FlowMason gates everything via permsets.

Pipeline. A directed-acyclic graph of stages defined in JSON. Stored in FlowMason_Pipeline__c (mutable) or FlowMasonPipeline__mdt (deployable).

Placeholder. Templates in pipeline JSON resolved by InputMapper.

Plugin. External-vendor extension. Five types (component, provider, binding, callable, pipeline). See Plugin SDK.

Provider. LLM / audio / document / vector / cache backend implementor.

Provider mode. direct / trust_layer / auto. Per-stage or global via defaultProviderMode.

Q

Queueable depth. ExecutionState.chainDepth. Capped by queueableChainDepthMax (default 5).

R

Rate limiter. Per-user / per-org token-bucket throttle.

REL-1 / REL-2 / REL-3. Cross-object query enablers: relationship-aware schema prompts, validator subquery acceptance, decomposer planner enrichment.

Retention. Auto-archive cutoff. executionRetentionDays, stageLogRetentionDays, auditLogRetentionDays, orgChatRetentionDays.

Run. One execution of one pipeline. Identified by executionId.

S

Schema version. ExecutionState.schemaVersion. Currently 1.

Single-flight. Cache-key idiom that prevents duplicate in-flight work.

Stage. One unit of execution within a pipeline.

StageTrace. Per-stage execution detail. Composes ExecutionTrace.stages[].

Studio. Authoring canvas (pipelineBuilderLwc). See Pipeline Studio.

Surface. Lightning placement of the Org Chat LWC. Seven tokens: tab / utility / global_action / copilot / record_page / home_page / app_page. ADR-009.

T

Telemetry. FlowMasonRun__e Platform Event → trigger → FM_Run_Audit__c.

Template. FM_LLM_Template__c (mutable) / FM_LLM_Task__mdt (deployable). Versioned LLM prompt definitions.

ThreadState. Per-conversation provider history cached server-side (FMThreadState).

Tool-calling. Provider-agnostic multi-step LLM reasoning via 4 canonical tools. ADR-013.

Trust boundary. A point in code where untrusted input is sanitised. Two big ones: FMSoqlValidator (assistant SOQL) + FMSecurityUtil (FLS/CRUD).

Trust layer. Salesforce Einstein masking layer. Engaged when providerMode = trust_layer.

U

USER_MODE / SYSTEM_MODE. Database.queryWithBinds / Database.query access-level enums. FlowMason uses USER_MODE for customer data, SYSTEM_MODE for component metadata.

V

Validator (pipeline). PipelineValidator. Static analysis on pipeline JSON: cycles, unreachable stages, unresolved placeholders.

Validator (SOQL). FMSoqlValidator. Runtime sanitiser on every assistant-generated SOQL.

Variable. Named slot in ExecutionContext.contextVars.

Y

Yield. Runtime suspends the pipeline mid-run when governor threshold trips. State serialised, resumed via Queueable.