Glossary
The following terms are used in Temporal Platform documentation.
Action
An Action is the fundamental pricing unit in Temporal Cloud.
Tags: term, pricing, temporal-cloud, explanation
Activity
In day-to-day conversation, the term "Activity" denotes an Activity Type, Activity Definition, or Activity Execution.
Tags: term, explanation
Activity Definition
An Activity Definition is the code that defines the constraints of an Activity Task Execution.
Tags: term, explanation
Activity Execution
An Activity Execution is the full chain of Activity Task Executions.
Tags: term, explanation
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.
Tags: term, explanation
Activity Id
A unique identifier for an Activity Execution.
Tags: term, explanation
Activity Task
An Activity Task contains the context needed to make an Activity Task Execution.
Tags: term, explanation
Activity Task Execution
An Activity Task Execution occurs when a Worker uses the context provided from the Activity Task and executes the Activity Definition.
Tags: term, explanation
Activity Type
An Activity Type is the mapping of a name to an Activity Definition.
Tags: term, explanation
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.
Tags: term, explanation
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.
Tags: term, explanation
Audit Logging
Audit Logging is a feature that provides forensic access information for accounts, users, and Namespaces.
Tags: term, explanation, temporal-cloud, operations
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.
Tags: term
Child Workflow
A Child Workflow Execution is a Workflow Execution that is spawned from within another Workflow.
Tags: term, explanation, child-workflow
Claim Mapper
The Claim Mapper component is a pluggable component that extracts Claims from JSON Web Tokens (JWTs).
Tags: term
Codec Server
A Codec Server is an HTTP server that uses your custom Payload Codec to encode and decode your data remotely through endpoints.
Tags: term
Command
A Command is a requested action issued by a Worker to the Temporal Service after a Workflow Task Execution completes.
Tags: term, explanation
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.
Tags: term, explanation, continue-as-new
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.
Tags: term, explanation, continue-as-new
Custom Data Converter
A custom Data Converter extends the default Data Converter with custom logic for Payload conversion or Payload encryption.
Tags: term, explanation
Data Converter
A Data Converter is a Temporal SDK component that serializes and encodes data entering and exiting a Temporal Service.
Tags: term, explanation
Default Data Converter
The default Data Converter is used by the Temporal SDK to convert objects into bytes using a series of Payload Converters.
Tags: term, explanation
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.
Tags: term, explanation, delay-workflow
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.
Tags: term, explanation, filtered-lists, visibility
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.
Tags: temporal, durable-execution, term
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.
Tags: term, explanation
Event
Events are created by a Temporal Service in response to external occurrences and Commands generated by a Workflow Execution.
Tags: term, explanation
Event History
An append-only log of Events that represents the full state a Workflow Execution.
Tags: term, explanation
Failover
A Failover shifts Workflow Execution processing from an active Temporal Namespace to a standby Temporal Namespace during outages or other incidents. Standby Namespaces use replication to duplicate data and prevent data loss during Failover.
Tags: term, explanation
Failure
Temporal Failures are representations of various types of errors that occur in the system.
Tags: term, explanation
Failure Converter
A Failure Converter converts error objects to proto Failures and back.
Tags: term, explanation
Failures
A Failure is Temporal's representation of various types of errors that occur in the system.
Tags: failure, explanation, term
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.
Tags: term
General Availability
Learn more about the General Availability release stage
Tags: product-release-stages, term
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.
Tags: term, explanation
Heartbeat Timeout
A Heartbeat Timeout is the maximum time between Activity Heartbeats.
Tags: term, explanation, timeouts
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.
Tags: term
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.
Tags: term
List Filter
A List Filter is the SQL-like string that is provided as the parameter to an advanced Visibility List API.
Tags: term, explanation, filtered-lists, visibility
Local Activity
A Local Activity is an Activity Execution that executes in the same process as the Workflow Execution that spawns it.
Tags: term, explanation
Matching Service
The Matching Service is responsible for hosting external Task Queues for Task dispatching.
Tags: term
Memo
A Memo is a non-indexed user-supplied set of Workflow Execution metadata that is returned when you describe or list Workflow Executions.
Tags: term, explanation
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.
Tags: term, explanation
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.
Tags: term, explanation
Namespace
A Namespace is a unit of isolation within the Temporal Platform
Tags: term, explanation
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).
Tags: term, explanation, child-workflow-executions
Payload
A Payload represents binary data such as input and output from Activities and Workflows.
Tags: term, payloads, explanation
Payload Codec
A Payload Codec transforms an array of Payloads into another array of Payloads.
Tags: term, explanation
Payload Converter
A Payload Converter serializes data, converting objects or values to bytes and back.
Tags: term, explanation
Pre-release
Learn more about the Pre-release stage
Tags: product-release-stages, term
Public Preview
Learn more about the Public Preview release stage
Tags: product-release-stages, term
Query
A Query is a synchronous operation that is used to report the state of a Workflow Execution.
Tags: term, queries, explanation
Remote data encoding
Remote data encding is using your custom Data Converter to decode (and encode) your Payloads remotely through endpoints.
Tags: term, explanation
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.
Tags: term, resets, explanation
Retention Period
A Retention Period is the amount of time a Workflow Execution Event History remains in the Temporal Service's persistence store.
Tags: term, explanation
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.
Tags: term, explanation
Run Id
A Run Id is a globally unique, platform-level identifier for a Workflow Execution.
Tags: term, explanation
Schedule
A Schedule enables the scheduling of Workflow Executions.
Tags: term, explanation
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.
Tags: term, explanation, timeouts
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.
Tags: term, explanation, timeouts
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.
Tags: term, explanation, filtered-lists, visibility
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.
Tags: term, explanation
Signal
A Signal is an asynchronous request to a Workflow Execution.
Tags: term, signals, explanation
Signal-With-Start
Signal-With-Start starts and Signals a Workflow Execution, or just Signals it if it already exists.
Tags: term, explanation
Start-To-Close Timeout
A Start-To-Close Timeout is the maximum time allowed for a single Activity Task Execution.
Tags: term, explanation, timeouts
State Transition
A State Transition is a unit of progress by a Workflow Execution.
Tags: term, explanation
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.
Tags: term, explanation
Task
A Task is the context needed to make progress with a specific Workflow Execution or Activity Execution.
Tags: term, explanation
Task Queue
A Task Queue is a first-in, first-out queue that a Worker Process polls for Tasks.
Tags: term, explanation
Task Routing
Task Routing is when a Task Queue is paired with one or more Worker Processes, primarily for Activity Task Executions.
Tags: term, explanation
Task Token
A Task Token is a unique identifier for an Activity Task Execution.
Tags: term, explanation
Temporal
Temporal is a scalable and reliable runtime for Reentrant Processes called Temporal Workflow Executions.
Tags: term, explanation
Temporal Application
A Temporal Application is a set of Workflow Executions.
Tags: term, explanation
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.
Tags: term, explanation
Temporal Cloud
Temporal Cloud is a managed, hosted Temporal environment that provides a platform for Temporal Applications.
Tags: term, explanation
Temporal Cloud Account Id
A Temporal Cloud Account Id is a unique identifier for a customer.
Tags: term, explanation
Temporal Cloud Namespace Id
A Cloud Namespace Id is a globally unique identifier for a Namespace in Temporal Cloud.
Tags: term, explanation
Temporal Cloud Namespace Name
A Cloud Namespace Name is a customer-supplied name for a Namespace in Temporal Cloud.
Tags: term, explanation
Temporal Cloud gRPC Endpoint
A Cloud gRPC Endpoint is a Namespace-specific address used to access Temporal Cloud from your code.
Tags: term, explanation
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.
Tags: term, explanation
Temporal Service configuration
Temporal Service configuration is the setup and configuration details of your Temporal Service, defined using YAML.
Tags: term, explanation
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.
Tags: term, explanation
Temporal Platform
The Temporal Platform consists of a Temporal Service and Worker Processes.
Tags: term, explanation
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.
Tags: term, explanation
Temporal Server
The Temporal Server is a grouping of four horizontally scalable services.
Tags: term, explanation
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.
Tags: term, explanation
Update
An Update is a request to and a response from Workflow Execution.
Tags: term, updates, explanation
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.
Tags: term
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.
Tags: term, explanation
Worker Entity
A Worker Entity is the individual Worker within a Worker Process that listens to a specific Task Queue.
Tags: term, explanation
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.
Tags: term, explanation
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.
Tags: term, explanation
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.
Tags: term
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.
Tags: term, explanation
Workflow
In day-to-day conversations, the term "Workflow" frequently denotes either a Workflow Type, a Workflow Definition, or a Workflow Execution.
Tags: term, explanation
Workflow Definition
A Workflow Definition is the code that defines the constraints of a Workflow Execution.
Tags: term, explanation
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.
Tags: term, explanation
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.
Tags: term, explanation, timeouts
Workflow History Export
Workflow History export allows users to export Closed Workflow Histories to a user's Cloud Storage Sink
Tags: term, explanation, temporal-cloud, operations
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.
Tags: term, explanation
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.
Tags: term, explanation
Workflow Run Timeout
This is the maximum amount of time that a single Workflow Run is restricted to.
Tags: term, explanation, timeouts
Workflow Task
A Workflow Task is a Task that contains the context needed to make progress with a Workflow Execution.
Tags: term, explanation
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.
Tags: term, explanation
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.
Tags: term, explanation, timeouts
Workflow Type
A Workflow Type is a name that maps to a Workflow Definition.
Tags: term, explanation
tctl (deprecated)
tctl is a command-line tool that you can use to interact with a Temporal Service. It is superceded by the Temporal CLI utility