Skip to main content

Glossary

The following terms are used in Temporal Platform documentation.

Action​

An Action is the fundamental pricing unit in Temporal Cloud. Temporal Actions are the building blocks for Workflow Executions. When you execute a Temporal Workflow, its Actions create the ongoing state and progress of your Temporal Application.

Actions Per Second (APS)​

APS, or Actions per second, is specific to Temporal Cloud. Each Temporal Cloud Namespace enforces a rate limit, which is measured in Actions per second (APS). This is the number of Actions, such as starting or signaling a Workflow, that can be performed per second within a specific Namespace.

Activity​

In day-to-day conversation, the term "Activity" denotes an Activity Type, Activity Definition, or Activity Execution.

Activity Definition​

An Activity Definition is the code that defines the constraints of an Activity Task Execution.

Activity Execution​

An Activity Execution is the full chain of Activity Task Executions.

Activity Heartbeat​

An Activity Heartbeat is a ping from the Worker that is executing the Activity to the Temporal Service.

Each ping informs the Temporal Service that the Activity Execution is making progress and the Worker has not crashed.

Activity Id​

A unique identifier for an Activity Execution.

Activity Task​

An Activity Task contains the context needed to make an Activity Task Execution.

Activity Task Execution​

An Activity Task Execution occurs when a Worker uses the context provided from the Activity Task and executes the Activity Definition.

Activity Type​

An Activity Type is the mapping of a name to an Activity Definition.

Archival​

Archival is a feature specific to a Self-hosted Temporal Service that automatically backs up Event Histories from Temporal Service persistence to a custom blob store after the Closed Workflow Execution retention period is reached.

Asynchronous Activity Completion​

Asynchronous Activity Completion occurs when an external system provides the final result of a computation, started by an Activity, to the Temporal System.

Audit Logging​

Audit Logging is a feature that provides forensic access information for accounts, users, and Namespaces.

Authorizer Plugin​

The Authorizer plugin contains a single Authorize method, which is invoked for each incoming API call. Authorize receives information about the API call, along with the role and permission claims of the caller.

Child Workflow​

A Child Workflow Execution is a Workflow Execution that is spawned from within another Workflow.

Claim Mapper​

The Claim Mapper component is a pluggable component that extracts Claims from JSON Web Tokens (JWTs).

Codec Server​

A Codec Server is an HTTP server that uses your custom Payload Codec to encode and decode your data remotely through endpoints.

Command​

A Command is a requested action issued by a Worker to the Temporal Service after a Workflow Task Execution completes.

Continue-As-New​

Continue-As-New is the mechanism by which all relevant state is passed to a new Workflow Execution with a fresh Event History.

Core SDK​

The Core SDK is a shared common core library used by several Temporal SDKs. Written in Rust, the Core SDK provides complex concurrency management and state machine logic among its standout features. Centralizing development enables the Core SDK to support quick and reliable deployment of new features to existing SDKs, and to more easily add new SDK languages to the Temporal ecosystem.

Custom Data Converter​

A custom Data Converter extends the default Data Converter with custom logic for Payload conversion or Payload encryption.

Data Converter​

A Data Converter is a Temporal SDK component that serializes and encodes data entering and exiting a Temporal Service.

Default Data Converter​

The default Data Converter is used by the Temporal SDK to convert objects into bytes using a series of Payload Converters.

Delay Workflow Execution​

Start Delay determines the amount of time to wait before initiating a Workflow Execution. If the Workflow receives a Signal-With-Start during the delay, it dispatches a Workflow Task and the remaining delay is bypassed.

Dual Visibility​

Dual Visibility is a feature, specific to a Self-hosted Temporal Service, that lets you set a secondary Visibility store in your Temporal Service to facilitate migrating your Visibility data from one database to another.

Durable Execution​

Durable Execution in the context of Temporal refers to the ability of a Workflow Execution to maintain its state and progress even in the face of failures, crashes, or server outages.

Dynamic Handler​

Dynamic Handlers are Workflows, Activities, Signals, or Queries that are unnamed and invoked when no other named handler matches the call from the Server at runtime.

Event​

Events are created by a Temporal Service in response to external occurrences and Commands generated by a Workflow Execution.

Event History​

An append-only log of Events that represents the full state a Workflow Execution.

Failback​

After Temporal Cloud has resolved an outage or incident involving a failover, a failback process shifts Workflow Execution processing back to the original region that was active before the incident.

Failover​

A failover shifts Workflow Execution processing from an active Temporal Namespace region to a standby Temporal Namespace region during outages or other incidents. Standby Namespace regions use replication to duplicate data and prevent data loss during failover.

Failure​

Temporal Failures are representations of various types of errors that occur in the system.

Failure Converter​

A Failure Converter converts error objects to proto Failures and back.

Failures​

A Failure is Temporal's representation of various types of errors that occur in the system.

Frontend Service​

The Frontend Service is a stateless gateway service that exposes a strongly typed Proto API. The Frontend Service is responsible for rate limiting, authorizing, validating, and routing all inbound calls.

General Availability​

Learn more about the General Availability release stage

Global Namespace​

A Global Namespace is a Namespace that duplicates data from an active Temporal Service to a standby Service using the replication to keep both Namespaces in sync. Global Namespaces are designed to respond to service issues like network congestion. When service to the primary Cluster is compromised, a failover transfers control from the active to the standby cluster.

Heartbeat Timeout​

A Heartbeat Timeout is the maximum time between Activity Heartbeats.

History Service​

The History Service is responsible for persisting Workflow Execution state and determining what to do next to progress the Workflow Execution through History Shards.

History Shard​

A History Shard is an important unit within a Temporal Service by which the scale of concurrent Workflow Execution throughput can be measured.

List Filter​

A List Filter is the SQL-like string that is provided as the parameter to an advanced Visibility List API.

Local Activity​

A Local Activity is an Activity Execution that executes in the same process as the Workflow Execution that spawns it.

Matching Service​

The Matching Service is responsible for hosting external Task Queues for Task dispatching.

Memo​

A Memo is a non-indexed user-supplied set of Workflow Execution metadata that is returned when you describe or list Workflow Executions.

Multi-Cluster Replication​

Multi-Cluster Replication is a feature which asynchronously replicates Workflow Executions from active Clusters to other passive Clusters, for backup and state reconstruction.

Multi-region Namespace​

A multi-region Namespace (MRN) is a Temporal Cloud Namespace that is configured to work across an active region and a standby region. Each region corresponds to a dedicated Temporal Cloud Service. Temporal Cloud automatically replicates Workflow Executions and metadata from the active to the standby region. MRNs are designed to respond to service issues as they arise. In the event that the Namespace's performance is compromised, a failover transfers control from the active to the standby region.

Namespace​

A Namespace is a unit of isolation within the Temporal Platform.

Nexus API Definitions​

A common code package, schema, or documentation that a Caller can use to obtain Service and Operation names as associated input/output types a Service will accept for a given Operation.

Nexus API Registry​

The Nexus API Registry stores information about Nexus Endpoints. In the open source version of Temporal, the registry is scoped to a cluster, while in Temporal Cloud, it is scoped to an account. Endpoint names must be unique within the registry. When the Temporal Service dispatches a Nexus request, it resolves the request's Endpoint to a Namespace and Task Queue through the Registry.

Nexus Async Completion Callback​

A Nexus Async Completion Callback is the completion callback for an asynchronous Nexus Operation.

Nexus Endpoint​

A Nexus Endpoint is an API proxy that can serve one or more Nexus Services from a target such as a Worker listening on a target Temporal Namespace and target Task Queue. This allows service providers to present a clean API contract and hide the underlying implementation, which may consist of many internal Workflows. Multiple Nexus Endpoints can target the same Namespace, and over time a Nexus Endpoint will be able to span multiple Namespaces with service routing rules.

Nexus Machinery​

Temporal has built-in Nexus Machinery that performs the low-level Nexus RPC operations on the wire and provides an integrated Temporal SDK experience to create Nexus Services in a handler Worker and use them from a caller Workflow through a Nexus Endpoint.

Nexus Operation​

An arbitrary-duration operation that may be synchronous or asynchronous, short-lived, or long-lived, and used to connect durable executions within and across Namespaces, clusters, regions, and clouds. Unlike a traditional RPC, an asynchronous Nexus Operation has an operation identity that can be used to re-attach to a long-lived Nexus Operation, for example, one backed by a Temporal Workflow. Nexus Operations support a uniform interface to get the status of an operation or its result, receive a completion callback, or cancel the operation – all of which are fully integrated into the Temporal Platform.

Nexus Operation Events​

Nexus Operations Events are history events that surface in the Caller Workflow to indicate the state of an Operation including Nexus Operation Scheduled, Nexus Operation Started, Nexus Operation Completed.

Nexus Operation Handler​

The Nexus handler code in a Temporal Worker typically created using Temporal SDK builder functions that make it easy to abstract Temporal primitives and expose a clean service contract for others to use.

Nexus RPC​

Nexus RPC is a protocol designed with durable execution in mind. It supports arbitrary-duration Operations that extend beyond a traditional RPC — a key underpinning to connect durable executions within and across Namespaces, clusters, regions, and cloud boundaries.

Nexus Service​

A Nexus Service is a named collection of arbitrary-duration Nexus Operations that provide an API contract suitable for sharing across team boundaries. Nexus Services are registered with a Temporal Worker that is listening on the target Namespace and Task Queue for an Endpoint.

Parent Close Policy​

If a Workflow Execution is a Child Workflow Execution, a Parent Close Policy determines what happens to the Workflow Execution if its Parent Workflow Execution changes to a Closed status (Completed, Failed, Timed out).

Payload​

A Payload represents binary data such as input and output from Activities and Workflows.

Payload Codec​

A Payload Codec transforms an array of Payloads into another array of Payloads.

Payload Converter​

A Payload Converter serializes data, converting objects or values to bytes and back.

Pre-release​

Learn more about the Pre-release stage

Public Preview​

Learn more about the Public Preview release stage

Query​

A Query is a synchronous operation that is used to report the state of a Workflow Execution.

Remote data encoding​

Remote data encoding is using your custom Data Converter to decode (and encode) your Payloads remotely through endpoints.

Requests Per Second (RPS)​

RPS, or Requests per second, is used in the Temporal Service (both in self-hosted Temporal and Temporal Cloud). This is a measure that controls the rate of requests at the service level, such as the Frontend, History, or Matching Service.

Reset​

A Reset terminates a Workflow Execution, removes the progress in the Event History up to the reset point, and then creates a new Workflow Execution with the same Workflow Type and Id to continue.

Retention Period​

A Retention Period is the amount of time a Workflow Execution Event History remains in the Temporal Service's persistence store.

Retry Policy​

A Retry Policy is a collection of attributes that instructs the Temporal Server how to retry a failure of a Workflow Execution or an Activity Task Execution.

Run Id​

A Run Id is a globally unique, platform-level identifier for a Workflow Execution.

Schedule​

A Schedule enables the scheduling of Workflow Executions.

Schedule-To-Close Timeout​

A Schedule-To-Close Timeout is the maximum amount of time allowed for the overall Activity Execution, from when the first Activity Task is scheduled to when the last Activity Task, in the chain of Activity Tasks that make up the Activity Execution, reaches a Closed status.

Schedule-To-Start Timeout​

A Schedule-To-Start Timeout is the maximum amount of time that is allowed from when an Activity Task is placed in a Task Queue to when a Worker picks it up from the Task Queue.

Search Attribute​

A Search Attribute is an indexed name used in List Filters to filter a list of Workflow Executions that have the Search Attribute in their metadata.

Side Effect​

A Side Effect is a way to execute a short, non-deterministic code snippet, such as generating a UUID, that executes the provided function once and records its result into the Workflow Execution Event History.

Signal​

A Signal is an asynchronous request to a Workflow Execution.

Signal-With-Start​

Signal-With-Start starts and Signals a Workflow Execution, or just Signals it if it already exists.

Start-To-Close Timeout​

A Start-To-Close Timeout is the maximum time allowed for a single Activity Task Execution.

State Transition​

A State Transition is a unit of progress by a Workflow Execution.

Sticky Execution​

A Sticky Execution is a when a Worker Entity caches the Workflow Execution Event History and creates a dedicated Task Queue to listen on.

Task​

A Task is the context needed to make progress with a specific Workflow Execution or Activity Execution.

Task Queue​

A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.

Task Routing​

Task Routing is when a Task Queue is paired with one or more Worker Processes, primarily for Activity Task Executions.

Task Token​

A Task Token is a unique identifier for an Activity Task Execution.

Temporal​

Temporal is a scalable and reliable runtime for Reentrant Processes called Temporal Workflow Executions.

Temporal Application​

A Temporal Application is a set of Workflow Executions.

Temporal CLI​

The Temporal CLI is the most recent version of Temporal's command-line tool.

Temporal Client​

A Temporal Client, provided by a Temporal SDK, provides a set of APIs to communicate with a Temporal Service.

Temporal Cloud​

Temporal Cloud is a managed, hosted Temporal environment that provides a platform for Temporal Applications.

Temporal Cloud Account Id​

A Temporal Cloud Account Id is a unique identifier for a customer.

Temporal Cloud Namespace Id​

A Cloud Namespace Id is a globally unique identifier for a Namespace in Temporal Cloud.

Temporal Cloud Namespace Name​

A Cloud Namespace Name is a customer-supplied name for a Namespace in Temporal Cloud.

Temporal Cloud gRPC Endpoint​

A Cloud gRPC Endpoint is a Namespace-specific address used to access Temporal Cloud from your code.

Temporal Cluster​

The term "Temporal Cluster" is being phased out. Instead the term Temporal Service is now being used.

Temporal Service​

A Temporal Service is a Temporal Server paired with Persistence and Visibility stores.

Temporal Service configuration​

Temporal Service configuration is the setup and configuration details of your Temporal Service, defined using YAML.

Temporal Cron Job​

A Temporal Cron Job is the series of Workflow Executions that occur when a Cron Schedule is provided in the call to spawn a Workflow Execution.

Temporal Platform​

The Temporal Platform consists of a Temporal Service and Worker Processes.

Temporal SDK​

A Temporal SDK is a language-specific library that offers APIs to construct and use a Temporal Client to communicate with a Temporal Service, develop Workflow Definitions, and develop Worker Programs.

Temporal Server​

The Temporal Server is a grouping of four horizontally scalable services.

Temporal Web UI​

The Temporal Web UI provides users with Workflow Execution state and metadata for debugging purposes.

Timer​

Temporal SDKs offer Timer APIs so that Workflow Executions are deterministic in their handling of time values.

Update​

An Update is a request to and a response from Workflow Execution.

Visibility​

The term Visibility, within the Temporal Platform, refers to the subsystems and APIs that enable an operator to view Workflow Executions that currently exist within a Temporal Service.

Worker​

In day-to-day conversations, the term Worker is used to denote both a Worker Program and a Worker Process. Temporal documentation aims to be explicit and differentiate between them.

Worker Entity​

A Worker Entity is the individual Worker within a Worker Process that listens to a specific Task Queue.

Worker Process​

A Worker Process is responsible for polling a Task Queue, dequeueing a Task, executing your code in response to a Task, and responding to the Temporal Server with the results.

Worker Program​

A Worker Program is the static code that defines the constraints of the Worker Process, developed using the APIs of a Temporal SDK.

Worker Service​

The Worker Service runs background processing for the replication queue, system Workflows, and (in versions older than 1.5.0) the Kafka visibility processor.

Worker Session​

A Worker Session is a feature provided by some SDKs that provides a straightforward way to ensure that Activity Tasks are executed with the same Worker without requiring you to manually specify Task Queue names.

Workflow​

In day-to-day conversations, the term "Workflow" frequently denotes either a Workflow Type, a Workflow Definition, or a Workflow Execution.

Workflow Definition​

A Workflow Definition is the code that defines the constraints of a Workflow Execution.

Workflow Execution​

A Temporal Workflow Execution is a durable, scalable, reliable, and reactive function execution. It is the main unit of execution of a Temporal Application.

Workflow Execution Timeout​

A Workflow Execution Timeout is the maximum time that a Workflow Execution can be executing (have an Open status) including retries and any usage of Continue As New.

Workflow History Export​

Workflow History export allows users to export Closed Workflow Histories to a user's Cloud Storage Sink.

Workflow Id​

A Workflow Id is a customizable, application-level identifier for a Workflow Execution that is unique to an Open Workflow Execution within a Namespace.

Workflow Id Conflict Policy​

A Workflow Id Conflict Policy determines how to resolve the conflict when spawning a new Workflow Execution with a particular Workflow Id that is used by an Open Workflow Execution already.

Workflow Id Reuse Policy​

A Workflow Id Reuse Policy determines whether a Workflow Execution is allowed to spawn with a particular Workflow Id, if that Workflow Id has been used with a previous, and now Closed, Workflow Execution.

Workflow Run Timeout​

This is the maximum amount of time that a single Workflow Run is restricted to.

Workflow Task​

A Workflow Task is a Task that contains the context needed to make progress with a Workflow Execution.

Workflow Task Execution​

A Workflow Task Execution occurs when a Worker picks up a Workflow Task and uses it to make progress on the execution of a Workflow Definition.

Workflow Task Timeout​

A Workflow Task Timeout is the maximum amount of time that the Temporal Server will wait for a Worker to start processing a Workflow Task after the Task has been pulled from the Task Queue.

Workflow Type​

A Workflow Type is a name that maps to a Workflow Definition.

tctl (deprecated)​

tctl is a command-line tool that you can use to interact with a Temporal Service. It is superseded by the Temporal CLI utility.