plinthHelp Deutsch

Jobs

Follow background jobs such as imports, scans and bulk changes, cancel them and find out why one failed.

Everything that takes longer runs in the background as a job: syncs, imports, scans and bulk changes. You keep working while a job runs. The jobs tray in the top bar shows what is running right now, and the page Jobs shows the full history with progress and errors.

Where to find it

  • The tray: the button Background jobs in the top bar. A ring around it shows that something is running, and a number shows how many jobs are active.
  • The page: Help and administration > Jobs, or History in the tray. Its address is /s/<shop>/jobs.
  • The start page shows Failed background jobs and Running background jobs under To do when there are any.

What you need

  • Access to the shop. Everybody sees their own jobs. The header then says yours only.
  • People who manage the jobs of the whole shop see the jobs of everyone, the card Initial data import and the buttons to stop all jobs. By default these are the roles Owner and Management.

How do I follow a job?

Video: Background jobs: check status and cancel (0:21)
  1. Start something that runs in the background, for example a scan or a bulk change.
  2. Click Background jobs in the top bar. The tray lists active and recent jobs with their progress.
  3. You may leave the page. The job keeps running when you leave the page.
  4. When a job finishes, a short message appears: Done: with the job name, or Job failed.
  5. For details click History. On the page Jobs, click the arrow at the start of a row. The row opens and shows the message, the error text if there is one, the area, the progress as numbers, who started it and when.

How do I read the page Jobs?

  1. The four tiles at the top count the jobs by state: Running, Queued, Failed and Done. A click filters the list by this state, a second click removes the filter.
  2. Further filters: Awaiting approval, Canceled and Undone, and on the left the Area the job belongs to.
  3. The search field Job, type, person narrows the list by text.
  4. The table shows Job, Area, Status, Progress, Started by and Time. Jobs that plinth starts by itself, for example the nightly statistics run, show System as the starter.

What do the states mean?

State Meaning
Running Running right now. The progress updates by itself.
Queued Waiting for a free slot; it starts by itself.
Awaiting approval Waiting for a second person to approve it. Nothing changes until then.
Done Finished. Expand the row for the details.
Failed Stopped with an error. Expand the row for the reason, then start it again.
Canceled Cancelled by a person. What was already written stays.
Undone The changes of this job were undone.

How do I cancel one job?

You can cancel a job that is Queued or Running if you started it or if you manage the jobs of this area.

  1. Open Help and administration > Jobs.
  2. Find the job. Click the cancel button at the end of its row, or expand the row and click Cancel.
  3. Confirm Cancel this job? with Cancel.

A running job stops at its next check, not in the same second. What was already written stays. Cancelling does not undo anything.

How do I stop all jobs?

This is for people who manage the jobs of the whole shop.

  1. Open Help and administration > Jobs.
  2. In the card Initial data import, choose one of the two buttons:
    • Stop all waiting jobs: jobs that have not started are cancelled. Running jobs keep running.
    • Stop waiting and running jobs: waiting jobs are cancelled and running jobs stop at their next check. What was already written stays.
  3. Confirm.

Warning: Stopping all jobs also stops jobs of your colleagues. Use it when a shop is overloaded or something was started by mistake, not as a routine.

How do I see the state of the first import?

The card Initial data import on the page Jobs lists the jobs of the first import, each with its state: Waiting, Running with the count, Done at with the time, Failed or Not run yet. The statistics jobs are marked (background import) and finish last. The wizard shows the same list in its step First import. See Onboarding wizard.

How do I undo a job?

The page Jobs shows that a job was undone (state Undone), but undoing is done in the area that started the job. There you also see exactly what would be restored.

  • Price changes: Prices and promotions > Price runs. See Prices.
  • Bulk changes: Prices and promotions > Planned changes. See Bulk editing.
  • Other areas that write to the shop offer undo at the change or run itself. See the help page of the area.

Not every job can be undone. Scans, imports and statistics jobs only read from the shop, so there is nothing to take back.

How do I approve a job?

A job in the state Awaiting approval needs a second person. The approval is given in the area that created the job, for example under Prices or Workflow. The person who created the job cannot approve it themselves.

Why did my job fail?

Expand the row. The reason is shown in red.

Reason Cause Fix
Interrupted by a restart. Start it again. plinth was restarted while the job ran. Start the job again in its area.
A message that the Shopware sign-in has expired The job writes to the shop in your name and needs your Shopware sign-in. It ran out before or while the job ran. Sign in again (through Shopware) and start the job again.
A message that the shop is read-only The shop is set to Read-only. Jobs that could write are refused. Nothing to fix. If the shop should be writable, a person with Manage shops changes that. See Onboarding wizard.
This job can't run here. This installation cannot run this kind of job. Report the problem.
An error from Shopware Shopware refused or could not be reached. Try again later. If it keeps failing, report the problem with the error text.

Note: If you have a local account without a Shopware sign-in, your jobs write through the shop's integration. This is recorded in the audit log with your name.

Common errors and fixes

Message Cause Fix
Couldn't load the jobs. The list could not be read. Reload the page.
The job can't be canceled. The job is already finished, or you are not allowed to cancel it. Reload the page and check its state.
Couldn't cancel the jobs. Stopping all jobs failed. Try again; if it persists, report the problem.
Another user must approve. You created the job and tried to approve it yourself. Ask a second person with the approve permission.
Entries were changed after the job ran. Something the job changed has been edited since. Undo would overwrite the newer change. Check the entries in the area before you decide.
The change data of this job no longer exists. It can't be undone. The stored before-values of the job are gone. Correct the data by hand or with a new change.
Job not found. The job does not exist or belongs to another shop. Check the shop you are in.

See also