WJb Docs - Reference

Browse APIs, configuration options, interfaces, and implementation details.

⚡ Actions
🔀 Workflow
📦 Jobs
⚙️ Runtime
💾 Persistence
🗄 Storage
🧩 Workflow Metadata
🛠 Extensions & Helpers

JobStatus

Represents the current execution state of a job.

JobStatus allows the WJb runtime, stores, monitoring tools, and applications to determine where a job is in its lifecycle.

Purpose

A job changes state as it moves through execution.

Created
   ↓
Pending
   ↓
Running
   ↓
Completed

JobStatus provides a consistent way to observe that state.

Lifecycle

A typical successful execution flow is:

Pending
   ↓
Running
   ↓
Succeeded

A failed execution flow is:

Pending
   ↓
Running
   ↓
Failed

Depending on configuration and runtime behavior, additional transitions may occur.

Monitoring

Job status information is commonly used by:

  • Dashboards
  • Administrative tools
  • Monitoring systems
  • Queries
  • Support tools

Filtering

Status information is often used to locate jobs.

Examples:

Show Failed Jobs
Show Running Jobs
Show Pending Jobs

This makes status one of the most frequently queried job properties.

Relationship to JobInfo

JobInfo contains information about a job.

JobStatus represents the job's current state.

JobInfo
    ↓
JobStatus

Relationship to JobProgress

Progress indicates how much work has been completed.

Status indicates the current execution state.

JobStatus
       ↓
Running

JobProgress ↓ 75%

Both pieces of information are often displayed together.

Runtime Usage

Workers and stores rely on status transitions to coordinate execution.

Worker
   ↓
Status Change
   ↓
Store

Accurate status information is essential for reliable job processing.

Best Practices

Use Status for Monitoring

Prefer JobStatus when determining job state.

Avoid Inferring State

Do not infer job status from timestamps, logs, or progress information when a status value is available.

Query by Status

Use status-based filtering when building dashboards and operational reports.

Related Types

  • JobInfo
  • JobProgress
  • JobQuery
  • JobEnvelope

See Also

  • JobInfo
  • JobProgress
  • JobQuery
An unhandled error has occurred. Reload 🗙

Rejoining the server...

Rejoin failed... trying again in seconds.

Failed to rejoin.
Please retry or reload the page.

The session has been paused by the server.

Failed to resume the session.
Please retry or reload the page.