Module Queue

92 vues Markdown

Every job the panel gives to a module waits here: you see what is pending, what failed, and run it again.

Opening the Screen

Choose Tools › Module Queue from the menu, or open {admin}/tools/module-queue directly.

What Is on the Screen

Five figures at the top, a toolbar under them, and the job list. The figures refresh every few seconds and the list every minute. A queue being worked through updates while you watch it. On a narrow screen the toolbar opens with Show Options.

The figures

Total Tasks Every job in the queue, whatever its status.

Pending Waiting for its turn. The cron takes these in batches.

Processing Running right now. A job stuck here goes back to pending after a few minutes, or turns into a failure once its attempts run out.

Completed The module accepted the job and it is finished.

Failed Every attempt was used and the module still refused. Only these need you.

The list

A row carries the module and its type, the action, and the service or add-on the job belongs to. Next to them are the client, the creation time, the attempts against the limit, and the status. The search box above the list covers the module name, the action and the messages recorded during the run. Where your account may download listed data, the download button next to it exports the filtered list. The menu at the end of a row holds that job's actions.

The task window

View opens the whole record. At the top are the task number, module type, module, action, status and attempts. Under them sit the service, the add-on when the job belongs to one, and the client, then the created, last updated and next retry times. The process log closes the window, with the API requests where the module recorded them. Run Now and Retry also work from inside the window, and the answer appears there without a page reload. View Service at the bottom opens the related service in a new tab, where the job belongs to one.

Fields

Module, action, status and date sit behind Advanced Filter. They combine, and they stay in the address, so a narrowed list can be shared. The number on the button counts the filters in use. Closing the panel clears all of them.

Apply to Selected What to do with the ticked rows: Retry or Delete. Nothing happens while no row is ticked. No default.

Module Narrows the list to one module by name. Optional, empty by default (All Modules).

Action The job type: create, renew, suspend and the rest, named as the system names them. An action outside the list can be typed in. Optional (All Actions).

Status Pending, Processing, Completed or Failed. Optional (All Statuses).

Date Range Limits the list by creation date. Optional, empty by default.

Tasks

Run a job now

Open the row menu and choose Run Now on a pending job, or Retry on a failed one.
The job goes to the module at once instead of waiting for the cron. A failed job has its attempt count reset first.
The status and the attempts on the row update, and the process log keeps what the module answered.

Run several jobs

Tick the rows, then choose Retry under Apply to Selected.
The window counts the jobs it will take; confirm with Retry at the bottom of it.
They run one after another and the list reloads. Rows that are neither pending nor failed stay out of the run.

Retry every failed job

Click Retry All Failed. The button is off while the failed figure is zero.
Every failed job returns to pending with its attempts reset, and the cron takes them on its next run.

Clear and delete

Clear Completed removes the finished jobs after a confirmation. The button is off while the completed figure is zero.
For a single job use Delete in the row menu. For several, tick the rows and choose Delete under Apply to Selected.
Deleting more than one row asks for your own password before it runs.
The rows leave the queue. The service itself is not touched.

Things to Watch

Deleting a job is not undoing it

A deleted row is gone for good and the job is never sent to the module. Where the work still has to happen, retry it instead of deleting it.

Running a job reaches the provider

Run Now and Retry talk to the module's provider straight away. A creation or a deletion then happens on the provider as well. Read the process log before you repeat a job whose result you are unsure of.

The queue prunes itself

Completed and failed jobs are removed after the retention period set on the Automation screen. An old job may already be missing from the list. The module log keeps the longer history.

Required Privileges

The screen, the queue actions and the deletions need TOOLS_MODULE_QUEUE. Without it the page answers Access Denied. The download button in the list header follows the panel-wide TABLE_EXPORT instead; an account without that privilege never sees the button.

Cet article vous a-t-il été utile ?

Merci pour votre retour !

Besoin d'aide supplémentaire ?

Notre équipe d'assistance est disponible 24h/24 pour tout ce que vous ne trouvez pas ci-dessus.

Nous contacter Ouvrir un ticket