Start typing to search.

Core Concepts

Glossary

View Markdown

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

Envoy

The self-hosted data movement and workflow product, including its web UI, API, CLI, control plane, executor, and streaming runtime. envoy appears in binary examples, environment variables, YAML filenames, logs, database names, and technical reference pages.

ClonePartner

The company that develops, distributes, and supports Envoy.

Task

One portable, linear streaming pipeline defined in YAML. A task declares connector slots and ordered steps.

Step

One stage in a task pipeline. A step may call a connector, transform or filter a record, manage an ID mapping, validate data, transfer a file, or perform another supported operation.

Connector

A named configuration for a data source or destination. A connector has a type, such as csv, sqlite, postgres, mongodb, or a catalog-backed SaaS integration.

Connector slot

A name-and-type requirement in a task or job template. Slots contain no credentials. A run or job maps slots to real connectors.

Job template

A reusable DAG of tasks. It defines dependencies, connector mapping, creation arguments, optional runtime job configuration, and a failure policy.

Job

An instantiated job template with concrete connectors and create-time values bound. Jobs are persistent and can be run repeatedly.

Job configuration

Runtime-editable values associated with a job, such as field mappings and sync options. Values are snapshotted onto each run and exposed as job_config.

Task run

One execution of one task. A run records status, arguments, connector mapping, timing, logs, metrics, and error details.

Job run

One execution of a job DAG. It coordinates task runs according to dependencies and the template's failure policy.

Control plane

The Envoy server that hosts the UI and API, stores state, schedules work, resolves secrets, and dispatches runs.

Executor

The Envoy worker that starts task subprocesses. It may run locally with the server or as a separate HTTP service.

Trigger

A schedule attached to a job. A trigger is recurring cron or a one-off UTC datetime and can optionally target a task subtree.

Dashboard template

A reusable YAML dashboard definition attached to a job template. It is snapshotted into a dashboard when a job is created.

Dashboard

A job-bound operator or shareable view. Dashboards can contain status, charts, tables, curated explorers, forms, field mappings, and actions.

Data Explorer

The UI for discovering connector resources, building queries, inspecting results, exporting data, and saving team presets.

Argument

A caller-supplied task value. Task arguments are typed at run start. Job-template arguments are selected at job creation and substituted through ${NAME} placeholders.

Variable

A typed value defined inside a task YAML and read from JSONata as variables.name.

JSONata

The expression language used for transformations, conditions, dynamic step config, dashboard expressions, and other declarative logic.

State backend

The database holding Envoy application state. Supported server backends are SQLite, Microsoft SQL Server, and PostgreSQL.

Secret provider

The storage implementation for connector configurations and TOTP secrets. In-database providers use encrypted envelopes; Azure deployments can use Azure Key Vault.

Run log store

The location of per-run logs. It is configured independently from general server logging and may be file-, database-, PostgreSQL-, MSSQL-, or VictoriaLogs-backed.

Archive

A reversible visibility state used by tasks, templates, and jobs. Archived items are retained but excluded from normal active workflows.

Preset

A team-shared Data Explorer query definition. Presets may contain fixed filters or prompt for parameters when applied.