Job Queue Group (object)
Table of Contents
Note
This page refers to the Job Queue Group for RIO Education V3. If you are looking for V4, check here.
Job Queue Group
- For the framework overview, see: Queue Management System Framework.
- For the configuration behind each job type, see: Job Queue Config (Custom Metadata Type).
A Job Queue Group represents a set of related jobs that were started together as part of a single request.
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.
How to Use This Information
- For monitoring: Check the Job Queue Group status to know whether your request is still processing, completed, failed, or cancelled.
- For results: Review the counts (Total Jobs, Success Records, Error Records) to understand the outcome of your request.
- For troubleshooting: Open the logs linked to the group to see details of what happened with each Job Queue.
Related Records
The following records are related to the Job Queue Group:
- Job Queues - the individual jobs belonging to this request, shown on the record page's "Job Queues" tab.
- Logs (Errors) - the info, warning, and error log entries recorded for this group, shown on the record page's "Troubleshooting Logs" tab.
Related Features and Actions
- "Retry Job" button - retries the group's failed jobs.
- "Cancel Job" button - cancels the group's jobs that have not run yet.
Important Fields
Apart from Status and Notes, the fields below are maintained automatically by the queue framework as the group's Job Queues run - they are read-only on the page.
| Field | Description | Notes |
|---|---|---|
| Job Queue Group # | Auto-generated record number (e.g. JQG-00001). | Assigned automatically. |
| Job Operation Context | Track the job context for wizard filtering purposes. | - |
| Status |
The overall status of the request. Options:
|
Derived automatically from the child Job Queues' statuses: Pending while all jobs are pending, Processing while any job is processing, then Failed if any job failed, Cancelled if all were cancelled, or Completed otherwise. A group already Cancelled is not overwritten. |
|
Total Jobs Completed Jobs Failed Jobs Cancelled Jobs |
Counts of the group's Job Queues: in total, and by their outcome (completed / failed / cancelled). | Maintained by automation as the jobs run. |
|
Total Records Success Records Error Records Warning Records |
Sums of the records processed across the group's Job Queues, in total and by their result (success / error / warning). | Maintained by automation. Only completed and failed jobs are counted - cancelled jobs' records are excluded. |
| Start Datetime | The date and time when the request started - the earliest start of the group's finished Job Queues. | - |
| End Datetime | The date and time when the request ended - the latest end of the group's finished Job Queues. | - |
| Notes | Notes for the job queue group, such as remarks. | - |
| Job Summary | A short summary of the job/related parameters. | - |
Frequently Asked Questions
Why don't the record counts add up after cancelling some jobs?
The group's record counts (Total / Success / Error / Warning Records) only sum the jobs that actually ran to an outcome - completed or failed. Records belonging to cancelled Job Queues are deliberately excluded.
Why is the group still "Processing" when most jobs are done?
The group's Status follows its child Job Queues: it stays Processing while any job is still processing, and only settles into Completed, Failed, or Cancelled once every job has reached an outcome.
What happens to the Job Queues if I delete a Job Queue Group?
Deleting a group also deletes its related child records (its Job Queues and Logs), so only delete a group when its history is no longer needed.