Difference between revisions of "Module Queue"

From WHMCS Documentation

 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
The Module Queue lists, and allows quick retry of, failed automated actions. An automated action is one that is not manually initiated from the Service or Domain view by clicking a button.
+
<div class="docs-alert-info"><i class="fa fa-info-circle"></i> This page describes a feature available in version 7.1 and above.</div>
 +
 
 +
The module queue lists and allows quick retry of failed automated actions. An automated action is one that is not manually initiated from the '''Service''' or '''Domain''' views by clicking a button.
 +
 
 +
You can access this feature at '''Utilities > Module Queue'''.
  
 
==What is the Module Queue for?==
 
==What is the Module Queue for?==
The queue will allow for individual retries or dismissals of errors, along with a mass retry of all actions.
+
The queue will allow individual retries and dismissals of errors or a mass retry of all issues in the list.
  
 
==What information is on the Module Queue?==
 
==What information is on the Module Queue?==
The entries are displayed with the client name, package name and associated domain along with the action being completed and the latest error and last attempt time.
+
The entries display the client name, package name, and associated domain. It also lists the completed action, latest error, and last attempt time.
  
[[File:module_queue.png|400px]]
+
[[File:module_queue.png|600px]]
  
 
==What happens after a retry?==
 
==What happens after a retry?==
A retry, dismissal or mass retry will provide updated information, without a page reload, to provide information for the latest retry, or a success message as appropriate.
+
A retry, dismissal, or mass retry will provide updated information, without a page reload, to provide information for the latest retry, or a success message, as appropriate.
  
[[File:module_queue_retried.png]]
+
[[File:module_queue_retried.png|600px]]
  
 
==What if I fix the item directly?==
 
==What if I fix the item directly?==
A retry directly on the service or domain for a queue item from the appropriate Admin page will mark the attempt as completed if the action is subsequently successful and so will no longer appear in the queue list.
+
A retry directly on the service or domain for a queue item from the appropriate admin page will mark the attempt as complete if the action is subsequently successful. It will no longer appear in the queue list.

Latest revision as of 22:34, 14 April 2022

This page describes a feature available in version 7.1 and above.

The module queue lists and allows quick retry of failed automated actions. An automated action is one that is not manually initiated from the Service or Domain views by clicking a button.

You can access this feature at Utilities > Module Queue.

What is the Module Queue for?

The queue will allow individual retries and dismissals of errors or a mass retry of all issues in the list.

What information is on the Module Queue?

The entries display the client name, package name, and associated domain. It also lists the completed action, latest error, and last attempt time.

Module queue.png

What happens after a retry?

A retry, dismissal, or mass retry will provide updated information, without a page reload, to provide information for the latest retry, or a success message, as appropriate.

Module queue retried.png

What if I fix the item directly?

A retry directly on the service or domain for a queue item from the appropriate admin page will mark the attempt as complete if the action is subsequently successful. It will no longer appear in the queue list.