Start typing to search.

Core Concepts

Glossary

View Markdown

Definitions for the Envoy terms used throughout the UI, API, CLI, YAML, and operations guides.

Glossary

Every product term used in this documentation, in one table. Each term links to the page that covers it in depth.

Term Definition
Argument A create-time parameter declared by a Job Template (or task). Values are chosen when a Job is created and substituted into ${VAR} placeholders in the template snapshot. See Template arguments.
Bundle An export/import package of tasks, job templates, and related definitions for moving work between deployments. See Bundles.
Catalog connector A connector type registered at boot from the deployment's catalog (for example zendesk, hubspot), backed by a connected account rather than compiled-in code. See Catalog and connected accounts.
Connector A stored, named configuration (credentials, paths, URLs) for a connector type, encrypted at rest on the server. Bound to slots when Jobs are created or runs start. See Connectors and slots.
Connector mapping The wiring between names: in a Job Template, task slot names → template connector names; in a Job, template connector names → stored Connector IDs. See Connectors and slots.
Connector slot A task's typed declaration that it needs a connector — a name and a type, never credentials. See Connectors and slots.
Control plane The Envoy server: web UI, REST API, state store, scheduler, and run dispatch. See Architecture.
Dashboard A configurable page of widgets (charts, tables, forms, actions) attached to a Job for operators or customers. See Dashboards.
Data Explorer The UI surface for browsing and querying any stored Connector's data interactively. See Data Explorer.
Executor A process that registers with a control plane and runs task subprocesses on its behalf. A control plane can also execute locally. See Control plane and executors.
Job An instantiated Job Template with real Connectors bound and argument values applied. Persistent and runnable many times. See Tasks, jobs, and templates.
Job config Runtime-editable settings declared by a template with defaults, adjustable per Job after creation, and snapshotted onto each run. See Job config.
Job Run One execution of a Job's DAG, containing one task run per executed node. See Job Runs.
Job Template A YAML definition composing tasks into a DAG, with connector mapping, arguments, job config defaults, and a failure policy. See Tasks, jobs, and templates.
JSONata The expression language used in step configs, filters, and mappings to transform and inspect records. See Working with JSONata.
Mapping database The store of source-to-destination ID mappings that makes sync tasks idempotent across reruns. See Idempotent sync.
Run One execution of one task in its own subprocess, standalone or inside a Job Run, with its own logs, metrics, and status. See Run lifecycle.
Step One operation in a task's pipeline — reading via a connector method, transforming, filtering, syncing. Records stream through steps one at a time. See Step reference.
Task A portable YAML pipeline: connector slots, variables, and steps. Contains no credentials or environment-specific values. See Tasks, jobs, and templates.
Trigger A cron schedule attached to a Job (optionally a single task) that starts runs automatically. See Triggers.
Variable A typed, named value declared in a task's variables block and available to JSONata expressions in that task. See Task anatomy.