SAService Architect Back to designer
SAService ArchitectDocumentation
Scheduling & TemporalTemporal
Scheduling guide Activity | Workflow

Temporal endpoint properties

Common configuration for on-demand execution and optional durable scheduling.

When to use

Use this page while designing, implementing, operating, or troubleshooting scheduled and durable execution.

Behavior

  • temporalExecutionType selects Activity or Workflow generation.
  • taskQueue binds starters and workers.
  • The generator groups endpoints by connector, Task Queue, and execution type to derive Worker capacity.
  • enabled: false preserves graph wiring but does not start this endpoint external integration.
  • tracingEnabled is evaluated for admitted Input events; Sink adapters ignore it and propagate existing message context instead.
  • Empty schedule means on-demand only; a non-empty value also provisions a Temporal Schedule.

Why schedule fields may be empty

Most Temporal Activity and Workflow endpoints are started on demand by a Temporal Sink and do not own a Temporal Schedule. Empty schedule and scheduleId values are correct for those endpoints.

  • On demand: keep both schedule and scheduleId empty.
  • Scheduled: provide both a five-field schedule and a stable scheduleId.
  • scheduleId does not apply to a normal Cron endpoint.

Execution properties

Durable execution identity and routing.

PropertyTypeDescription
temporalExecutionTypeenum

Generated execution type.

RequiredDefault: ActivityAllowed: Activity, Workflow
taskQueuestring

Task Queue shared by the generated starter and Worker.

RequiredDefault: default

Worker capacity properties

Endpoint-owned limits aggregated into the Worker for one connector and Task Queue.

PropertyTypeDescription
maxConcurrentActivitiesinteger

Maximum Activity Tasks that the Worker may execute concurrently.

RequiredDefault: 2Minimum: 1Activity only.
maxConcurrentWorkflowTasksinteger

Maximum Workflow Tasks that the Worker may process concurrently. It does not limit open Workflow executions.

RequiredDefault: 4Minimum: 1Workflow only.

Timeouts and retry properties

Execution duration, heartbeat, and attempt policy.

PropertyTypeDescription
workflowExecutionTimeoutmilliseconds

Total execution limit; zero means no explicit limit.

Default: 0Minimum: 0
activityStartToCloseTimeoutmilliseconds

One Activity attempt limit.

Default: 30000Minimum: 1Activity only.
activityHeartbeatTimeoutmilliseconds

Heartbeat limit; zero disables it.

Default: 0Minimum: 0Activity only.
maximumAttemptsinteger

Maximum Activity attempts including the initial attempt. Required by the current endpoint contract in both modes, but it does not define Workflow retry policy.

RequiredDefault: 1Minimum: 1

Schedule properties

Optional durable schedule fields.

PropertyTypeDescription
enabledboolean

Enables endpoint registration.

Default: true
tracingEnabledboolean

Creates tracing for each admitted scheduled execution.

Default: false
schedulestring

Optional five-field cron expression without seconds. Empty means this endpoint is started on demand only.

scheduleIdstring

Permanent unique Schedule identity inside the Temporal namespace, for example billing-reconciliation-workflow-schedule. It is not a cron expression or generated number.

Required when schedule is non-empty.
timezoneenum

Schedule timezone.

Default: UTCAllowed: UTC
overlapPolicyenum

Scheduled start overlap.

Default: SkipAllowed: Allow, Skip
missedRunPolicyenum

Missed scheduled starts.

Default: FireOnceAllowed: Skip, FireOnce

On-demand endpoint

temporalExecutionType: Activity
taskQueue: billing
maxConcurrentActivities: 2
maximumAttempts: 3
activityStartToCloseTimeout: 30000
schedule: ""
scheduleId: ""