Development build — sample configuration

See background jobs

Follow the tasks the system runs on its own, such as billing cycles and report exports, and retry the ones that failed.

Some work takes too long to happen while someone waits on a screen: running a billing cycle, preparing invoices as PDF files, exporting a report. The system does this work on its own, in the background, as jobs. The platform Background jobs screen lists these jobs for every water utility, so the platform team can see what is running and step in when something fails.

Before you start#

  • Your role must be allowed to read background jobs. To retry a failed job, it must also be allowed to change them.
  • Some installations run without a work queue. In that case the screen shows Background jobs are not active and long tasks run straight away instead.

Step 1: See what is running#

  1. In the platform menu, open Background jobs.
  2. The Jobs tab lists recent jobs with Job, Status, Utility, Attempts, Created and Finished.
  3. Job tells you what kind of work it is, for example Billing cycle, Billing schedule, Report export, Compliance export, PDF invoices or Automations.
  4. Attempts shows how many tries the job has used out of the tries it is allowed. A job that fails is tried again on its own.

Step 2: Look at a job in detail#

  1. Click a job to open it.
  2. Read Type, Available, Started and Finished to see when it was queued and how long it ran.
  3. If it went wrong, Last error shows what the system recorded. Source request helps trace the action that started it.

Step 3: Retry a failed job#

  1. Open the Failed tab. It lists the jobs that used up all their attempts, with Failed, Last error and Retry.
  2. Jobs marked To retry have not been retried yet.
  3. Fix the cause first if you can, for example a missing setting for that utility.
  4. Click the job, then Retry job, and confirm in Retry this job.
  5. You see Job added back to the queue. The job is marked Retried, and View retried job opens the new copy.

What happens next#

The retried job runs as a new job and appears on the Jobs tab. Each failed job can be retried only once. If the new copy fails too, it lands on the Failed tab again with its own error, which usually means the cause has not been fixed yet. The platform Home shows Jobs queued and Failed jobs, so you can spot a build-up early.

Common problems#

  • This job has already been retried. Each failed job can be retried only once. Open the retried copy instead.
  • No error details. The job failed without recording why. Check the utility's settings and the audit records around that time.
  • Could not retry the job. The retry was not saved. Try again in a moment.
  • No background work yet. No billing cycle or export has run in the background yet.

Start today. Set up your utility in minutes.