WJb Docs - Reference
Browse APIs, configuration options, interfaces, and implementation details.
⚡ Actions
🔀 Workflow
📦 Jobs
⚙️ Runtime
💾 Persistence
🗄 Storage
🧩 Workflow Metadata
🛠 Extensions & Helpers
JobProgress
Represents the current progress of a job.
JobProgress provides progress information that can be used by the runtime, monitoring tools, dashboards, and user interfaces to track long-running work.
Purpose
Use JobProgress to observe how much work has been completed by a job.
Running Job
↓
JobProgress
↓
Monitoring
Progress information allows systems to display execution status while a job is still running.
Responsibilities
Progress data typically describes:
- Current progress state
- Completion percentage
- Processed work items
- Status messages
- Execution checkpoints
Execution Flow
IProgressAction
↓
JobProgress
↓
Dashboard
Actions report progress while executing.
Consumers read JobProgress to track execution.
Monitoring
JobProgress is commonly used by:
- Administrative dashboards
- Monitoring systems
- UI components
- Support tools
- Operational reporting
Typical Usage
Long-running work often exposes progress information.
Examples:
Import Records
Generate Reports
Upload Files
Process Images
Synchronize Data
Progress updates provide visibility into execution.
Relationship to IProgressAction
IProgressAction produces progress updates.
JobProgress stores and exposes those updates.
IProgressAction
↓
JobProgress
Relationship to JobInfo
Progress belongs to a job.
JobInfo
↓
JobProgress
Monitoring tools commonly read progress information through a job record.
Best Practices
Report Meaningful Progress
Progress updates should reflect actual work completed.
Avoid Excessive Updates
Reporting too frequently may create unnecessary overhead.
Use Progress for Observation
Business logic should not depend on progress values.
Progress is intended for monitoring and diagnostics.
Related Types
- IProgressAction
- JobInfo
- JobStatus
- JobQuery
See Also
- IProgressAction
- JobInfo
- JobStatus
- JobQuery