# Task Queue Tool
# About Task Queue Tool
The task Queue tool enables you to manage and monitor all tasks generated by the module, with filters to sort by type and detailed views showing status, related items, and timestamps.
It offers options to run, delete, or view individual tasks, along with search and sorting capabilities for specific entries.
Additional features include bulk task deletion and automatic pruning after a set period.
# Management
The Queue section allows you to manage and monitor tasks issued by the module.
It is directly accessible from the main menu, providing a centralized location for task management.
Important: Some modules may not yet include the latest version of this tool, but upcoming updates will provide access to the most current features.
# Task List
The Queue section includes the Task List, where you can view all tasks issued by the module.
You can filter the tasks by type using the 'Show More' buttons for more straightforward navigation.
Possible task statuses to be displayed:
- Pending - Indicates that the job is queued and awaiting execution.
- Waiting - The job has been initialized but is currently waiting before it can proceed.
- Running - The job is actively being executed.
- Cancelled - The job was terminated manually before it could be completed.
- Failed - The job failed permanently after exceeding the number of retry attempts.
- Error - The job encountered a temporary error and is scheduled to retry.
- Finished - The job completed all tasks successfully.
- Total - Represents the overall count of jobs in all statuses.
The information on each task includes:
- Task ID
- Related item
- Task status
- Task type
- Attempts taken
- Date of creation
- Date of the last status update
You may also use the action buttons to:
- See task details
- Manually run the task
- Delete the task
To find specific tasks use the search and sorting functions.
# Task Details
Details provide important information about each task to help you monitor its progress.
It includes data that allows you to track the task's status, retries, and key timestamps.
- Task ID
- Job
- Queue
- Retry Count
- Parent ID
- Type
- Related Item
- Custom Relation
- Status
- Retry After Date
- Created At Date
- Updated At Date
Related log entries can be found in a separate tab.
# Mass Actions
Tasks can also be deleted with the mass action function.
Simply mark the checkboxes next to the tasks you want to delete, and confirm the action by clicking on the 'Delete' button.
# Additional Actions
Additional actions include the 'Auto Prune' system, which automatically deletes tasks after a predefined number of days.
This helps keep the task queue organized and free of outdated entries. There is also an option to disable cron job information.
The options are in order:
- Auto Prune - enable or disable the auto prune system, which will automatically delete tasks after a specified time.
- Auto Prune Older Than - specify the time period for auto prune system, tasks older than provided number of days will be deleted.
- Display 'Cron Job Configuration' Hint - display or hide the 'Cron Job Configuration' hint at the top of the page.