Job Queue (object)
Table of Contents
Note
This page refers to the Job Queue object for RIO Education V3. If you are looking for V4, check here.
Job Queue
- For the framework overview, see: Queue Management System Framework.
- For the configuration behind each job type, see: Job Queue Config (Custom Metadata Type).
The Job Queue object stores and tracks background jobs in RIO Education. These jobs handle large amounts of data behind the scenes so users don't have to process them manually. Each record in the Job Queue tells you what the job is, which records it's working on, its progress, and its outcome.
Sample Model
Based on the configured batch size, a single request may generate multiple Job Queue records. In this case, a Job Queue Group is created to organize and group those related Job Queues together. The group provides an overview of the entire request, including the total number of jobs, how many succeeded, and how many failed. Logs are linked to both the group and individual jobs, making it easier to monitor progress, review results, and troubleshoot issues.
Related Records
The following records are related to the Job Queue:
- Job Queue Group - the parent group collecting all related jobs from the same request for easier tracking and monitoring.
- Logs - the info, warning, and error log entries recorded while the job ran, shown on the record page's "Processing History" tab.
Related Features and Actions
- "Retry Job" button - retries a failed or cancelled job. The retry creates a new Job Queue record (referencing the original through its Origin Job Queue ID) and marks the original as Retry Attempted. When retrying errors only, just the record Ids listed in "Job Handler Error Record Ids" are reprocessed. Jobs that are still Pending or Processing cannot be retried.
- "Cancel Job" button - cancels the job if it has not run yet.
Important Fields
Job Queue records are created and maintained by the queue framework - apart from Status, the fields are read-only on the page.
| Field | Description | Notes |
|---|---|---|
| Job Queue ID | Auto-generated record number (e.g. JOB-00001). | Assigned automatically. |
| Job Queue Group | Lookup to the Job Queue Group, which collects all related jobs from the same request for easier tracking and monitoring. | - |
| Job Operation | The job operation, matching a record of the Job Queue Config metadata that defines how this type of job runs. | - |
| Job Operation Context | Track the job context for wizard filtering purposes. | - |
|
Source Record Name Source Record Id |
The name and Id of the source record that initiated the job. These could be used by wizards for searching purposes. | - |
| Status |
The job status. Options:
|
- |
|
Start Datetime End Datetime |
The date and time of when the job started and ended. | - |
| Retry Attempted | Checkbox indicating that the job has been retried. | - |
| Origin Job Queue ID | On a retry job, tracks the original Job Queue's ID, so the retry can be traced back for monitoring purposes. | - |
| Number of Attempts | The number of attempts that have been attempted for the job. | - |
|
Number of Records Number of Success Records Number of Error Records Number of Warning Records |
The counts of the records this job processed: in total, and by their result (success / error / warning). | Counted automatically from the corresponding "Job Handler ... Record Ids" fields. |
| Job Handler Class Name | The handler Apex class name to be initiated by the Job Queue Worker. | - |
| Job Handler Record Ids | The record ids in semi-colon separated string to be set on the job handler by the Job Queue Worker - the records this job processes. | - |
| Job Handler Params | The parameters in json serialized string to be set on the job handler by the Job Queue Worker. | - |
|
Job Handler Success Record Ids Job Handler Error Record Ids Job Handler Warning Record Ids |
The record ids that were reported with success / error / warning by the job handler, in semi-colon separated values. | The error record ids are used when the job is retried with "errors only". |
Frequently Asked Questions
How do I retry a failed job?
Use the "Retry Job" button on the Job Queue (or its Job Queue Group). A new Job Queue record is created for the retry - referencing the original through its Origin Job Queue ID - and the original is marked as Retry Attempted. Retrying "errors only" reprocesses just the record Ids in "Job Handler Error Record Ids". Jobs that are Pending or Processing cannot be retried.
Can I edit a Job Queue record?
No - Job Queue records are created and maintained by the queue framework, and their fields are read-only on the page. Use the Retry Job and Cancel Job buttons to act on a job instead.
Where do I see what went wrong with a job?
Open the "Processing History" tab on the Job Queue record - the Logs listed there hold the info, warning, and error entries recorded while the job ran, including error details for troubleshooting.