Console Reference: c3QReport
c3QReport displays the status of a specified queue in a table. A queue holds a list of jobs (asynchronous processes) executed in your application environment. To learn more about queues, see Overview of Invalidation Queues and Asynchronous Process and Monitor and Manage Queues.
Parameters
| Name | Required | Type | Description |
|---|---|---|---|
queue | ✓ | Type | The queue to be cleared. |
groupByTargetObjId | Boolean | When true, group rows by Type identifier. | |
groupByContext | Boolean | When true, group rows by execution context. |
The value of the queue parameter must be an instance of a Queue, or c3QReport will throw an error.
Examples
Report the status of BatchQueues:
JavaScript
c3QReport(BatchQueue);
// Example output:
//
// | targetTypeId | targetType | status | count
// --+--------------+------------+--------+------
// 0 | 54 | WordCount | failed | 2Group rows by target object ID. This adds a targetObjId column to the report:
JavaScript
c3QReport(BatchQueue, true);
// Example output:
//
// | targetTypeId | targetType | targetObjId | priority | status | count
// --+--------------+------------+-----------------+----------+--------+------
// 0 | 54 | WordCount | WordEnumeration | 300 | failed | 1
// 1 | 54 | WordCount | WordCount | 300 | failed | 1Group rows by execution context. This adds a context column to the report:
JavaScript
c3QReport(BatchQueue, false, true);
// Example output:
//
// | targetTypeId | targetType | context | status | count
// --+--------------+------------+-----------------------+--------+------
// 0 | 54 | WordCount | run:C:dispatchDoStart | failed | 1
// 1 | 54 | WordCount | run:B:dispatchDoStart | failed | 1You can set both groupByTargetObjId and groupByContext to true. This adds both targetObjId and context columns to the log output.
JavaScript
c3QReport(BatchQueue, true, true);
// Example output:
//
// | targetTypeId | targetType | targetObjId | context | status | count
// --+--------------+------------+-----------------+-----------------------+--------+------
// 0 | 54 | WordCount | WordEnumeration | run:C:dispatchDoStart | failed | 1
// 1 | 54 | WordCount | WordCount | run:B:dispatchDoStart | failed | 1